Retorisesti tehokkaiden käyttöohjeiden luominen

Ohjekirjat

Monet ihmiset yhdistävät käyttöohjeet kodinkoneisiin, tietokonetarvikkeisiin ja kokoonpanoa vaativiin tuotteisiin (esim. huonekaluihin). Koska emme huomaa käyttävämme niitä säännöllisesti tai koska olemme tottuneet odottamaan niitä vain tietyissä yhteyksissä, on helppo unohtaa, kuinka tärkeitä ne ovat. Hyvin suunnitellun käyttöohjeen laatu saattaa jäädä huomaamatta. Kuitenkin, kun kohtaamme turhautumista kirjahyllyn tai lelun kokoamisessa tai yrittäessämme selvittää, miten muuttaa tai aktivoida jokin tietty kodinkoneen asetus, hyvin suunnitellun käyttöohjeen merkitys tulee selväksi.

Ymmärtää käyttöohjeiden retorista tilannetta

Ohjeet, kuten muutkin tekstilajit, ovat retorisen tilanteen muovaamia. Teknisten käsikirjoittajien sisällölliset ja muodolliset valinnat riippuvat käyttöohjeen tarkoituksesta, kohderyhmästä ja käyttöyhteydestä. Kun kirjoitat omaa käyttöohjetta, ota huomioon seuraavat retoriseen tilanteeseen liittyvät ajatukset ja kysymykset.

Tarkoitus

Yleisesti käyttöohjeen tarkoituksena on perehdyttää käyttäjä tuotteeseen ja/tai opastaa käyttäjää sarjassa vaiheita, jotka johtavat jonkin tehtävän suorittamiseen. Jokaisella käyttöohjeella on kuitenkin myös tarkempi lopputulos. Jos tunnistat, mikä tämä erityinen lopputulos on, voit tehdä tehokkaampia retorisia päätöksiä sisällöstä ja suunnittelusta. Kysy itseltäsi:

Mitkä ovat ohjeiden erityiset tavoitellut lopputulokset? (esim. kakun leipominen tyhjästä, ilmastointilaitteen asentaminen jne.)
Sen lisäksi, että ohjeet auttavat käyttäjiä saavuttamaan tärkeimmän toivotun lopputuloksen (tärkeimmät toivotut lopputulokset), onko olemassa muita tarkoituksia, joita ohjeet palvelevat? (esim. vianmääritysneuvojen antaminen, käyttäjien opettaminen suorittamaan ylimääräisiä, yksinkertaisia tehtäviä, jotka ovat välttämättömiä päätavoitteen saavuttamiseksi)

Käyttäjäkunta

Käyttäjäkunnan (eli asiakirjan ensisijaisen käyttäjäkunnan) profiilin luominen on olennaisen tärkeää, jotta voidaan tehdä harkittuja valintoja laajuuden, sisällön ja suunnittelun suhteen. Pohdi näitä kysymyksiä yleisöstä ennen kirjoittamista:

Minkälainen on yleisön perehtyneisyys tai asiantuntemus käyttöohjeen aiheeseen liittyen?
Minkälainen on yleisön yleinen mukavuustaso uusien taitojen oppimisessa ohjelmistoihin, sovelluksiin, resepteihin jne. liittyen?
Minkälainen on yleisösi ”tyypillinen” oppimistapa? Miten käyttöoppaasi vastaa yleisön oppimistyyliin, tavoitteisiin ja tehtäviin liittyviin tarpeisiin?

Konteksti

Ajattele kontekstia ajallisena, sosiaalisena, teknologisena ja kulttuurisena tilanteena, joka ympäröi käyttöoppaan luomista ja käyttöä. Seuraavat kysymykset auttavat sinua tunnistamaan kontekstin:

