DRAFT VERSION - NOT AN OFFICIALLY APPROVED DOCUMENT
Dokumentation i OS2-produkter og -projekter
Åbenhed og videndeling er grundlæggende principper i OS2. Dokumentation bør derfor være tilgængelig og til at finde – også for personer, der ikke kender produktets eller projektets organisering.
En tydelig dokumentationsstruktur gør det muligt at finde beslutninger, aftaler og viden og understøtter kontinuiteten, når personer og roller skifter.
Indholdsfortegnelse
Ansvar for dokumentation
Det enkelte OS2-produkt eller -projekt har ansvar for at:
- Tage stilling til, hvor forskellige typer dokumentation opbevares.
- Gøre dokumentationsstrukturen synlig og forståelig for andre.
- Holde informationen om dokumentationsstrukturen opdateret.
- Sikre, at relevant dokumentation er offentligt tilgængelig, medmindre der er en konkret grund til at begrænse adgangen.
Fælles praksis
Nextcloud og GitHub er OS2’s fælles værktøjer til fildeling og dokumentation.
Alle produkter og projekter forventes at have en README-fil i deres offentlige Nextcloud-mappe. Den fungerer som vejviser til dokumentationen, uanset hvor den opbevares.
Enkelte produkter og projekter anvender også andre platforme. Disse bør fremgå af README-filen, så dokumentationen fortsat kan findes.