Tekninen kirjoittaminen teknikoille

Yksi yleisimmistä ja tärkeimmistä teknisen kirjoittamisen käyttökohteista on ohjeiden kirjoittaminen – ohjeiden vaiheittaiset selitykset siitä, miten jokin asia tehdään: miten jotain kootaan, miten jotakin käytetään, miten jotakin korjataan tai miten jokin henkilökohtainen prosessi selitetään (esimerkiksi yliopistoon ilmoittautuminen opintoihin), jotta lukijat ymmärtäisivät sen paremmin ja voisivat mahdollisesti käyttää sitä itse.

Prosessitekstit ovat erittäin yleisiä kouluissa ja ammateissa. Koulussa opettajat antavat usein prosessitehtäviä. Esimerkiksi humanististen tieteiden professorit saattavat pyytää kuvausta siitä, miten jokin taiteen tai kirjallisuuden aikakausi kehittyi; historian professorit kulttuurin johtajien panosta aikojen kuluessa; yhteiskuntatieteiden professorit keksintöjen kronologiaa; insinöörien professorit selityksiä siitä, miten ääni muuttuu sähköisiksi signaaleiksi; kauppatieteiden professorit sitä, miten Yhdysvaltain keskuspankki toimii tai miten tuotetta myydään.

Luemme päivittäin kuvailevia prosesseja, kuten reseptejä, uuden ohjelmiston käyttöohjeita tai neuvoa-antavia kolumneja, joissa kerrotaan siitä, miten laihdutetaan tai miten pärjätä koulussa tai ammatissa. Näissä teksteissä keskitytään vastaamaan johonkin seuraavista kysymyksistä:

• ”Miten tämä tehdään?”
• ”Miten voin tehdä tämän?”

Vaikka prosessikertomuksen tai -ohjeen aiheet voivat vaihdella, monissa niistä on yhtäläisyyksiä: useimmat niistä on kirjoitettu selittämään, miten jokin asia toimii, useimmat niistä on jäsennetty kronologiseen järjestykseen numeroitujen vaiheiden avulla, ja useimmat niistä nojautuvat laajalti visuaaliseen materiaaliin. Kirjoittaessaan ohjeita esimerkiksi uuden ohjelmiston opettelemiseksi kirjoittajat saattavat käyttää kuvakaappauksia ja/tai kuvavideoita opastamaan käyttäjiä ohjeen läpi.

Yleisesti ohjeissa on hyvä olla sekä tekstiä että visuaalista materiaalia, koska yleisö koostuu todennäköisesti ihmisistä, joilla on erilaisia oppimistyylejä. Visuaalien käyttö voi kuitenkin vaihdella yleisöstäsi ja ohjeiden käyttötarkoituksesta riippuen. Visuaalit auttavat selventämään käsitettä, jota on vaikea selittää pelkillä sanoilla. Grafiikkaa voidaan käyttää osoittamaan, miltä jokin asia näyttää, miltä jonkin asian pitäisi näyttää, kun vaihe on suoritettu, miten jokin asia tehdään tai rakennetaan, osoittamaan suuntauksia tai suhteita, lisäämään elävyyttä projektiin tai yksinkertaisesti auttamaan tiedon järjestämisessä. Grafiikka on hyödyllistä, koska lähes kaikki (myös lapset ja muunkieliset) ymmärtävät visuaalisia ohjeita ja näkevät tarkalleen, mitä heidän on tehtävä.

Ohjeiden tyypit

Prosessitekstejä on kolmea päätyyppiä:

• • • Kuvailevat prosessit: Nämä vastaavat kysymykseen ”Miten tämä tehdään?”. Näissä teksteissä kuvataan, miten prosessi tapahtuu, jotta lukijat voivat ymmärtää sitä paremmin. Esimerkiksi kuvailevan prosessin kirjoittaminen siitä, miten ilmoittauduit kurssille verkossa sen sijaan, että olisit ilmoittautunut henkilökohtaisesti, voi olla hyödyllistä jollekin, joka ei ole koskaan tehnyt verkkoilmoittautumista.

Preskriptiiviset prosessit: Nämä prosessit ovat luonteeltaan selittäviä; ne määrittelevät, miten jokin asia tehdään (tai kuinka jokin asia pitäisi tehdä), niin että lukijat voivat tehdä sen itse. Nämä ovat yleisimpiä ohjeasiakirjoja. Voit esimerkiksi kirjoittaa käyttäjille kuvailevan prosessioppaan, jossa selitetään, miten autojen perushuolto, kuten öljynvaihto, sytytystulppien tarkistus tai jarrupalojen vaihto, tehdään. *Alempana luetellut esimerkit ovat esimerkkejä kuvailevista prosesseista.

• • • Sekoitetuissa kuvailevissa ja kuvailevissa prosesseissa asiakirjan pääpaino on kuvailevassa prosessissa, kun taas asiakirjassa on muutama jakso, joissa esitetään yhteenveto siitä, miten lukijat voivat suorittaa prosessin. Toisin sanoen kirjoittajat voivat käsitellä sekä ”Miten voin tehdä tämän?” että ”Miten tämä tehdään?” saman tekstin eri osissa. Vaihtoehtoisesti he saattavat laatia samasta asiakirjasta eri versioita kahdelle yleisölle – käyttäjistä koostuvalle yleisölle ja kiinnostuneista koostuvalle yleisölle.

Alkuun pääseminen

Ohjeen kirjoittamisprojektin tai -tehtävän alussa on tärkeää miettiä kohderyhmää ja määritellä sen tietyn menettelyn ominaispiirteet (tehtävien ja vaiheiden määrä), josta aiot kirjoittaa.

Ohderyhmä ja tilanne: Määrittele jo varhaisessa vaiheessa ohjeidesi yleisö ja tilanne. Muista, että yleisön määrittely tarkoittaa sen tietämyksen ja aiheeseen perehtyneisyyden tason määrittelyä. Joskus on hyödyllistä kuvata yleisösi ensin itsellesi ja arvioida viestisi lopussa sen perusteella, onko se varmasti sopiva yleisöllesi.

Tehtävien määrä: Tärkeä näkökohta on se, kuinka monta tehtävää on siinä menettelyssä, jota varten olet kirjoittamassa ohjeita. Termiä menettely voidaan käyttää viittaamaan koko siihen toimintakokonaisuuteen, jota ohjeissasi käsitellään, kun taas termiä tehtävä voidaan käyttää määrittelemään menettelyn sisällä oleva puoliksi itsenäinen toimintaryhmä. Esimerkiksi modeemin asentaminen on yksi tehtävä yleisessä menettelyssä, joka koskee tietokoneen liittämistä internetiin.

Toisena esimerkkinä yksinkertainen menettely, kuten auton öljynvaihto, sisältää vain yhden tehtävän; siinä ei ole muita puoliksi itsenäisiä toimintaryhmiä. Monimutkaisempi menettely, kuten mikroaaltouunin käyttö, sisältää runsaasti puoliksi toisistaan riippumattomia tehtäviä, kuten kellon asettaminen, tehon asettaminen, ajastimen käyttäminen, mikroaaltouunin puhdistaminen ja huoltaminen ja niin edelleen.

Joissain ohjeissa on vain yksi tehtävä, mutta tuon yhden tehtävän sisällä on monia vaiheita. Kuvitellaan esimerkiksi ohjeet lasten keinun kokoamiseen. Yksi tehokas lähestymistapa olisi ryhmitellä samankaltaiset ja toisiinsa liittyvät vaiheet vaiheisiin ja numeroida vaiheet uudelleen jokaisen uuden vaiheen kohdalla. Vaihe on ryhmä samankaltaisia vaiheita yhden tehtävän sisällä. Keinulaitteen esimerkissä rungon pystyttäminen olisi yksi vaihe, sen ankkuroiminen maahan toinen vaihe ja laatikkokeinun kokoaminen vielä toinen vaihe.

Ohjeiden keskittäminen

Toinen näkökohta, jota et ehkä pysty määrittelemään varhaisessa vaiheessa, on se, miten keskität ohjeesi. Useimmissa ohjeissa voit keskittyä tehtäviin, tai voit keskittyä tarvittaviin välineisiin.

• • • • Tehtävälähtöisessä lähestymistavassa puhelinvastaajan käyttöohjeissa olisi osioita, jotka käsittelisivät tervehdyksen nauhoittamista, viestien kuuntelemista, viestien tallentamista, viestien välittämistä eteenpäin ja viestien poistamista. Nämä ovat tehtäviä – tyypillisiä asioita, joita käyttäjät haluaisivat tehdä laitteella.

• • • • Työkalut-lähestymistavassa kopiokoneen käyttöä koskevissa ohjeissa olisi puolestaan osioita kopiointinäppäimestä, peruutusnäppäimestä, suurennos/vähennys-näppäimestä, kollaatti/nidonta-näppäimestä, paperikaukalosta, kopiokoneen kopiointikoko-näppäimestä, ja niin edelleen. Jos suunnittelisit tämän suunnitelman mukaiset ohjeet, kirjoittaisit todennäköisesti vaiheet jokaisen kopiokoneen painikkeen tai ominaisuuden käyttämiseksi.