Minkä verran sinulla on aikaa tämän käyttöohjeen laatimiseen?
Onko käyttäjällä aikarajoitteita?
Mitä teknisiä rajoitteita sinun on otettava huomioon käyttöohjetta laatiessasi? Pohdi teknologiataitojasi ja käyttömahdollisuuksiesi tasoa.
Miten yleisösi pääsee käsikirjaan käsiksi? (esim. yleisö pääsee käsikirjaan verkossa yrityksen verkkosivuston kautta)
Mitä lisävälineitä tai -materiaaleja oletat yleisöllä jo olevan? Onko heillä käytettävissään tekniikkaa tai materiaaleja, joita tarvitaan ohjeiden noudattamiseen? (esim. kirjahyllyn onnistunut rakentaminen edellyttää vasaraa, ruuvimeisseliä ja avointa työtilaa)
Minkä kulttuurin näkökulmasta kirjoitat käyttöohjetta? Jakaako yleisö tämän saman kulttuurisen kontekstin? (esim. saksalainen resepti, jossa vaaditaan vaniljasokeria, ainesosaa, jota ei ole helposti saatavilla Yhdysvalloissa, on ehkä muutettava amerikkalaisia käyttäjiä varten)

Retoriikkatilanteen tuntemuksen käyttäminen tehokkaiden retoristen valintojen tekemiseen

Vaikka useimmat käyttöohjeet nojautuvat joihinkin vakiokonventioihin, kukin käyttöohje olisi räätälöitävä niin, että sillä saavutetaan tiettyä käyttötarkoitusta varten tiettyä yleisöä varten tietyssä kontekstissa. Seuraavassa osiossa esitellään joitakin käyttöohjeiden yleisiä piirteitä ja otetaan samalla huomioon retorinen tilanne ja se, miten se voi vaatia poikkeamista tietyistä konventioista.

Laajuus

Retorinen tilanne auttaa määrittelemään käyttöohjeeseen sisällytettävien yksityiskohtien määrän. Esimerkiksi työpöydän kokoamista koskevan käyttöohjeen laajuus on helppo määrittää, koska sillä on vain yksi lopputulos: työpöydän kokoaminen. Digitaalisen peilikameran (Digital Single Lens Reflex, DSLR) käyttöohje voidaan kuitenkin kirjoittaa sekä amatööreille että kokeneemmille kameran käyttäjille, ja sen on ehkä sisällettävä ohjeet perustehtävien (esim. akun ja muistikortin asentaminen) sekä edistyneempien tehtävien suorittamiseen (esim, asetusten säätäminen tiettyjä kuvausympäristöjä varten).

Sisältö

Joihinkin käyttöohjeiden vakio-osioihin kuuluvat etusivu, johdanto, vaiheiden sarja, loppupäätelmä ja takasivu, vaikka joissakin käyttöohjeissa ei välttämättä käytetä kaikkia näitä osioita tai niitä ei merkitä tällä tavalla. Esimerkiksi laajoja etu- ja takaosia on usein pidemmissä ja monimutkaisemmissa käsikirjoissa. Useimmissa ohjeissa on kuitenkin johdanto, jossa annetaan tarvittavat tiedot vaiheiden suorittamiseksi turvallisesti ja tehokkaasti. Johdanto voi sisältää selityksen siitä, kenen pitäisi suorittaa tehtävä (ehkä käyttäjällä on oltava tietty taito), tarvittavat materiaalit, mahdolliset varotoimet, jotka käyttäjän pitäisi ottaa käyttöön (turvallisuusvihjeitä tai muita varoituksia), ja joissakin tapauksissa arvion siitä, kuinka kauan prosessi kestää (yleinen piirre resepteissä). Joissakin tapauksissa on tarpeen sisällyttää selitys siitä, miksi käyttäjän tulisi noudattaa ohjeita. Esimerkiksi auton öljynvaihto-ohjeissa voidaan selittää, miksi tehtävä on välttämätön ajoneuvon moitteettoman toiminnan kannalta.

