Waar moet een goede handleiding aan voldoen?

Om je doelgroep en klanten zo goed mogelijk van dienst te kunnen zijn, kan een handleiding heel handig zijn. Deze gaat namelijk in op één specifiek onderwerp, zoals een bepaald product of dienst. Deze handleiding kan je een hoop klantencontact besparen, dus het is belangrijk dat je weet hoe je je hem schrijft en hoe je hem in moet zetten. Een goede handleiding informeert en lost problemen op voordat je dat zelf hoeft te doen.

Een aantal van de tips die we je in dit artikel gaan geven, gaven we ook al in het artikel Hoe schrijf je het perfecte kennisbankartikel? Maar omdat het schrijven van een handleiding toch nét even andere koek is, wijden we hier graag een apart artikel aan. De opzet en manier van schrijven is voor kennisbankartikelen en handleidingen misschien vrijwel hetzelfde, maar de informatie en opzet verschillen sterk. Handleidingen zijn daarnaast vaak technischer van aard.

Weet wie je doelgroep is

Wanneer je een handleiding gaat schrijven, is het altijd aan te raden om even een momentje te nemen om je helemaal in te leven in de lezer. Voor wie is de handleiding bedoeld? Bedenk daarbij ook wat de demografische gegevens van deze ‘persoon’ zijn. Waar woont te lezer, hoe oud is hij, wat is zijn opleidingsniveau, in welke sector werkt hij en heeft hij hobby’s? Creëer dus een ijkpersoon.

Deze informatie zorgt ervoor dat jij precies duidelijk hebt voor wie je schrijft en daarop kun je je tone of voice aanpassen, evenals de inhoud van de handleiding. Als je klanten voornamelijk laagopgeleid zijn, dan hou je de taal zo duidelijk mogelijk zonder moeilijke woorden of jargon en zorg je er ook voor dat de teksten zo kort mogelijk zijn.

Bij hoogopgeleiden kun je best wat mooiere zinnen formuleren met vaktaal, want deze zullen dit beter begrijpen. Hetzelfde geldt voor het verschil in leeftijd: jongeren zullen beter begrijpen hoe mobiele telefoons en digitale media werken dan senioren, welke weer meer kennis hebben op andere gebieden. Het allerbelangrijkst bij het schrijven voor welke doelgroep dan ook is altijd: ga ervan uit dat deze nog niets over het product weet.

Weet wat je product is

Wanneer je weet wie je doelgroep is, is het tijd om het product te leren kennen. We gaan ervan uit dat je je eigen producten goed kent, maar in het geval dat je iemand inhuurt om je handleiding voor je te schrijven, is het belangrijk dat de schrijver alle ins en outs van het onderwerp weet. Geef deze persoon dus zoveel mogelijk informatie, tot aan de vragen van je klanten over dit product aan toe. Een goed idee is om de handleiding te laten schrijven door iemand van de klantenservice of productontwikkeling. Zij zijn al bekend met het product, met je klanten én met de problemen die zij ondervinden met het product.

Weet wat je doel is

Waarom schrijf je deze handleiding? Er moet een duidelijke aanleiding voor zijn, want je handleiding moet een doel hebben. Misschien een vraag beantwoorden, de klant helpen een product of dienst te begrijpen of een probleem oplossen. Wanneer je weet wat je precies wilt bereiken met de handleiding, heb je houvast bij het schrijven en kun je dus minder snel teveel uitweiden over een bepaald onderwerp. Ook kun je achteraf zeggen of het doel bereikt is en dus of je handleiding nut heeft.

Duidelijke indeling

Wanneer je duidelijk hebt voor wie je precies gaat schrijven, dan kan je aan de slag. Maar voordat je werkelijk begint met schrijven, is het heel handig om eerst een overzicht te maken van wat je allemaal in de handleiding wilt hebben staan. Schrijf de onderwerpen op, zodat je ze daarna op de juiste manier kan ordenen. Bedenk een aantal onderwerpen, dit zullen je hoofdstukken gaan worden.

Daaronder plaats je subonderwerpen in de vorm van paragrafen. De hoofdstukken en paragrafen hebben altijd een titel. Eventuele subonderwerpen kunnen ook zonder titel geplaatst worden, maar om het voor de lezer gemakkelijk te maken de tekst te scannen, helpt het om ook daar titels bij te schrijven.

Let goed op de volgorde van de onderwerpen. Het is bijvoorbeeld niet logisch om te beginnen met het onderhoud van een stofzuiger als de lezer nog niet eens weet hoe hij het apparaat aan moet zetten en gebruiken. En het is niet gewoonlijk om de veelgestelde vragen aan het begin van de handleiding te zetten, deze gaan doorgaans helemaal achteraan, waar je overigens ook vaak een index vind indien de handleiding redelijk lang is.

Titelpagina en inhoudsopgave

Dan wordt het eindelijk tijd om écht aan de slag te gaan. Er zijn een aantal dingen die van een handleiding een goede handleiding maken. Daarbij komen er een aantal (schrijf)technische aspecten om de hoek kijken, zoals een titelpagina en inhoudsopgave. Als je de handleiding in meerdere talen gaat schrijven, dan is het belangrijk deze te vermelden in de inhoudsopgave.

