Pisanje tehničkog priručnika jednostavan je zadatak koji uključuje organiziranje koraka i stvaranje jasnog, konciznog teksta. Cilj tehničkog priručnika je pružiti informacije o tome kako izvesti operaciju u najmanjoj mogućoj mjeri i na najjasniji mogući način. Tehnički priručnici često uključuju suradnju mnogih ljudi, uključujući stručnjake za predmet, urednike i tehničke pisce. Budući da tehnički priručnici mogu biti podvrgnuti stalnoj reviziji i ažuriranju, komunikacija između uključenih strana je ključna za razvoj priručnika.
Utvrdite stil tehničkog priručnika izradom pojednostavljenog vodiča za stil ili slijedeći postojeći vodič za stil, kao što je Microsoft Style Guide za tehničke priručnike. Stilski vodič pomoći će u stvaranju kostura priručnika i osigurati dosljednost.
Napišite korake za postupak počevši s glagolom. Ako je potrebno savjetovanje za pisanje koraka, intervjuiranje i postavljanje pitanja stručnjaka za određenu temu. Time će se osigurati valjanost postupaka; u suprotnom, koraci ne moraju biti logični i / ili neispravni. Koraci trebaju biti logički uređeni i podijeljeni u logička poglavlja ili podjele.
Dodajte grafike i ilustracije koracima koji ih zahtijevaju. Ne zaboravite dodati numeraciju brojeva i naslove svakoj slici / ilustraciji.
Napravite tablicu sadržaja i indeks za jednostavnu referencu.
Dodajte dnevnik promjena ili list ažuriranja koji bilježi svaku promjenu i ažurira priručnik za buduće revizije i izdanja. Tehničke priručnike uvijek treba urediti netko drugi, a ne tehnički pisac, po mogućnosti profesionalni urednik.
