Denne vejledning retter sig mod redaktører og indholdsleverandører. Her kan du se retningslinjerne for, hvad en it-vejledning skal indeholde, og hvordan den skal laves. Retningslinjerne gælder:
Formål
Formålet med VIAs it-vejledninger er, at de skal være:
- præcise.
- simple.
- overskuelige.
- logisk strukturerede.
- den kortest mulige forklaring på noget specifikt.
- webtilgængelige. Læs vejledning til webtilgængeligt indhold her.
Skabelon
Anvend "IT-vejledningsskabelon" som template, når du opretter en ny vejledning. Skabelonen har en præ-defineret opsætning, som blandt andet sikrer, at VIAs designstandarder (eks. farvepalette) og præ-definerede annotationer på billeder anvendes.
Titel
Skal være sigende og kort. Navngiv fx vejledningen det emne og system/produkt, som vejledningen omhandler, eks: ”Fornyelse af NemID Medarbejdersignatur”.
Kronologi
- Introduktion: Begynd altid med et introduktionselement, hvor du beskriver, hvem vejledningen er til, og hvad man får ud af læsningen. Skriv så kort som muligt og nævn målgrupperne så tidligt som muligt. Eks:
Denne vejledning henvender sig til alle studerende og medarbejdere og forklarer, hvordan du deltager i et Microsoft Teams-møde, samt hvilke funktioner, du kan bruge under mødet.
- Strukturér vejledningen ved at anvende de indbyggede typografier i ScreenSteps såsom overskrift-(herunder fold ud overskrifter), paragraf- og listeelementer.
- Trin-for-trin-beskrivelsen kommer altid inden et evt. billede til at underbygge forståelsen. Disse to må aldrig adskilles, fx af et gult warning-indholdselement.
- Hvis du skal tilføje et gul opmærksomhedselement (warning) må du ikke placere det mellem trinbeskrivelse og billedet.
- Brug så få indholdselementer som muligt, og kun til netop det, de er beregnet til. Brug den lyseblå Introduktion til introduktionen, den gule Warning og den grønne Tip. Vær opmærksom på, at ikke alle elementtyper må anvendes. Læs om de forskellige indholdstyper her.
Følgende er et eksempel på, hvordan du IKKE skal bruge eller strukturere din vejledning med indholdselementer, fordi det virker for rodet:
Følgende er et eksempel på, hvordan du korrekt bruger eller strukturerer din vejledning med indholdselementer, hvor vejledningen virker mere simpel og overskuelig:
Introduction: Introduktionselement, der udelukkende anvendes som det første afsnit i hver vejledning, hvori målgruppe samt formålet med vejledningen beskrives.
Info: Denne elementtype må ikke anvendes.
Alert: Denne elementtype må ikke anvendes.
Warning: Advarselselement, der anvendet til at skabe opmæksomhed omkring noget, brugeren skal være opmærksom på. Eksempelvis OBS. eller NB punkter.
Tip: Tip element, der anvendes til at give brugere forskellige tips og tricks.
Punktopstilling
Brug punktopstilling med tal. når du skriver trin-for-trin, der refererer direkte til et skærmbillede med tal. Start talrækken forfra efter hver overskrift.
Overskrift
- Trin 1
- Trin 2
- Trin 3
*Billede*
- Trin 4
- Trin 5.
*Billede*
Overskrift
- Trin 1
- Trin 2
- Trin 3.
*Billede*
Hvis du beskriver trin eller information, der ikke relaterer sig til et trin på et billede, skal du blot bruge almindeligt punkttegn. Se eksempler på, hvordan opstilling med tal og punkttegn anvendes nedenfor.
Regler for punktopstilling
Sæt altid punktum efter hvert punkt, når punkterne er helsætninger - bydeformer fungerer som helsætninger. Eksempelvis:
- Følg installationsguiden.
- Vælg afslut, når du er færdig.
Hvis din punktopstilling ikke består af helsætninger, skal du kun sætte et enkelt punktum, og det er efter det sidste punkt. Eksempelvis:
- Undersøg
- Skriv
- Rediger.
Der er dog enkelte undtagelser til reglen overnfor. Du skal ikke sætte punktum efter sidste punkt, hvis punktopstillingen er en del af:
- en indholdsfortegnelse
- en tabel
- et regnskab
- en madopskrift.
Begynd altid dine punkter med stort i trinvise forklaringer, hvor du anvender opstilling med tal. Derudover skal du også bruge stort, når du anvender alm. punktopstilling. Sidste er ikke en grammatisk regel, men er vedtaget for it-vejledninger for at skabe sammenhæng og ensartethed på tværs af it-vejledningerne. Eksempelvis:
- Kaffe
- Morgenmad
- Arbejde.
Du skal starte med småt, når punkterne fuldender den sætning, der står før punktopstillingen. Derfor skal du:
- starte med stort, når du bruger punktopstilling med tal
- starte med småt, når punkterne fuldender slutningen, der står inden punktopstillingen.
Derudover må du aldrig sætte komma eller "og" efter et punkt i en punktopstilling.
Links
Brug Knowledge Base Link til at linke til andre vejledninger i vejledningsbiblioteket, der uddyber indhold eller på anden måde understøtter indholdet i vejledningen. Disse skal åbne i samme vindue.
Brug Heading Link til at linke internt i en vejledning i en længere vejledning. Brug det evt. til at skabe en indholdsfortegnelse, hvis det er en lang og kompliceret vejledning.
Brug External link til at linke til eksterne websider. Disse skal åbne i et nyt vindue.
- Hvis du linker til en webside, der ligger bagved login (VIA), skal du efter linket tilføje: (kræver VIAlogin).
Navnestandarder
Overhold VIAs navnestandarder (både for afdelingsnavne og navne på systemer og software). Find navnestandarder i VIA her (kun for IT og digitalisering) eller på Systemer og services på Medarbejderportalen her (kræver VIAlogin).
Sprog
Sproget i vejledningen skal være:
- Let og forståeligt.
- Direkte tiltaleform (du, dig, din).
- Handlingsorienteret (vælg, åbn, etc.)
- Skrevet i præsens (nutid).
- Brugerorienteret, så anvend alment kendte begreber og ikke fagspecifikke.
- "Sådan" må ikke bruges i overskrifter, forkort derfor sætningen.
Eksempel:
Sådan virker målgruppestyring i MitVIA, kan ændres til
Målgruppestyring i MitVIA.
Ud over ovenstående skal du være opmærksom på følgende i forhold til sprog:
- Begræns brugen af kompleks sætningsopbygning
- Brug ikke "klik på" eller "tryk på", men "vælg" eller "åbn".
- Begræns sætningslængde for at holde lix-tallet nede.
- Vær opmærksom på stavefejl. Hvis du ikke allerede har dansk stave- og grammatikkontrol i Desktop editor, læs vejledningen her.
Billeder og skærmbilleder
Brug billeder sammen med tekst, når billeder understøtter vejledningen. Brug aldrig billeder i stedet for tekst. Læs gerne om webtilgængelighed og billeder her og læs om webtilgængelighed og billeder i ScreenSteps her.
Vær opmærksom på, at:
- billeder og skærmbilleder kun skal vise det relevante for vejledningen, så brug beskæringsfunktionen til at beskære billeder.
- billederne skal være tydelige og læsbare.
- hvis du bruger annotationer (rammer, pile, tal, mv.) på skærmbillederne, skal du bruge den prædefinerede skabelon (IT-skabelon primær). Læs mere om annotationer her.
- hvis du bruger skærmbilleder skal du undgå for markante farver såsom mørk udseende. Brug i stedet lyst udseende på din computer eller device. Se eksemplet nedenfor.
Billeder, der understøtter en trinvis beskrivelse, tilføjer ikke yderligere information. Derfor skal disse billeder ikke have en alternativ tekst, men markeres som dekorative. Du tjekker, at billeder er markeret som dekorative ved at:
- Kigge i dokumentets outline.
- Se, om der står noget ved siden af det pågældende billedelement.
- Hvis der ikke står noget, er billedet angivet som værende dekorativ.
- Hvis der står noget, er der tilføjet en alternativ tekst. Hvis du vil fjerne denne, så se trinene nedenfor omkring, hvordan du tilføjer en alternativ tekst, og frem for at tilføje, skal du fjerne den.
For at tilføje en alternativ tekst, skal du:
- Gå til Content Inspector.
- Skrive den alternative tekst i feltet "Image ALT Tag".
Billeder, der tilføjer information, der ikke er beskrevet med tekst, skal have en alternativ tekst. Dette gør du ved at beskrive billedet i Image ALT Tag under Content Inspector. Se de beskrevne trin ovenfor.
Læs vejledningen Alternative tekster til billeder og illustrationer for råd og vejledning til den gode alternative tekst.
Video
Indsæt ikke video direkte i en vejledning. Indsæt i stedet link til det sted, videoen ligger (eks. Kaltura). Vær derudover opmærksom på webtilgængelighedskravene til video. Læs om kravene her.
Publicering
Når du publicerer din vejledning kan det være relevant at overveje flere ting:
- Skal der linkes til vejledningen fra andre steder, fx fra selve systemet eller relevante sider, hvor behovet for vejledning kan opstå?
- Skal der tilføjes ekstra søgetermer som fx "trådløs netværk", "wifi" og "Wi-Fi", så vejledningen er lettere at fremsøge? Læs om tilføjelse af ekstra søgetermer her.