Pisanie podręcznika technicznego jest prostym zadaniem, które polega na organizowaniu kroków i tworzeniu jasnych, zwięzłych sformułowań. Celem podręcznika technicznego jest dostarczenie informacji o tym, jak wykonać operację w jak najmniejszej liczbie kroków iw możliwie najprostszy sposób. Podręczniki techniczne często wymagają współpracy wielu osób, w tym ekspertów merytorycznych, redaktorów i pisarzy technicznych. Ponieważ podręczniki techniczne mogą również podlegać ciągłym zmianom i aktualizacjom, komunikacja między zaangażowanymi stronami ma kluczowe znaczenie dla opracowania podręcznika.
Określ styl podręcznika technicznego, tworząc uproszczony przewodnik po stylach lub postępując zgodnie z istniejącym przewodnikiem po stylach, takim jak Przewodnik po stylach Microsoft dla podręczników technicznych. Przewodnik po stylu pomoże w stworzeniu szkieletu podręcznika i zapewni spójność.
Napisz kroki procedury rozpoczynając od czasownika. Jeśli potrzebna jest konsultacja, aby napisać kroki, przeprowadzić rozmowę i zadać pytania ekspertom. Zapewni to ważność procedur; w przeciwnym razie kroki mogą nie być logiczne i / lub nieczynne. Kroki powinny być logicznie uporządkowane i podzielone na logiczne rozdziały lub działy.
Dodaj grafiki i ilustracje do kroków, które ich wymagają. Pamiętaj, aby dodać numerację figur i tytułów do każdej grafiki / ilustracji.
Stwórz spis treści i indeks dla łatwego odniesienia.
Dodaj dziennik zmian lub arkusz aktualizacji, który rejestruje każdą zmianę i aktualizację do podręcznika dla przyszłych wersji i wydań. Instrukcje techniczne powinny zawsze być edytowane przez osobę inną niż autor techniczny, najlepiej przez profesjonalnego redaktora.
