Madalas na puno ng mga hindi maintindihang pag-uusap, mga acronym, at mga direksyon na nangangailangan ng isang Ph.D upang maunawaan, ang mga user manual ng software ay paminsan-minsan na nakasulat mula sa punto ng view ng isang developer kaysa sa isang gumagamit. Bilang resulta, ang gabay ay maaaring gumawa ng mga pagpapalagay tungkol sa antas ng kasanayan ng mambabasa na madalas ay hindi tama. Ang unang hakbang sa pagsulat ng isang mahusay na manu-manong gumagamit ay upang makuha ang aktwal na proseso ng pagsulat bilang malayo mula sa mga inhinyero hangga't maaari.
Alam ng software developer na higit pa kaysa sa kahit sino kung bakit ang software ay gumagana, ngunit hindi ito nangangahulugan na dapat isulat ng developer ang gabay. Sa kabaligtaran, ito ay isang natatanging pagkakasala. Ang mas mahalaga kaysa sa isang malalim na pag-unawa sa mga panloob na gawain ng software ay isang pag-unawa kung sino ang magiging end user, kung ano ang kanyang antas ng edukasyon, at kung paano ang gumagamit ng end na iyon ay gagamit ng software. Sa karamihan ng mga kaso, ang mga end user ay hindi kailangang malaman ang mas mahusay na mga punto ng programming at ang back-end workings ng software - kailangan lang nilang malaman kung paano gamitin ito upang gawing mas madali ang kanilang mga trabaho.
Pagsubok ng User
Ang manu-manong gumagamit ay dapat na higit sa lahat na nakatuon sa gawain, sa halip na mabigat na naglalarawang. Dahil nakasulat ang manu-manong upang matulungan ang mga user na maunawaan kung paano gagawa ng mga partikular na gawain, ang manunulat ay kailangang magkaroon ng pag-unawa sa mga tungkulin na rin, at bilang resulta, ang pagsasaayos ng bawat discrete step ng bawat tampok ay ganap na mahalaga. Hindi kinakailangan para sa manunulat na alamin kung paano ang programa ay nilikha mula sa isang disenyo o pag-unlad na pananaw, ngunit ito ay mahalaga upang magkaroon ng isang malakas na kaalaman sa pag-aaral ng lahat ng mga tampok nito. Habang ginagawa ang bawat gawain, maglaan ng oras upang isulat ang bawat hakbang, kabilang ang mga pag-click, mga drop-down na menu, at iba pang mga pagkilos.
Ang Proseso ng Panayam
Kahit na ang developer ay hindi dapat na magsulat ng manwal, siya pa rin ay isang mahalagang mapagkukunan sa manunulat, at bago magsimula ang pagsusulat, magplano ng pulong kickoff sa pagitan ng manunulat, developer at inhinyero, at potensyal na end-user upang makatulong na ipaalam ang trabaho ng manunulat mula sa simula. Ang mga panayam sa mga eksperto sa paksa at mga inhinyero ay dapat maitala, na may mga transcript na ginawa para sa pagtukoy sa ibang pagkakataon.
Imagery
Ang isang user manual ay hindi dapat masyadong text-mabigat. Sa halip, isama ang liberal na paggamit ng mga graphics at screen clip. Ang paglalarawan ng isang pagkilos ay mas malinaw sa mga direksyon na batay sa teksto na sinamahan ng isang screen clip na malinaw na naglalarawan ng direksyon na iyon. Isama ang bago at pagkatapos ng mga pagtingin, upang ipakita kung ano ang hitsura ng screen bago kumukuha ng bawat pagkilos, at kung ano ang mangyayari pagkatapos na ang pagkilos ay kinuha. Ang isang simpleng screen capture utility tulad ng Snipping Tool na kasama sa Microsoft Windows ay mahusay na gumagana para sa pagkuha ng mga imaheng ito. Tiyaking bilangin ang bawat larawan, at isama ang isang caption na maikli na naglalarawan dito. I-center agad ito sa parapo na unang nagpapakilala sa konsepto na inilalarawan sa larawan.
Pag-format
Ang malinaw na pakikipag-usap sa isang teknikal na dokumento ay nangangailangan ng pagpaplano at maingat na pagsunod sa mga pamantayan sa buong gabay. Ang mga pamantayan sa parehong pagtatanghal, wika, at katawagan ay nakakatulong na maiwasan ang pagkalito. Ang mga template ay magagamit at maaaring maging isang mahusay na panimulang punto para sa pagkakapareho, bagaman ang mga ito ay maaaring tiyak na iniangkop upang umangkop sa bawat sitwasyon. Paggamit ng isang isang-inch margin na may isang solong hanay na pinakamahusay na nababagay sa pangangailangan upang magdagdag ng mga graphics; ang isang dalawang-haligi setting ay maaaring lumitaw masyadong masikip, at maaaring gumawa ng paglalagay ng mga imahe nakalilito.
Bersyon at Pagsubaybay
Higit sa anumang iba pang uri ng dokumento, ang isang gabay sa gumagamit ng software ay malamang na dumaan sa maraming mga iteration bago ito kumpleto, at malamang na ito ay dumaan sa isang proseso ng pagsusuri sa pamamagitan ng maraming mga stakeholder. Nagtatampok ang paggamit ng mga Pagbabago sa Track sa Microsoft Word ay isang madaling paraan upang masubaybayan ang mga komento at pagbabago ng bawat indibidwal. Ang paglikha ng maramihang mga bersyon pagkatapos ng bawat ikot ng pagsusuri, bawat isa ay may ibang pangalan ng file, ay tumutulong din sa proseso ng kasama at tinitiyak na ang lahat ng mga stakeholder ay nasiyahan sa huling resulta.
