intro definuje manuál . Vysvetlite , kto by si mali prečítať dokument a kto je nie je určený pre , aké informácie je v cene a za akých okolností je to užitočné . Pre návodu na použitie výrobku predpokladať , že čitateľ kúpil výrobok a je pripravený sa naučiť , ako ju používať . Udržujte úvod krátka , takže sa užívateľ dostane do technických aspektov manuálu tak rýchlo , ako je to možné .
Obrysy
Technické príručky sú často stanovené v kapitoly a podkapitoly , ktorý tiež ideálny obrys . Zoznam všetkých plánovaných úsekov pre ručné a obsahoval podrobné podsekcie kde je to nutné. Nebojte sa zmeniť poradie sekcií, ako budete postupovať . Len preto , že ste si mysleli , téme prvého neznamená , že čitateľ musí najprv tento bit informácie . Konečné poradie úsekov by mala odrážať prirodzený vývoj bude užívateľ robiť , keď sa učí tému . Použite podstatné meno a sloveso v sekcii okruhu definovať položky a činnosti v rámci časti .
Byť aktívny
Každý krok v technickom manuáli pokyn čítačka v jednej akcii , ktorá , keď sa vykonáva s ďalšími krokmi , vedie k úplnej akcii . Počet krokov alebo grafická " guľky " , jedná sa kroky . V niektorých situáciách , kroky môžu byť čiastkové kroky označené číslami alebo písmenami v základných krokov . Spisovatelia majú určitú voľnosť v tom, ako identifikovať kroky , ale mala by byť v súlade v celej príručke .
Keep It Simple
najjednoduchší jazyk , ktorý primerane prenáša informácie . Vy neviete , kto bude čítať návod a ako dobre sa vyznajú v technickom žargóne téme . Vyhnite sa vysokej úrovne detailov alebo informácií nie je nutné odovzdať informácie . Dlhé vety , viac ako 20 slov , majú tendenciu sa odradiť čitateľa . Vety o menej ako 10 slov môže dať dokument sekanie zvuku .
Popíšte Téma
fotografiami , grafy a grafy pre ilustráciu tému . Tieto obrázky môžu byť za tisíc slov a priťahujú oko čitateľa . Pokiaľ grafické obrázky nie sú možné , používať opisné vety . Slovné príklady a ilustrácie tiež umožňujú čitateľovi predstaviť tému .