Psaní technického manuálu je přímý úkol, který zahrnuje organizaci kroků a vytvoření jasného a stručného textu. Cílem technického manuálu je poskytnout informace o tom, jak provést operaci v nejmenším množství kroků a co nejjasněji. Technické příručky často zahrnují spolupráci mnoha lidí, včetně odborníků na předměty, redaktorů a technických spisovatelů. Vzhledem k tomu, že technické příručky mohou být také předmětem neustálé revize a aktualizací, komunikace mezi zainteresovanými stranami je zásadní pro vypracování příručky.
Určete styl technického manuálu buď vytvořením zjednodušeného průvodci styly, nebo podle stávajícího průvodce styly, jako je průvodce styly Microsoft pro technické příručky. Příručka stylů pomůže při vytváření kostry příručky a zajištění konzistence.
Zadejte kroky pro postup začínající slovesem. Je-li zapotřebí konzultace k psaní kroků, rozhovor a klást otázky odborníků na téma. To zajistí platnost postupů; jinak nemusí být kroky logické a / nebo nevhodné. Kroky by měly být logicky uspořádány a rozděleny na logické kapitoly nebo oddíly.
Přidejte grafiky a ilustrace na kroky, které je vyžadují. Nezapomeňte přidat číslování čísel a názvy do každé grafiky / ilustrace.
Vytvořte obsah a index pro snadnou orientaci.
Přidejte protokol změn nebo aktualizační list, který zaznamenává každou změnu a aktualizuje se v příručce pro budoucí revize a vydání. Technická příručka by měla být vždy editována jiným uživatelem než technickým zapisovatelem, nejlépe profesionálním redaktorem.
