Techničtí autoři vytvářejí různé typy dokumentace, například uživatelské příručky, dokumentaci API, příručky „Jak na to“ atd. Napsal jsem článek o tom, jak napsat uživatelskou příručku, takže dnes vám povím o tvorbě příručky ‚Jak na to‘.
Když dostanete úkol vytvořit příručku, vaším prvním krokem by mělo být plánování. Zde je uvedeno, co byste měli udělat:
Pochopte svou cílovou skupinu
Když začnete psát příručku, měli byste jasně pochopit, kdo je vaše cílová skupina. Jaký je jejich věk, jaké je jejich zázemí atd. To určí styl vašeho průvodce „Jak na to“ na té nejzákladnější úrovni – složitost použitého jazyka, počet termínů a mnoho dalších charakteristik.
Pátrejte po postupu
Doporučuji vám přečíst si o zkušenostech jiných lidí s psaním průvodců „Jak na to“. Pomůže vám to získat jasnou představu o budoucí práci a můžete začlenit přístupy ostatních do svého pracovního procesu. Například jsem psal o procesu technického psaní Amrute Ranade, článek si můžete přečíst zde: „Skvělý proces technického psaní“. Tuto metodu tedy můžete použít i vy, abyste si usnadnili psaní technických textů.
Sbírejte užitečné materiály
Předtím, než začnete psát, shromážděte materiály a informace, které vám pomohou napsat příručku „jak na to“. Mohou to být další informace o produktu, jiné příručky „jak na to“ k podobným produktům nebo něco jiného.
Pište příručku „jak na to“
Nejprve si vytvořte plán – příručku se vám bude psát snáze, pokud si ji představíte. Po všech těchto přípravách je nejvyšší čas začít psát. Při tvorbě průvodce byste měli mít na paměti následující tipy:
- Pište srozumitelnou angličtinou, abyste mluvili stejným jazykem jako vaši čtenáři.
- Váš jazyk by měl být vždy stručný (např, „Vyberte možnost“ místo „Měli byste vybrat možnost“).
- Vytvořte číslované seznamy pro strukturování kroků, pokud je uživatel potřebuje dokončit
- Přidejte vizuální obsah, jako jsou fotografie, snímky obrazovky a diagramy.
- Rozdělte obsah na části s nadpisy, ale pište je srozumitelně
- Pokud chcete používat vtipy, buďte opatrní: lidé vám nemusí rozumět
- Přidejte mini-TOC, aby byla velká témata čitelnější.
Nejzásadnější rada je následující – pravopisné a gramatické chyby jsou v dokumentaci nepřípustné, proto svou příručku důkladně zkontrolujte. Zde je seznam nejlepších bezplatných programů pro kontrolu gramatiky. Také můžete požádat někoho jiného, aby za vás provedl korekturu, nebo si zpětně přečíst vlastní kroky, abyste se ujistili, že je váš text jasný a jednoduchý. Zde je několik dalších zdrojů pro psaní skvělé dokumentace:
- Grammar Books for Technical Writers
- Style Guides for Technical Writers
To samozřejmě není vše, co je třeba vědět o psaní příruček „Jak na to“, ale tyto tipy jsou podle mě nejpodstatnější. Doufám, že vám pomohou.
Přeji vám hodně štěstí při psaní příruček!