Kung sisingilin ka ng pagsusulat ng isang dokumento na dapat na magturo sa ibang tao kung paano gumawa ng isang bagay, ang paraan ngayon ng paggawa nito nang higit pa o mas kaunting itapon ang mga lumang pamamaraan sa bintana.
1. Malaking Bombastic Header
Mapapansin mo ang mga header sa PCMech, tulad ng isang karapatan sa itaas ng pangungusap na ito, ay napakalaki. Ito ay dahil mas madali silang makita, mabasa at malaman kung nasaan ka sa dokumento.
2. Mas kaunting Mga Salita
Maling daanan:
Ang sumusunod na dokumentasyon ay nagpapaliwanag kung paano gamitin at patakbuhin ang Fanny Whacker 2000.
Tamang paraan:
Mga tagubilin sa kung paano gamitin ang Fanny Whacker 2000
Laging tandaan ang pariralang ito sa pagsulat ng babasahin: PUMILI SA POINT AS FAST AS POSSIBLE.
3. Laktawan ang mga walang saysay na sanggunian
Kung ang sanggunian ay walang kinalaman sa pangunahing pagtuturo ng kung ano ang sinusubukan mong ilarawan, tulad ng:
Para sa karagdagang impormasyon tungkol sa Turnip Twaddler ng Fanny Whacker 2000, mangyaring tingnan ang dokumento ng FU, subseksyon na ID10T.
… huwag gawin iyon.
4. Petsa ito. Laging.
Ang petsa kung kailan isinulat ang dokumentasyon ay dapat na nasa lugar ng paa ng bawat pahina. Kung ito ay isang elektronikong dokumento, ang petsa ay ipinakita nang dalawang beses. Minsan sa simula, isang beses sa pagtatapos.
Maaari mong isulat ito bilang "Huling Binagong (I-insert ang petsa dito)".
5. Ang mga babala ay dapat palaging nai-post bago ang punto ng walang pagbabalik
Kung mayroong isang bagay sa iyong babasahin na maaaring makapinsala / sirain / mapuksa ang isang bagay kung hindi tama ang gampanan, ang impormasyong ito ay dapat na mailagay nang direkta pagkatapos ng sinabi ng pagtuturo, maging sa payak na paningin (na nangangahulugang sa parehong pahina) at tinanggap.
Halimbawa:
Hakbang 5. Paglilinis ng Fanny Whacker 2000
Ang mga paddles ng FW2000 ay dapat na malinis na malinis gamit ang isang hindi nakasasakit na malambot na tela.
BABALA: Gumamit lamang ng ammonia-free solvent upang maiwasan ang FW2000 mula sa pagsabog at magreresulta sa iyong hindi tiyak na pagkamatay.
Sa isang pangwakas na tala, ang mabuting dokumentasyon ay hindi mula sa pagiging sobrang deskripsyon tungkol sa bawat solong posibleng maiisip. Basahin ang iyong dokumentasyon at tanungin ang iyong sarili, maayos ba itong nagtuturo? Kung oo ang sagot, ang susunod na tanong ay, mabilis ba itong nagtuturo? Kung oo, mabuti ang dokumentasyon.
