Tämä Metaoppaan ensimmäinen osa käsittelee näennäisesti naurettavan alkeellista asiaa: miten annan yksinkertaisen neuvon jonkin asian teknisestä tekemisestä esimerkiksi jossakin tietokoneohjelmassa, ohjelmoinnissa, laitteen käytössä tms. Todellisuudessa sellainen on tavattoman monimutkainen ja haastava tehtävä, vaikka itse asiasisältö olisi miten yksinkertainen. - Pääpaino tässä on neuvon antamisella kirjoitetussa muodossa.
Jos sanoma voidaan tulkita eri tavoin, niin se tulkitaan tavalla, josta on eniten vahinkoa.
Mieti ensin. Ryhdy kirjoittamaan itse ohjetta vasta sitten, kun tarvittava sisältö on hahmottunut.
Kuka, mitä, missä, minkä ja kenen avulla, miksi, miten, milloin? Vastaa mielessäsi (tai omalla muistilapullasi) näihin kysymyksiin. Muotoile sitten ohje; sen ei tarvitse jäsennykseltään olla tuon muistisäännön mukainen.
Edellä sovelletusta vanhasta ohjeesta on myös heksametrimittainen suomennos, joka ehkä jää paremmin mieleen: "Ken, mitä, miss', mitä keinoja käyttäin, miks', miten, milloin?"
Mene suoraan asiaan, mutta kerro, mikä asia on kyseessä, eli vastaa jollakin tavalla edellä oleviin kysymyksiin. Esitä siis lyhyesti, mihin ohje liittyy ja mihin tilanteeseen se on tarkoitettu, mutta älä lavertele; viittaa juttuihin, joissa kerrotaan aiheesta syvällisemmin, selittelevämmin tai teknisemmin.
Kirjoita alkuun tiivistelmä. Asiantuntevalle lukijalle se ehkä riittääkin; hän tarvitsee vain vinkin. Mutta tärkeämpää on, että palatessaan ohjeeseen tavallinenkin lukija heti näkee, miten homma taas menikään.
Esitä asiat järjestyksessä. Jos jotkin asiat pitää tehdä järjestyksessä, esitä ne siinä jäjestyksessä. Tee selväksi, milloin on kyse tästä ja milloin vaihtoehdoista, ja tee selväksi, millä perustein vaihtoehdoista voi valita.
Käytä lyhyitä ja yksinkertaisia lauseita. Käytä yleisesti ymmärrettyjä sanoja. Mainitse tarvittaessa synonyymeja, esimerkiksi englanninkielinen termi, koska se voi olla monelle tutumpi.
Yritä kuvittaa ohje. Pelkästään se, että mukana on kuva tilanteesta, jossa toimenpide tehdään (esim. ikkunasta, jossa jokin valinta tehdään), on havainnollistavaa. Lisäksi se antaa lukijalle varmistuksen siitä, että hän on toimimassa oikein. Toisaalta tämän takia pitää kertoa mahdollisesti muuntelusta, esim. "käyttöliittymä voi näyttää erilaiselta kuin kuvassa, koska valikot voivat olla esim. suomeksi eikä englanniksi".
Kerro palautteesta, jota käyttäjä saa ohjelmalta tms. Ihminen kaipaa varmistusta siitä, että hän on toiminut oikein, ja ehkä ennalta tietoa siitä, mitä tapahtuu, jos jotain menee pieleen. Jos esimerkiksi neuvot antamaan jonkin komennon, kerro, mitä pitäisi tapahtua, kun se on annettu. Sekin, ettei mitään tapahdu, on hyödyllinen tieto.
Tarkista, toimiiko ohjeesi. Tarkista tarpeeksi monessa eri tilanteessa. Mikäli mahdollista, pyydä jotakuta lukemaan ohjeesi ja toimimaan sen mukaan.
Esimerkiksi olen valinnut JavaScriptin enabloinnin ja disabloinnin Operan versiossa 5. On tavallaan eduksi, jos et ollenkaan tiedä, mistä on kyse. Yksi hyvän ohjeen ominaisuus nimittäin on, että se ei häiritse niitä, joita se ei koske: lukija näkee siitä helposti, onko se hänelle tarkoitettu.
Käytännön syynä valintaan on se, että tämäkin asia muuttui versiosta 4 versioon 5 siirryttäessä, ja tarvittava menettely on melko hankalasti löydettävissä. Se on myös helppo unohtaa. Toisaalta se on helppo tarkistaa ohjeesta, kunhan ohje on olemassa ja siinä on tiivistelmä alussa!
Vastaamme ensin mielessämme seitsemään peruskysymykseen:
Opera-selaimen versiossa 5
voi JavaScript-koodien suorittamisen kieltää (disabloida)
tai sallia (enabloida) seuraavasti:
File > Preferences... > Plugins > JavaScript > Enable JavaScript
Tämä tarkoittaa seuraavaa:
Yleensä on syytä heti Opera 5:n ensimmäisellä käyttökerralla kieltää (disabloida) JavaScript-koodien suoritus niihin liittyvien turvariskien takia. Tällainen asetus jää voimaan, kunnes se muutetaan, eikä sitä tarvitse tehdä myöhemmillä käyttökerroilla uudestaan. Jos myöhemmin jossakin erityisessä käytössä on tarpeellista tai hyödyllistä sallia se (hyvin tehty Web-sivu kyllä ilmoittaa tämän tavalla tai toisella), voit tehdä niin edellä kuvatulla tavalla ja sitten kyseisen käytön jälkeen taas kieltää sen. Huomaa, että kieltäminen sujuu yleensä helposti, koska Preferences-ikkuna aukeaa valmiiksi "oikeasta kohdasta" eli siitä kohdasta, missä viimeksi oli tehty muutoksia.
Selityksiä ja tarkennuksia:
Tämä ohje koskee Opera 5:n englanninkielistä versiota.
Opera 5:n File-kohdan Edit-alivalikko on oheisen kuvan kaltainen; yksityiskohdissa voi olla eroja. Kuten kuvasta näkyy, Preferences-ikkunaan pääsee myös suoraan Alt+P:llä (painetaan välilyöntinäppäimen vasemmalla puolen oleva Alt-näppäin alas ja sitä alhaalla pitäen näpäytetään P-näppäintä).
Preferences-ikkunassa ei valintoja voi tehdä pikanäppäimillä, mutta nuolinäppäimellä voi liikkua valikossa ylös ja alas, jolloin valikosta oikealla oleva näkymä muuttuu. Kun ollaan Plugins-kohdassa, voi näppäilyllä Alt+E sallia JavaScript-koodien suorittamisen, jos se oli kiellettynä, ja kääntäen.
Se, että ohjeessa on selitetty graafisen käyttöliittymän lisäksi myös vastaavat näppäimistökomennot, ei ole ainoastaan sitä varten, että kokeneet käyttäjät tietäisivät, miten tehdään pikavalintoja. Hehän luultavasti itsekin huomaisivat ne, koska graafinen käyttöliittymä viittaa niihin. Näppäimistökomennot voivat olla olennaisia sen kannalta, voiko käyttäjä lainkaan tehdä sitä, mistä on kyse. Ongelmana voi olla esimerkiksi näkövamma, motoriikan häiriö - tai se, että hiiri on rikki. Vrt. Web Content Accessibility Guidelines, kohta Design for device-independence. Yleisemmin sanottuna tämä on esimerkki siitä, että ohjeen tekijän ei pidä olettaa, että jokaisella lukijalla on samanlaiset toimintamahdollisuudet kuin hänellä itsellään.
Pitäisikö ohjeeseen ehkä vielä lisätä kuva Preferences-ikkunasta? Kenties. Mutta kuvat vievät tilaa, ja tässä tapauksessa kuva olisi melkoisen iso, vaikka ikkunasta leikkaisi osan poiskin. Kuvituksessa tarvitaan siis harkintaa ja kompromisseja tilankäytön ja havainnollisuuden välillä.
Toisaalta onko ohje jo tällaisena aivan liian pitkä? Kenties. Viestinnän luonteesta johtuu, että mitään ihannelaajuutta ohjeelle ei ole olemassa. Kokeneelle käyttäjälle hyvin lyhyt ohje on paras, hyvin kokematon taas tarvitsisi hyvinkin yksityiskohtaisen ja selittävän ohjeen.
Käytännön mahdollisuuksista ja asian tärkeydestä sitten riippuu, montako versiota tehdään. Jos jostakin yksinkertaisesta asiasta kysytään esimerkiksi jostakin neuvontapisteestä monta kertaa päivässä ja kysyjät ovat taustaltaan erilaisia, kannattaa ehkä työn ja vaivan säästämiseksi tehdä vähän työtä ja nähdä vaivaa vaikka kolmenkin erilaajuisen ohjeen tekemiseen.
Esimerkiksi jos meilitse ("sähköpostitse") vastaa kysymykseen, miten
esimerkissämme käsitelty asia tehdään, niin hyvä menettely voisi olla
kirjoittaa viestiin ohjeemme alussa oleva pikaohje
File > Preferences... > Plugins > JavaScript > Enable JavaScript
ja liittää sen perään maininta, että tarkemmin asia selitetään
Web-osoitteessa se-ja-se.