”Onhan kirjoittajanne varmasti alamme asiantuntija? Alamme on hyvin tekninen ja erilainen kuin muut.” Tämä kysymys selityksineen esitetään usein dokumentointipalveluita tarjoavalle yritykselle. Yrityksissä on useasti vallalla kuvitelma, että heidän alansa on niin erityinen, ettei aiheesta voi kirjoittaa dokumentaatiota kukaan muu kuin alan ehdoton asiantuntija.
Yleensä on kuitenkin niin, että nämä alan ehdottomat asiantuntijat ovat jo yrityksessä töissä: hoitamassa asiantuntijatehtäviä muun muassa tuotekehityksessä. Heillä ei ole aikaa tai halua kirjoittaa dokumentaatiota – siksihän dokumentointipalveluita tarjoavaa yritystä on lähestytty. Lisäksi alan asiantuntijat ovat oman aihepiirinsä erikoisosaajia, mutta harvoin kirjoittamisen saati teknisen dokumentoinnin ammattilaisia, eikä heillä välttämättä ole kykyä tuottaa niin pitkälle vietyä ja laadukasta dokumentaatiota kuin esimerkiksi yritysimagon vuoksi olisi suotavaa.
Tekninen kirjoittaja sen sijaan on tiedon jäsentelyn sekä kielen ja kirjoittamisen ammattilainen. Eurooppalaisen teknisen viestinnän kattojärjestön, TC Europen, määritelmän mukaan tekninen kirjoittaja edustaa tuotteen ja käyttäjän välissä olevaa rajapintaa. On vain eduksi, ettei kirjoittaja tunne aihealuetta liian syvällisesti, sillä dokumentti voi hyvin olla myös lukijan ensikosketus aiheeseen. Kirjoittaja pystyy tällöin paremmin samaistumaan lukijaan ja kirjoittamaan sopivalla vaatimustasolla ja tarkkuudella. Selittääkseen keskeiset käsitteet selvästi kirjoittajan on tietenkin ymmärrettävä käsillä oleva asia perustasolla. Selkeä ja johdonmukainen teksti auttaa vähemmän perehtynyttä lukijaa ymmärtämään lukemaansa.
Tekninen kirjoittaja edustaa tuotteen ja käyttäjän välissä olevaa rajapintaa.
Pystyäkseen kirjoittamaan laadukasta dokumentaatiota, aihealueen läpikotaisen tuntemuksen sijaan teknisen kirjoittajan avaintaitoja ovat:
Tiedonkeruu eri lähteistä, kuten asiakkaan olemassa olevasta materiaalista (vanhat dokumentit, tekniset tiedot, markkinointimateriaali), alan nettisivuilta sekä asiantuntijoita haastattelemalla. Rohkeus esittää tyhmältäkin tuntuvia kysymyksiä on merkittävä osa tiedonkeruutaitoa.
Teknisen kirjoittamisen käytäntöjen hallinta. Ne ovat samat alasta riippumatta: dokumentin suunnittelu, käyttäjä- ja tehtäväanalyysi, tietojen keruu ja jäsentely, dokumentin versiointi ja testaus, palautteen vastaanottaminen sekä dokumentin ja työskentelytapojen kehittäminen saadun palautteen perusteella.
Laadunhallinta, joka dokumentoinnissa tarkoittaa monia asioita. Selkeä, kielioppia noudattava teksti on varmasti ensinnä asiakkaan mielessä. Käyttäjäystävällisyys ja käytettävyys ovat tärkeitä dokumentaation laatutekijöitä, ja niihin kuuluvat myös muun muassa yhdenmukainen terminologia ja dokumentin rakenteen suunnittelu. Harkittu termien valinta ja niiden johdonmukainen käyttö edistävät tekstin ymmärrettävyyttä, ja selkeä rakenne ja yhtenäinen tyyli puolestaan helpottavat lukemista ja tiedonhakua dokumentista. Lisäksi kirjoittajan on varmistettava, että dokumentin tiedot kattavat käyttäjän tarpeet – on osattava erottaa olennainen epäolennaisesta, ja tarkoitus ei ole kertoa kaikesta kaikkea.
Vastaus asiakkaan kysymykseen siis on: ei, kirjoittajamme ei ole alanne asiantuntija ja hyvä niin! Oman erityisosaamisensa ansiosta hän pystyy kirjoittamaan objektiivista ja käyttäjäystävällistä dokumentaatiota, jonka avulla yritys voi edistää omia tavoitteitaan.
Tarvitseeko yrityksesi apua monikielisen teknisen dokumentaation tuottamisessa? Pitäisikö yrityksesi jo tuottamia sisältöjä kääntää toiselle kielelle? Ota yhteyttä, niin asiantuntijamme auttavat sinua valitsemaan tarpeeseesi sopivimmat ratkaisut.
Updated