Skriv for Aksel
Aksel er avhengig av at folkene som sitter tett på produktutviklingen i NAV bidrar med innhold om god praksis. Her finner du det du trenger å vite for å bli en god Aksel-skribent.
Før du skriver
- Ta kontakt med temaredaktør for å planlegge innholdet
- Les om Aksel og sett deg inn i innholdsprinsippene. Innholdet skal i korte trekk:
- dekke tverrfaglige produktteams behov
- være levende og praktisk
- være tilpasset konteksten til tverrfaglige produktteam i NAV - bruk eksempler
- invitere til dialog. Alt innhold skal ha en avsender slik at kollegaer enkelt kan komme i kontakt med den som har skrevet artikkelen.
Når du skriver
Språkstilen vi bruker i Aksel skal være enkel, vennlig og tilgjengelig:
- Bruk et aktivt språk og personlige pronomen som «du» og «vi»
- Bruk gjerne et hverdagslig språk og unngå komplisert fagterminologi
- Sett de viktigste nøkkelordene langt frem i teksten
- Skriv hele, korte setninger
- Skriv gode og meningsbærende overskrifter og mellomtitler
- Skap kontraster i teksten med for eksempel punktlister, tipsbokser og accordions
- Skriv til en kollega som kan mindre om stoffet enn deg selv
- Bruk eksempler for å forklare slik at budskapet ditt blir enklere å forstå
Det er god praksis å få en kollega eller to til å lese teksten før publisering for å sjekke om teksten er forståelig og svarer på brukeroppgavene.
Tips
Test teksten på en kollega i målgruppa. Les om lavterskel brukertesting av tekst.
Bruk NAV språkhjelp for å få hjelp til å gjøre teksten din mer lettlest.
Når du redigerer innholdet i Sanity
Aksel ligger i Sanity, som er et headless CMS med god redaktøropplevelse. Les om hvordan du logger inn og publiserer i Sanity. Følg disse tipsene for at innholdet du publiserer har god kvalitet og er universelt utformet:
- URL blir automatisk generert basert på tittelen. Du kan gjerne forkorte den for å gjøre den mer lesbar.
- Når du lenker til andre sider, må du skrive en lenketekst som er beskrivende for lenkens mål.
- Hvis du bruker bilder, må du legge inn alt-tekst som fungerer som et reelt alternativ for bildet.
- Sørg for at overskriftsnivåene er i sammenhengende rekkefølge (H2 > H3 er OK, H2 > H4 er ikke OK).
- Bruk verktøyene i Sanity for å lage tabeller og lister, fremfor å mekke en egen løsning
- Legg til alle som har bidratt til innholdet i feltet for redaktører. Den som står først vil stå som forfatter øverst i artikkelen, mens resten vil stå som bidragsytere nederst.
- Forhåndsvisningen for siden du jobber med blir automatisk oppdatert når du redigerer innholdet i Sanity. Vi anbefaler at du åpner forhåndsvisning/preview og har både denne og editor-siden åpen, slik at du kan se hvordan innholdet blir seende ut.
Når du er fornøyd med teksten og har lagt den inn i Sanity, avtaler du publisering med temaredaktør. Du publiserer innholdet, men innholdet blir ikke synlig på temasiden før temaredaktøren legger det til der.
Etter du har publisert
God praksis-innholdet på Aksel skal være levende og relevant, og må derfor oppdateres når det er behov for det. Du som har skrevet innholdet har ansvar for å oppdatere innholdet når det er behov og sikre at det fortsatt er relevant.
Vi har noen mekanismer som er med på å gjøre denne jobben lettere:
- Etter 12 mnd regnes en god praksis-artikkel som "utdatert" i systemet. For designsystem-artikler er det 6 mnd.
- Du vil da finne artikkelen under en egen mappe som heter "Mine artikler som trenger oppdatering" under god praksis mappen i sanity.
- Alle artikler vil ha en banner i toppen som varsler om at artikkelen trenger en oppdatering.
- Gå gjennom artikkel og verifiser at alt fortsatt stemmer, evt oppdatere innhold der det trengs.
- Trykk "Godkjenn innhold"-knappen for å publisere endringer og oppdatere "sist godkjent"-verdien.
- Om innholdet ikke trenger noen endringer for å godkjennes kan du velge "Godkjenn innhold uten å publisere" i undermenyen ved siden av "Publiser" knappen.
Tips
Du finner flere skriveråd i artikkelen: Slik skriver vi i NAV