Extranetin ohjesivu

Käytä extranetin ohjesivun sisältömallia kaikkiin extranetin ohjeisiin. Ennen kuin luot uuden ohjesivun, tarkista voiko sisällön liittää toiseen ohjeeseen. 

Ohjeen kirjoittajille

Extranetin ohjeet kirjoitetaan usein ensin viralliseen muotoon word-pohjalla. Sisältömalliohjeet on tuotu myös word-muotoon, jolloin ne ovat käytettävissä ohjeen kirjoittajille. 

Suositellut sisällöt ja käytettävät elementit

Käytä ekxranetin ohjesivulla seuraavia elementtejä ohjeistetussa järjestyksessä.

1. Otsikko ja ingressi

Kirjoita otsikko otsikkokenttään ja ingressi ingressikenttään. Lisää tarvittaessa otsikon loppuun sulkuihin erikoiskohderyhmä, jolle ohje on erityisesti suunnattu. Näitä ovat neuvonta, DialOk tai poliisi. Tiivistä ingressiin ohjeen kuvaus ja kenelle ohje on suunnattu.

2. Sisällysluettelo

Jos sivulla on 3–8 väliotsikkoa, käytä sivun sisäistä sisällysluetteloa. Extranetin ohjeet ovat yleensä pitkiä, jolloin sisällysluettelo on lähes aina tarpeellinen. 

Otsikko 2 -tyylillä tehdyt otsikot nousevat sivun sisäiseen sisällysluetteloon. Kirjoita väliotsikot niin, että tärkeimmät aihekokonaisuudet ovat silmäiltävissä sisällysluettelosta. 

Sisällysluettelon otat käyttöön ingressin alapuolelta valitsemalla Näytä sisällysluettelo sivun alussa. Sisällysluettelon otsikon oletusteksti on Tällä sivulla. Käytämme aina oletusotsikkoa. Älä siis kirjoita mitään kohtaan Sisällysluettelon otsikko.

3. Erikoistilanteet (tarvittaessa)

Erottele normaalista poikkeavat erikoistilanteet omaan osioonsa. Otsikoi osio Erikoistilanteet. Jos erikoistilanteita on kolme tai useampi, ja ne ovat selkeästi toisistaan erilaisia tapauksia, voit käyttää tässä sisältöhaitaria. Muutoin erikoistilanteet tehdään teksti-elementillä. 

Käyttäjät tarkistavat usein erikoistilanteisiin liittyviä ohjeistuksia, pidä siksi sisältö näkyvillä sivun alussa.

4. Sisältö

Kirjoita sivun sisältö ensisijaisesti käyttämällä tekstielementtiä. Mene suoraan asiaan ja nosta tärkeimmät aiheet sisällön alkuun. Muista selkeät väliotsikot ja oikeat otsikkotasot. Lisää tarvittaessa aiheeseen liittyvä kuva tai linkki. Jos haluat lisätä kuvia, videoita tai kaavioita, noudata Traficom.fi:n yleistä ohjeistusta. Myös Extranetin sisältöjen tulee vastata saavutettavuusvaatimuksia. 

Selkeät esimerkit auttavat käyttäjää tulkitsemaan ohjetta. Erottele esimerkit muusta sisällöstä laatikkoelementillä. Luo jokaiselle esimerkille oma laatikko.

5. Toimi näin (tarvittaessa)

Jos toimintaohje on käännettävissä muotoon, jossa se esitetään prosessina, hyödynnä Ohje-elementtiä. Ohje-elementin avulla sisältö muuttuu helpommin silmäiltäväksi ja ymmärrettäväksi. Ohje-elementti otsikoidaan Toimi näin. Tarvittaessa otsikossa voi olla tarkentava selite, jolloin toimi näin tulee sen jälkee. Esimerkiksi Toisen omistajan rekisteröinti, toimi näin. Otsikkoon ei tule kaksoispisteitä. 

