intro definuje manuál . Vysvětlete, kdo by si měli přečíst dokument a kdo je není určen pro , jaké informace je v ceně a za jakých okolností je to užitečné. Pro návodu k použití výrobku předpokládat, že čtenář koupil výrobek a je připraven se naučit, jak ji používat. Udržujte úvod krátká, takže se uživatel dostane do technických aspektů manuálu tak rychle, jak je to možné.
Obrysy
Technické příručky jsou často stanoveny v kapitoly a podkapitoly , který také ideální obrys . Seznam všech plánovaných úseků pro ruční a obsahoval podrobná podsekce kde je to nutné . Nebojte se změnit pořadí sekcí , jak budete postupovat . Jen proto, že jste si mysleli, tématu prvního neznamená, že čtenář musí nejprve tento bit informace . Konečné pořadí úseků by měla odrážet přirozený vývoj bude uživatel dělat , když se učí téma . Použijte podstatné jméno a sloveso v sekci okruhu definovat položky a akce v rámci části.
Být aktivní
Každý krok v technickém manuálu pokyn čtečka v jedné akci , která , když se provádí s dalšími kroky , vede k úplné akci . Počet kroků nebo grafická " kulky ", jedná se kroky . V některých situacích , kroky mohou být dílčí kroky označené čísly nebo písmeny v základních kroků . Spisovatelé mají určitou volnost v tom, jak identifikovat kroky , ale měla by být v souladu v celé příručce .
Keep It Simple
nejjednodušší jazyk, který přiměřeně přenáší informace . Vy nevíte, kdo bude číst návod a jak dobře se vyznají v technickém žargonu tématu . Vyhněte se vysoké úrovně detailů nebo informací není nutné předat informace. Dlouhé věty , více než 20 slov , mají tendenci se odradit čtenáře . Věty o méně než 10 slov může dát dokument sekání zvuku .
Popište Téma
fotografiemi , grafy a grafy pro ilustraci téma. Tyto obrázky mohou být za tisíc slov a přitahují oko čtenáře . Pokud grafické obrázky nejsou možné , používat popisné věty . Slovní příklady a ilustrace též umožňují čtenáři představit téma.