Software-engineers en andere IT'ers hebben een gruwelijke hekel aan documenteren. Deels omdat beschrijven en uitleggen altijd na het werk komt waarvoor ze eigenlijk gekozen hebben. Ze gaan liever aan de slag met het volgende probleem. Deels omdat ze vinden dat de geïmplementeerde oplossing voor zich spreekt. En ten slotte omdat ze niet van de woorden zijn en documenteren dus relatief veel van hun tijd in beslag neemt.
Een bijkomend probleem is de doelgroep. Schrijf je als IT'er voor je collega's, die onderhoud moeten plegen en aanvullende code moeten schrijven? Of voor de gebruiker? En wie is die gebruiker dan? Is het een applicatie- of systeembeheerder, van wie je wel wat voorkennis mag verwachten? Hoeveel voorkennis dan? Of is het een eindgebruiker, die nog helemaal in de denkwijze van de software-engineer ingevoerd moet worden? Voor wie iedere overgeslagen, ongedocumenteerde stap tot frustratie leidt?
En heb je je toch met tegenzin in dit mijnenveld 'documenteren' laten jagen, dan krijg je te maken met softwareversies, met klanten die bepaalde opties niet hebben aangeschaft, met aansluitingsproblemen met software van andere leveranciers, met workarounds waar je niet trots op bent …
Lees meer
Dit keer een puur informatieve tekst zonder mijn gekleurde blik: over doelgericht en lezergericht schrijven. Saai? Helemaal niet!
Lees meer