Tegenwoordig maak ik voor elke website die ik bouw een logboek. Waarom? Omdat ik na een tijdje niet meer weet wat ik waar heb aangepast.
So what? zul je zeggen.. Nou, als er een update wordt uitgebracht van het script waarmee ik de site bouw (voor mij is dat WordPress of WebsiteBaker) dan kan het zomaar gebeuren dat er iets wordt overschreven dat ik juist zo handig had bedacht. Of dat iets niet meer werkt waardoor ik word gedwongen een trucje (even) op te heffen, maar welk trucje en waar? Zo kunnen er meer redenen zijn om bij te houden hoe je je site hebt aangepakt en aangepast.
Dat logboekje hoeft niet super uitgebreid te zijn: bij mij bestaat het uit een tekstbestandje dat ik lokaal in de directory van de klant op sla. Waar mogelijk verwijs ik daarin naar commentaren die ik in de code van de scripts of de plugins heb opgenomen en die beschrijven wat is veranderd of toegevoegd (voorbeeld: header.php: regel 15 toegevoegd).
Ik doe het nog te kort om te kunnen zeggen of het werkt maar één ding is zeker: niets documenteren levert waarschijnlijk veel meer werk op en mogelijk zelfs een website die je bijna opnieuw kunt gaan maken.
Iemand die ook zoiets doet?
Lees meer over het aanbrengen van commentaar in gemengde php / HTML code