Bieži piepildīta ar žargonu, akronīmiem un norādījumiem, kas prasa, lai saprastu, ka programmatūras lietotāja rokasgrāmatas tiek rakstītas no attīstītāja, nevis lietotāja viedokļa. Rezultātā rokasgrāmatā var izdarīt pieņēmumus par lasītāja prasmju līmeni, kas bieži ir nepareizi. Pirmais solis labas lietotāja rokasgrāmatas sagatavošanā ir iegūt faktisko rakstīšanas procesu pēc iespējas tālāk no inženieriem.
Programmatūras izstrādātājs zina vairāk nekā jebkurš, kas padara programmatūras darbu, bet tas nenozīmē, ka attīstītājam vajadzētu uzrakstīt rokasgrāmatu. Gluži pretēji, tas ir atšķirīgs trūkums. Svarīgāka nekā dziļa izpratne par programmatūras iekšējo darbību ir izpratne par to, kas būs gala lietotājs, kāds ir viņa izglītības līmenis un kā šis gala lietotājs izmantos programmatūru. Vairumā gadījumu galalietotājiem nav jāzina sīkāki programmēšanas punkti un programmatūras back-end darbība - viņiem tikai jāzina, kā to izmantot, lai atvieglotu darbu.
Lietotāja pārbaude
Lietošanas rokasgrāmatai jābūt lielākoties uz uzdevumiem orientētai, nevis stipri aprakstošai. Tā kā rokasgrāmata ir sagatavota, lai palīdzētu lietotājiem saprast, kā izpildīt konkrētus uzdevumus, rakstniekam ir jāapzinās arī šie uzdevumi, un tādēļ katra iezīme ir diskrēta. Rakstniekam nav obligāti jāzina, kā programma tika veidota no dizaina vai attīstības viedokļa, bet ir būtiski, lai būtu spēcīgas darba zināšanas par visām tās iezīmēm. Veicot katru uzdevumu, nepieciešams laiks, lai pierakstītu katru soli, ieskaitot klikšķus, nolaižamās izvēlnes un citas darbības.
Intervijas process
Kaut arī izstrādātājs nedrīkst rakstīt rokasgrāmatu, viņa joprojām būs vērtīgs resurss rakstniekam, un pirms rakstīšanas sākšanas, plānojiet tikšanos ar rakstnieku, attīstītāju un inženieriem, kā arī potenciālajiem lietotājiem, lai palīdzētu informēt rakstnieka darbs no sākuma. Ir jāreģistrē intervijas ar priekšmetu ekspertiem un inženieriem, izmantojot transkriptus vēlākai atsaucei.
Attēli
Lietošanas pamācībai nevajadzētu būt pārāk smagai. Drīzāk jāiekļauj grafikas un ekrāna klipu liberāla izmantošana. Darbības apraksts ir daudz skaidrāks ar teksta virzieniem, kam pievienots ekrāna klips, kas skaidri parāda šo virzienu. Iekļaujiet gan pirms, gan pēc skatiem, lai parādītu, kā ekrāns izskatās pirms katras darbības veikšanas, un to, kas notiek pēc darbības veikšanas. Vienkāršs ekrāna uztveršanas rīks, piemēram, Microsoft Windows iekļauts Snipping rīks, labi darbojas šo attēlu uzņemšanai. Noteikti numurējiet katru attēlu un iekļaujiet to ar īsu aprakstu. Centrējiet to tūlīt zem punkta, kas pirmo reizi ievieš attēlā attēloto koncepciju.
Formatēšana
Lai sazinātos skaidri tehniskajā dokumentā, ir nepieciešama plānošana un rūpīga standartu ievērošana visā rokasgrāmatā. Standarti gan noformējumā, gan valodā un nomenklatūrā palīdz izvairīties no neskaidrībām. Veidnes ir pieejamas un var būt labs sākumpunkts vienotībai, lai gan tās noteikti var pielāgot katrai situācijai. Izmantojot vienu collu rezervi ar vienu kolonnu, vislabāk ir jāpievieno grafika; divu sleju iestatījums var būt pārāk pārpildīts, un var padarīt attēlu mulsinošu.
Versija un izsekošana
Vairāk nekā jebkura cita veida dokumentā programmatūras lietotāja rokasgrāmata, iespējams, iet cauri vairākām atkārtojumiem, pirms tā ir pabeigta, un, visticamāk, vairākas ieinteresētās personas veiks pārskatīšanas procesu. Izmantojot funkciju Microsoft Word, izmantojiet funkciju Track Changes, lai sekotu katra indivīda komentāriem un izmaiņām. Vairāku versiju izveide pēc katra pārskatīšanas cikla, katrs ar citu faila nosaukumu, palīdz arī procesam un nodrošina, ka visas ieinteresētās personas ir apmierinātas ar gala rezultātu.
