Sjekk at veiledningen har:
Tjenestenavnet i tittelen
Navnet på tjenesten må være i tittelen på alle veiledningssider. Da kommer brukerne til riktig tjeneste når de søker etter hjelp fra IT-forsiden, og artiklene blir lettere å finne i søkelista og i Google-søk.
Konsistente formuleringer
Hva heter tjenesten du jobber med? Den skal skrives på samme måte overalt på sidene. Det samme gjelder begreper som "e-post", som skrives med bindestrek, (mens engelsk "email" skrives uten). Vær også spesielt oppmerksom på forskjellen på tjenesten Nettskjema - med stor "N" - men substantivet "et nettskjema/nettskjemaet" med liten.
Referanser til grensesnittet i fet skrift
Knapper som skal klikkes på eller navn på dialogbokser eller felt som skal fylles ut, utheves med fet skrift. Ikke bruk anførselstegn eller kursiv.
Overskriftshierarki: H2-H3-H4
Overskriftshierarkiet gjør teksten lettere å lese, er nødvendig for universell utforming og kan på sikt bli viktig for søkbarheten i veiledningene. Den første overskriften i artikkelen, og andre avsnitt som er like viktige, skal ha overskriften H2. Undravsnitt skal ha H3, punkter under det igjen H4 osv. Valg av overskrifter er ikke et estetisk valg, men viktig for lesbarhet og universell utforming.
Klart, enkelt og aktivt språk uten unødvendige forbehold
Vær tydelig om veien fra problem til løsning. Unngå alle språklige omveier av typen "dersom du skulle ønske å logge inn i tjeneste N, kan det være en god ide å vurdere om du skal..." Formen skal være "Slik logger du inn i tjeneste N:" og så en presis forklaring. Bruk du-form, ikke man, eller lignende. Skriv hvis, ikke om eller dersom.
Kulepunktlister ved oppramsinger
Kulepunktlister bidrar til:
- å øke lesbarheten ved oppramsinger
- å synliggjøre viktigheten av punktene
- å brekke opp tekster som inneholder mye informasjon
Nummererte lister ved prosedyrer som skal følges
Nummererte lister loser leseren gjennom løsningen på problemet han eller hun har oppsøkt veiledningen for å løse. For eksempel slik:
- Hvor i tjenesten du finner stedet du skal starte på. (Gå til .... )
- Menyen du skal velge i. (Åpne ...-menyen, og velg ...)
- Handlingen du skal utføre med menyvalget ditt. (Fyll ut ...-feltet og kontroller at ...)
- Og til slutt: trykk på Fullfør (eller liknende) og oppgaven er fullført.
Handlingsdrivende lenker
Lenker skal være tydelige på hva de sender brukeren til. For eksempel slik:
Les mer om hvordan du skriver gode brukerveiledninger.
Lenker kan godt være lange eller en hel setning. Det er viktig for universell utforming at lenketeksten sier hva du oppnår ved å klikke. Lenker som er kun ett ord som her, les eller klikk er ikke gode lenker og skal ikke brukes.
Alternativ tekst på alle bilder
Bilder er generelt et pluss i veiledninger, men bruken må vurderes opp mot vedlikeholdsbehovet. Bilder som viser noe annet enn det brukeren ser i tjenesten er snarere et minus.
Uansett skal alle bilder ha alternativ tekst. Slik gjør du det:
Høyreklikk på bildet og velg Bildeegenskaper i menyen.
Så skriver du inn hva bildet viser i feltet for Alternativ tekst.
Søkefelt og kontaktvelger nederst
Alle veiledninger skal ha tre komponenter nederst:
- Søkefeltet
- Tilbakemeldingsfelt
- Kontaktinformasjon
Disse kan kopieres fra https://www.uio.no/tjenester/it/utenfra/rdp/hjelp/windows/ (norsk) og https://www.uio.no/english/services/it/home-away/rdp/help/windows/ (engelsk).
OBS: URI i søkefeltet må gjenspeile hvor veiledningen befinner seg. uris=[/tjenester/it/xxx/xxx/hjelp]