Oppijan verkkopalvelun käyttöohjeiden laatiminen 14.2.2013 elina.melkko@etnoteam.fi
Sisältö! Yleistä käyttöohjeiden laatimisesta Hyvä käyttöohje Käyttöohjeen kieli! Virkailijan käyttöliittymän ohjeiden laatiminen Virkailijan käyttöliittymän ohjeet Ohjeikkuna Mistä liikkeelle?! Muuta Muita tarvittavia ohjeita Ohjeiden ylläpidossa huomioitavaa
Yleistä käyttöohjeiden laatimisesta
Hyvä käyttöohje 1/2! Hyvän ohjeen lähtökohta on tarve käyttöohjeelle: miksi, mihin, miten, missä olosuhteissa ja kuka käyttää! Mitä tietoa käyttäjät tarvitsevat vs. mitä tietoa käyttäjillä jo on! Mikä tieto on syytä kertoa nyt vs. mihin voidaan viitata! Mitä käsitteitä käyttäjät ymmärtävät parhaiten! Mitä tulee pystyä tekemään, mitkä vaiheet tehtävään liittyvät lähde: www.cs.tut.fi/~projekti/dokumentit/sunnumv_kayttoohje2005.pdf
Hyvä käyttöohje 2/2! Ohjeessa on sisällysluettelo tai hakemisto! Käyttöohjeen eri osat toimivat itsenäisesti, koska niitä usein luetaan yksi kerrallaan! Rakenne hyvin jäsennelty; otsikot ja väliotsikot numeroitu ja hyvin nimetty! Sisältö on ajantasainen, paikkansapitävä, riittävä! Esitystapa! Luettava; käyttäjän kannalta ymmärrettävä! Avainsanat, esim. käyttöliittymän käsitteet, korostettu! Sisältää havainnollisia kuvia ja/tai esimerkkejä
Käyttöohjeen kieli 1/2! Käytä luonnollista kieltä! Muista oppilaitoksen virkailijan näkökulma! Käytä käyttöliittymässä käytettyjä termejä synonyymien sijaan! Vältä toteutusprojektiin vakiintuneita termejä! Puhuttele lukijaa! Käytä suoria käskymuotoja, verbit aktiivimuodossa! Käytä lyhyitä lauseita! Ole myönteinen, älä kiellä
Käyttöohjeen kieli 2/2! Laadi ohjeet rakenteella Tavoite - toiminta - palaute! Käytä johdonmukaisesti samoja termejä ja puhuttelumuotoja! Vältä epämääräisiä tai moniselitteisiä ilmaisuja! Kerro käyttäjälle palvelun antamista palautteista! Välitä käyttäjälle positiivinen malli palvelun käytöstä
Virkailijan käyttöliittymän ohjeiden laatiminen
Virkailijan käyttöliittymän ohjeet 1/2! Kenttäkohtaiset ohjeet! Otsikkoa selventävä teksti, jonka avulla virkailija pystyy suoriutumaan tehtävistä! Ensisijaisesti kentän otsikon tulee olla hyvin valittu! Varsinainen käyttöohje! Avautuu erilliseen ikkunaan käyttöliittymän -merkistä! Avautuu siitä kohtaa, missä virkailija on menossa, mutta mahdollistaa ohjeiden selailun/navigoinnin laajemmin
Virkailijan käyttöliittymän ohjeet 2/2! Ilmoitustekstit Ruudulle tuleva palaute ongelmista, virheestä tai onnistuneesta toiminnosta
Varsinaisen ohjeen toteutus: Ohjeikkuna! Sisällysluettelo! Hakutoiminto! Tulostaminen! Navigointi kappale kerrallaan
Miten liikkeelle? 1/2! Aloita tunnistamalla palveluun liittyvät virkailijan tehtävät ja luo niistä sisällysluettelo.! Tarkista, miten sisällysluettelo suhtautuu käyttöliittymään ja suunnittele mitkä tekstit avautuvat mistäkin. Kiinnitä huomiota siihen, että luo uusi ja muokkaa näkymät ovat sama näkymä eli ohje avautuu samasta paikkaa.! Aloita kuvaamaan ohjetekstiä virkailijan tehtävien mukaisesti; miten virkailijan tavoitteet saadaan toteutettua. Kirjaa ylös kaikki ne seikat, jotka mielestäsi ohjeessa tulee sanoa ja tarkenna rakennetta tarvittaessa.
Miten liikkeelle? 2/2! Vältä saman asian kuvaamista moneen kertaan mieluummin viittaa toiseen kappaleeseen.! Esimerkiksi käsitteet kuvataan sanastossa! Palvelua kehitetään koko ajan. Kuvaa siis mieluiten tavoitetilaa, jottei sinun tarvitse päivittää ohjeita montaa kertaa.! Mieti mihin haluat ruutukaappauksia ja merkitse paikat muistiin. Kannattaa kuitenkin ottaa kuvat vasta sitten kun palvelu on valmiimpi.! Kun kappaleen teksti on koossa, mieti mitä siitä on tärkeää kertoa käyttöliittymässä. Yritä tiivistää sanoma lyhyeksi ja mieti teksteille paikat.
Muuta
Komponenttien ja kuvakkeiden nimiä! Ohjekuvake (information icon)! otsikkoteksti (label)! tekstikenttä (text field)! painike (button)! valintaruutu (check box)! radiopainike (radio button)! valintalista (combo box)! kalenterikuvake (calendar icon)! valikkokuvake (menu icon)! avautuva hierarkia (collapsible hierarchy)
Erilaisia ohjeita Muita tarvittavia ohjeita 1/2! Yleisohjeet Opintopolun toiminta erillisinä palveluina Käyttöoikeuksien muodostuminen! Prosessiohjeet Kuvaavat prosessin vaiheet, roolit ja vastuut Prosessikuvat Mikä muuttuu verrattuna vanhaan
Muita tarvittavia ohjeita 2/2! Sanasto-osa Sanastotyöryhmän sanasto luettavissa Uusia palveluun liittyviä käsitteitä ei tarvitse kuvata joka paikassa erikseen, vaan voidaan viitata tarvittavissa paikoissa yhteen sanastoon
Ohjeiden ylläpidossa huomioitavaa! Varsinaisen käyttöohjeen, kenttäkohtaisten ohjeiden sekä ilmoitustekstien ylläpito! Edellä mainittujen ohjeiden ylläpito kaikilla käyttöliittymäkielillä! Ohjeiden ylläpito toteutetaan hankkeen myöhemmissä vaiheissa.