Písanie technickej príručky je jednoduchou úlohou, ktorá zahŕňa organizovanie krokov a vytvorenie jasného a stručného znenia. Cieľom technickej príručky je poskytnúť informácie o tom, ako vykonať operáciu v najmenšom množstve krokov a čo najjasnejšie. Technické manuály často zahŕňajú spoluprácu mnohých ľudí vrátane odborníkov na predmet, redaktorov a technických spisovateľov. Pretože technické manuály môžu tiež prechádzať neustálymi revíziami a aktualizáciami, komunikácia medzi zainteresovanými stranami je rozhodujúca pre vypracovanie manuálu.
Určite štýl technickej príručky buď vytvorením zjednodušeného sprievodcu štýlom, alebo podľa existujúcej príručky štýlov, ako je príručka Microsoft Style pre technické príručky. Sprievodca štýlom vám pomôže vytvoriť kostru manuálu a zabezpečiť konzistenciu.
Napíšte kroky pre postup začínajúci slovesom. Ak potrebujete konzultácie na napísanie krokov, rozhovor a položte otázky odborníkov na predmet. Tým sa zabezpečí platnosť postupov; inak, kroky nemusia byť logické a / alebo nevhodné. Kroky by mali byť logicky usporiadané a rozdelené do logických kapitol alebo divízií.
Pridajte grafiku a ilustrácie na kroky, ktoré ich vyžadujú. Nezabudnite pridať číslovanie čísel a názvy jednotlivých obrázkov / obrázkov.
Vytvorte obsah a index pre ľahkú orientáciu.
Pridajte záznam o zmenách alebo aktualizačný hárok, ktorý zaznamenáva každú zmenu a aktualizuje sa do príručky pre budúce revízie a vydania. Technické príručky by mali byť vždy editované niekým iným než technickým spisovateľom, najlepšie profesionálnym redaktorom.
