Deze week probeerde ik een bug (een foutje) uit te leggen aan een van mijn klanten:
“Het probleem is opgelost. Omdat ik weet dat je het op prijs stelt om te weten hoe het zit zal ik het uitleggen: Om de gegevensuitvraag te versnellen hebben we 2 verschillende caches, dit zo gegroeid, een tijdelijke en een langdurige. De fout zat ‘m in het feit dat de langdurige cache niet werd bijgewerkt omdat de tijdelijke cache aangaf dat er niets veranderd was, terwijl in het echt wel iets veranderd was. De langdurige cache, waarvan we gebruik maken tijdens het sorteren werd dus niet bijgewerkt. Aangezien de kortdurende cache eigenlijk overbodig is geworden toen we de langdurige hebben gebouwd, heb ik deze er tussenuitgehaald.”
‘Verrassend’ genoeg kwam dat niet over. Toen hetzelfde verhaaltje opnieuw getypt, maar dan met net iets andere acteurs:
“Het probleem is opgelost. Omdat ik weet dat je het op prijs stelt om te weten hoe het zit zal ik het uitleggen. Omdat Jan nogal traag is met het opzoeken van het antwoord hadden we al Marie en sinds een tijdje Piet in dienst. Marie onthoudt het tijdelijk en Piet voor altijd. Omdat Piet steeds aan Marie vroeg of er iets gewijzigd was en Marie nog wel dacht dat ze het wist, terwijl Jan ondertussen wel een ander antwoord zou geven, werd het antwoord van Piet ook niet anders. Voor de werking van het systeem is met het aannemen van Piet de rol van Marie overbodig geworden. Nu Marie ontslagen is (in deze rol) kan de fout niet meer voorkomen: Piet vraagt nu altijd rechtstreeks aan Jan of er nog wijzigingen zijn. En hiermee kan Piet weer goed sorteren.”
En het kwam over. Ik merk twee wijzigingen op: de tekst is vrij van ‘moeilijke termen’, maar ook de tekst is iets anders gaan lopen. Door technische terminologie te vermijden ga je ook proberen helderder te schrijven. Meer Jip en Janneke, zeg maar…
Vond je dit leuk, volg me op Mastodon, voeg die RSS, euh ATOM feed toe aan je feedreader, of schrijf je hieronder in op mijn nieuwsbrief.
Dit artikel van murblog van Maarten Brouwers (murb) is in licentie gegeven volgens een Creative Commons Naamsvermelding 3.0 Nederland licentie .