Nog beter is om voor elke taal aparte versies te maken. Je maakt de handleiding immers digitaal, dus het kost je niets extra’s om er aparte handleidingen voor aan te maken. Als je je handleiding digitaal gaat aanbieden, bijvoorbeeld op je website of in je kennisbank, dan is het belangrijk om in de inhoudsopgave te linken naar de betreffende pagina’s. Op die manier komt de lezer met één klik op de knop op het hoofdstuk of de paragraaf terecht met de informatie waarnaar hij op zoek is.

Introductie

Bij een handleiding, net zoals bij ieder ander geschreven medium, is een introductie onmisbaar. Dit vertelt namelijk precies wat de lezer kan verwachten in de handleiding. Een korte tekst van ongeveer een alinea lang (misschien twee) vertelt waar de handleiding voor is bedoeld en hoe het de lezer kan helpen. De lezer kan aan de hand van deze inleiding bepalen of de handleiding antwoord gaat geven op de vraag die hij heeft of een oplossing op zijn probleem.

Het kan de lezer namelijk de nodige tijd en moeite schelen om vóóraf te weten of een handleiding hem werkelijk gaat helpen, want zo niet dan heeft het weinig nut voor de lezer om hem te gaan lezen. Schrijf de inleiding liefst altijd als de handleiding helemaal klaar is en je dus weet wat erin staat. Het zal op die manier makkelijker te schrijven zijn.

Productsomschrijving

Dan begin je met het omschrijven van het product. Wees hierin kort en bondig, maar probeer wel alle functies te vermelden. Je begint altijd met de technische gegevens van het product of de dienst. Daarna beantwoord je vragen zoals:

  • Waarvoor is het product bedoeld?
  • Wat doet het product voor je?
  • Hoe moet je het product gebruiken?
  • Hoe moet je het product schoonmaken/onderhouden?
  • Wat is het garantiebeleid?
  • Veel voorkomende problemen/veelgestelde vragen

In de handleiding geef je antwoord op bovenstaande vragen in korte en duidelijke taal. Daarbij is het altijd verstandig om visuele aspecten toe te voegen. Bijvoorbeeld een plattegrond, tekening van het product met alle knopjes en andere details erbij(genummerd) of een bepaald aspect van het onderwerp uitgelicht. Belangrijk bij het toevoegen van afbeeldingen is wel dat het toegevoegde waarde heeft. Wanneer een visual niet echt nodig is om een bepaalde stof te kunnen begrijpen, dan voeg je deze niet toe.

Om een tekst goed leesbaar te maken kun je naast tekeningen of afbeeldingen ook opsommingen toevoegen. Een stap-voor-stapuitleg is altijd verstandig wanneer er een bepaalde volgorde vereist is voor een reeks handelingen, omdat je zeker weet dat er geen stap overgeslagen zal worden. Het verkleint de kans op fouten. Schrijf verder korte zinnen en hou de alinea’s ook zo kort mogelijk. Wanneer er dingen zijn die mensen vaak fout doen, kun je dit erbij vermelden met daarbij hoe het wél moet, hoewel het misschien verstandig zou zijn om het ontwerp van het product te herzien…

Voor fysieke producten: pak het product erbij

Bij het schrijven van de handleiding is het altijd belangrijk dat je het product (liefst zoveel mogelijk uit elkaar gehaald indien van toepassing) voor je hebt liggen. Op die manier kun je precies opschrijven wat je doet en weet je zeker dat je geen stap of onderdeeltje overslaat. Je ziet wat de lezer zal zien en weet dus precies hoe je iets moet verwoorden en uitleggen. Zeker met stap-voor-staphandleidingen of -omschrijvingen is dit handig.

Testen en updaten

Tot slot is het verstandig je handleiding te testen bij iemand die representatief is voor de doelgroep. Laat deze persoon de handleiding doorlezen en met behulp van het product de handleiding testen. Vergeet nooit een handleiding aan te passen als je product of dienst een update gekregen heeft. Vooral met software is dit een risico omdat dat vaak jaarlijks of zelfs vaker geüpdatet wordt.

Maak de handleiding digitaal beschikbaar

En een laatste tip is de volgende: wanneer je een handleiding schrijft voor een fysiek product, dan moet er altijd een fysieke handleiding bij. Het is verstandig om deze handleiding ook digitaal beschikbaar te maken, indien de klant hem kwijtraakt of weggooit. IKEA doet dit sinds een tijdje heel goed.

Plaats de handleiding bijvoorbeeld op je website of verstuur hem via e-mail. Op die manier kan de klant hem altijd terugvinden. Wanneer je geen fysiek product verkoopt, is het verstandiger om de handleiding alleen digitaal te publiceren. Op die manier kost het geen materiaal en hoef je het product niet te versturen.

We hopen dat dit artikel je helpt bij het schrijven van een handleiding. Heb jij een technische handleiding? Lees dan eens ons artikel over hoe je de perfecte technische documentatie creëert.

laat een reactie achter

Meld u zich aan voor onze nieuwsbrief
Meld u zich aan voor onze maandelijkse nieuwsbrief boordevol tips over kennismanagement
Dit venster nooit meer tonen