Sider og struktur
Konvensjonene under gjelder alle sider på nettstedet. De gjør at leseren finner fram på samme måte overalt, og at vi slipper å diskutere strukturen på nytt for hver seksjon.
Sider med undersider: bare ingress
En side som har undersider, har bare en kort ingress på to–fire setninger. Under ingressen viser nettstedet automatisk seksjonsinnholdet, altså lista over undersidene. Eksempel: Pilot 6.
- Ikke legg annet innhold på en slik side. Innhold som bare står der, blir lett «skjult» bak lista og har ingen egen plass i menyen.
- Trenger innholdet en egen side, lag den som underside, for eksempel «Om …».
Én side, ett dokument
Et dokument med kapitler legges som én side, ikke som én underside per kapittel. Kapitlene vises i menyen til høyre («På denne siden»), og leseren kan hoppe mellom dem.
- Kapitler er overskrifter på nivå 2 (Overskrift 2 i editoren), underkapitler på nivå 3. Nivå 1 er sidetittelen.
- Bruk undersider bare når innholdet er en egen enhet som kan leses for seg, for eksempel referater fra møter eller en leveranse.
Ingen kapittelnummerering
Overskrifter har ikke nummer («Teknisk målarkitektur», ikke «9. Teknisk målarkitektur»).
- Henvisninger til andre kapitler skrives som lenker med kapitlets navn, for eksempel «se Teknisk målarkitektur», der navnet lenker til kapitlet. Ankeret er overskriften med små bokstaver og bindestrek mellom ordene (#teknisk-målarkitektur). Enklest er å kopiere lenken med lenkeikonet, se under.
- Trengs en eksakt referanse til en side, bruk sidens ID (vises under tittelen) og datoen den sist ble endret. Versjonshistorikken ligger i GitHub.
- Nummerering som tilhører kilden, beholdes: kildelister [1], [2], lovparagrafer, nummererte prinsipper og figurnumre.
Lenke til en overskrift
Hold musepekeren over en overskrift eller sidetittelen, så vises et lenkeikon. Klikk på det for å kopiere lenken til overskriften (eller siden) til utklippstavlen.
Oppgaver og framdrift
Delprosjekter og løsninger med oppgaver i GitHub har siden «Oppgaver og framdrift». Den står rett etter «Om …» (eller «Bakgrunn og begrunnelse»), og først der det ikke finnes en slik side.
Konvensjoner for bestemte seksjoner
- Piloter: se Dokumentasjon av piloter i Arbeidsmodell.