Tämän johdantomateriaalin jälkeen seuraa vaiheittaisten ohjeiden sarja. Katso seuraavasta osiosta ”Kieli”, miten laatia selkeät ja tehokkaat vaiheet. Lopuksi käyttöohjeeseen voi sisältyä ”Vianmääritysopas” tai ”Vinkkejä”-osio, joka auttaa käyttäjiä käsittelemään yleisiä ongelmia, joita he saattavat kohdata ohjeita seuratessaan tai prosessin päätyttyä.

Kieli

Yllä olevat ”Yleisöä” ja ”Kontekstiä” koskevat kysymykset voivat ohjata tehokkaiden kielellisten valintojen tekemisessä. Seuraavissa alaluvuissa on selityksiä ohjeiden yleisistä kielellisistä piirteistä sekä vinkkejä selkeään ja ytimekkääseen kirjoittamiseen tässä tyylilajissa.

Imperatiivin mieliala

Ohjeissa, kuten käskyissä, käytetään usein imperatiivin mielialaa. Jos haluat kirjoittaa tällä tavalla, puhuttele yleisöä suoraan käyttämällä aktiivista ääntämystä ja erityisiä verbejä. Mikä seuraavista tarjoaa selkeimmän ohjeen vaiheen?

”Paina punaista painiketta aloittaaksesi pelin pelaamisen”
”Kun punaista painiketta painetaan, peli alkaa”
”Käyttäjän tulee painaa painiketta”

Vaikkakin käyttäjä voisi luultavasti saada tolkkua mistä tahansa näistä lausekkeista, ensimmäinen selittää selkeimmin, mitä toimia käyttäjän tulisi suorittaa. Toisessa, passiivirakenteisessa lauseessa ei täsmennetä, kenen pitäisi painaa nappia. Kolmannessa esimerkissä viitataan epämääräiseen subjektiin, ”operaattoriin”, mikä saattaa hämmentää käyttäjää.

Sanavalinta

Ohjeita kirjoitettaessa sanavalinnan huolellinen harkinta on tärkeää, koska joissakin tapauksissa käyttäjän turvallisuus on vaarassa. Tästä syystä on pyrittävä selkeyteen ja ytimekkyyteen. Jotta voit tehdä tehokkaita päätöksiä sananvalinnasta, ota huomioon ensisijaisen yleisösi asiantuntemuksen taso ja kulttuuritausta. Saatat kokea tarpeelliseksi

määritellä monimutkaisia termejä.
kirjoittaa lyhenteet, kun ne otetaan käyttöön ensimmäistä kertaa (esim, digital single-lens reflex camera, DSLR).
välttäkää vertauksia, metaforia, slangia tai korvikkeita, jotka voivat hämmentää käyttäjiä.
käyttäkää selkokieltä, sillä joissakin tapauksissa voi aiheutua vakavia oikeudellisia seurauksia, jos ohjeistus on epäselvä. Lisätietoja selkokielestä on kohdassa http://www.plainlanguage.gov/index.cfm
sisällytä ohjeiden käännökset useille kielille.
käytä lyhyitä ja informatiivisia otsikoita ja väliotsikoita

Johdonmukaisuus ja rinnakkaisuus

Rinnakkaisrakenne eli rinnakkaisuus tarkoittaa, että käytetään samaa kielioppirakennetta informaation tai ideoiden esittämiseen. Rinnakkaisuutta käytetään usein luettavuuden parantamiseksi ja johdonmukaisuuden luomiseksi.

Tämä numeerinen ohjeluettelo sisältää vaiheen, joka rikkoo rinnakkaisrakenteen. Mikä näistä vaiheista vaikuttaa erilaiselta kuin muut?

Poista ruuvi avataksesi paristolokeron.
Asenna paristot paristolokerossa olevan kuvan mukaisesti.
Nyt voit sulkea lokeron ja ruuvata sen kiinni.

Vaihe kolme rikkoo luettelon rinnakkaisrakenteen, koska se ei ala direktiiviverbillä.

Käytetäänkö seuraavissa otsikoissa rinnakkaisrakennetta? Miksi vai miksi ei?

”Paristojen asentaminen”
”Laitteen kytkeminen pois päältä/päälle”
”Laitteen lataaminen”

