Teknisen käsikirjan kirjoittaminen on suoraviivainen tehtävä, johon kuuluu vaiheiden järjestäminen ja selkeän, tiiviin sanamuodon luominen. Teknisen käsikirjan tavoitteena on antaa tietoa siitä, miten toimenpide suoritetaan mahdollisimman vähäisessä määrin ja mahdollisimman selkeästi. Tekniset käsikirjat sisältävät usein yhteistyötä monien ihmisten kanssa, mukaan lukien aiheen asiantuntijat, toimittajat ja tekniset kirjoittajat. Koska teknisiä käsikirjoja voidaan myös jatkuvasti tarkistaa ja päivittää, osapuolten välinen viestintä on ratkaisevan tärkeää käsikirjan kehittämiselle.
Määritä teknisen käsikirjan tyyli luomalla yksinkertaistettu tyyliopas tai noudattamalla olemassa olevaa tyyliopasta, kuten Microsoftin Style Guide for Technical Manuals. Tyyli-opas auttaa luomaan käsikirjan rungon ja varmistamaan johdonmukaisuuden.
Kirjoita toimenpiteen vaiheet verbillä. Jos kuulemisia tarvitaan vaiheiden kirjoittamiseen, haastattelu ja kysymysten esittäminen aiheen asiantuntijoille. Näin varmistetaan menettelyjen pätevyys; muuten vaiheet eivät ehkä ole loogisia ja / tai epäkunnossa. Vaiheet on järjestettävä loogisesti ja erotettava loogisiin lukuihin tai osastoihin.
Lisää grafiikkaa ja piirroksia vaiheisiin, jotka vaativat niitä. Muista lisätä kuvien numerointi ja otsikot jokaiselle graafiselle / kuvalliselle kuvalle.
Luo sisällysluettelo ja indeksi helpon viittauksen vuoksi.
Lisää muutosloki tai päivitysarkki, joka tallentaa jokaisen muutoksen ja päivittää käyttöoppaan tulevia tarkistuksia ja julkaisuja varten. Teknisiä käsikirjoja pitäisi aina muokata joku muu kuin tekninen kirjoittaja, mieluiten ammattimainen toimittaja.
