Al din kodebase funktionalitet – politisk såvel som kildekode – SKAL beskrives i et sprog, der er let at forstå for dem, der forstår formålet af koden.
Dokumentationen SKAL indeholde:
En beskrivelse af hvordan man installerer og kører kildekoden,
Eksempler, der demonstrerer nøglefunktionaliteten.
Dokumentationen BØR indeholde:
En beskrivelse på højt niveau, det er enkelt at forstå for et bredt publikum af interessenter, så som den generelle offentlighed og journalister,
En sektion, der beskriver, hvordan man installerer og kører en enkeltstående version af kildekoden inklusive, hvis nødvendigt, et testdatasæt,
Eksempler for at funktionaliteter.
Der BØR være fortsatte integrationstests af kvalitet af din dokumentation.
Dokumentationen MÅ indeholde eksempler, som giver brugere lyst til at bruge din kodebase med det samme.
Du MÅ bruge eksempler i din dokumentation for at teste din kode.
Hvorfor er dette vigtigt
Brugerne kan begynde at bruge og bidrage hurtigere.
Du hjælper folk med at opdage din kodebase, særligt folk der spørger ”er der allerede kode, som gør noget lignende dette”.
Det giver gennemsigtighed i din organisation og processer.