Suunnittelu

Dokumentin suunnittelulla tarkoitetaan tapaa, jolla tieto järjestetään ja esitetään. Koska visuaalisen ilmeen käsittelyyn kuluu vähemmän aikaa, käyttäjät huomaavat yleensä suunnittelun laadun ennen sisällön laatua ja reagoivat siihen. Vaikka et käyttäisikään kuvia tai grafiikkaa, sinun on otettava huomioon suunnittelu. Vähimmillään tämä tarkoittaa, että on tehtävä valintoja ulkoasun, tietojen järjestyksen, fonttikoon, kirjasintyypin, otsikoiden, värien ja valkoisen tilan suhteen. Suunnitteluelementtien tulisi ohjata käyttäjää sujuvasti käsikirjan läpi. Tämä tarkoittaa, että asiakirjasta on tehtävä skannauskelpoinen; skannauskelpoisen asiakirjan avulla käyttäjät voivat navigoida sisällön läpi löytääkseen tietyn tiedon. Kuten minkä tahansa asiakirjan kohdalla, suunnittelua koskevissa päätöksissä on otettava huomioon kohderyhmä, tarkoitus ja yleinen helppokäyttöisyys.

Johdonmukaisuus/toistuvuus

Suunnitteluelementin käyttäminen yhdenmukaisella tavalla koko asiakirjassa opastaa käyttäjiä antamalla heille käsityksen siitä, mitä he voivat odottaa (esim. sama kirjasintyyppi ja -koko kaikissa otsikoissa; sama ulkoasu sivusta toiseen).

Kontrasti

Suunnitteluelementin käyttäminen käyttöoppaan tiettyjen tietojen tai ominaisuuksien korostamiseksi (esim. sanan suuraakkoset korostamiseksi; laatikon tai kehyksen asettaminen kohteen ympärille; värien vaihtaminen korostamiseksi). Kontrasti on ensisijaisesti tehokas, kun asiakirjassa käytetään yleisesti johdonmukaisuutta. Jos johdonmukaisuus puuttuu, kontrastin luominen on vaikeampaa.

Kohdistus

Sivun kohtien järjestäminen vaaka- ja/tai pystysuuntaisella kohdistuksella luo hierarkiaa ja rakennetta, ja sitä voidaan käyttää tasapainon, kontrastin tai johdonmukaisuuden saavuttamiseen. Esimerkiksi tässä asiakirjassa käytetään pystysuuntaista tasausta hierarkian luomiseksi suunnitteluelementin nimen, joka on vasemmalle tasattu, ja sen kuvauksen, joka on sisennetty, välille.

Tasapaino

Esineiden jakaminen tasaisesti tietylle tilalle. Tämän saavuttamiseksi on otettava huomioon kunkin elementin painoarvo eli silmän taipumus painautua elementtiä kohti. Koska esimerkiksi kuva painaa enemmän kuin teksti, kuvan sijoittelua koskevissa päätöksissä olisi harkittava, miten sen painoarvo tasapainotetaan suhteessa muihin kohtiin visuaalisen sekaannuksen välttämiseksi.

Valkoinen tila

Valkoisen tilan käyttäminen ammattimaisen, tasapainoisen asiakirjan luomiseksi. Tämä suunnitteluelementti viittaa kuvien ja tekstin puuttumiseen sen sijaan, että se ilmoittaisi tilan värin. Valkoinen tila auttaa erottamaan yksittäiset kohteet ja kohderyhmät (esim. käsikirjan osiot) toisistaan ja helpottaa asiakirjojen skannaamista.

Ryhmittely/läheisyys

Seuraavien kuvien tai sisällön sijoittaminen lähelle toisiaan. Esimerkiksi kaikkien tietyn tehtävän suorittamiseen tarvittavien materiaalien kuvien ryhmittely yhteen.

Värit

