Retningslinjer for innhold
Så fint at du vil bidra med innhold! ✍️
Siden alt som skrives på denne siden er fritt tilgjengelig på Internet, er det viktig å følge noen enkle regler og retningslinjer for innhold.
Språk og stil
Innholdet på disse sidene er primært for teknikere og teknisk språk er derfor å forvente. Men, om uttrykk brukes som ikke kan antas å være godt kjent må de beskrives. Språket skal kunne leses og forstås av de fleste teknikere, ikke bare de som har jobbet med sikkerhet i flere tiår!
Husk også at alle artikler skal ha en inngress som skal kunne leses og forstås av alle fra ledere og leveranseorganisasjon til sikkerhetseksperten og juniorutvikleren.
Artikeloppbygging
Alle artiklene skal ha følgende oppbygning
---
sidebar_position: N
title: Kortfattet tittel
---
# Kortfattet tittel
__Inngress__
Inngressen skal være oppsummerende og bruke et språk som kan leses og forstås av alle.
## Brødtekst
Alle artikler skal være teknologi-agnostiske.
Bruk gjerne spesifikk teknologi i eksempler, men unngå artikler som kun gir mening på Azure eller AWS.
Bruk features i MD / Docosaurus til å understreke eller utheve viktige punkter.
Bruk code fencing til å vise eksempler og del opp innholdet med headings (ingen liker wall of text)
Eksternt innhold
Bruk permalenker der dette er mulig.
Bruker du tekst fra en annen artikkel eller kilde så må dette refereres til.
Hjelp!
Trenger du hjelp med Markdown?
Noe du lurer på angående innhold, hva du kan bidra med osv? Ta kontakt med oss på Slack eller se følgende issue