Metaopas, 2. osa:
Lyhyen ohjeen tekeminen

Tämä on keskeneräinen. Lähinnä jäsentämättömiä ideoita. Linkitkään eivät toimi kuin sattumalta.

Lyhyen ohjeen mallitapauksena voisi pitää meiliohjelman ("sähköpostiohjelman") peruskäyttöoppaan tekemistä. Kyse on suhteellisen yksinkertaisesta ohjelmasta, jossa on muutama perustoiminto, kuten meilin lukeminen ja meilin lähettäminen, ja joukko lisätoimintoja, esimerkiksi meilien tulostaminen paperille, arkistointi ja osoitekirjan tekeminen.

Lyhyen ohjeen tarkoitus on kuvata perustoiminnot ja kertoa lyhyesti, minkätyyppisiä lisätoimintoja on olemassa ja missä niistä kerrotaan. Se, mitkä luokitellaan perustoiminnoiksi, riippuu paitsi ohjelmasta myös sen aiotusta käyttötarkoituksesta. Jossakin käyttöympäristössä esim. paperille tulostus voi olla aivan välttämätön perustoiminto. Perustoimintoja rajattaessa on syytä olla pidättyväinen. On tärkeää, että käyttäjä tuntee hallitsevansa ne toiminnot, joita hän tarvitsee päivittäin tai jotka muuten ovat hänelle olennaisimpia.

Ellei ohjetta tehdä erityisen "tasalaatuiselle" lukijakunnalle, siitä pitäisi pyrkiä tekemään ainakin kaksi muunnelmaa, lyhyt ja pitkä. Lyhyt on tarkoitettu sellaiselle, joka suunnilleen jo tietää, mistä on kyse, tai jolla on kokemusta samantapaisista asioista tai joka muuten on nopea oppimaan. Pitkä on selittävämpi, oppikirjamaisempi ja kuvitetumpi. Lyhyestä on viittauksia pitkään myös eri kohdista eikä vain yleisesti; tämä mahdollistaa sen, että lukija ikäänkuin tekee itselleen välimuotoisen oppaan: käyttää runkona lyhyttä, mutta lukee lisäksi osia pitkästä silloin, kun on tarvis. Hyperteksti on periaatteessa ihanteellinen väline tällaisen toteuttamiseen.

Teknisin keinoin, esimerkiksi ns. esiprosessointitekniikoilla, voidaan kenties huolehtia siitä, että oppaasta on vain yksi peruskappale ("master copy"), ja ohjelmalla generoidaan siitä lyhyt ja pitkä versio. Alkeellisimmillaan on kyse vain ehdollisuudesta: peruskappaleen osista jotkin on merkattu sellaisiksi, että ne tulevat mukaan vain lyhyeen versioon. Tekniikkaa ei kuitenkaan pidä päästää isännäksi, eikä lopputulosta pidä tuottaa sen mukaan, mikä on helpointa tuottaa. Yleisesti ei pelkkä lyhentäminen toimi kovinkaan hyvin.

Oppaassa on syytä olla lyhyt johdantokappale, joka sanoo, mistä on kyse, ja viittaa yleisesitteeseen, joka laajemmin ja ehkä mainoshenkisemmin kertoo ohjelman tarkoituksesta ja soveltuvuudesta eri tehtäviin. Oppaan ei pitäisi toistaa sellaisia asioita eikä yrittää olla esitteen korvike. Ohjeen ei pidä enää yrittää vakuuttaa käyttäjää siitä, miten hieno ohjelma on kyseessä. Hyvä yleissääntö on, että ohjeessa ei pitäisi olla adjektiiveja, ainakaan ellei niillä ole sellaista objektiivista merkitystä, että kilpailevan tuotteen tekijäkin myöntäisi ne oikeiksi. Laatuarvostelu jääköön käyttäjän tehtäväksi.

Asennusohje on syytä kirjoittaa erikseen, jos se tarvitaan. Käyttöohjeen alussa vain viitataan siihen; esimerkiksi meilioppaassa on syytä painokkaasti kehottaa käyttäjää panemaan asetukset kuntoon, ennen kuin tekee mitään muuta. Mutta itse ne asetukset kuuluvat muualla selostettaviksi. On häiritsevää, jos oppaan alussa on juttu, joka tarvitsee tehdä yhden kerran ja jonka voi sitten unohtaa. Sen sijaan asennuksen yhteydessä tehtäviä asetuksia (konfigurointeja) voi joskus olla tarpeen käsitellä käyttöohjeessakin, jos niiden muuttelu tilanteen mukaan kuuluu ohjelman normaaliin käyttöön.

