Často vyplnené žargónom, akronymami a usmerneniami, ktoré vyžadujú doktorát, aby pochopili, sú užívateľské príručky softvéru niekedy napísané z pohľadu vývojára a nie od používateľa. Výsledkom je, že sprievodca môže urobiť predpoklady o úrovni čitateľov, ktoré sú často nesprávne. Prvým krokom pri písaní správnej používateľskej príručky je dosiahnuť skutočný proces písania čo najďalej od inžinierov.
Vývojár softvéru vie viac než ktokoľvek, čo robí softvér, ale to neznamená, že by mal vývojár napísať sprievodcu. Naopak, je to výrazná nevýhoda. Dôležitejšie ako hlboké pochopenie vnútorného fungovania softvéru je pochopenie toho, kto bude koncový používateľ, aká je jeho úroveň vzdelania a ako tento koncový používateľ bude používať softvér. Vo väčšine prípadov koncoví používatelia nepotrebujú poznať jemnejšie body programovania a spätnú funkciu softvéru - stačí, aby vedeli, ako ich používať na uľahčenie ich práce.
Testovanie používateľov
Používateľská príručka by mala byť do značnej miery zameraná skôr na úlohu, než na značne popisnú. Pretože manuál je napísaný, aby pomohol užívateľom pochopiť, ako vykonávať konkrétne úlohy, spisovateľ musí mať pochopenie týchto úloh rovnako, a ako výsledok, prejsť každý diskrétny krok každej funkcie je absolútne nevyhnutné. Nie je nevyhnutné, aby spisovateľ nevyhnutne vedel, ako bol program vytvorený z hľadiska dizajnu alebo vývoja, ale je nevyhnutné mať silné pracovné znalosti o všetkých jeho funkciách. Pri vykonávaní každej úlohy potrebujete čas na zapísanie každého kroku vrátane kliknutí, rozbaľovacích ponúk a ďalších akcií.
Proces rozhovoru
Napriek tomu, že vývojár by nemal byť ten, ktorý by napísal príručku, bude pre spisovateľa stále cenným zdrojom a pred začiatkom písania naplánovať stretnutie medzi spisovateľom, vývojárom a inžiniermi a potenciálnymi koncovými používateľmi, ktoré pomôžu informovať spisovateľa od začiatku. Mali by sa zaznamenať rozhovory s odborníkmi na predmet a inžiniermi s prepismi, ktoré by sa mohli vykonať neskôr.
obraznosť
Používateľská príručka by nemala byť príliš textovo náročná. Skôr začlenenie liberálneho používania grafiky a obrazoviek. Opis akcie je oveľa jasnejšia s textovými smermi sprevádzanými klipom na obrazovke, ktorý jasne ukazuje tento smer. Zahrňte zobrazenie pred a po zobrazení, aby ste zobrazili, ako obrazovka vyzerá pred prijatím každej akcie, a čo sa stane po vykonaní akcie. Jednoduchý nástroj na snímanie obrazovky, ako je nástroj na strihanie, ktorý je súčasťou systému Microsoft Windows, funguje dobre na zachytenie týchto obrázkov. Uistite sa, že každý obrázok je označený a obsahuje popis, ktorý ho stručne opisuje. Zaraďte ju hneď pod odsek, ktorý najprv predstavuje koncept zobrazený na obrázku.
formátovanie
Jasné komunikovanie v technickom dokumente vyžaduje plánovanie a dôsledné dodržiavanie noriem v celom sprievodcovi. Normy v prezentácii, jazyku a nomenklatúre pomáhajú predchádzať zmätku. Šablóny sú k dispozícii a môžu byť dobrým východiskovým bodom pre jednotnosť, aj keď tieto môžu byť určite prispôsobené každej situácii. Použitie jedného palca okraj s jedným stĺpcom najlepšie vyhovuje potrebe pridať grafiku; nastavenie s dvoma stĺpcami sa môže zdať príliš preplnené a môže spôsobiť, že umiestnenie obrázkov je mätúce.
Verzia a sledovanie
Viac ako iný typ dokumentu, softvérová používateľská príručka bude pravdepodobne prejsť viacerými iteráciami ešte predtým, ako bude dokončená a pravdepodobne prejde procesom preskúmania viacerými zúčastnenými stranami. Použitie funkcie sledovania zmien v aplikácii Microsoft Word je jednoduchý spôsob, ako sledovať komentáre a zmeny každého jednotlivca. Vytváranie viacerých verzií po každom prehliadacom cykle, každý s iným názvom súboru, pomáha takisto v procese a zabezpečuje, aby boli všetky zainteresované strany spokojné s konečným výsledkom.
