5. Schrijfvaardigheden voor Servicedesk-documentatie

Documenteren is niet alleen een kwestie van informatie vastleggen. Het is een vaardigheid. Een ambacht zelfs. Goede documentatie is helder, logisch, prettig leesbaar en vooral bruikbaar. Het helpt collega’s om hun werk goed te doen, voorkomt fouten en bespaart tijd. Slechte documentatie doet precies het tegenovergestelde: het frustreert, vertraagt en zorgt voor misverstanden.

In dit hoofdstuk gaan we in op de kunst van het schrijven. Niet op een academische manier, maar op een manier die past bij de Servicedesk: praktisch, duidelijk en direct toepasbaar.

Schrijven begint met begrijpen

Voordat je ook maar één woord opschrijft, moet je begrijpen wat je aan het documenteren bent. Dat klinkt vanzelfsprekend, maar is de praktijk wordt dit vaak overgeslagen. Iemand voert een taak uit, schrijft snel op wat hij doet, en klaar. Maar documentatie die alleen beschrijft wat je doet, mist vaak de essentie: waarom je het doet, wanneer je het doet en wat er mis kan gaan.

Goede documentatie begint met drie vragen:

Wat is het doel van deze taak?
Niet alleen “een mailbox toevoegen”, maar “zorgen dat een medewerker toegang heeft tot een gedeelde mailbox”.
Wie gaat dit document gebruiken?
Een ervaren collega heeft andere informatie nodig dan iemand die net begint.
Wat moet iemand weten om dit zonder fouten te kunnen uitvoeren?
Denk aan uitzonderingen, valkuilen, foutmeldingen en afhankelijkheden.

Wanneer je deze drie vragen helder hebt, wordt het schrijven veel eenvoudiger.

Schrijven in duidelijke, begrijpelijke taal

Documentatie hoeft niet mooi te zijn. Het hoeft niet literair te zijn. Het moet duidelijk zijn. Dat betekent dat je schrijft in gewone taal, zonder onnodige ingewikkeldheid. Veel technische mensen hebben de neiging om te schrijven zoals ze denken: compact, vol jargon en soms wat rommelig. Maar documentatie moet juist het tegenovergestelde zijn.

Duidelijke taal betekent:

korte zinnen;
actieve formulering (“Klik op…”, niet “Er kan worden geklikt op…”);
geen overbodige woorden;
geen jargon dat niet nodig is;
uitleg waar dat wel nodig is.

Het doel is dat iemand die het document leeft, niet hoeft ne te denken over de tekst, maar alleen over de taak.

Structuur is belangrijkste dan stijl

Een goed document is logisch opgebouwd. De lever moet intuïtief begrijpen waar hij informatie kan vinden. Een vaste structuur helpt daarbij enorm. Het maakt documentatie voorspelbaar, herkenbaar en makkelijk te scannen.

Een werkinstructies heeft bijvoorbeeld bijna altijd dezelfde opbouw:

doel van de taak;
wanneer deze taak uitvoert;
wat je nodig hebt;
de stappen;
foutscenario’s;
bijzonderheden of uitzonderingen.

Een handleiding voor eindgebruikers heeft weer een andere structuur, omdat de doelgroep anders is. Maar ook daar geldt: consistentie is goud waard.

Wanneer alle documenten dezelfde opbouw hebben, voelt het alsof je een goed georganiseerde gereedschapskist opent. Je weer precies waar alles ligt.

Schrijven voor scanners, niet voor lezers

De meeste mensen lezen documentatie niet van begin tot eind. Ze scannen. Ze zoeken naar het stukje informatie dat ze nodig hebben. Daarom moet documentatie scanbaar zijn.

Dat betekent:

duidelijke kopjes;
witruimte tussen alinea’s;
korte paragrafen;
visuele aanwijzingen zoals vetgedrukte termen of genummerde stappen;
geen lange blokken tekst.

Een document dat eruitziet als een muur van tekst wordt niet gelezen. Een document dat overzichtelijk is, wordt gebruikt.

Schrijven met de gebruiker in gedachten

Elke doelgroep heeft zijn eigen manier van denken. Een Servicedesk-medewerker denkt anders dan een eindgebruiker. Een nieuwe collega denkt anders dan iemand die al jaren meedraait. Daarom moet je altijd schrijven vanuit het perspectief van de gebruiker.

Stel jezelf steeds de vraag:

Wat heeft deze persoon nodig om dit goed te kunnen doen?

Voor een nieuwe medewerker betekent dat meer uitleg.

Voor een ervaren collega betekent dat minder tekst en meer kern.

Voor een eindgebruiker betekent dat eenvoud en geruststelling.

Wanneer je schrijft vanuit de gebruiker, wordt documentatie vanzelf beter.

Voordelen en context maken alles duidelijker

Een instructie die alleen stappen bevat, is functioneel. Maar een instructie die ook context geeft, is veel krachtiger. Bijvoorbeeld:

“Gebruik deze instructie wanneer een medewerker geen toegang heeft tot de gedeelde mailbox ‘Financiën’.”
“Let op: deze mailbox wordt gebruikt door meerdere afdelingen. Controleer altijd of de medewerker de juiste rechten heeft.”

Context helpt de lezer begrijpen waarom iets belangrijk is. Het voorkomt fouten en maakt het document waardevoller.

Voorbeelden werken hetzelfde. Een screenshot van de juiste instelling, een voorbeeld van een foutmelding of een korte toelichting op een veelvoorkomend probleem kan het verschil maken tussen succes en frustratie.

Schrijven is schrappen

Een van de belangrijkste vaardigheden bij documenteren is het vermogen om te schrappen. Veel documenten worden onnodig lang omdat schrijvers alles willen uitleggen Maar documentatie moet niet alles uitleggen, alleen wat nodig is.

Vraag jezelf bij elke zin af:

Draagt dit bij aan het doel van het document?

Zo niet, dan kan het weg.

Korte documenten worden vaker gelezen. En documenten die vaker gelezen worden, worden vaker gebruikt.

Documenteren is een teamactiviteit

Hoewel iedereen individueel documenten schrijft, is documenteren iets dat je als team doet. Niemand heft alles kennis. Niemand ziet alle uitzonderingen. Niemand maakt nooit fouten. Daarom is feedback essentieel.

Laat collega’s je document testen. Laat iemand die de taak niet kent de instructie volgen. Laat een ervaren collega controleren of de stappen kloppen. Laat iemand met frisse ogen kijken naar de structuur.

Documentatie die door meerdere mensen is gezien, is beter dan documentatie die door één persoon is geschreven en nooit is gecontroleerd.

De kracht van een uniforme schrijfstijl

Wanneer alle medewerkers op dezelfde manier schrijven, ontstaat rust. Documenten voelen vertrouwd, ongeacht wie ze heeft geschreven. Dat maakt het makkelijker om nieuwe documenten te maken en om bestaande documenten te gebruiken,

Een uniforme schrijfstijl betekent niet dat iedereen exact hetzelfde moet schrijven, maar wel dat iedereen dezelfde principes volgt: