Hoe een handleiding schrijven?

Hoe een handleiding schrijven? Wij zochten het voor je uit:

Stap 1. Ken het materiaal – en het product – van binnen en buiten. Wees er zeker van dat je de procedure volledig begrijpt – zowel uit praktisch als theoretisch standpunt. Zorg ervoor dat je de procedure die je gaat beschrijven succesvol kan uitvoeren, door herhaaldelijk door de nodige stappen te gaan tot je ervan overtuigd bent dat je weet hoe ze uit te voeren en ze duidelijk
kan uitleggen.

Stap 2. Ga ervan uit dat de lezer niets af weet van de procedure die jij gaat beschrijven in je handleiding. Dit zal je eraan herinneren om niets over te slaan tijdens het uitleggen hoe de procedure uit te voeren en zal voorkomen dat er gaten in je uitleg zijn die de lezer frustrerend zal vinden.

Stap 3. Gebruik schema’s om informatie weer te geven dat moeilijk onder woorden te brengen is. Gebruik dit voor informatie dat zo ingewikkeld is voor de lezer dat ze het zonder visueel aanzicht van het onderwerp, onderdeel of procedure niet kunnen inbeelden en ze op deze manier een referentie hebben tijdens het uitvoeren van de instructies in de handleiding.

Stap 4. Laat de lezer het doel van iedere actie en iedere stap in de procedure begrijpen, motiveer haar iedere stap uit te voeren door er de reden van uit te leggen en de voordelen van het volgen van de richtlijnen voorgesteld in de handleiding. Laat de lezer niet raden waarom een bepaalde actie nodig kan zijn of zich afvraagt waarom het behulpzaam is. Dit doen kan ervoor zorgen dat ze een nodige stap, of een hele procedure overslaat dat haar het leven gemakkelijker kan maken – en haar enthousiasme voor jouw product stijgt

Stap 5. Leg de procedure uit in korte, gemakkelijk te onthouden stappen. Leg dan de stappen in volgorde voor, van begin tot einde, er van uitgaande dat iedere stap op logische wijze naar de volgende leid. Wees er zeker van geen belangrijke achtergrond informatie weg te laten dat de volgende stap duidelijk zal maken en het in de juiste context plaatst.

Stap 6. Schrijf in klare gewone taal, en zorg ervoor dat de woorden die jij in jouw handleiding gebruikt niet dubbelzinnig zijn. Als een instructie op verschillende manieren kan opgevat worden, herschrijf het dan tot het klaar en duidelijk is wat de lezer juist moet doen.

Stap 7. Test de handleiding op een testgroep van mensen die het profiel passen van de toekomstige doelgroep. Observeer hoe moeilijk of gemakkelijk het is voor de groep om de procedure helemaal uit te voeren waar het bedrijf jou heeft aangeworven de handleiding voor te schrijven. Vraag om feedback van je testgroep over hun ervaringen en suggesties over wat je anders kan doen om het te verbeteren. Breng dan veranderingen aan in de handleiding dat het leven gemakkelijker maakt voor diegenen die het product in de toekomst aankopen.