Värien valitseminen kontrastin ja korostuksen luomiseksi, lukijan ohjaamiseksi tilan läpi ja visuaalisesti miellyttävän asiakirjan suunnittelemiseksi. Sinun tulisi tarkastella asiakirjan kokonaisuutta, jotta voit luoda johdonmukaisen värimaailman. Jos esimerkiksi haluat käyttää asiakirjassa sinistä väriä, sinun on varmistettava, että sitä käytetään johdonmukaisesti ja että se täydentää asiakirjan muita värejä. Tämä on erityisen tärkeää integroitaessa värigrafiikkaa ja/tai kuvia.

Kuvat

Värikuvien valitseminen kyseiseen asiayhteyteen ja käsikirjan tarkoitukseen sopiviksi. Kannattaa harkita, onko kuvien tarkoitus olla itsenäisiä vai täydentää kirjallisia ohjeita. Harkitse kuvatyyppejä, kuten piirroksia, valokuvia ja graafisia kuvituksia, sekä sitä, tarvitaanko lisäkutsuja tai -merkintöjä kuvan tiettyjen osien korostamiseksi. Kuvat olisi valittava siten, että ne täydentävät käyttöohjeen muita suunnitteluelementtejä.

Johtopäätös

Hyvä käyttöohje alkaa retorisen tilanteen – tarkoituksen, yleisön ja kontekstin – huolellisella harkinnalla. Nämä tiedot ovat avainasemassa, kun tehdään sekä asianmukaisia että tehokkaita valintoja sisällön, kielen ja ulkoasun suhteen. Ihanteellisessa aikajänteessä teknisillä kirjoittajilla on mahdollisuus tehdä käytettävyystestejä, joiden tarkoituksena on arvioida, kuinka hyvin asiakirja täyttää tarkoituksensa. Kun käyttöoppaasi on testattu, otat saadun palautteen huomioon viimeistellessäsi sen suunnittelun ja sisällön.

Harjoitus 1 – Tutustu käyttöoppaisiin

Seuraavalla verkkosivustolla on useita esimerkkejä avoimen lähdekoodin käyttöoppaista. Seuraa tätä linkkiä, selaa luetteloa ja valitse yksi ohjekirja, johon tutustut perusteellisesti. Selaa ohjekirjaa tutustuaksesi sen sisältöön ja ulkoasuun. Käsittele sen jälkeen ohjaajalle tai luokkatovereillesi osoitetussa muistiossa seuraavia asioita.

Tunnista retorinen tilanne

Kuka on yleisö? Mistä tiedät, kuka on yleisö? Mitä voit olettaa yleisöstä käsikirjan sisältö- ja muotoiluvalintojen perusteella?
Mikä on asiakirjan tarkoitus? Mistä tiedät, että tämä on ensisijainen tarkoitus (eli mitkä sisältö- ja suunnitteluvalinnat viestivät tarkoituksesta)?
Missä asiayhteydessä käsikirjan kirjallinen sisältö ja suunnittelu on tehty?

Tutki koostamisvalintoja

Kuvaile käsikirjan kokonaislaajuutta ja organisaatiota. Kuinka yksityiskohtainen käsikirja on? Mitä se kattaa? Miten tiedot on järjestetty?
Käsitelläänkö käsikirjassa kaikki sisällön ”vakio-ominaisuudet”? Miksi vai miksi ei? Onko lisäominaisuuksia? Mitä ne ovat ja mikä on niiden tarkoitus tai tarkoitukset?
Löydä ja kuvaile esimerkkejä tehokkaista kielivalinnoista. Selitä, miksi pidät niitä tehokkaina.
Löydä ja kuvaile esimerkkejä tehokkaasta suunnittelusta. Selitä, miksi pidät niitä tehokkaina.
Jos olisit tämän käyttöohjeen laatija, mitä olisit tehnyt toisin ja miksi?

Harjoitus 2 – Käyttöohjeen suunnittelu

Kuvittele, että olet laatimassa käyttöohjetta tuntemallesi prosessille tai tuotteelle, ja vastaa seuraaviin kehotuksiin.