Styleguide

Skriva för e-tjänster

När du skriver för en e-tjänst ställer det särskilda krav på hur du skriver och formaterar texterna. På den här sidan finns saker du behöver tänka på, men du behöver också läsa vad som gäller för de olika komponenterna.

Dessutom behöver du följa de vanliga klarspråkstipsen för att din text ska bli tydlig och begriplig. Det handlar till exempel om att du ska förklara nödvändiga facktermer, använda stor och liten bokstav vid rätt tillfälle och att du ska välja korta prepositioner. Läs mer på intranätet på sidan Klarspråk, skrivtips och översättning.

Använd samma begrepp och formuleringar som på Jordbruksverkets webbplats

Läs de texter om ämnet som finns på Jordbruksverkets webbplats. Det är viktigt att du använder samma centrala begrepp och formuleringar i e-tjänsten som på webbplatsen. Användaren ska känna igen sig och förstå att vi menar samma sak oberoende av vilken av våra kanaler hen använder.

Vilka begrepp som står i föreskrifter eller förordningar spelar ingen roll. Det är begrepp som användaren kommer i kontakt med som spelar roll.

Du ska självklart anpassa språket för den kanal du skriver för, men det är viktigt att just de begrepp som är centrala för ämnet är desamma. Det gäller också viktiga förklaringar.

Använd samma begrepp och formuleringar i hela e-tjänsten

Använd samma begrepp och formuleringar igenom hela tjänsten. Det blir förvirrande för användaren om du till exempel växlar mellan ”sök stöd” och ”sök ersättning”, eller ”resa med din hund” och ”transportera din hund”.

Var konsekvent med hur du benämner funktioner

Se till att alla funktioner som har samma syfte benämns likadant överallt i e-tjänsten. Alla knappar, ifyllningsfält och ikoner med samma syfte ska till exempel heta likadant både på skärmen och i koden. Om du vill att användaren ska fylla i sitt telefonnummer ska det inte stå telefon på ett ställe och telefonnummer på ett annat ställe. Även en eventuell ikon som visar en telefon ska benämnas på ett enhetligt sätt.

Fundera på vad användaren behöver veta just i e-tjänsten

Ge användaren den information som hen behöver just i e-tjänsten. Ofta har användaren läst på webbplatsen innan hen använder e-tjänsten. I vissa fall får användaren ett beslut ett tag efter att hen använt e-tjänsten, till exempel om hen har skickat in en ansökan om något. Vi kommunicerar alltså med användaren vid flera tillfällen. Användaren ska få informationen vid den tidpunkt och i det sammanhang som hen behöver den.

Skriv det viktigaste först

Skriv det viktigaste innehållet först. Informationen ska komma i rätt ordning så att ingen del av texten förutsätter kunskap om något som finns längre ner.

Skriv kort men tydligt och begripligt

Försök skriva så kort som möjligt, men ändå tillräckligt för att användaren ska förstå. Texterna ska vara konkreta, ”pang på” ­ inte pratiga. Användarna ”skummar” texten, snarare än läser varje ord. Det finns en risk att användaren missar information om texterna är för långa.

Läsaren är du och Jordbruksverket är vi

Vi har ett personligt tilltal i våra texter. Vi kallar läsaren för du och skriver vi om Jordbruksverket.

I texter som vänder sig till företag eller organisationer använder vi "du" så långt det är möjligt, eftersom det fortfarande är en person som läser texten. Men vi kan skriva till exempel "din organisation" eller "ni" när det gör texten lättare att förstå.

Gör ett nytt stycke där det behövs

En tydlig styckesindelning underlättar för läsaren att förstå sammanhanget i texten. Kortare stycken gör texten luftigare och lättare att läsa. Stycken kan variera i längd men 3 till 10 meningar är vanligt.

Varje nytt stycke behöver inte ha en egen rubrik, men om stycket handlar om någon nytt så bör du lägga till en ny rubrik.

Använd rätt rubriknivåer

