Documenteer de doelstellingen van de codebase
Duidelijk documenteren van de doelstellingen van een codebase communiceert het doel van de codebase. Het helpt belanghebbenden en bijdragers om de ontwikkeling van de codebase af te bakenen. De doelstellingen bieden ook een eenvoudige manier voor mensen om te beslissen of deze codebase, of een van de modules ervan, nu of in de toekomst interessant voor hen is.
Vereisten
- De codebase MOET documentatie bevatten van zijn doelstellingen, zoals een missie en doelverklaring, die begrijpelijk is voor ontwikkelaars en ontwerpers zodat zij de codebase kunnen gebruiken of eraan kunnen bijdragen.
- Codebase documentatie ZOU duidelijk de verbanden tussen beleidsdoelstellingen en codebase doelstellingen moeten beschrijven.
- Het documenteren van de doelstellingen van de codebase voor het algemene publiek is OPTIONEEL.
Quickscan
- Bevestig dat de codebase documentatie de codebase doelstellingen, missie of doel bevat.
- Controleer op beschrijvingen van verbanden tussen beleidsdoelstellingen en codebase doelstellingen.
Aanwijzingen voor beleidsmakers
- Voeg de beleidsdoelstellingen toe aan de codebase documentatie, bijvoorbeeld in de
README. - Zorg ervoor dat al uw codebase doelstellingen links of verwijzingen naar ondersteunende beleidsdocumenten hebben om te voldoen aan het criterium Bundel beleid en broncode.
Aanwijzingen voor managers
- Voeg de organisatorische en zakelijke doelstellingen toe aan de codebase documentatie, bijvoorbeeld in de
README.
Aanwijzingen voor ontwikkelaars en ontwerpers
- Voeg de technologie- en ontwerpdoelstellingen toe aan de codebase documentatie, bijvoorbeeld in de
README.
Meer informatie
- How to write project objectives door Marek Hajduczenia.