Een handleiding schrijven die mensen meteen begrijpen

Klanten mailen de klantenservice, nieuwe medewerkers stellen steeds dezelfde vragen, en een taak die "volgens de instructies" is uitgevoerd, gaat toch mis. Meestal ligt het aan de instructie zelf: geschreven door iemand die de taak te goed kent om te zien waar een nieuwkomer vastloopt. Dit zijn zeven regels waarmee instructies in één keer werken, of het nu gaat om een gebruikershandleiding, een artikel in het helpcentrum of een werkinstructie.

1. Eén taak per instructie

"Zo stel je je account in" is te breed. "Zo wijzig je je wachtwoord" en "Zo voeg je een teamlid toe" zijn twee aparte instructies. Een lezer zoekt één taak, vindt die, voert hem uit en gaat weer.

2. Begin met het resultaat en wat je nodig hebt

Zeg in de eerste twee regels wat de lezer gaat bereiken en wat hij nodig heeft voordat hij begint: toegangsrechten, een bestand, een wachtwoord, tien minuten tijd. Niets is frustrerender dan bij stap 7 ontdekken dat je vanaf het begin iets nodig had.

3. Genummerde stappen, elk met één actie

Elke stap is één actie en begint met een werkwoord: "Open Instellingen", "Klik op Opslaan". Staat er "en dan" in een stap, dan zijn het twee stappen. Met nummers houdt de lezer bij waar hij is en kan de klantenservice zeggen "zie stap 4".

4. De woorden van de lezer, niet die van jou

Schrijf de namen van knoppen en menu's precies zoals de lezer ze op het scherm ziet. Vermijd interne vaktaal en afkortingen; is een term onvermijdelijk, leg hem dan de eerste keer uit.

5. Laat zien wat er moet gebeuren

Beschrijf na een belangrijke stap het resultaat: "Er verschijnt een groene melding: Opgeslagen". De lezer weet dan dat hij op de goede weg is, en merkt het meteen als er iets misgaat.

6. Waarschuwingen voor de stap, niet erna

"Exporteer je gegevens voordat je op Verwijderen klikt: verwijderde gegevens kun je niet terugzetten." Een waarschuwing na de stap komt te laat.

7. Test het bij iemand die nieuw is

Geef de instructie aan iemand die de taak nog nooit heeft gedaan en kijk mee zonder te helpen. Elke plek waar hij aarzelt, iets vraagt of een fout maakt, moet je herschrijven. Vijf minuten testen levert meer problemen op dan een uur herlezen.

Beelden en structuur

• Screenshots voor stappen op een scherm, met de juiste knop gemarkeerd; werk ze bij als de interface verandert.
• Koppen bij lange procedures, zodat de lezer naar het deel kan springen dat hij nodig heeft.
• Een onderdeel "Wat als" aan het eind voor veelvoorkomende problemen: "Heb je de e-mail niet ontvangen, kijk dan in je spammap".

Kort samengevat

Eén taak, eerst het resultaat en wat je nodig hebt, genummerde stappen met één actie, de woorden van de lezer, het verwachte resultaat, waarschuwingen op tijd en een test bij een echte persoon. Heb je een handleiding, een set helpartikelen of werkinstructies nodig, bestel dan handleidingen en werkinstructies: je beschrijft het product of proces en krijgt duidelijke, gestructureerde instructies. De betaling wordt pas vrijgegeven nadat je het werk hebt goedgekeurd.