Ohjeiden sisältö

Muista lukea osio ”Asiakirjan suunnittelu” ennen ohjeiden laatimista. Sisällytä seuraavat asiat:

Esittely: Kun suunnittelet ohjeesi johdannon huolellisesti, muista:

• • • • • mainita selitettävät erityistehtävät tai -menettelyt.
        • mainita, mitä yleisö tarvitsee tietämystä ja taustatietoa ymmärtääkseen ohjeet.
        • Anna yleiskuva menettelystä ja siitä, mitä sillä saavutetaan.
        • Näytä olosuhteet, joissa näitä ohjeita tulisi (tai ei tulisi) käyttää.
        • Anna yleiskuva ohjeiden sisällöstä.

Yleisluonteiset varoitus-, varoitus-, vaara- ja vaaratiedotteet: Ohjeiden on myös varoitettava lukijoita mahdollisuudesta pilata laitteensa, mokata menettely ja/tai satuttaa itsensä. Lisäksi ohjeissa on korostettava keskeisiä kohtia tai poikkeuksia. Näissä tilanteissa kannattaa käyttää erityisiä merkintöjä, kuten huomautus, varoitus, varoitus ja/tai vaara.

Tekninen tausta tai teoria: Joidenkin ohjeiden alussa (yleensä johdannon jälkeen) voi olla tarpeen käsitellä menettelyyn liittyvää taustaa. Tietyissä ohjeissa tämä tausta on kriittinen – muuten menettelyn vaiheissa ei ole mitään järkeä. Joissakin tapauksissa ohjeiden kirjoittajat saattavat joutua käyttämään huomattavan paljon aikaa asioiden selittämiseen lukijalle, ennen kuin siirrytään prosessin varsinaisiin vaiheisiin.

Välineet ja tarvikkeet: Useimmissa ohjeissa on luettelo asioista, jotka sinun on kerättävä ennen toimenpiteen aloittamista. Tähän kuuluvat varusteet eli työkalut, joita käytät toimenpiteessä (kuten sekoituskulhot, lusikat, leipäpannut, vasarat, porat ja sahat) ja tarvikkeet eli asiat, joita toimenpiteessä kuluu (kuten puu, maali, öljy, jauhot ja naulat). Ohjeissa nämä luetellaan yleensä joko yksinkertaisena pystysuorana luettelona tai kaksisarakkeisena luettelona ohjeen alussa. Käytä kaksisarakkeista luetteloa, jos joihinkin tai kaikkiin tuotteisiin on lisättävä tarkennuksia – esimerkiksi tuotemerkit, koot, määrät, tyypit, mallinumerot ja niin edelleen.

Keskustelu vaiheista: Kun pääset varsinaiseen vaiheiden kirjoittamiseen, muista miettiä huolellisesti vaiheiden rakenne ja muoto, mahdollisesti tarvittavat lisätiedot sekä ohjeiden näkökulma ja yleinen kirjoitustyyli. Yksi teknisessä kirjoittamisessa käytetty näkökulma on toinen persoona, joka puhuttelee yleisöä sinä.

*Yleisesti ottaen ohjeiden kirjoittajien tulisi pyrkiä seuraaviin seikkoihin:

• • • • Käytä selkeää ja yksinkertaista kirjoitustapaa aina kun mahdollista.
  • • • • Osaa perinpohjainen ymmärrys prosessista sen kaikissa teknisissä yksityiskohdissa.
    • • • • Pyrkikää asettumaan sen lukijan asemaan, joka tulee käyttämään ohjeitanne.

    

    Opiskelijan ohje-esimerkkejä

    • Hitsausohje-esimerkki (opiskelijanäyte)
    • Mekatroniikan ohje-esimerkki – diodien testaus. & Transistorit (oppilasnäyte)
    • Auto/Diesel Ohjeet – Kuinka vaihtaa Toyota Corollan takajousitanko (oppilasnäyte)
    • Vuode Siirto-ohjeet (oppilasnäyte)
    • Kitaran jousien vaihtaminen (oppilasnäyte)

    Ammattilaisohjeiden näytteet

    • Hitsaaminen Ohjeet Näyte 1 (ammatillinen näyte)
    • Barbie Dreamhouse (ammatillinen näyte)
    • Trampoliinin kokoaminen (ammatillinen näyte)