teknisen kirjoittamisen perusperiaatteet

aina silloin tällöin on tarpeen palata teknisen kirjoittamisen perusperiaatteisiin. Siitä lähtien, kun aloitimme vuonna 1997, teknisen kirjoittamisen perusperiaatteet ovat pysyneet samoina, vaikka viestintämuodot muuttuvat.

tarkoitus ja yleisö

ennen uuden kirjoitusprojektin aloittamista teknisen kirjoittajan on analysoitava dokumentin käyttötarkoitus ja tunnistettava sille tarkoitettu yleisö. Kirjoittajan on kysyttävä:

• kuka lukee asiakirjat?
• mitkä ovat heidän harhansa?
• mitä velvollisuuksia minulla on tiedon välittämisessä yleisölle?

tyyliopas

tekniset kirjoittajat käyttävät usein yrityksen tyyliopasta, jos sellainen on saatavilla, varmistaakseen, että heidän dokumentaationsa on jäsennelty. Tyyliopas (kuten AP Stylebook) antaa ohjeita siitä, miltä dokumentti näyttää, millaista kieltä se käyttää ja miten ideat järjestetään. Tämä organisaatio antaa jatkuvuutta asiakirjan tai sarjan asiakirjoja, joten yleisö voi helposti ymmärtää tietoa. Tekninen kirjoittaja voi esimerkiksi dokumentoida prosessin aikajärjestyksessä, kuten tyylioppaassa sanotaan. Ilman tätä rakennetta lukija olisi hämmentynyt ja kykenemätön seuraamaan prosessia. Tyylioppaat tekevät kirjoittamisesta johdonmukaisempaa ja luettavampaa.

kirjoitustyyli

tekniset kirjoittajat muuttavat kirjoitustyyliään riippuen yleisöstä ja tilanteesta, josta he kirjoittavat. Jos he kirjoittavat teknistä dokumentaatiota, tyylin pitäisi olla muodollinen, vailla tunnetta, jonka saat luovalla kirjoittamisella. Jos he kirjoittavat sähköpostia jollekin hankkeessa mukana olevalle johtajalle, heidän tyylinsä olisi keskustelevampi.

tietojen saatavuus

esteettömyydellä tarkoitetaan sitä, kuinka helposti asiakirjan tiedot ovat tavoitellun yleisön saatavilla. Tekninen asiakirja sisältää sisällysluettelon, otsakkeet, alatunnisteet ja sivunumerot, joiden avulla lukijat voivat selata asiakirjaa ja löytää tarvitsemansa tiedot. Teknisessä asiakirjassa on myös erityinen otsakkeiden ja alaotsikoiden rakenne, jotta tiedot voidaan jakaa asiaankuuluviin osiin, joihin lukija voi helposti tutustua.

nämä ovat vain muutamia näkökohtia, joita käsittelemme teknisinä kirjoittajina. Jos haluat parantaa omaa teknistä kirjoitustaitoasi, harkitse teknisen kirjoittamisen työpajaamme. Se voidaan räätälöidä 1 henkilön tai 20 henkilön tarpeisiin!

jos et halua kirjoittaa dokumenttia itse ja tarvitset apua kokeneelta tekniseltä kirjoittajalta, tutustu Palvelusivullemme.

olemme täällä auttamassa. Ota yhteyttä jo tänään!