Metaopas: oppaiden tekemisen opas

Tämä on keskeneräinen. Linkitkään eivät toimi kuin sattumalta.

Tämä metaopas käsittelee neljäntasoisten ohjeiden tai oppaiden laatimista. Tätä kirjoitettaessa on ajateltu ennen muuta tietokoneisiin liittyviä ohjeita, esimerkiksi ohjelman käyttöohjetta tai ohjelmointikielen käsikirjaa. Osuudet on tarkoitettu luettaviksi järjestyksessä. Pitää osata antaa yksinkertainen neuvo, ennen kuin yrittää jotain vaativampaa; sitä paitsi laaja ohjeisto sisältää suuren joukon pieniä ohjeita. Ja aluksi pitää oppia, että emme osaa antaa yksinkertaisia neuvoja vaan sekin asia on opeteltava.

Yksinkertaisen neuvon antaminen

Tässä on kyse yhden asian tekemisestä, vaikkapa tiedoston avaamisesta jollakin ohjelmalla tai tekstin siirtämisestä Windows-sovelluksesta toiseen leikepöydän kautta. Usein asia on pettävän yksinkertainen, kun sen osaa: se, joka osaa, ei tule ajatelleeksi, miten helppoa on olla ymmärtämättä selitystä tai ymmärtää se väärin. Pituus on ehkä tyypillisesti yksi tekstikappale ja siihen ehkä liittyvä kuva.

Lyhyen ohjeen tekeminen [pahasti kesken]

Tässä on kyse suhteellisen rajatusta asiakokonaisuudesta, esimerkiksi jonkin ohjelman muutamasta peruskäyttötoiminnosta yksinkertaisinta käyttöä varten tai ohjelman asentamisesta. Tyypillisesti tällainen ohje koostuu ehkä 5 - 10 yksinkertaisesta neuvosta, jotka voivat toisistaan suhteellisen riippumattomia tai peräkkäin toteutettavia. Pituus on yleensä yhden A4-sivun luokkaa.

Käyttöoppaan tekeminen [tekemättä]

Tässä laaditaan jo suhteellisen monipuolinen ohjeisto, mutta ei välttämättä kaikkia toimintoja kattavaa. Käyttöopas pyrkii antamaan esimerkiksi ohjelman normaaliin käyttöön tarvittavat valmiudet. Tyypillinen pituus on parikymmentä sivua, mutta se voi olla paljon lyhyempikin, jos ohjelma on yksinkertainen.

Käsikirjan tekeminen [tekemättä]

Käsikirja (manuaali) on yksityiskohtainen ja kattava kuvaus, joka on järjestetty jonkin sisäisen systematiikan mukaan, ei oppikirjamaista lukemista varten. Sitä ei ole tarkoitus lukea kannesta kanteen, vaan sieltä haetaan tietoja tarvittaessa. Laajuus vaihtelee suuresti kuvattavan asian mukaan; se voi olla satoja sivuja tai jopa useita niteitä.

Tähän oppaaseen liittyy myös jälkipuhe - esipuheen hypertekstivastine, joka selittää, miksi tästa tuli sellainen kuin tuli, ja kertoo muutakin, mitä kirjoittajan teki mieli sanoa mutta joka ei kuulu varsinaiseen sisältöön.


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

Jukka Korpela, jkorpela@malibutelecom.com