Tehniskās rokasgrāmatas rakstīšana ir vienkāršs uzdevums, kas ietver pasākumu organizēšanu un skaidru, kodolīgu formulējumu. Tehniskās rokasgrāmatas mērķis ir sniegt informāciju par to, kā veikt darbību vismazākos soļos un pēc iespējas skaidrāk. Tehniskajās rokasgrāmatās bieži ir iesaistīti daudzi cilvēki, tostarp eksperti, redaktori un tehniskie rakstnieki. Tā kā tehniskās rokasgrāmatas var arī pastāvīgi pārskatīt un atjaunināt, saziņa starp iesaistītajām pusēm ir būtiska rokasgrāmatas izstrādei.
Nosakiet tehniskās rokasgrāmatas stilu, izveidojot vienkāršotu stila rokasgrāmatu vai izpildot esošo stila rokasgrāmatu, piemēram, Microsoft stila rokasgrāmatu tehniskajām rokasgrāmatām. Stila ceļvedis palīdzēs veidot rokasgrāmatas skeletu un nodrošināt konsekvenci.
Uzrakstiet procedūras darbības, sākot ar verbi. Ja konsultācijas ir nepieciešamas, lai uzrakstītu pasākumus, intervijas un uzdotu jautājumus jautājumos par ekspertiem. Tas nodrošinās procedūru derīgumu; pretējā gadījumā soļi var nebūt loģiski un / vai neatbilstoši. Pakāpieni būtu loģiski jānorāda un jāsadala loģiskās nodaļās vai nodaļās.
Pievienojiet grafikas un ilustrācijas pasākumiem, kas tos prasa. Atcerieties pievienot skaitļu numurus un nosaukumus katram grafikam / ilustrācijai.
Izveidojiet satura rādītāju un indeksu, lai to varētu viegli izmantot.
Pievienojiet izmaiņu žurnālu vai atjaunināšanas lapu, kurā tiek ierakstītas visas izmaiņas un atjauninātas rokasgrāmatā turpmākai pārskatīšanai un izlaidumiem. Tehniskās rokasgrāmatas vienmēr ir jāpārveido kāds cits, nevis tehniskais rakstnieks, vēlams profesionāls redaktors.
