Često ispunjeni žargonom, akronimima i uputama koje zahtijevaju razumijevanje doktora znanosti, priručnici za upotrebu softvera ponekad se pišu s gledišta razvojnog programera, a ne korisnika. Kao rezultat toga, vodič može napraviti pretpostavke o razini čitateljske vještine koja je često netočna. Prvi korak u pisanju dobrog korisničkog priručnika je dobiti stvarni proces pisanja što dalje od inženjera što je više moguće.
Programer zna više od bilo koga što softver čini radnim, ali to ne znači da bi programer trebao napisati vodič. Naprotiv, to je poseban nedostatak. Važnije od dubokog razumijevanja unutarnjeg funkcioniranja softvera je razumijevanje tko će biti krajnji korisnik, koja je njegova razina obrazovanja i kako će taj krajnji korisnik koristiti softver. U većini slučajeva, krajnjim korisnicima nije potrebno poznavati finije točke programiranja i back-end radnji softvera - oni samo trebaju znati kako ga koristiti kako bi olakšali posao.
Testiranje korisnika
Priručnik za korisnike trebao bi u velikoj mjeri biti usmjeren na zadatke, a ne u velikoj mjeri opisan. Budući da je priručnik napisan da pomogne korisnicima razumjeti kako izvršiti određene zadatke, pisac mora imati razumijevanje i za te zadatke, i kao rezultat toga, prolazak kroz svaki diskretni korak svake značajke je apsolutno neophodan. Nije nužno da pisac nužno zna kako je program izrađen s gledišta dizajna ili razvoja, ali je bitno imati snažno znanje svih njegovih značajki. Prilikom izvršavanja svakog zadatka odvojite vrijeme za zapisivanje svakog koraka, uključujući klikove, padajuće izbornike i druge radnje.
Proces intervjua
Iako programer ne bi trebao biti onaj koji će pisati priručnik, ona će i dalje biti vrijedan resurs piscu, a prije nego što počne pisati, planirajte početni sastanak između pisca, razvojnog inženjera i inženjera i potencijalnih krajnjih korisnika kako bi pomogli informirati rad pisca od početka. Intervjui sa stručnjacima i inženjerima koji se bave temom trebaju biti zabilježeni, s transkriptima napravljenim za kasniju referencu.
lik
Korisnički priručnik ne bi smio biti pretežak za tekst. Umjesto toga, uključite liberalnu uporabu grafike i isječke zaslona. Opis radnje je mnogo jasniji s uputama temeljenim na tekstu koje prate isječak zaslona koji jasno ilustrira taj smjer. Uključite i prije i poslije prikaza, kako biste prikazali kako izgleda zaslon prije poduzimanja svake radnje i što se događa nakon poduzimanja akcije. Jednostavan zaslon za snimanje korisni programi kao što je alat za izrezivanje uključen u Microsoft Windows dobro radi za hvatanje tih slika. Svakako označite svaku sliku i uključite opis koji ga ukratko opisuje. Usredotočite ga odmah ispod paragrafa koji prvi uvodi pojam prikazan na slici.
oblikovanje
Jasno priopćavanje u tehničkom dokumentu zahtijeva planiranje i pažljivo pridržavanje standarda u cijelom vodiču. Standardi u prezentaciji, jeziku i nomenklaturi pomažu izbjeći konfuziju. Predlošci su dostupni i mogu biti dobra polazna točka za ujednačenost, iako se oni sigurno mogu prilagoditi svakoj situaciji. Korištenje margine od jednog inča s jednim stupcem najbolje odgovara potrebi za dodavanjem grafike; postavka s dva stupca može se činiti previše pretrpana i može zbuniti postavljanje slika.
Verziranje i praćenje
Više od bilo koje druge vrste dokumenta, vodič za korisnike softvera vjerojatno će proći kroz više iteracija prije nego što bude dovršen, i vjerojatno će proći kroz postupak pregleda od strane više dionika. Upotreba značajke Track Changes u programu Microsoft Word jednostavan je način praćenja komentara i promjena svakog pojedinca. Stvaranje više verzija nakon svakog ciklusa pregleda, svaki s različitim nazivom datoteke, također pomaže procesu i osigurava da su svi dionici zadovoljni konačnim rezultatom.
