7. Documenteren in de praktijk: van taak naar instructie

Documenteren begint niet met schrijven, maar met doen. De beste werkinstructies ontstaan wanneer iemand een taak uitvoert en tegelijkertijd observeert wat er gebeurt: welke stappen neem je, waar moet je op letten, welke foutmeldingen kun je tegenkomen, en welke keuzes maak je onderweg?

In dit hoofdstuk laten we zien hoe je van een uitgevoerde taak een duidelijke, bruikbare en complete werkinstructie maakt. Niet door ingewikkelde theorie, maar praktische aanpak die past bij de Servicedesk.

Begin bij de taak, niet bij de tekst

Veel mensen beginnen met schrijven terwijl ze de taak nog niet volledig hebben doorlopen. Dat leidt bijna altijd tot onvolledige instructies. Je vergeet stappen, je mist details of je schrijft dingen op die in de praktijk anders blijken te werken.

De beste manier om een werkinstructie te maken is simpel:

Voer de taak uit alsof je hem voor het eerst doet.

En schrijf op wat je ziet, doet en denkt.

Dat betekent:

je klikt bewust op elke knop;
je let op wat er op het scherm gebeurt;
je noteert elke stap, ook de kleine;
je kijkt kritisch naar foutmeldingen of varianten;
je observeert waar je twijfelt, dat zijn vaak de plekken waar anderen ook vastlopen.

Wanneer je de taak uitvoert met de ogen van een nieuwe collega, ontstaat vanzelf een instructie die helder en bruikbaar is.

Schrijf eerst ruw, perfectioneer later

Een veel gemakte fout is dat mensen tijdens het schrijven al proberen om alles perfect te formuleren. Dat vertraagt het proces enorm en maakt het schrijven onnodig zwaar.

De truc is om eerst een ruwe versie te maken. Gewoon opschrijven wat je doet, zonder te letten op stijl, structuur of formulering. Pas daarna ga je het document netjes maken.

Een ruwe versie kan er zo uitzien:

“Klik op dat blauwe ding rechtsboven.”
“Hier moet je even wachten, duurt soms lang.”
“Als je foutmelding krijgt, opnieuw proberen.”

Dat is prima. Het belangrijkste is dat de informatie er staat. De verfijning komt later.

Bouw de instructie op in logische onderdelen

Wanneer de ruwe versie klaar is, ga je de instructie structureren. Een goede werkinstructie heeft een vaste opbouw die de lezer helpt om snel te begrijpen wat hij moet doen.

Een logische structuur bestaat meestal uit:

Doen van de taak

Waarom bestaat deze instructie? Wat bereik je ermee?

Wanneer gebruik je deze instructie?

In welke situatie is die de juiste aanpak?

Wat heb je nodig?

Denk aan rechten, toegang, software, gegevens of voorbereidingen.

De stappen

Duidelijk, genummerd, stap voor stap.

Foutscenario’s en oplossingen

Wat kan er misgaan en wat moet je dan doen?

Bijzonderheden of varianten

Zijn er uitzonderingen? Afwijkende situaties? Alternatieve routes?

Deze structuur zorgt ervoor dat de instructie niet alleen uitvoerbaar is, maar ook begrijpelijk en compleet.

Schrijf de stappen alsof je iemand begeleidt

De stappen vormen het hart van de instructie. Ze moeten helder, concreet en uitvoerbaar zijn. Een goede stap beschrijft precies wat iemand moet doen, zonder ruimte voor interpretatie.

Vergelijk:

Slecht:

“Open Outlook en voeg de mailbox toe.”

Goed:

“Open Outlook. Klik linksboven op Bestand. Kies vervolgens voor Accountinstellingen en klik op Accountinstellingen… Selecteer het tabblad E-mail en klik op Nieuw. Vul het emailadres van de gedeelde mailbox in en klik op Volgende.”

Het verschil zit in de details. De tweede versie laat geen twijfelbestaan over wat je moet doen.

Voeg screenshots toe waar dat helpt

Screenshots zijn geen verplichting, maar ze kunnen een instructie enorm versterken. Vooral wanneer:

knoppen lastig te vinden zijn;
schermen op elkaar lijken;
foutmeldingen visueel zijn;
er meerdere opties zijn en je de juiste wilt aanwijzen.

Een screenshot moet altijd ondersteunend zijn, nooit leidend. Het is een hulpmiddel, geen vervanging van tekst. Zorg dat screenshots actueel blijven, verwijderde afbeeldingen zorgen voor verwarring.

Denk aan foutmeldingen en uitzonderingen

Een instructie die alleen werkt wanneer alles goed gaat, is niet compleet. In de praktijk gaat er regelmatig iets mis: een account bestaat al, een knop is grijs, een systeem reageert niet, een gebruiker heeft onvoldoende rechten.

Daarom is het belangrijk om foutscenario’s op te nemen:

Wat kan er misgaan?
Wat betekent de foutmelding?
Wat moet je doen om het op te lossen?
Wanneer moet je escaleren?

Dit is vaak het verschil tussen een instructie die werkt en een instructie die frustratie oplevert.

Test de instructie met iemand anders

De beste manier om te controleren of een instructie werkt, is door iemand anders hem te laten uitvoeren. Niet iemand die de taak al kent, maar iemand die hem nog nooit heeft gedaan.

Wanneer die persoon de taak foutloos kan uitvoeren, weet je dat de instructie goed is. Wanneer hij vastloopt, weet je precies waar je moet verbeteren.

Testen is geen luxe, maar een essentieel onderdeel van documenten.

Maak het document af: toon, stijl en consistentie

Wanneer de inhoud klopt, ga je het document netjes maken:

controleer spelling en grammatica;
zorg dat de toon past bij de doelgroep;
maakt de opmaak consistent;
gebruik dezelfde termen als in andere documenten;
verwijder overbodige tekst;
voeg metadata toe (versie, datum, eigenaar).

Dit is de fase waarin de instructie verandert van een ruwe schets in een professioneel document.

Publiceer het document op de juiste plek

Een instructie is pas waardevol wanneer mensen hem kunnen vinden. Publiceer hem daarom op de centrale plek waar alle documentatie staat. Zorg dat de titel duidelijk is, dat het document in de juiste categorie staat en dat collega’s weten dat het bestaat.

Een goede instructie die niemand kan vinden, ie het zo nutteloos als geen instructie.

Documenteren als onderdeel van het werk

Het doel van dit hoofdstuk is niet om documentatie ingewikkeld te maken, maar juist om het toegankelijk te maken. Wanneer je deze stappen volgt, wordt documenteren een natuurlijk onderdeel van het werk: