Documenteer de doelstellingen
Het duidelijk documenteren van de doelstellingen van de codebase communiceert de bedoeling van de codebase. Het helpt belanghebbenden en bijdragers de ontwikkeling van de codebase af te kaderen. De doelstellingen bieden ook een gemakkelijke manier voor mensen om te beslissen of deze codebase, of een van modules ervan, nu of in de toekomst interessant voor hen is.
Vereisten
-
De codebase MOET documentatie bevatten over haar doelstellingen, zoals een missie- en doelstatement, die begrijpelijk is voor ontwikkelaars en ontwerpers zodat zij de codebase kunnen gebruiken of eraan kunnen bijdragen.
-
De documentatie van de codebase ZOU duidelijk de verbanden tussen de beleidsdoelstellingen en de doelstellingen van de codebase MOETEN beschrijven.
-
Het documenteren van de doelstellingen van de codebase voor het algemeen publiek is OPTIONEEL.
Hoe te testen
-
Controleer of de documentatie van de codebase de doelstellingen, de missie of het doel bevat.
-
Controleer op beschrijvingen van verbanden tussen de beleidsdoelstellingen en de doelstellingen van de codebase.
Beleidsmakers in de publieke sector: wat je moet doen
-
Voeg de beleidsdoelstellingen toe aan de documentatie van de codebase, bijvoorbeeld in de
README. -
Zorg ervoor dat aan al je doelstellingen van de codebase koppelingen of verwijzingen naar ondersteunende beleidsdocumenten zijn toegevoegd om te voldoen aan het criterium voor bundelen van beleid en broncode.
Managers: wat je moet doen
- Voeg de organisatie- en bedrijfsdoelstellingen toe aan de documentatie van de codebase, bijvoorbeeld in de
README.
Ontwikkelaars en ontwerpers: wat je moet doen
- Voeg de technologie- en ontwerpdoelstellingen toe aan de documentatie van de codebase, bijvoorbeeld in de
README.
Meer informatie
- How to write project objectives door Marek Hajduczenia.