Hoe schrijf je een uitstekende handleiding in 5 eenvoudige stappen?
Door het schrijven van een uitstekende handleiding bereik je twee dingen: je helpt je klanten om gemakkelijk passende oplossingen te vinden en toe te passen en je verlaagt de kosten van de klantenservice van je bedrijf aanzienlijk. |
Door het schrijven van een uitstekende handleiding bereik je twee dingen: je helpt je klanten om gemakkelijk passende oplossingen te vinden en toe te passen en je verlaagt de kosten van de klantenservice van je bedrijf aanzienlijk. Bovendien zullen je klanten je product graag aanbevelen en de leiders in je niche zullen je merk zeker aanbevelen aan andere experts en hun klanten. Daarom kan het schrijven van een uitstekende handleiding een van de beste investeringen van je bedrijf zijn. Maar hoe kun je een uitstekende handleiding schrijven?
1. Definieer voor wie je schrijft.
Hoe goed ken je je productgebruikers? Voordat je met het schrijven begint, moet je eerst je doelgroep definiëren en hun woordkeuze en technische kennis onderzoeken. Als je contact opneemt met technische experts, moet je woordkeuze en technische termen anders zijn dan wanneer je schrijft voor onervaren productgebruikers met weinig of geen technische kennis.
2. Alle relevante secties opnemen.
Uitstekende handleidingen bevatten verschillende hoofdsecties. Deze hoofdsecties omvatten de titelpagina's, de inhoudsopgave, de inleiding, de hoofdstukken, de bijlage, de woordenlijst, de index en de achterzijde.... Niet al deze secties kunnen relevant zijn voor je handleiding, dus het kan nodig zijn om zorgvuldig de secties te selecteren die je handleidingen zo gebruiksvriendelijk mogelijk maken. Deze hoofdsecties moeten de activiteiten in je handleiding vereenvoudigen, niet compliceren. Om dit te bereiken, moet je een consistent formaat voor elke sectie gebruiken en elke sectie introduceren met een korte samenvatting van de uit te voeren activiteit.
3. Zorg ervoor dat de inhoud goed leesbaar is.
Eerst moet je de instructies of procedures scheiden van de referentiematerialen. Dit maakt het voor gebruikers gemakkelijker om snel door de handleiding te navigeren. Elke instructie moet zo geschreven zijn dat het de gebruikers helpt bij het uitvoeren van bepaalde taken. Identificeer eerst de hoofdactiviteiten en verdeel vervolgens elke hoofdactiviteit in deelactiviteiten. Beschrijf een reeks stappen die gebruikers informeren over hoe elke sub activiteit gemakkelijk uit te voeren is. Gebruik korte zinnen en woorden die je gebruikers zullen begrijpen. Leg de gebruikers uit wat de kenmerken van het product zijn en hoe deze te gebruiken. Geef de betekenis of het belang aan met contrasten, kleuren of schakeringen. Ga er niet van uit dat de gebruikers alle door je genoemde vereenvoudigde technische termen begrijpen: Je dient een verklarende woordenlijst van technische termen op te stellen die de betekenis van elke term uitlegt in overeenstemming met de manier waarop deze in de handleiding wordt gebruikt.
4. Spreek de gebruikers rechtstreeks aan.
Je handleiding hoeft niet saai te zijn; schrijf altijd actief en gebruik het persoonlijke voornaamwoord van de tweede persoon. Gebruik het opdrachtformulier van het meest relevante werkwoord wanneer je gebruikers vraagt om een actie uit te voeren. Bijvoorbeeld: "Selecteer de tweede optie in het uitklapmenu en druk op [Enter]".
5. Deel je tekst op in meerdere teksten.
Afhankelijk van de expertise van je doelgroep kan het nodig zijn om grote delen van de informatie op te delen in kleinere delen, dit proces wordt chunking genoemd. Chunking is anders dan het creëren van deelactiviteiten. Als een sub-activiteit een langer deel van de informatie bevat dat voor gebruikers een uitdaging kan vormen, kun je de informatie opsplitsen in een lijst van brokken. Dit is een van de beste manieren voor het schrijven van instructies en handleidingen.