Principper for dokumentation
Udviklingsleverandørerne skal vedligeholde den eksisterende dokumentation som den forefindes på STAR’s WIKI.
Dokumentationen er primært fremkommet gennem releaseprocessen, hvor opdateret dokumentation er en del af releasens godkendelseskriterier.
STAR ønsker at dokumentation udarbejdes ud fra følgende principper:
P30 | Dokumentation målrettet kørende kode Fokus er leverance af kørende kode. Dette betyder, at dokumentationen skal udarbejdes med det formål at sikre kørende kode. Dette omfatter dokumentation, der understøtter idriftsættelse, videreudvikling og vedligehold, integration med eksterne parter og evt. overdragelse til ny leverandør. |
|---|---|
P31 | Overordnet dokumentation målrettet grundlæggende forståelse Dokumentation, der ikke er tæt knyttet til kørende kode, giver værdi ved at beskrive vores systemlandskab på et så højt niveau, at den bidrager til umiddelbar forståelse for systemernes funktion og indretning. |
P32 | Korrekt dansk STAR mener, at god og korrekt anvendelse af dansk i dokumentation og kommunikation giver bedre kvalitet. |