Tekninen kirjoittaminen

Tekninen kirjoittaminen on teknisen viestinnän osa-alue, jonka avulla kommunikoidaan teknistä tietoa. Usein teknisen kirjoittamisen tuloksena syntyy dokumentaatio, jonka muoto ja sisältö riippuu yleisön ja tuotteen tarpeesta.

Tekninen kirjoittaminen eroaa muusta kirjoittamisesta rakenteensa ja käytetyn kielen perusteella. Tekninen kirjoittaminen on yleisesti ottaen hyvin rakenteellista, jossa käytetään paljon numeroituja otsikoita, kuvia ja erilaisten osien hierarkioita. Käytetty kieli on muodoltaan virallista, eikä siten ilmennä kirjoittajan persoonallisuutta.

Haasteet

Kuten kirjoittamisessa yleensäkin, teknisten kirjoittajien tulee ymmärtää yleisöänsä esimerkiksi käyttäjiä, sekä dokumentin tarkoitusta ja kuvattavaa asiaa, esimerkiksi tuotetta tai ohjelmistoa. Formaatti, organisointi ja tyyli ovat tärkeitä asioita, sillä ne voivat tehdä tekstistä helppolukuisen. Esimerkiksi käyttöohjeissa diagrammit ja erilaiset kuvat auttavat lukijaa. Tekstin tulisi olla saatavilla silloin käyttäjä sitä tarvitsee, ja ideaalisesti ainoastaan silloin.

Tuotokset

Ohjelmistot dokumentoidaan usein online help -teksteinä. Help-teksti kertoo kuinka ohjelmistossa navigoidaan, kuinka tehdään toimenpiteitä ja kuinka eri ohjelmiston näyttöjä/ikkunoita käytetään.

Erilaisia teknisen kirjoittamisen tuotoksia ovat

• Asennusohjeet
• Lehtiartikkelit
• Käyttöohjeet
• Esitysmateriaali
• Tekniset referenssiaineistot
• Julkaisutiedotteet
• Tieteelliset raportit
• Testisuunnitelmat ja raportit
• Koulutusmateriaalit
• Huolto- ja kunnossapitoohjeet
• Ongelmanratkaisuoppaat
• Referenssikuvaukset
• Erilaiset filmit

Aiheesta muualla

• Mitä on tekninen viestintä? Suomen teknisen viestinnän yhdistys. Viitattu 19.1.2012.