Van ontwikkelaar naar technisch schrijver: de zaak van de Java-ontwikkelaars

Een grote internationale maker van computersystemen droeg systematisch bij aan de ontwikkeling van open source software. Tal van werknemers hadden als taak het ontwikkelen van stukken code die vervolgens kosteloos aan de gemeenschap ter beschikking werd gesteld. Die code moest natuurlijk worden gedocumenteerd, maar ook nog een technisch schrijver inzetten ging onze opdrachtgever net iets te ver.

Wat we deden

Wat de ontwikkelaars maakten, moesten ze ook zelf documenteren. De betrokken software-engineers kregen daarom de kans deel te nemen aan een tweedaagse workshop. Daarin leerde een consultant van Byte Ryte ze om precies het soort software dat ze maakten, te documenteren voor precies de doelgroep die de software zou gaan gebruiken. Het werd een sterk interactieve, op de praktijk gerichte cursus. Na afloop konden ze de voor hun zo wezensvreemde taak van "documentatie maken" met vertrouwen tot een succesvol einde brengen.

Hoe we het deden

In twee dagen kan je van programmeurs geen schrijvers maken—maar dat hoefde ook helemaal niet. De cursus was op maat gemaakt en toegespitst op de specifieke situatie, waarbij ook in aanmerking was genomen de (meest Oosteuropese) achtergrond van de deelnemers. De uitdaging daarbij was om ze te voorzien van praktisch toepasbare methoden en technieken. Uiteindelijk konden ze zo'n 90% van de code die ze schreven zodanig documenteren, dat het resultaat voor 90% van de lezers toereikend was.