Často naplněný žargonem, zkratkami a pokyny, které vyžadují, aby doktorát pochopil, jsou uživatelské příručky softwaru někdy psány z pohledu vývojáře a nikoli od uživatele. Výsledkem je, že průvodce může předpoklady o úrovni čtenáře, které jsou často nesprávné. Prvním krokem při psaní správné uživatelské příručky je získání skutečného procesu psaní co nejdál od inženýrů.
Vývojář softwaru ví více než kdokoli, co dělá software, ale to neznamená, že vývojář by měl napsat průvodce. Naopak je to výrazná nevýhoda. Důležitější než hluboké pochopení vnitřního fungování softwaru je pochopení toho, kdo bude konečným uživatelem, jaké je jeho vzdělávací úroveň a jak tento koncový uživatel bude používat software. Ve většině případů koncoví uživatelé nepotřebují znát jemnější body programování a back-end fungování softwaru - prostě potřebují vědět, jak je používat, aby usnadnili práci.
Testování uživatelů
Uživatelská příručka by měla být spíše zaměřena na úkoly než na silnou popisnost. Vzhledem k tomu, že příručka je napsána, aby pomohla uživatelům pochopit, jak provádět konkrétní úkoly, musí mít spisovatel také znalosti o těchto úkolech a v důsledku toho je absolutně nezbytné projít každý samostatný krok každé funkce. Není nutné, aby spisovatel nutně věděl, jak byl program vytvořen z hlediska designu nebo vývoje, ale je velmi důležité mít silné pracovní znalosti o všech jeho vlastnostech. Během provádění každého úkolu je třeba věnovat pozornost každému kroku, včetně kliknutí, rozbalovacích nabídek a dalších akcí.
Proces rozhovoru
Ačkoli vývojář by neměl být ten, který by psal manuál, bude i nadále cenným zdrojem pro spisovatele a před zahájením psaní plánu naplánovat schůzku o kickoff mezi spisovatelem, vývojářem a inženýry a potenciálními koncovými uživateli, aby pomohla informovat spisovatelova díla od počátku. Měly by být zaznamenány rozhovory s odborníky na předměty a inženýry, s přepisy provedenými pro pozdější použití.
Obrázky
Uživatelská příručka by neměla být příliš textově náročná. Spíše začlenit liberální využití grafických a obrazovkových klips. Popis akce je mnohem srozumitelnější s textem založenými pokyny doprovázenými klipem na obrazovce, který jasně ukazuje tento směr. Zahrnout zobrazení před a po zobrazení, aby se ukázalo, jak vypadá obrazovka před provedením každé akce a co se stane po provedení akce. Jednoduchý nástroj pro snímání obrazovky, jako je například nástroj Strihání zahrnutý v systému Microsoft Windows, funguje dobře pro zachycení těchto obrázků. Ujistěte se, že každý snímek je číslovaný a obsahuje popis, který jej stručně popisuje. Umístěte jej hned pod odstavec, který nejprve představuje koncept zobrazený na obrázku.
Formátování
Jasné komunikace v technickém dokumentu vyžaduje plánování a pečlivé dodržování norem v celém průvodci. Normy jak v prezentaci, tak v jazyce a nomenklatuře pomáhají vyhnout se nejasnostem. Šablony jsou k dispozici a mohou být dobrým výchozím bodem pro jednotnost, ačkoli tyto mohou určitě být přizpůsobeny tak, aby vyhovovaly každé situaci. Použití jednoho palce okraje s jedním sloupcem nejlépe vyhovuje potřebě přidat grafiku; nastavení dvou sloupců může vypadat příliš přeplněné a může způsobit, že umístění obrazů je matoucí.
Verze a sledování
Více než jakýkoli jiný typ dokumentu, softwarová uživatelská příručka pravděpodobně projde několika opakováním předtím, než bude dokončena, a je pravděpodobné, že projde procesem přezkumu několika zúčastněných stran. Použití funkce Track Changes v aplikaci Microsoft Word je snadný způsob, jak sledovat komentáře a změny každého jednotlivce. Vytváření více verzí po každém přezkumném cyklu, každý s jiným názvem souboru, také pomáhá procesu a zajišťuje, aby všechny zúčastněné strany byly s konečným výsledkem spokojeny.
