Při psaní návodů se vyhněte přesvědčovacímu jazyku a vycházejte z úkolů. Pište stručně a jasně a zaměřte se na to, abyste uživateli umožnili úspěšně splnit úkol.

Obecně se řiďte těmito pokyny:

Souvislost a jasnost

Udržujte věty krátké a srozumitelné. Pokud je to možné, používejte běžnou terminologii. Vyhněte se používání idiomů, slangu, žargonu, přezdívek, zkratek a akronymů. Pokud používáte terminologii, která by mohla být nová nebo matoucí, pak každý termín jasně definujte, když se v pokynech objeví poprvé.

Posluchači

Při psaní pokynů je důležité znát své posluchače, abyste zahrnuli všechny potřebné informace a vyloučili zbytečné. Znalost publika vám umožní vytvořit rozumné a dobře informované předpoklady založené na pravděpodobném zázemí, zkušenostech a obeznámenosti publika s danou problematikou. Pokud například píšete návod pro skupinu seniorů v místní pobočce veřejné knihovny, nemusí být bezpečné předpokládat, že jsou obeznámeni se základy otevírání konkrétní softwarové aplikace. Pokud však píšete návod pro skupinu vývojářů softwaru v rámci profesionální organizace, lze bezpečně předpokládat, že jsou obeznámeni se základy otevírání konkrétní softwarové aplikace.

Při rozhodování o tom, jaké informace do návodu zahrnout a jaké ne, je důležité jasně určit, kdo je vaše publikum a jaká je jeho pravděpodobná znalost tématu návodu a souvisejících základních informací.

Pokud je pravděpodobné, že publikum má širokou škálu zkušeností a znalostí, které zahrnují různé úrovně obeznámenosti a odbornosti, můžete použít různé techniky, aby každá sada pokynů byla stručná a zaměřená na jeden úkol, a přitom poskytovala potřebné informace. Můžete například vytvořit samostatné pokyny pro nezbytné informace a poskytnout publiku prostředky pro rychlý a snadný přístup k jednotlivým pokynům (prostřednictvím hypertextových odkazů, příloh atd.).

Grafika

Obrázky mluví hlasitěji než slova. Přidání grafiky pro vyjádření myšlenek může být účinnější než samotná slova. Návody, které jsou dobře ilustrované a doprovázejí vaše písemné pokyny, jsou obvykle velmi úspěšné. Přidává další úroveň porozumění a umožňuje čtenáři projít si je nebo odstranit problémy, pokud se vyskytnou. Obrázky přidávají další rozměr, který vašemu čtenáři umožní představit si konečný produkt. Také při použití grafiky byste měli mít na paměti ty, kteří se učí vizuálně, a grafiku přizpůsobit.

Ačkoli jsou obrázky skvělé, musíte být opatrní, abyste nezařadili fotografie nebo ilustrace, které jsou matoucí nebo nesouvisejí se skutečnými písemnými pokyny. Pokud s pokyny spojíte špatný obrázek, můžete čtenáři způsobit stres nebo vnést zmatek, když se bude snažit rozluštit, co máte na mysli.

Při pořizování obrázků dbejte také na to, aby byl prostor dobře osvětlen a obrázky byly jasné a jasné. Tmavé nebo rozmazané obrázky jsou často obtížně sledovatelné. Dbejte na to, abyste předmět fotografovali pokaždé ve stejné orientaci, aby nedošlo k záměně, a zvažte použití stativu.

Při použití obrázků v návodech je důležitá také jejich velikost. Obrázek, který je příliš malý na to, aby byl vidět, je stejně nepoužitelný jako rozmazaný obrázek.

Chcete-li, aby váš text a grafika u každého kroku byly účinné a srozumitelné, měly by jasně odpovídat danému kroku návodu.

Formátování

Pamatujte, že čtenáři budou při čtení návodu úkol skutečně provádět. Neměli byste tedy používat souvislé bloky malého, těžko čitelného textu. Ujistěte se, že jste vytvořili design a rozvržení stránky s pokyny, které umožní snadnou čitelnost a dodá jí estetickou kvalitu. Zachování jednoduchosti stránky, ale s definovanou hierarchií, pomůže čtenáři dokončit kroky návodu.

Při navrhování stránky je pro čitelnost důležitá pevná hierarchie. Použití tučných nadpisů, kurzívy a římských číslic pomůže čtenáři snadno najít své místo a napomůže celkovému vizuálnímu vzhledu.

Pořadí

Je důležité, aby vaše pokyny byly naplánovány v logickém sledu. Dbejte na to, abyste na první stránce jasně formulovali problém. Na problémy navazujte souborem konkrétních kroků, které podrobně popisují, jak navrhovaný problém vyřešit. Technické pokyny musí plynout v logickém schématu. Například při montáži stolu by nebylo dobré, kdybyste jej dokončili dříve, než budete mít všechny šrouby na svém místě. Jak již bylo řečeno, tam, kde je to nutné, by měla být k dispozici také jasná grafika, která objasní činnost. Pamatujte, že obrázek vydá za tisíc slov.

Testování a ověřování

Všichni víme, že návod je obtížné napsat a že někdy zní dobře na papíře, ale když se pokusíte návod skutečně použít, můžete zjistit, že vaše formulace nedává ostatním smysl. Nezapomeňte, že to, co může být pro vás běžné nebo samozřejmé, může čtenáře zmást, proto poznejte své publikum. Kromě toho, že si návod vyzkoušíte sami na sobě, nechte ho otestovat i někoho, kdo o vašem produktu nic neví. Tomu se říká studie použitelnosti. Udělejte si poznámky o tom, co fungovalo a co ne, a pak podle toho návod upravte. Z dlouhodobého hlediska platí, že čím více lidí váš návod otestuje, tím efektivnější bude jeho konečná podoba.

.