Kerro tässä vain se tieto, mitä käyttäjän pitää ehdottomasti tietää, ennen kuin hän lähtee hoitamaan asiaansa. Jos haluat lisätä ohje-elementtiin linkkejä, joilla ohjaat käyttäjän lisätietojen äärelle, lisää linkit linkkielementillä peräkkäin ohjeen vaiheen tekstin jälkeen. Älä käytä linkkejä tekstin sisällä tai keskellä.

6. Yleistä uusille käyttäjille tai yleistä aiheesta 

Osio taustoittaa, kiteyttää ja avaa ohjeen yleistiedot uudelle käyttäjälle. Osio voi toimia myös muistilistana kokeneelle käyttäjälle. Osio sijoitetaan tärkeimpien ohjeiden jälkeen, jos kyseessä on ohjekokonaisuus, joka on jo vakiintunut käyttäjien arjessa. Jos kyseessä on uusi ohje, osion voi siirtää ohjeiden alkuun. Mieti tässä kohtaa kohderyhmää ja sitä, onko osiolle tarvetta, ja missä kohtaa ohjetta se sijaitsee. 

Käytä tekstielementtiä. Otsikoi osio Yleistä uusille käyttäjille tai Yleistä aiheesta, esimerkiksi Yleistä ajoneuvon rekisteröinnistä. Voit sisällyttää seuraavia aiheita:

• Lyhyt kuvaus: mistä ohjeessa on kyse?
• Yleistietoa (vakioaikoja, kestoja, määriä tai rajauksia)
• Taustaa (lait, lakimuutokset ja tärkeät päivämäärät)
• Sanastoa

Jos sanasto on pitkä tai liittyy moneen eri ohjeeseen, luo sanastolle oma perussivu. Linkitä sanasto-sivu osioon. Jos sanasto on lyhyt (1-7 sanaa) ja liittyy vain tähän ohjeeseen, lisää sanasto osioon haitari -elementillä.

Huom! Tämä osio ei ole käyttäjien mielestä tärkeä neuvonnalle.

7. Lisätiedot (tarvittaessa)

Lisää ohjeeseen liittyvät linkit ja liitteet mieluiten asiayhteyteen. Jos linkkejä on paljon, lisää linkit ohjesivun loppuun linkkilista-elementillä ilman taustaväriä.  Otsikoi osio Lisätiedot. 

Jos linkkejä on paljon, jaottele linkit teemoittain ja otsikoi kuvaavasti. Esimerkiksi lisätietoa henkilötiedoista tai lisätietoa rekisteröinnin esteistä. 

8. Ohjeen tiedot

Käytä tekstielementtiä. Otsikoi osio Ohjeen tiedot. Lisää seuraavat tiedot:

• Asianumero
• Voimaantulopäivä
• Julkaisupäivä

9. Ohjeen päivitykset (tarvittaessa)

Kun päivität ohjetta lisää ohjeeseen päivityskommentti -elementti. Mainitse lyhyesti, että ohje on päivitetty ja mitä olet päivittänyt esim. "Ohjeeseen on päivitetty tilanne x". Päivityskommentti -elementti merkitsee päivityksen päivämäärän ja lisää kommentin sivun alaosaan. 

Extranet järjestelmäohjeet

Järjestelmäohjeet eivät noudata samaa sisältömallia asiaohjeiden kanssa. Järjestelmäohjeiden tehtävänä on opastaa järjestelmän käytössä - jätä siis itse asiaan liittyvät ohjeet, kuten myöntämisedellytykset ja muut perustiedot varsinaiseen ohjeeseen. Linkitä asian ohje järjestelmäohjeeseen. 

Huomioi nämä asiat järjestelmäohjeessa:

