Pisanje tehničnega priročnika je preprosta naloga, ki vključuje organiziranje korakov in ustvarjanje jasnih, jedrnatih besedil. Cilj tehničnega priročnika je zagotoviti informacije o tem, kako izvesti operacijo v najmanjši možni meri in na najbolj jasen način. Tehnični priročniki pogosto vključujejo sodelovanje številnih ljudi, vključno s strokovnjaki s področja, uredniki in tehničnimi pisci. Ker so lahko tudi tehnični priročniki podvrženi stalnemu pregledu in posodabljanju, je komunikacija med vpletenimi stranmi ključna za razvoj priročnika.
Določite slog tehničnega priročnika, tako da ustvarite poenostavljen priročnik za slog ali pa sledite obstoječemu priročniku za slog, kot je Microsoftov vodnik po stilu za tehnične priročnike. Slog vodnik vam bo pomagal ustvariti okostje priročnika in zagotoviti doslednost.
Napišite korake za postopek, ki se začne z glagolom. Če je potrebno posvetovanje za pisanje korakov, razgovor in postavitev vprašanj strokovnjakov za predmet. To bo zagotovilo veljavnost postopkov; v nasprotnem primeru koraki ne smejo biti logični in / ali neurejeni. Koraki morajo biti logično urejeni in razdeljeni v logična poglavja ali delitve.
Dodajte grafike in ilustracije za korake, ki jih zahtevajo. Ne pozabite dodajati številčenja številk in naslove vsaki sliki / ilustraciji.
Ustvarite kazalo in indeks za lažje iskanje.
Dodajte dnevnik sprememb ali list za posodobitve, ki beleži vsako spremembo in posodobite priročnik za prihodnje revizije in izdaje. Tehnične priročnike mora vedno urediti nekdo, ki ni tehnični pisatelj, po možnosti strokovni urednik.
