Yksi yleisimmistä ja tärkeimmistä teknisen kirjoittamisen käyttökohteista on ohjeiden antaminen, eli vaiheittaiset selitykset siitä, miten jotakin kootaan, käytetään, korjataan tai huolletaan. Vaikka ohjeet saattavat vaikuttaa intuitiivisilta ja yksinkertaisilta kirjoittaa, ne ovat huonoimmin kirjoitettuja asiakirjoja. Useimmilla meistä on luultavasti ollut monia raivostuttavia kokemuksia huonosti kirjoitetuista ohjeista. Tässä luvussa kerrotaan, mitä ammattilaiset pitävät parhaana tekniikkana ohjeiden laatimisessa.
Tehokas ohjeistus edellyttää seuraavaa:
- Kirkasta, täsmällistä ja yksinkertaista kirjoittamista
- Menettelyn perusteellista ymmärtämistä kaikkine teknisine yksityiskohtineen
- Kykyä asettua lukijan asemaan, sen henkilön asemaan, joka yrittää käyttää ohjeitasi
- Kykyä visualisoida menettelytapa yksityiskohtaisesti ja vangita tämä tietoisuus paperille
- Halukkuutta testata ohjeitasi sellaisella henkilöllä, jota varten olet ne kirjoittanut.
Ohjeiden kirjoittamisprojektin alussa on tärkeää määrittää sen tietyn menettelyn rakenne tai ominaisuudet, josta aiot kirjoittaa. Seuraavassa on muutamia vaiheita, joita kannattaa noudattaa:
Tehdä huolellinen yleisö- ja tehtäväanalyysi
Määrittele jo varhaisessa vaiheessa ohjeidesi yleisö ja tilanne. Muista, että yleisön määrittely tarkoittaa sen määrittelyä, kuinka hyvin lukijasi tuntevat aiheen.
Määrittele tehtävien määrä
Miten monta tehtävää on siinä menettelyssä, josta kirjoitat? Käytetään termiä menettely viittaamaan koko siihen toimintakokonaisuuteen, jota ohjeissasi on tarkoitus käsitellä. Tehtävä on osittain itsenäinen toimintojen ryhmä menettelyn sisällä: esimerkiksi mikroaaltouunin kellon asettaminen on yksi tehtävä mikroaaltouunin käyttämistä koskevassa suuressa kokonaismenettelyssä.
Yksinkertainen menettely, kuten auton öljynvaihto, sisältää vain yhden tehtävän; siinä ei ole osittain itsenäisiä toimintojen ryhmittelyjä. Monimutkaisempi menettely, kuten mikroaaltouunin käyttäminen, sisältää useita puoliksi toisistaan riippumattomia tehtäviä: muun muassa kellon asettaminen; tehotason asettaminen; ajastimen käyttäminen; mikroaaltouunin puhdistaminen ja huoltaminen.
Joissain ohjeissa on vain yksi tehtävä, mutta siinä on monta vaihetta tuon yhden tehtävän sisällä. Kuvitellaan esimerkiksi ohjeet lasten keinun kokoamiseen. Omassa kokemuksessani vaiheita oli yli 130! Se voi olla hieman pelottavaa. Hyvä lähestymistapa on ryhmitellä samankaltaiset ja toisiinsa liittyvät vaiheet vaiheisiin ja aloittaa vaiheiden numerointi uudelleen jokaisen uuden vaiheen kohdalla. Vaihe on siis ryhmä samankaltaisia vaiheita yhden tehtävän menettelyssä. Keinulaudan esimerkissä rungon pystyttäminen olisi yksi vaihe; sen ankkuroiminen maahan olisi toinen vaihe; laatikkokeinun kokoaminen olisi vielä toinen vaihe.
3. Määritä paras lähestymistapa vaiheittaiseen keskusteluun
Useimmissa ohjeissa voit keskittyä tehtäviin, tai voit keskittyä työkaluihin (tai työkalujen ominaisuuksiin). Tehtävälähestymistavassa (jota kutsutaan myös tehtäväsuuntautuneisuudeksi) puhelinvastaajapalvelun käyttöä koskevissa ohjeissa olisi nämä osiot:
- Tervehdyksen nauhoittaminen
- Viestien toistaminen
- Viestien tallentaminen
- Viestien edelleenlähettäminen
- Viestien poistaminen ja niin edelleen
Nämä ovat tehtäviä – tyypillisiä asioita, joita haluaisimme tehdä puhelinvaihteen avulla.
Toisaalta työkalujen lähestymistavassa kopiokoneen käyttöohjeissa olisi todennäköisesti osioita siitä, miten käyttää tiettyjä ominaisuuksia:
- Kopioi-painike
- Peruuta-painike
- Suurenna/vähennä-painike
- Kokoa/niitti-painike
- Kopioi-koko-painike ja niin edelleen
Jos suunnittelisit käyttöohjeita tästä suunnitelmasta, kirjoittaisit vaiheet jokaisen painikkeen tai kopiokoneen ominaisuuden käyttöä varten. Ohjeita, joissa käytetään tätä työkalujen lähestymistapaa, on vaikea saada toimimaan. Joskus painikkeen nimi ei oikein vastaa sitä tehtävää, johon se liittyy; joskus on käytettävä useampaa kuin vain yhtä painiketta tehtävän suorittamiseksi. Silti voi olla tilanteita, joissa työkalut/ominaisuus-lähestymistapa voi olla parempi.
4. Suunnittele tehtävien ryhmittelyt
Tehtävien luetteleminen ei välttämättä ole kaikki, mitä sinun tarvitsee tehdä. Tehtäviä voi olla niin paljon, että ne on ryhmiteltävä, jotta lukijat löytävät yksittäiset tehtävät helpommin. Esimerkiksi seuraavat ovat yleisiä tehtäväryhmittelyjä ohjeissa:
- Pakkauksen purkamis- ja asennustehtävät
- Asennus- ja mukautustehtävät
- Peruskäyttötehtävät
- Rutiininomaiset huoltotehtävät
- Vianetsintätehtävät.
Yleisiä ohjeita sisältäviä osioita
Seuraavassa esitellään osioita, joita löydät yleisesti käyttöohjeistoista. Älä oleta, että jokaisen niistä on oltava kirjoittamissasi varsinaisissa ohjeissa, että niiden on oltava tässä esitetyssä järjestyksessä tai että nämä ovat ainoat mahdolliset osiot ohjeissa.
Vaihtoehtoisia muotoja löydät esimerkkiohjeista.
Esittely: Suunnittele ohjeidesi johdanto huolellisesti. Se voi sisältää jotakin seuraavista (mutta ei välttämättä tässä järjestyksessä):
- Ilmoita selitettävät erityistehtävät tai -menettely sekä laajuus (mitä käsitellään ja mitä ei)
- Ilmoita, mitä tietoja ja taustatietoja yleisö tarvitsee ymmärtääkseen ohjeet
- Anna yleiskuva menettelystä ja siitä, mitä sillä saavutetaan
- Ilmoita olosuhteet, joissa näitä ohjeita tulisi (tai ei tulisi) käyttää
- Anna yleiskatsaus ohjeiden sisältöön.
Yleiset varoitus-, varoitus-, vaaramerkinnät: Ohjeiden on usein varoitettava lukijoita mahdollisuudesta pilata laitteensa, mokata menettely ja satuttaa itsensä. Lisäksi ohjeissa on usein korostettava keskeisiä kohtia tai poikkeuksia. Näissä tilanteissa käytetään erityisiä huomautus-, varoitus-, varovaisuus- ja vaaramerkintöjä. Huomaa, miten näitä erityishuomautuksia käytetään edellä luetelluissa esimerkkiohjeissa.
Tekninen tausta tai teoria: Tietyntyyppisten ohjeiden alussa (johdannon jälkeen) saatetaan tarvita käsittelyä menettelyyn liittyvästä taustasta. Tietyissä ohjeissa tämä tausta on kriittinen – muuten menettelyn vaiheissa ei ole mitään järkeä. Sinulla on esimerkiksi ehkä jonkin verran kokemusta ohjelmistosovelluksista, joissa voit määritellä omat värisi työntämällä punaista, vihreää ja sinistä liukupalkkia ympäriinsä. Jotta todella ymmärtäisit, mitä olet tekemässä, sinulla on oltava jonkin verran taustatietoa väreistä. Vastaavasti voit kuvitella, että tietyissä kameroita käyttävissä ohjeissa saatetaan tarvita myös jonkin verran teoriaa.
Välineet ja tarvikkeet: Huomaa, että useimmissa ohjeissa on luettelo asioista, jotka sinun on hankittava 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. Käytä kaksisarakkeista luetteloa, jos joihinkin tai kaikkiin kohteisiin on lisättävä joitakin tarkennuksia – esimerkiksi tuotemerkit, koot, määrät, tyypit, mallinumerot ja niin edelleen.
Vaiheiden käsittely: Kun siirrytään varsinaiseen vaiheiden kirjoittamiseen, on syytä pitää mielessä useita asioita: (1) näiden vaiheiden rakenne ja muoto, (2) mahdollisesti tarvittavat lisätiedot ja (3) näkökulma ja yleinen kirjoitustyyli.
Rakenne ja muoto: Tavallisesti kuvittelemme ohjeiden olevan muotoiltu pystysuorina numeroituina luetteloina. Ja useimmat ovatkin sellaisia. Tavallisesti varsinaiset vaiheittaiset ohjeet muotoillaan näin. On kuitenkin olemassa joitakin variaatioita sekä joitakin muita näkökohtia:
- Kiinteässä järjestyksessä olevat vaiheet ovat vaiheita, jotka on suoritettava esitetyssä järjestyksessä. Jos esimerkiksi vaihdat autoon öljyä, öljyn tyhjennys on vaihe, jonka on tultava ennen uuden öljyn laittamista. Nämä ovat numeroituja luetteloita (yleensä pystysuoria numeroituja luetteloita).
- Vaihtuvan järjestyksen vaiheet ovat vaiheita, jotka voidaan suorittaa käytännössä missä tahansa järjestyksessä. Hyviä esimerkkejä ovat ne vianmääritysoppaat, joissa kehotetaan tarkistamaan tämä, tarkista tuo, kun yrität korjata jotain. Tällaiset vaiheet voi tehdä käytännössä missä tahansa järjestyksessä. Tämäntyyppisissä vaiheissa luettelopohjainen luettelo on sopiva muoto.
- Vaihtoehtoiset vaiheet ovat vaiheita, joissa esitetään kaksi tai useampia tapoja saman asian suorittamiseen. Vaihtoehtoisia vaiheita käytetään myös silloin, kun voi olla olemassa erilaisia ehtoja. Käytä tämän tyypin kanssa bulleted-luetteloita, joissa vaihtoehtojen väliin on lisätty OR, tai johdantokappale, joka osoittaa, että vaihtoehtoja ollaan esittämässä.
- Sisäkkäisiä vaiheita voidaan käyttää tapauksissa, joissa menettelyn yksittäiset vaiheet ovat itsessään melko monimutkaisia ja ne on jaettava alavaiheisiin. Tällöin sisennytään syvemmälle ja alivaiheet järjestetään peräkkäin muotoon a, b, c jne.
- ”Vaiheittaisia” ohjeita. voidaan käyttää silloin, kun ei todellakaan voida käyttää numeroitua pystysuoraa luetteloa tai tarjota suoraviivaista ohjeistustyylistä lukijan ohjaamista. Joidenkin tilanteiden on oltava niin yleisiä tai vaihtelevia, että vaiheita ei voida ilmoittaa.
Lisäkeskustelu: Usein ei riitä, että lukijaa vain kehotetaan tekemään näin tai näin. He tarvitsevat selittävää lisätietoa, kuten miten asian pitäisi näyttää ennen ja jälkeen askeleen; miksi heidän pitäisi välittää tämän askeleen tekemisestä; mikä mekaaninen periaate on sen takana, mitä he ovat tekemässä; vielä enemmän mikrotason selitystä askeleesta-keskustelua erityisistä toimista, jotka muodostavat askeleen.
Täydentävän keskustelun ongelma on kuitenkin se, että se voi piilottaa varsinaisen askeleen. Haluat, että varsinainen askel – erityiset toimet, jotka lukijan on tehtävä – erottuvat. Et halua, että se haudataan sanakasaan. On ainakin kaksi tekniikkaa tämän ongelman välttämiseksi: voit jakaa ohjeen ja täydennyksen erillisiin kappaleisiin tai lihavoida ohjeen.
Kirjoitustyyli
Käyttäjän tärkeimpien vaiheiden lihavointi voi olla erittäin hyödyllinen tapa viestittää selvästi, mitä lukijan on tehtävä. Usein komentoverbi on lihavoitu; joskus lihavoitu fontti korostaa käsiteltävää avainkomponenttia.
Passiivin käyttö ohjeissa voi olla ongelmallista. Jostain kumman syystä jotkut ohjeet kuulostavat tältä: ”Taukopainiketta on painettava, jotta näyttö voidaan pysäyttää tilapäisesti.”. Emme ole pelkästään huolissamme taukopainikkeen mielenterveydestä, vaan ihmettelemme myös, kenen pitäisi painaa sitä (ninjojen?). Olisi hyödyllisempää ilmoittaa, milloin lukijan on ”painettava taukopainiketta”. Mieti tätä esimerkkiä: ”Ajastinpainike asetetaan sen jälkeen kello 3:00.” Jälleen voisi kysyä: ”asetetaan kenen toimesta? Ninjat?” Henkilö, joka seuraa näitä ohjeita, saattaa ajatella, että kyseessä on vain viittaus johonkin olemassa olevaan tilaan, tai hän saattaa ihmetellä: ”Puhutaanko minulle?”. Kolmannen persoonan käyttö voi myös johtaa kiusallisuuteen: ”Käyttäjän tulisi sitten painaa Pause-painiketta.” Ohjeet tulisi tyypillisesti kirjoittaa käyttäen komentoverbin muotoja ja käyttämällä ”sinä” -asua, jotta käy täysin selväksi, mitä lukijan pitäisi tehdä.
Ilmaisevia ohjeita
Periaatteessa enemmän kuin missään muussa teknisen kirjoittamisen muodossa grafiikka on ratkaisevan tärkeää ohjeissa. Joskus sanat eivät yksinkertaisesti riitä selittämään vaihetta. Kuvitukset ovat usein ratkaisevia, jotta lukijat pystyvät hahmottamaan, mitä heidän pitäisi tehdä. Varmista, että grafiikka edustaa kuvaa lukijan näkökulmasta.
Ohjeiden muotoilu
Koska ihmiset harvoin haluavat lukea ohjeita, mutta usein heidän on pakko, muotoile ohjeesi vastentahtoisesti luettaviksi. Yritä saada lukijasi haluamaan lukea ne, tai ainakin olemaan vastustamatta ajatusta tutustua niihin. Hyvin luettava muoto antaa lukijalle, joka on selvittänyt osan ohjeista omin päin, mahdollisuuden hypätä kohtaan, jossa hän on jumissa. Käytä sitä, mitä olet oppinut otsikoista, luetteloista, visuaalisesta ilmeestä ja passiivisesta tilasta, luodaksesi tehokkaita ja helppolukuisia ohjeita:
Ohjeet: Tavallisesti haluat otsikoita kaikille mahdollisille taustaosioillesi, välineitä ja tarvikkeita koskevalle osiolle, yleisotsikon varsinaista ohjetta koskevalle osiolle ja alaotsikoita yksittäisille työtehtäville tai -vaiheille kyseisessä osiossa.
Luettelot: Ohjeissa hyödynnetään tyypillisesti laajalti luetteloita, erityisesti numeroituja pystysuuntaisia luetteloja varsinaisten vaihe vaihe vaiheelta tapahtuvien ohjeiden selityksille. Yksinkertaiset pystysuorat luettelot tai kaksisarakkeiset luettelot ovat yleensä hyviä laitteita ja tarvikkeita käsittelevässä osassa. Lauseen sisäiset luettelot ovat hyviä aina, kun annetaan yleiskatsaus tulevista asioista.
Erityishuomautukset: Lukijoita on ehkä varoitettava mahdollisuuksista, joissa he voivat vahingoittaa laitteitaan, tuhlata tarvikkeita, aiheuttaa koko toimenpiteen epäonnistumisen, vahingoittaa itseään tai muita – jopa vakavasti tai kuolettavasti. Yrityksiä on haastettu oikeuteen näiden erityishuomautusten puuttumisen, huonosti kirjoitettujen erityishuomautusten tai paikallaan olleiden erityishuomautusten vuoksi. Kohdassa Erityisilmoitukset käsitellään kattavasti näiden erityisilmoitusten asianmukaista käyttöä sekä niiden muotoa ja sijoittamista ohjeisiin.
Kun luet ja tarkistat ohjeita uudelleen, tarkista, että ne täyttävät seuraavat vaatimukset:
- Kuvaavat selkeästi täsmällisesti selitettävän menettelyn
- Antavat yleiskatsauksen sisällöstä
- Merkitsevät yleisön vaatimukset
- Käyttävät erilaisia luetteloita aina tarvittaessa; käytä erityisesti numeroituja luetteloita peräkkäisiä vaiheita varten
- Käytä otsikoita ja väliotsikoita jakamaan pää- ja alaluvut loogiseen, johdonmukaiseen järjestykseen
- Käytä tarvittaessa erityismerkintöjä
- Käytä grafiikkaa havainnollistamaan keskeisiä toimia ja kohteita
- Tarjoa tarvittaessa lisäselvityksiä vaiheista
- Luo tarvittaessa osio, jossa luetellaan välineet ja tarvikkeet.