Documenteren lijkt soms eenvoudiger dan het is. Je voert een taak uit, je schrijft op wat je doet en klaar. Maar in de praktijk ontstaan er allerlei valkuilen die ervoor zorgen dat documentatie onduidelijk, onvolledig of onbruikbaar wordt. Niet omdat mensen het verkeerd bedoelen, maar omdat documentatie een vaardigheid is die je moet ontwikkelen.
Is dit hoofdstuk bespreken we de meest voorkomende valkuilen binnen de Servicedesk en hoe je ze voorkomt. Het doel is niet om met een vinger te wijzen, maar om inzicht te geven. Want wanneer je weet waar het mis kan gaan, kun je documentatie maken die echt werkt.
De valkuilen van aannames
Een van de grootste velkuilen is aannemen dat iets “vanzelfsprekend” is. Voor jou misschien wel (je doet de taak al jaren) maar voor een collega die het voor het eerst doet, is niets vanzelfsprekend.
Aannames leiden tot instructies zoals:
- “log even in op de server.”
- “Zorg dat je rechten kloppen.”
- “Controleer of alles goed staat.”
Maar wat betekent dat precies? Welke server? Welke rechten? Wat is “goed”?
Hoe voorkom je dit?
Schrijf alsof je iemand begeleidt die de taak voor het eerst uitvoert. Niet omdat je collega’s dom zijn, maar omdat duidelijkheid fouten voorkomt.
De valkuil van te veel detail
Het tegenovergestelde komt ook voor: instructies die zo gedetailleerd zijn dat ze onleesbaar worden. Bijvoorbeeld wanneer elke muisbeweging wordt beschreven, of wanneer er tien screenshots staan van hetzelfde scherm.
Te veel detail maakt een document zwaar, lang en moeilijk te scannen. Het vertraagt in plaats van helpt.
Hoe voorkom je dit?
Beschrijf alleen wat nodig is om de taak foutloos uit te voeren. Niet meer, niet minder.
De valkuil van verouderde documentatie
Niets veroudert zo snel als IT-documentatie. Een update, een nieuwe interface, een wijziging in een proces en ineens klopt de instructie niet meer. Verouderde documentatie is gevaarlijker dan geen documentatie, omdat het medewerkers op het verkeerde been zet.
Hoe voorkom je dit?
Door documentatie te behandelen als een levend systeem. Regelmatige reviews, eigenschap en versiebeheer zijn essentieel.
De valkuil van inconsistentie
Wanneer verschillende medewerkers op verschillende manieren documenteren, ontstaat een rommeltje. De ene instructie begint met een doel, de andere niet. De ene gebruikt screenshots, de andere niet. De ene is technisch, de andere juist heel simpel.
Inconsistentie maakt documentatie onvoorspelbaar. Je weet nooit wat je kunt verwachten.
Hoe voorkom je dit?
Werk met templates en een uniforme schrijfstijl. Dat geeft rust en herkenbaarheid.
De valkuil van te veel jargon
Binnen de Servicedesk is jargon normaal. Iedereen weet wat AD, MFA, SSO, RDP of Intune betekent. Maar niet iedereen die documentatie leest, heeft dezelfde achtergrond. Nieuwe medewerkers kunnen verdwalen in afkortingen en technische termen.
Hoe voorkom je dit?
Gebruik jargon alleen wanneer je zeker weet dat de doelgroep het begrijpt. En leg het uit wanneer dat nodig is.
De valkuil van “ik doe het wel even”
Soms is het sneller om een taak gewoon uit te voeren dan om hem te documenteren. Zeker wanner het druk is. Maar elke keer dat je denkt “ik doe het wel even”, ontstaat er een gat in de kennisbasis. En dat gat wordt groter naarmate meer mensen ze denken.
Hoe voorkom je dit?
Door documenteren onderdeel te maken van het werk. Niet iets extra’s, maar iets noodzakelijks.
De valkuil van kopiëren zonder nadenken
Het is verleidelijk om een oude instructie te kopiëren en aan te passen. Maar vaak sluipen er dan fouten in: oude screenshots, verouderde stappen, verkeerde titels of vergeten uitzonderingen.
Hoe voorkom je dit?
Gebruik kopiëren als startpunt, niet als eindpunt. Controleer elke stap alsof je hem voor het eerst schrijft.
De valkuil van onduidelijke titels
Een instructie met de titel “Mailbox” of “VPN” zegt niets. Collega’s moeten kunnen zien wat een document doet zonder het te openen.
Hoe voorkom je dit?
Gebruik titels die beginnen met een werkwoord en het doel duidelijk maken, zoals:
- “Gedeelde mailbox toevoegen in Outlook”
- “VPN-client installeren op Windows”
- “Nieuwe gebruiker aanmaken in Azure AD”
Een goede titel bespaart iedereen tijd.
De valkuil van geen feedback vragen
Documentatie die nooit door iemand anders is gezien, bevat bijna altijd fouten. Niet omdat de schrijver slecht is, maar omdat niemand alles ziet.
Hoe voorkom je dit?
Laat collega’s je document testen. Laat iemand die de taak niet kent de instructie doorlopen. Feedback maakt documentatie beter.
De valkuil van vergeten context
Soms beschrijft een instructie perfect hoe je iets doet, maar niet wanneer of waarom. Daardoor weten medewerkers niet of ze de juiste instructie gebruiken.
Hoe voorkom je dit?
Begin elk document met een korte uitleg:
- Wat is het doel?
- Wanneer gebruik je dit?
- Voor wie is het bedoeld?
Context maakt een document bruikbaar.
De valkuil van “dit is wel duidelijk”
De grootste valkuil is denken dat iets duidelijk is. Want duidelijkheid is relatief. Wat voor jou logisch is, kan voor een ander totaal onduidelijk zijn.
Hoe voorkom je dit?
Door te schrijven met empathie. Door je te verplaatsen in de lezer. Door te testen. Door te verbeteren. Documenteren is geen eenmalige actie maar een doorlopend proces van leren en aanscherpen.