• Jos kyse on esimerkiksi oma asioinnin ohjeistuksesta, siirrä poikkeus- ja häiriötilanteiden kuvaus ohjeen alkuun. Muissa tapauksissa voit hyödyntää erikoistilanteet-osiota, tai kuvaa mahdollinen virhetilanne suoraan kyseisen järjestelmäosion ohjeessa. 
• Käytä mahdollisimman laadukkaita kuvankaappauskuvia. 
• Selitä myös kirjallisesti, mitä kuvankaappauskuvissa näkyy. Esimerkiksi järjestelmän eri osat, missä osassa kuvan tapauksessa ollaan, mistä löytyy mitäkin ja mitä kenttiin pitää täyttää. Käytä samoja termejä, mitä järjestelmässäkin. Kun kuvan sisältö on avattu kirjallisesti, voit merkitä kuvan Drupalissa koristeelliseksi. 
• Kirjoita ohjeessa selkeästi, kuka tekee mitäkin. Järjestelmä näyttää, asiakas täyttää - ja niin edelleen. 

Esimerkkejä

Jos kaipaat esimerkkejä sisältömallin ymmärtämisen tueksi, voit käydä selaamassa seuraavia ohjeita. Ne on kirjoitettu uuden sisältömallin mukaisesti. 

Miten kirjoitan ohjeen? 

Ohjeiden kirjoittaminen ei ole helppoa. Kirjoittaminen on kuin lihas - se vaatii toistuvaa harjoitusta ja ärsykettä. Älä huoli siis, jos aloittaminen tuntuu vaikealta. Tässä muutama vinkki, joilla pääset alkuun. 

Määritä kohderyhmä ja konteksti

Mieti tai pyydä ohjeen tuottajalta aina määritys ohjeen kohderyhmästä. Esimerkiksi asiakaspalvelu katsastustoimipisteissä. Tämä helpottaa myös kontekstin pohdintaa - millaisissa tilanteissa ohje on tarpeellinen? Mitkä asiat ovat silloin tärkeitä? Mitä käyttäjä kaipaa ensimmäisenä? 

Määritä "normaalitapaus"

Ohjeen kirjoittaminen kannattaa aloittaa määrittelemällä ohjeen "normaalitapaukset". Eli mikä on tavallisin tilanne, mihin ohjetta kaivataan? Ajoneuvojen rekisteröinnissä tämä olisi esimerkiksi normaalin ajoneuvon rekisteröinti niillä tavoilla, kun rekisteröinti voidaan suorittaa. Normaalitapaus on aina ohjeen selkäranka, jonka ympärille voit koota lisää sisältöä. 

Normaalitapauksia voi olla useita. Pidä normaalitapaukset ohjeen alussa. Jos pystyt, kuvaa normaalitapaus ohje-elementillä vaiheistettuna. 

Ehdot ohjeen toteutumiselle

Mikäli ohjeen normaalitapauksen toteutumiselle on olemassa ehtoja tai pohjatietoja, nämä on hyvä asettaa ihan ohjeen alkuun, ennen normaalitapausten kuvausta. Esimerkiksi ajoneuvojen rekisteröinnissä tällainen asia voisi olla rekisteröinnin esteet.

Erikoistilanteet

Normaalitapauksiin liittyy usein erikoistilanteita, jotka poikkeavat normaalista työnkulusta. Voit miettiä erikoistilanteet sellaisina tilanteina, joissa ohjeen lukija todennäköisesti avaa aina ohjeen. Erikoistilanteet kuvataan ohjeen alussa, otsikolla "erikoistilanteet". 

Muut työnkulut ja tarkennukset

Erikoistilanteiden sijaan normaalitapausten lisäksi voi olla myös toissijaisia työnkuluja. Kuvaa nämä normaalitapausten jälkeen. Ajoneuvon rekisteröinnin osalta tämä voisi olla esimerkiksi erikoisajoneuvon rekisteröinti. Tässä kohtaa ohjetta voit kuvata myös muita "perusasioita" jotka liittyvät koko ohjeeseen.  

Tuotettua tekstiä kannattaa aina sparrailla muiden sisällöntuottajien kanssa. Pyydä ainakin yhden kollegan palautetta ohjeesta - mieluusti sellaisen kollegan, joka ei välttämättä ole asian kanssa kovin paljoa tekemisissä.