Jedním z nejběžnějších a nejdůležitějších způsobů použití technického psaní je poskytování návodů, tedy vysvětlení krok za krokem, jak něco sestavit, provozovat, opravit nebo provádět běžnou údržbu. Přestože se může zdát, že jejich psaní je intuitivní a jednoduché, patří návody k nejhůře napsaným dokumentům, které můžete najít. Většina z nás má pravděpodobně mnoho nepříjemných zkušeností se špatně napsanými návody. Tato kapitola vám ukáže, jaké postupy při poskytování návodů považují za nejlepší odborníci.
Efektivní soubor instrukcí vyžaduje následující:
- Jasné, přesné a jednoduché psaní
- Důkladné pochopení postupu ve všech jeho technických detailech
- Schopnost vžít se do situace čtenáře, osoby, která se snaží váš návod použít
- Schopnost představit si postup do detailu a zachytit toto vědomí na papír
- Ochotu vyzkoušet si návod na typu osoby, pro kterou jste ho psali.
Na začátku projektu psaní návodu je důležité určit strukturu nebo charakteristiku konkrétního postupu, o kterém budete psát. Zde je několik kroků, kterými byste se měli řídit:
Provedete pečlivou analýzu publika a úkolu
Na začátku procesu definujte publikum a situaci, ve které se váš návod nachází. Nezapomeňte, že definovat publikum znamená určit úroveň obeznámenosti vašich čtenářů s tématem.
Určete počet úkolů
Kolik úkolů obsahuje postup, o kterém píšete? Termínem postup označujme celý soubor činností, o kterých má váš návod pojednávat. Úkol je polonezávislá skupina činností v rámci postupu: například nastavení hodin na mikrovlnné troubě je jedním úkolem ve velkém celkovém postupu obsluhy mikrovlnné trouby.
Jednoduchý postup, jako je výměna oleje v autě, obsahuje pouze jeden úkol; neexistují žádná polonezávislá seskupení činností. Složitější postup, jako je používání mikrovlnné trouby, obsahuje několik polonezávislých úkonů: nastavení hodin; nastavení úrovně výkonu; použití časovače; čištění a údržba mikrovlnné trouby, mimo jiné.
Některé instrukce mají pouze jeden úkol, ale v rámci tohoto jednoho úkolu mají mnoho kroků. Představte si například soubor návodů na sestavení dětské houpačky. Podle mých vlastních zkušeností obsahovala více než 130 kroků! To může být trochu skličující. Dobrým přístupem je seskupit podobné a související kroky do fází a v každé nové fázi začít kroky přečíslovat. Fáze je pak skupinou podobných kroků v rámci postupu s jedním úkolem. V příkladu s houpačkou by bylo fází sestavení rámu, další fází by bylo ukotvení věci do země, další fází by bylo sestavení skříňové houpačky.
3. Určete nejlepší přístup k diskusi krok za krokem
U většiny návodů se můžete zaměřit na úkoly, nebo se můžete zaměřit na nástroje (nebo vlastnosti nástrojů). V případě přístupu zaměřeného na úkoly (známého také jako orientace na úkoly) k návodu na používání služby pro vyřizování telefonních hovorů byste měli tyto části:
- Nahrání pozdravu
- Přehrání zpráv
- Uložení zpráv
- Přeposlání zpráv
- Odstranění zpráv a tak dále
To jsou úkoly – typické věci, které bychom chtěli se zařízením dělat.
Na druhou stranu, v případě přístupu k nástrojům v návodu na používání kopírky by pravděpodobně existovaly části o tom, jak používat konkrétní funkce:
- Tlačítko kopírování
- Tlačítko zrušení
- Tlačítko zvětšení/zmenšení
- Tlačítko sbalení/sešití
- Tlačítko velikosti kopie a tak dále
Pokud byste na tomto plánu navrhli sadu návodů, napsali byste kroky pro použití každého tlačítka nebo funkce kopírky. Návody využívající tento přístup k nástrojům je těžké zprovoznit. Někdy název tlačítka zcela neodpovídá úkolu, s nímž je spojen; někdy musíte k provedení úkolu použít více než jen jedno tlačítko. Přesto se mohou vyskytnout situace, kdy může být přístup nástrojů/funkcí vhodnější.
4. Navrhněte seskupení úloh
Výčet úloh nemusí být vše, co potřebujete udělat. Úkolů může být tolik, že je musíte seskupit, aby čtenáři mohli jednotlivé úkoly snáze najít. Běžná seskupení úloh v návodech jsou například následující:
- Úlohy vybalení a nastavení
- Úlohy instalace a přizpůsobení
- Základní provozní úlohy
- Úlohy rutinní údržby
- Úlohy odstraňování poruch.
Obvyklé oddíly v návodech
Následující text je přehledem oddílů, které v návodech běžně najdete. Nepředpokládejte, že každá z nich musí být ve skutečném návodu, který píšete, ani že musí být v pořadí, které je zde uvedeno, ani že se jedná o jediné možné oddíly v souboru návodů.
Pro alternativní formáty si prohlédněte příklady návodů.
Úvod: Úvod návodu pečlivě naplánujte. Může obsahovat některý z následujících bodů (ne však nutně v tomto pořadí):
- Uveďte konkrétní úkoly nebo postup, který má být vysvětlen, a také rozsah (co bude a nebude zahrnuto)
- Uveďte, co posluchači potřebují za znalosti a zázemí, aby návodu porozuměli
- Uveďte obecnou představu o postupu a o tom, čeho se jím dosáhne
- Uveďte podmínky, kdy by se tento návod měl (nebo neměl) použít
- Uveďte přehled obsahu návodu.
Všeobecná varování, upozornění, upozornění na nebezpečí: návody často musí čtenáře upozornit na možnost, že si zničí vybavení, pokazí postup a zraní se. Návody také často musí zdůrazňovat klíčové body nebo výjimky. Pro tyto situace se používají zvláštní upozornění – upozornění, varování, výstraha a nebezpečí. Všimněte si, jak jsou tato zvláštní upozornění použita ve výše uvedených příkladech návodů.
Technické pozadí nebo teorie: Na začátku některých druhů návodů (po úvodu) může být třeba probrat pozadí související s postupem. U některých pokynů je toto pozadí velmi důležité – jinak by kroky postupu nedávaly smysl. Možná máte například zkušenosti se softwarovými applety, ve kterých definujete vlastní barvy posouváním červených, zelených a modrých posuvníků. Abyste skutečně pochopili, co děláte, musíte mít nějaké základy o barvách. Podobně si můžete představit, že u některých návodů využívajících fotoaparáty může být zapotřebí i trocha teorie.
Vybavení a pomůcky: Všimněte si, že většina návodů obsahuje seznam věcí, které je třeba shromáždit před zahájením postupu. Patří sem vybavení, tedy nástroje, které při postupu používáte (například míchací misky, lžíce, chlebové pánve, kladiva, vrtačky a pily), a zásoby, tedy věci, které se při postupu spotřebovávají (například dřevo, barva, olej, mouka a hřebíky). V návodech se obvykle uvádějí buď v jednoduchém svislém seznamu, nebo ve dvousloupcovém seznamu. Dvousloupcový seznam použijte, pokud potřebujete k některým nebo všem položkám doplnit specifikace – například názvy značek, velikosti, množství, typy, čísla modelů a podobně.
Diskuse o krocích: Když se dostanete k samotnému psaní kroků, je třeba mít na paměti několik věcí: (1) strukturu a formát těchto kroků, (2) doplňující informace, které mohou být potřebné, a (3) úhel pohledu a obecný styl psaní.
Struktura a formát: obvykle si soubor návodů představujeme jako formátované svislé číslované seznamy. A většina z nich taková ve skutečnosti je. Obvykle takto naformátujete skutečné pokyny krok za krokem. Existují však některé varianty a také některé další úvahy:
- Kroky s pevným pořadím jsou kroky, které musí být provedeny v předloženém pořadí. Pokud například měníte olej v automobilu, vypuštění oleje je krok, který musí následovat před nalijením nového oleje. Jedná se o číslované seznamy (obvykle svislé číslované seznamy).
- Kroky s proměnlivým pořadím jsou kroky, které lze provádět prakticky v libovolném pořadí. Dobrým příkladem jsou ty návody na řešení problémů, které vám říkají, abyste zkontrolovali toto, zkontrolovali tamto, kde se snažíte něco opravit. Tyto druhy kroků můžete provádět prakticky v libovolném pořadí. U tohoto typu je vhodným formátem seznam s odrážkami.
- Alternativní kroky jsou takové, ve kterých jsou uvedeny dva nebo více způsobů, jak dosáhnout stejné věci. Alternativní kroky se používají také tehdy, když mohou existovat různé podmínky. U tohoto typu použijte seznamy s odrážkami, přičemž mezi alternativy vložte OR, nebo úvod, který naznačuje, že alternativy budou představeny.
- Vnořené kroky lze použít v případech, kdy jsou jednotlivé kroky v rámci postupu samy o sobě poměrně složité a je třeba je rozdělit na dílčí kroky. V takovém případě se dále odsadí a dílčí kroky se řadí za sebou jako a, b, c atd.
- „Bezkrokové“ instrukce. lze použít v případě, že opravdu nelze použít číslovaný svislý seznam nebo poskytnout přímé vedení čtenáře ve stylu návodu. Některé situace musí být natolik obecné nebo variabilní, že kroky nelze uvést.
Doplňující diskuse: Často nestačí čtenáři pouze říci, aby udělal to či ono. Potřebují další vysvětlující informace, například jak by měla věc vypadat před a po kroku; proč by se měli starat o provedení tohoto kroku; jaký mechanický princip stojí za tím, co dělají; ještě více vysvětlení na mikroúrovni kroku – diskuse o konkrétních činnostech, které tvoří daný krok.
Problémem doplňující diskuse však je, že může zakrýt vlastní krok. Chcete, aby skutečný krok – konkrétní akce, které má čtenář provést – vynikl. Nechcete, aby byl celý pohřben v hromadě slov. Existují přinejmenším dvě techniky, jak se tomuto problému vyhnout: můžete návod oddělit od doplňku do samostatných odstavců; nebo můžete návod ztučnit.
Styl psaní
Umístění klíčových uživatelských kroků tučně může být velmi užitečným způsobem, jak čtenáři jasně signalizovat, co má udělat. Často je tučně zvýrazněno rozkazovací sloveso; někdy tučný font zvýrazňuje klíčovou součást, o které se mluví.
Používání pasivního hlasu v návodech může být problematické. Z nějakého podivného důvodu zní některé pokyny takto: „Pro dočasné zastavení displeje je třeba stisknout tlačítko Pause.“ V tomto případě je třeba stisknout tlačítko Pause. Nejenže se obáváme o duševní zdraví tlačítka pauzy, ale zajímalo by nás, kdo ho má stisknout (ninjové?). Bylo by užitečnější uvést, kdy musí čtenář „stisknout tlačítko Pauza“. Vezměme si tento příklad: „Tlačítko časovače je pak nastaveno na 3:00“. Opět se lze zeptat: „je nastaveno kým? Ninjové?“ Člověk sledující tyto instrukce si může myslet, že jde o pouhý odkaz na nějaký existující stav, nebo se může ptát: „Mluví na mě?“. Používání třetí osoby může také vést k rozpakům: „Uživatel by pak měl stisknout tlačítko Pauza.“ Návody by měly být obvykle psány pomocí rozkazovacích způsobů slovesných a s použitím „vy“, aby bylo naprosto jasné, co má čtenář udělat.
Ilustrace návodu
Možná více než v jiných formách technického psaní je pro návody klíčová grafika. Někdy prostě nelze daný krok vysvětlit slovy. Ilustrace jsou často rozhodující pro to, aby si čtenáři dokázali představit, co mají udělat. Dbejte na to, aby grafika představovala obraz z pohledu čtenáře.
Formátování návodů
Protože lidé málokdy chtějí číst návody, ale často musí, naformátujte návody pro neochotné čtenáře. Snažte se, aby si je čtenář chtěl přečíst nebo se alespoň nebránil myšlence, že se s nimi seznámí. Vysoce čitelný formát umožní čtenářům, kteří na některé pokyny přišli sami, přeskočit na část, kde se zasekli. K vytvoření efektivních a čtivých návodů použijte to, co jste se naučili o nadpisech, seznamech, vizuálních prvcích a pasivním prostoru:
Nadpisy: za normálních okolností byste měli mít nadpisy pro případné podkladové části, část o vybavení a zásobách, obecný nadpis pro vlastní část návodu a podnadpisy pro jednotlivé úkoly nebo fáze v rámci této části.
Seznamy: podobně návody obvykle hojně využívají seznamy, zejména číslované svislé seznamy pro vlastní vysvětlení jednotlivých kroků. Jednoduché svislé seznamy nebo dvousloupcové seznamy jsou obvykle vhodné pro oddíl o vybavení a zásobách. Seznamy ve větách jsou dobré vždy, když podáváte přehled věcí, které budou následovat.
Speciální upozornění: možná budete muset čtenáře upozornit na možnosti, při kterých mohou poškodit své vybavení, vyplýtvat zásoby, způsobit selhání celého postupu, zranit sebe nebo ostatní – dokonce vážně nebo smrtelně. Společnosti byly žalovány za absenci těchto zvláštních upozornění, za špatně napsaná zvláštní upozornění nebo za zvláštní upozornění, která nebyla na svém místě. Kompletní informace o správném používání těchto zvláštních upozornění, jakož i o jejich formátu a umístění v návodech naleznete v části Zvláštní upozornění.
Při opětovném čtení a revizi pokynů zkontrolujte, zda splňují následující požadavky:
- Jasně popsal přesný postup, který má být vysvětlen
- Uvedl přehled obsahu
- Uvedl požadavky na posluchače
- Ve vhodných případech použil různé typy seznamů; zejména pro postupné kroky používejte číslované seznamy
- Používejte nadpisy a podnadpisy k logickému a ucelenému rozdělení hlavních oddílů a pododdílů
- Podle potřeby používejte speciální upozornění
- Používejte grafické znázornění klíčových činností a předmětů
- Podle potřeby poskytněte další doplňující vysvětlení jednotlivých kroků
- V případě potřeby vytvořte oddíl se seznamem vybavení a pomůcek.
.