Använd rätt rubriknivåer med h-element så att texten läses upp rätt av skärmläsare. För att veta vilka rubriknivåer du ska använda måste du veta hur designen ser ut på sidan. Du behöver samarbeta både med projektets designer och utvecklare för att veta vilka rubriknivåer som är rätt.

Använd aktiva verb som visar vem som gör vad

Använd aktiva verb i stället för passiva. Skriv "Du ska skicka in ansökan" i stället för ”Ansökan skickas in".

Aktiva verb gör det lättare för läsaren att ta till sig texten och det blir tydligt om det är läsaren eller någon annan som ska göra något.

Använd verb, inte substantiv

Undvik verb som har blivit substantiv. Skriv "utbilda" i stället för "hålla en utbildning". Skriv ”kontrollera” i stället för ”göra en kontroll”.

Skriv det viktigaste ordet först

Det är bra för alla läsare att det viktigaste ordet står först men särskilt viktigt är det för de personer som använder skärmläsare och bara lyssnar på det första ordet innan de klickar sig vidare. Skriv därför det viktiga ordet först. Skriv "Kontakta oss om du har frågor", skriv inte "Om du har frågor kan du kontakta oss".

Använd punktlistor vid uppräkning

Använd punktlistor när du har en text som innehåller en uppräkning eller flera alternativ. Punktlistor hjälper läsaren att orientera sig i texten på samma sätt som en bra mellanrubrik gör. Information om hur du skriver en punktlista på rätt sätt finns på intranätet på sidan Klarspråk, skrivtips och översättning.

Undvik förkortningar och tecken

Skriv alltid ut orden i stället för att använda förkortningen. Förkortningar kan vara svåra för läsaren att förstå och även om läsaren förstår så stoppar det upp läshastigheten. Förkortningar kan också läsas upp felaktigt av skärmläsare. I tabeller kan det vara platsbrist och där kan du välja de allmänt kända förkortningarna.

Även tecken stoppar upp läshastigheten. Undvik därför att använda till exempel parenteser, snedstreck och procenttecken.

Skriv datum och klockslag på enhetligt sätt

Skriv ut datumet i löpande text. Skriv ”den 31 januari 2025”, skriv inte ”250131”. Skriv "den 27 april", inte "27:e april".

Klockslag skriver du med punkt mellan timmar och minuter.

Sätt inte ut minuter om det är hela timtal som anges. Skriv klockan 8–12, inte 8.00–12.00. Om den ena tidsangivelsen gäller både timmar och minuter och den andra gäller bara timmar, ska du bara ange minuter i det första fallet: Växeln är öppen klockan 8.15–17.

Du ska inte skriva en nolla framför första siffran i ental.

Ge sidan en beskrivande titel

Sidans titel är det namn du ser i webbläsarfönstret (fliken). Sidans titel ska beskriva och sammanfatta sidans ämne. Varje sida ska ha en unik titel. Det är viktigt att titeln är uppbyggd så att det viktigaste kommer först och därmed alltid syns i fliken. En bra titel på en sida skulle kunna vara:

Välj insats-företagsstöd-Jordbruksverket

Tänk på att användaren ska kunna tabba sig fram i en logisk ordning

Användaren ska kunna navigera på sidan med hjälp av tangentbordet. Tab-ordningen ska vara logisk för användaren. När du har tagit fram innehållet på sidan har säkert du och designern haft en tanke på hur innehållet ska presenteras för användaren på ett bra sätt. Du får därför samarbeta med designern och utvecklaren för att se till att tab-ordningen blir logisk.

Beskriv de delar som inte är text

För att en skärmläsare ska kunna tyda allt som finns på skärmen måste du beskriva de delar av innehållet som inte är text med text. Du kan till exempel behöva beskriva en bild eller en ikon med text. Innehållet i till exempel en tabell eller en grafik kan du behöva beskriva både som text på sidan och i den bakomliggande koden. Ikoner, knappar och bilder som du beskriver i koden ska du beskriva enhetligt och tydligt. En telefonikon ska till exempel inte beskrivas som telefon på ett ställe och telefonlur på ett annat eftersom det blir svårt för de som använder skärmläsare.

Senast publicerad

Sidansvarig för sidan är Styleguide