Techninio vadovo rašymas yra paprastas uždavinys, apimantis veiksmų organizavimą ir aiškios, glaustos formuluotės sukūrimą. Techninio vadovo tikslas - pateikti informaciją apie tai, kaip operaciją atlikti kuo mažiau žingsnių ir kuo aiškiau. Techniniuose vadovuose dažnai dalyvauja daug žmonių, įskaitant dalykų ekspertus, redaktorius ir techninius rašytojus. Kadangi techniniai vadovai taip pat gali būti nuolat peržiūrimi ir atnaujinami, suinteresuotųjų šalių ryšiai yra labai svarbūs rengiant vadovą.
Nustatykite techninio vadovo stilių sukurdami supaprastintą stiliaus vadovą arba atlikdami esamą stiliaus vadovą, pvz., „Microsoft“ stiliaus vadovą techniniams vadovams. Stiliaus vadovas padės sukurti vadovo skeletą ir užtikrinti nuoseklumą.
Parašykite procedūros veiksmus, pradedant veiksmažodžiu. Jei reikia konsultacijų, norint parašyti žingsnius, interviu ir užduoti ekspertų klausimus. Tai užtikrins procedūrų pagrįstumą; kitaip, veiksmai gali būti ne logiški ir (arba) netvarkingi. Žingsniai turėtų būti išdėstyti logiškai ir suskirstyti į loginius skyrius ar skyrius.
Pridėkite grafikų ir iliustracijų, kurių reikia juos atlikti. Nepamirškite pridėti skaičiaus numerių ir pavadinimų kiekvienam grafui / iliustracijai.
Sukurkite turinį ir indeksą, kad būtų lengva nuoroda.
Pridėkite pakeitimų žurnalą arba atnaujinimo lapą, kuriame įrašomi visi pakeitimai ir atnaujinama vadovo versija, kad būtų galima atlikti būsimus pakeitimus ir išleidimus. Techninius vadovus visada turėtų redaguoti kitas nei techninis rašytojas, pageidautina profesionalus redaktorius.
