Een klanthandleiding schrijven rond één taak

Een klanthandleiding beschrijft hoe iemand een concrete taak uitvoert met uw product of dienst. Begin met het doel, de voorwaarden en het herkenbare eindresultaat. Schrijf daarna de stappen in uitvoeringsvolgorde. De lezer moet kunnen vaststellen waar hij is en wat hij doet wanneer een stap niet lukt.

Een handleiding is geen verkooptekst na aankoop. Ze helpt iemand handelen. Neem daarom alleen stappen op die u inhoudelijk heeft gecontroleerd. Voor veiligheidsgevoelige handelingen zijn geschikte vakkennis en productspecifieke instructies nodig. Een helder geschreven tekst kan een onveilige of onvolledige werkwijze niet verantwoord maken.

Begrens de taak en het vertrekpunt

Een titel zoals “Uw klantenportaal gebruiken” is vaak te breed. “Een eerder opgeslagen adres wijzigen” noemt een taak met een eindpunt. Bepaal welke versie van het product of de toepassing wordt beschreven. Bij veranderende software kan een intern versienummer of controledatum helpen om de instructie te onderhouden.

Noteer wat de lezer vooraf nodig heeft: toegang, informatie of materiaal. Verwar een voorwaarde niet met een stap. Iemand die nog geen account heeft, moet vóór de uitleg weten dat aanmelden vereist is. Verwijs naar de juiste route in plaats van de hele voorbereiding ongemerkt in stap één te verstoppen.

Schrijf vanuit waarneembare handelingen

Gebruik werkwoorden die iemand kan uitvoeren en benoem het onderdeel precies. “Open het tabblad Adressen” is herkenbaarder dan “Ga naar de juiste omgeving”. Gebruik de zichtbare naam van een knop, ook als uw voorkeur in een schrijfgids anders is. Een instructie en een interface die verschillende namen gebruiken, maken de taak moeilijker.

De W3C-schrijftips adviseren duidelijke instructies en begrijpelijke inhoud. In een handleiding betekent dat ook dat de volgorde en voorwaarden expliciet moeten zijn. Vermijd aanwijzingen die uitsluitend afhangen van kleur of positie, zoals “klik rechts op het groene ding”. Die kenmerken kunnen veranderen of niet waarneembaar zijn.

Een fictieve handleiding voor een adreswijziging

Het portaal Voorbeeldzaken is verzonnen. De volgende oefening beschrijft geen echte toepassing en bevat geen echte accountgegevens. In het fictieve portaal kunt u een opgeslagen contactadres aanpassen. Een bestaand verzendlabel wordt daardoor niet gewijzigd.

De opening luidt: “Met deze stappen wijzigt u het contactadres in uw profiel. Het nieuwe adres geldt voor volgende contactgegevens die uit het profiel worden overgenomen. Controleer een lopende bestelling afzonderlijk.” De grens staat vóór de handeling die anders verkeerde verwachtingen kan wekken.

De stappen zijn:

1. Meld u aan en open Profiel.
2. Kies bij Contactadres de knop Wijzigen.
3. Vul het nieuwe adres in. Controleer huisnummer en eventuele toevoeging.
4. Kies Adres opslaan.
5. Controleer of het nieuwe adres onder Contactadres zichtbaar is.

De laatste stap is een controle, geen extra bevestigingsknop. Dat verschil voorkomt dat iemand blijft zoeken naar een handeling die niet bestaat. In een echte handleiding moeten de labels en de beschreven gevolgen overeenkomen met de toepassing.

Voeg het resultaat toe waar twijfel kan ontstaan

Na een belangrijke stap kunt u kort zeggen wat iemand hoort te zien. Doe dat vooral wanneer een handeling niet onmiddellijk een duidelijke uitkomst heeft. Schrijf geen resultaat dat u alleen verwacht maar niet heeft laten controleren. Een formulier kan bijvoorbeeld een ontvangstbericht tonen zonder de aanvraag inhoudelijk goed te keuren.

Vermijd overbodige bevestiging bij iedere kleine beweging. Als een eenvoudige stap duidelijk zichtbaar werkt, heeft de lezer geen extra alinea nodig. Gebruik meer uitleg op punten waar iemand een beslissing moet nemen, gegevens kan verliezen of niet zelfstandig kan bepalen of de taak klaar is.

De grens met microcopy is praktisch: een korte aanwijzing hoort soms direct bij het veld of de knop. Een handleiding op afstand kan niet alle ontbrekende uitleg in de interface opvangen.

Maak een stoproute voor problemen

Beschrijf een herkenbaar probleem met een passende volgende stap. In de fictieve adresoefening kan dat zijn: “Verschijnt het oude adres opnieuw? Controleer of het opslaan een foutmelding gaf. Blijft het probleem bestaan, neem contact op via de ondersteuning van het portaal.” Dat is alleen bruikbaar als die route bestaat.

Zeg wat iemand bij een melding moet doorgeven en wat niet. Vraag geen wachtwoord of onnodige gevoelige gegevens. Bij veiligheidsrisico’s kan stoppen de juiste uitkomst zijn. Laat een bevoegde deskundige zulke grenzen bepalen. Een algemeen advies om “gewoon opnieuw te proberen” kan onjuist zijn wanneer een handeling een betaling of andere onomkeerbare stap veroorzaakt.

Gebruik beelden en tekst als aanvulling op elkaar

Een schermafbeelding kan een onbekend onderdeel herkenbaar maken. Snijd niet zo veel weg dat de lezer de plaats niet meer begrijpt. Verwijder echte persoonsgegevens uit oefenbeelden. Benoem wat het beeld toevoegt en houd essentiële instructies ook in tekst beschikbaar.

De W3C-tutorial over afbeeldingen maakt onderscheid tussen functies van beelden en de bijbehorende tekstalternatieven. Een instructief beeld heeft andere behoeften dan versiering. De gids over toegankelijke teksten helpt om ook koppen, links en formuleringen na te kijken.

Controleer met een taak, niet alleen met een tekstlezing

Laat iemand vanuit het beschreven vertrekpunt de handelingen volgen. Observeer waar een label afwijkt, een voorwaarde ontbreekt of een stap meerdere interpretaties heeft. Doe dit alleen in een geschikte oefenomgeving of met een veilig afgebakende taak. Een inhoudelijke controle hoeft geen echte klantgegevens te gebruiken.

Leg bevindingen vast als concrete problemen. “Onduidelijk” wordt dan bijvoorbeeld “de handleiding noemt Instellingen, maar de knop heet Profiel”. Controleer na publicatie ook de livepagina: nummering, links, beelden en mobiele leesbaarheid kunnen anders uitpakken dan in het document.

Een FAQ kan terugkerende randvragen opvangen. Wie de uitleg wil hergebruiken als mail of video, moet de versie en beperkingen meenemen. Wijs één bron aan die bij wijzigingen wordt bijgewerkt, zodat afgeleide instructies niet zelfstandig blijven rondzwerven.

Bronnen bij deze gids

• W3C: schrijftips voor webtoegankelijkheid, voor duidelijke taal en instructies.
• W3C: afbeeldingen, voor de functie van beelden en tekstalternatieven.