Pogosto napolnjena z žargonom, kraticami in navodili, ki zahtevajo razumevanje doktorja znanosti, so uporabniški priročniki programske opreme včasih napisani z vidika razvijalca in ne uporabnika. Zato lahko vodnik predpostavlja, da je bralčeva raven znanja pogosto netočna. Prvi korak pri pisanju dobrega uporabniškega priročnika je, da dobite dejanski proces pisanja čim dlje od inženirjev.
Razvijalec programske opreme ve več kot kdorkoli, kaj naredi programsko opremo, vendar to ne pomeni, da bi moral razvijalec napisati vodnik. Nasprotno, to je izrazita pomanjkljivost. Bolj pomembno kot globoko razumevanje notranjega dela programske opreme je razumevanje, kdo bo končni uporabnik, kakšna je njegova izobrazbena raven in kako bo ta uporabnik uporabljal programsko opremo. V večini primerov končnim uporabnikom ni treba poznati natančnejših točk programiranja in back-end delovanja programske opreme - samo morajo vedeti, kako jo uporabiti, da bodo njihova dela lažja.
Testiranje uporabnikov
Uporabniški priročnik mora biti v veliki meri usmerjen k nalogam, ne pa močno opisen. Ker je priročnik napisan tako, da uporabnikom pomaga razumeti, kako se izvajajo določene naloge, mora imeti pisatelj tudi razumevanje teh nalog, zaradi česar je prehod skozi vsak posamezen korak vsakega elementa nujno potreben. Ni nujno, da pisatelj nujno ve, kako je bil program ustvarjen z vidika oblikovanja ali razvoja, vendar je bistveno, da imamo dobro delovno znanje vseh njegovih značilnosti. Med izvajanjem vsake naloge vzemite čas, da zapišete vsak korak, vključno s kliki, spustnimi meniji in drugimi dejanji.
Proces pogovorov
Čeprav razvijalec ne bi smel biti tisti, ki bi napisal priročnik, bo pisatelj še vedno dragocen vir, in preden se začne pisati, načrtujte srečanje pisatelja, razvijalca in inženirjev ter potencialnih končnih uporabnikov, ki bodo pomagali obvestiti pisateljsko delo od začetka. Intervjuji s strokovnjaki in inženirji morajo biti zabeleženi s prepisi, ki bodo kasneje posredovani.
Slike
Uporabniški priročnik ne sme biti preveč težak za besedilo. Namesto tega vključite liberalno uporabo grafike in posnetke zaslona. Opis dejanja je veliko jasnejši z besedilnimi navodili, ki jih spremlja posnetek zaslona, ki jasno kaže to smer. Vključite pred in po pogledih, da prikažete, kako izgleda zaslon pred vsakim dejanjem, in kaj se zgodi po tem, ko ste ukrepali. Preprost pripomoček za zajem zaslona, kot je orodje za izrezovanje, vključeno v Microsoft Windows, dobro deluje za zajem teh slik. Prepričajte se, da ste označili vsako sliko in vključite napis, ki ga na kratko opisuje. Centrirajte ga takoj pod odstavkom, ki najprej predstavi koncept, prikazan na sliki.
Oblikovanje
Jasno sporočanje v tehničnem dokumentu zahteva načrtovanje in skrbno upoštevanje standardov v celotnem priročniku. Standardi v predstavitvi, jeziku in nomenklaturi preprečujejo zmedo. Predloge so na voljo in so lahko dobro izhodišče za enotnost, čeprav jih je mogoče prilagoditi vsakemu primeru. Uporaba ene palčke z enim stolpcem najbolj ustreza potrebi po dodajanju grafike; nastavitev v dveh stolpcih se lahko zdi preveč natrpanih in lahko povzroči zmedo pri umestitvi slik.
Različice in sledenje
Uporabniški priročnik za programsko opremo bo verjetno več kot katera koli druga vrsta dokumentov prešel v več iteracij, preden bo dokončan, in verjetno bo šel skozi postopek pregleda več zainteresiranih strani. Uporaba funkcije Spremembe sprememb v programu Microsoft Word je preprost način za spremljanje komentarjev in sprememb vsakega posameznika. Ustvarjanje več različic po vsakem ciklu pregleda, vsak z drugačnim imenom datoteke, prav tako pomaga procesu in zagotavlja, da so vse zainteresirane strani zadovoljne s končnim rezultatom.
