Ang pagsulat ng dokumentasyon ng software ay gumaganap ng mahalagang papel sa gawain ng isang programmer. Gaya ng sinasabi nila, kung hindi ito dokumentado, hindi ito umiiral, at sa karamihan ng mga kaso, ang pagdodokumento ng iyong code sa wastong paraan ay kasinghalaga ng aktwal na pagsulat nito. “Gaano man kaganda ang iyong library at gaano man katalino ang disenyo nito, kung ikaw lang ang nakakaintindi nito, wala itong maidudulot na mabuti. Ang ibig sabihin ng dokumentasyon ay hindi lamang mga awtomatikong nabuong sanggunian ng API, kundi pati na rin ang mga naka-annot na halimbawa at malalim na mga tutorial. Kailangan mo ang tatlo para matiyak na madaling ma-adopt ang iyong library,” sabi ni Nicholas Zakas, isang kilalang front end engineer at may-akda ng libro. Kaya naman ngayon nagpasya kaming tingnan ang ilan sa mga pinakamahusay at pinakakaraniwang ginagamit na tool para sa dokumentasyon ng software at teknikal na pagsulat.
Tulong sa mga tool sa pag-akda
Ang mga tool sa pag-author ng tulong ay gumaganap ng malaking papel sa dokumentasyon ng software at teknikal na pagsulat, dahil ginagawa nitong mas madali ang pagdidisenyo, pagsulat, pag-publish, at pagpapanatili ng dokumentasyon ng software. Nagbibigay-daan sa iyo ang mga ito na bawasan ang oras at pagsisikap na kailangan kapag lumilikha ng lahat ng uri ng tulong na materyales para sa mga end-user at iba pang programmer/empleyado.
Ang MadCap Flare ay isa sa pinakasikat na tool sa pag-author ng tulong salamat sa maraming pagpili ng mga feature na nagbibigay-daan sa iyong gumawa ng higit pa sa pagsulat ng dokumentasyon ng tulong. Ang MadCap Flare ay idinisenyo para sa advanced na pag-akda batay sa paksa, single-source na pag-publish at pamamahala ng nilalaman. Binibigyang-daan ka nitong lumikha ng mga website ng Tulong at suporta sa customer, mga FAQ, mga base ng kaalaman, mga online learning center, mga gabay, mga manual ng patakaran at pamamaraan, at higit pa. Pinapadali ng mga feature ng MadCap Flare na muling gamitin ang parehong nilalaman sa maraming channel at mabilis itong mai-publish sa isang hanay ng mga platform.
Ang Document360 ay isa pang malawakang ginagamit na web platform na nagbibigay-daan sa iyong bumuo, mag-publish at mag-update ng lahat ng uri ng mga base ng kaalaman at mga materyales sa tulong. Mayroon din itong multi-profile functionality, kabilang ang isang simpleng Markdown text editor, Category Manager para buuin ang knowledge base structure, mga feature sa pagpapasadya ng landing page, versioning rollback, backup at restore, flexible na tungkulin at pagsasaayos ng mga pahintulot, at iba pa.
Ang Adobe RoboHelp ay isa pang makapangyarihang alternatibong tool sa pag-akda ng tulong, na nag-aalok ng bahagyang naiibang seleksyon ng mga feature kumpara sa MadCap Flare at Document360. Sa partikular, nag-aalok ang Adobe RoboHelp ng madaling multiformat na pag-publish, na nagbibigay-daan sa iyong mag-publish ng nilalaman sa isang malawak na hanay ng mga sikat na format ng output, kabilang ang Frameless Responsive HTML5, PDF, Microsoft Help (CHM), at kahit na hindi gaanong karaniwang mga format tulad ng EPUB 3, KF8, at MOBI.
Ang pangunahing bentahe ng Help+Manual ay ang simpleng interface nito na ginagawang napaka-accessible at madaling gamitin, kasama ang buong functionality ng isang WYSIWYG XML editor, multi-channel publishing, buong suporta para sa multimedia at kumplikadong modular na mga proyekto, Webhelp tool para sa tuluy-tuloy na pagsasama ng dokumentasyon sa mga aktibong website, at iba pa.
Nagbibigay din ang ClickHelp ng napakahusay na web platform para sa dokumentasyon ng software sa anyo ng mga base ng kaalaman, FAQ, tutorial, at iba pang mga format ng Tulong. Sinusuportahan ang maraming format gaya ng Word, HTML, RTF, CHM, ODT, CHM, HTML5 Web Help, PDF, DOCX, atbp. Ang ilan sa mga signature feature ng ClickHelp ay patented na full-text na paghahanap na nagpapadali sa paghahanap ng mga partikular na paksa o artikulo para sa parehong mga may-akda at user, pati na rin ang isang pagpipilian ng ilang pre-built na template para sa disenyo ng dokumentasyon.
Mga tool sa pagkuha ng screen
Karamihan sa dokumentasyon ng software at mga materyal ng tulong ay kailangang magsama ng mga screenshot, kaya makatuwirang gumawa ng maikling pangkalahatang-ideya ng pinakamahusay na mga tool sa pagkuha ng screen doon.
Kung gumagamit ka ng Windows bilang iyong OS, ito ay may kasamang Snipping Tool, na nagbibigay-daan sa iyong gumawa ng mga screenshot ng buong screen, hiwalay na mga bintana o isang bahagi ng screen, at gamitin ang pen tool upang i-highlight ang ilang partikular na bahagi ng screenshot.
Ang FireShot ay isang sikat na browser plugin na sumusuporta sa halos lahat ng modernong browser gaya ng Chrome, Firefox, Internet Explorer, at Opera. Binibigyang-daan kang makuha ang buong web page o ilang partikular na bahagi nito.
Ang SnagIt ay isang mas kumplikadong tool sa pagkuha ng screen. Binibigyang-daan ka nitong makuha ang mga scrolling area ng anumang page, pati na rin ang pagsuporta sa pag-record ng video. Maaari mo ring gamitin ang larawang ito upang lumikha ng mga GIF at mag-record ng mga partikular na hanay ng mga aksyon sa screen.
Mga checker ng spelling at grammar
Ang pagtiyak na ang iyong dokumentasyon ay nakasulat nang tama nang walang mga pagkakamali sa grammar at bantas ay mahalaga din. Narito ang ilan sa mga tool na makakatulong sa iyong mahanap ang mga pagkakamali sa iyong mga text at ayusin ang mga ito.
Isa sa pinakasikat na libreng online na spelling at grammar checker. Maaaring tukuyin at itama ng mga Scriben ang mahigit 250 iba't ibang uri ng pagkakamali, kabilang ang mga pangngalan, panghalip, pang-ukol, pandiwa, homonym, bantas, palalimbagan, at iba pa.
Isa pang mahusay na libreng tool na matatagpuan ang iba't ibang mga pagkakamali sa iyong mga teksto at nagbibigay ng ilang mga pagpipilian upang mapabuti ang iyong mga salita.
Bilang karagdagan sa pagpapakita ng mga typo at mga pagkakamali sa iyong mga teksto, ang Grammar.com ay nagbibigay sa iyo ng mga kaugnay na mungkahi pati na rin ang mga tuntunin sa grammar at ebook upang mapabuti ang iyong pagsusulat (lahat nang libre).
“Gaano man kaganda ang iyong library at gaano man katalino ang disenyo nito, kung ikaw lang ang nakakaintindi nito, wala itong maidudulot na mabuti. Ang ibig sabihin ng dokumentasyon ay hindi lamang mga awtomatikong nabuong sanggunian ng API, kundi pati na rin ang mga naka-annot na halimbawa at malalim na mga tutorial. Kailangan mo ang tatlo para matiyak na madaling ma-adopt ang iyong library,” sabi ni Nicholas Zakas, isang kilalang front end engineer at may-akda ng libro. Kaya naman ngayon nagpasya kaming tingnan ang ilan sa mga pinakamahusay at pinakakaraniwang ginagamit na tool para sa dokumentasyon ng software at teknikal na pagsulat.
GO TO FULL VERSION