Tekniset kirjoittajat luovat erityyppistä dokumentaatiota, esimerkiksi käyttöoppaita, API-dokumentaatiota, How to -oppaita ja niin edelleen. Kirjoitin artikkelin käyttöoppaan kirjoittamisesta, joten tänään kerron sinulle ’How to’ -oppaan luomisesta.
Kun saat tehtäväksi oppaan luomisen, ensimmäisenä askeleenasi tulisi olla suunnittelu. Tässä on, mitä sinun tulisi tehdä:
Ymmärrä kohdeyleisösi
Kun aloitat oppaan kirjoittamisen, sinun tulisi selvästi ymmärtää, kuka on kohdeyleisösi. Mikä on heidän ikänsä, mikä on heidän taustansa ja niin edelleen. Tämä määrittelee ”How to” -oppaasi tyylin perustavanlaatuisimmalla tasolla – käytetyn kielen monimutkaisuus, termien määrä ja monet muut ominaisuudet.
Tutkimus prosessista
Suosittelen, että luet muiden ihmisten kokemuksia ”How to” -oppaiden kirjoittamisesta. Se auttaa sinua saamaan selkeän kuvan tulevasta työstä, ja voit integroida muiden lähestymistapoja omaan työprosessiisi. Kirjoitin esimerkiksi Amrute Ranaden teknisen kirjoittamisen prosessista, voit lukea artikkelin täältä: ’Suuri teknisen kirjoittamisen prosessi’. Voit siis käyttää tätä menetelmää myös teknisen kirjoittamisen helpottamiseksi.
Kerää hyödyllistä materiaalia
Kerää ennen kirjoittamisen aloittamista materiaalia ja tietoa, joka auttaa sinua kirjoittamaan ”miten”-oppaan. Se voi olla lisätietoa tuotteesta, muita samankaltaisten tuotteiden ”miten”-oppaita tai jotain muuta.
Kirjoita ”miten”-opas
Luo ensin suunnitelma – oppaan kirjoittaminen helpottuu helpommin, jos visualisoit sen. Kaikkien näiden valmistelujen jälkeen on korkea aika aloittaa kirjoittaminen. Opasta laatiessasi kannattaa pitää mielessä seuraavat vinkit:
- Kirjoita selkokielellä, jotta puhut samaa kieltä kuin lukijasi.
- Kielenkäyttösi tulisi aina olla tiivistä (esim, ’Valitse vaihtoehto’ sen sijaan, että sanoisit ’Sinun pitäisi valita vaihtoehto’).
- Luo numeroituja luetteloita vaiheiden jäsentämiseksi, jos käyttäjän on suoritettava niitä
- Lisää visuaalista sisältöä, kuten valokuvia, kuvakaappauksia ja kaavioita.
- Jaottele sisältö otsikoituihin osioihin, mutta kirjoita ne selkeästi
- Jos haluat käyttää vitsejä, ole varovainen: ihmiset eivät välttämättä ymmärrä sinua
- Lisää mini-TOC-otsikoita tehdäksesi isoista aiheista helppolukuisempia.
Edellyttävin vinkki on seuraavanlainen – oikeinkirjoitus- ja kielioppivirheitä ei voida hyväksyä dokumentaatiossa, joten tarkista oppaasi huolellisesti. Tässä on luettelo parhaista ilmaisista kieliopin tarkistusohjelmista. Voit myös pyytää jotakuta toista oikolukemaan puolestasi tai lukea omat vaiheesi takaperin varmistaaksesi, että kirjoituksesi on selkeää ja yksinkertaista. Tässä on pari muuta resurssia loistavan dokumentaation kirjoittamiseen:
- Kielioppikirjat teknisille kirjoittajille
- Tyylioppaat teknisille kirjoittajille
Tämä ei tietenkään ole kaikki, mitä ”How to” -oppaiden kirjoittamisesta on tiedettävä, mutta nämä vinkit ovat mielestäni olennaisimmat. Toivottavasti niistä on sinulle apua.
Onnea oppaiden kirjoittamiseen!