Oppaan alkuun kannattaa pyrkiä sisällyttämään tiivistelmä, joka toimii samalla sisällysluettelona. Esimerkiksi meiliohjelman käyttöohjeen alussa voisi olla sellaisia kohtia kuin "Meilin lähettäminen: m", jolloin siis jo sisällysluettelossa ja otsikossa kerrotaan, mitä käskyä käytetään, jolloin asia jää mieleen paremmin ja on helpompi tarkistaa. Tämä on jossain mielessä ihanne, jota ei toki aina voida saavuttaa. Usein joudutaan tyytymään siihen, että tiivistelmä on erillinen "referenssikortti" (reference card). Sen kohdista on syytä tehdä hyperteksti- tai muut viittaukset varsinaisen ohjeen vastaaviin kohtiin.

Ohjelman käyttöohjeessa pitäisi ensimmäiseksi kertoa ohjelman käynnistys, lopetus ja help-toiminto. On tärkeää sekä teknisistä että psyykkisistä syistä, että käyttäjä saa heti alussa tiedon siitä, miten ohjelmasta pääsee ulos ja miten siinä voi saada apua eri tilanteissa. Help-toimintoa kannattaa lyhyesti luonnehtia (esim. olematon, suppea, vain kokeneelle käyttäjälle hyödyllinen); samalla on syytä mainita, onko se niin sanotusti kontekstiriippuvainen eli johtaako esimerkiksi kysymysmerkin käyttö tai help-näppäimen painaminen aina samaan avustustoiminnon tilaan vai onko tila kulloisenkin käyttötilanteen mukainen.

Perusasioiden tekeminen ohjelmalla voidaan yleensä jakaa teemoihin ja mahdollisesti alakohtiin. Kannattaa aloittaa yksinkertaisimmista asioista, esimerkiksi tekstinkäsittelyohjelman osalta ihan siitä, miten kirjoitetaan tekstiä ilman mitään muotoiluja ja korjataan mahdollisia virheitä, sitten tallennetaan tulos. Meiliohjelman osalta keskeimpiä perustoimintoja ovat meilin lukeminen ja lähettäminen, mutta niitä yhdistävänä tekijänä on mahdollisuus vastata meiliin, kun se on luettu.

Kunkin teeman käsittelyn sopiva perusrakenne on:

  1. otsikko, mielellään sellainen, joka samalla sanoo asian lyhyesti (siis esim.: tiedoston tallennus: Save)
  2. otsikon alla ensin lyhyt tarkempi selitys, joka toimii samalla pikaohjeena, kun tähän kohtaan myöhemmin palataan; usein tämä koostuu joukosta peräkkäin suoritettavia yksinkertaisia toimenpiteitä (sellaisia, joiden esittämistä käsitteli tämän Metaoppaan 1. osa)
  3. tarvittaessa lisäselityksiä, jotka esittävät vaihtoehtoisia tapoja (esim. pikavalintoja) tai teeman muunnelmia (esim.: tiedoston tallennus eri nimellä kuin aiemmin: Save As) tai vain sanallista lisäselostusta niitä varten, joille lyhyt selitys ei riittänyt
  4. kuva tai muu havainnollistus
  5. mahdollinen viittaus tarkempaan kuvaukseen oppaan laajemmassa versiossa tai käsikirjassa.

Ns. filosofiaa eli ohjelman yleisiä toimintaperiaatteita, ajatusmalleja ja käsitteitä pitäisi perusoppaassa käsitellä vain sen verran kuin on todella välttämätöntä. Tämä on yleensä huomattavan paljon vähemmän kuin ohjelmaan syvällisesti perehtynyt ihminen ajattelee.

Loppuun kuuluu luettelomainen esitys siitä, mitä muuta ohjelmalla voi tehdä, pääkohdittain. Mielellän tärkeysjärjestyksessä, ehkä luokiteltuina sopiviksi "paketeiksi" niin, että lukijalle ehdotetaan joukkoa seuraavaksi tärkeimpiä toimintoja opiskeltaviksi. Isoissa ohjelmissa on niiden toimintojen moninaisuus usein suuri ongelma. Luonnollisestikin ehdotettavat "paketit" voivat olla erilaisia eri käyttäjäryhmille. Esimerkiksi tekstinkäsittelyohjelman käyttäjä tarvitsee perustietojen jälkeen varsin erilaisia asioita sen mukaan, kirjoittaako hän esimerkiksi liikekirjeitä, romaaneja vai matemaattisia tutkielmia.


Viimeisimmän päivityksen ajankohta: 2000-12-22

Jukka Korpela