In veel organisaties is de documentatiedrift doorgeslagen en is documenteren een doel op zich geworden. Documentatie moet echter, net als de beschreven software, worden bijgehouden. Het is dus verstandig om goed na te denken over wat je documenteert, en hoe.
In een vorige column heb ik het gehad over softwarerot: het verschijnsel dat wijzigingen aan een stuk software na verloop van tijd de oorspronkelijke ontwerpfilosofie steeds meer geweld aandoen, waardoor de beruchte spaghetticode ontstaat. Aan de maatregelen die ik toen noemde (codereviews, gegenereerde documentatie en training van nieuwe medewerkers) wil ik er nog een toevoegen die ik al meermalen succesvol heb toegepast: het schrijven van kookboeken.
Net als de kookboeken die thuis in de keuken staan, bevatten ook deze kookboeken collecties met recepten. Maar in plaats van een lekkere quiche of pasta zijn dit recepten die andere software-engineers stapsgewijs uitleggen hoe ze bepaalde uitbreidingen of wijzigingen moeten doorvoeren.
This article is exclusively available to premium members of Bits&Chips. Already a premium member? Please log in. Not yet a premium member? Become one for just €20 for the first year and enjoy all the benefits.
