Een handleiding ontwerpen in 5 stappen
Bij het ontwerpen van een handleiding dient te allen tijde rekening te worden gehouden met een aantal aspecten. Deze aspecten zijn voor ieder product, apparaat of software hetzelfde en zijn dus algemeen toepasbaar. Een sterke kennis en kunde van deze aspecten verbetert het eindresultaat aanzienlijk. Hieronder staan de belangrijkste aspecten bij het ontwerpen van een goede handleiding overzichtelijk weer gegeven.
1. Handleiding ontwerpen? Weet voor wie u schrijft!
Herinner uzelf tijdens een handleiding ontwerpen constant aan het feit dat ieder type gebruiker zijn of haar eigen kenmerken heeft. Het is belangrijk hier rekening mee te houden om op deze manier de informatie over het product op een accurate en effectieve wijze naar de gebruiker te communiceren. De bejaarde eindgebruiker van een telefoontoestel stelt immers hele andere eisen aan een handleiding dan de installateur van een complex zuiveringssysteem. Een goede handleiding is afgestemd op het type gebruiker, oftewel de doelgroep.
Voordat het daadwerkelijk ontwerpen van de handleiding begint, dient eerst gesproken te worden met diverse betrokken professionals. Dit kunnen industrieel ontwerp- of elektrotechnici zijn, maar bijvoorbeeld ook communicatie adviseurs of werktuigbouwkundigen. Deze experts leveren productinformatie aan die zij in hun eigen vaktaal verwoord hebben. Voor de ontwerper van de handleiding is het vervolgens de kunst om deze informatie op een begrijpelijke manier richting de gebruiker te communiceren. Hierbij is uiteraard wel van groot belang dat er geen afbreuk wordt gedaan aan de feitelijkheid van de informatie.
2. Schrijf de inhoudsopgave
Leg ter vergelijking een tiental goede handleidingen naast elkaar en probeer de overeenkomsten te herkennen. Een goede handleiding stelt de gebruiker in staat om een product goed, veilig en op de bedoelde manier te gebruiken. Dit is vrijwel onmogelijk zonder volledig te zijn. In Nederland is er een norm voor handleidingen, te weten de NEN5509. Deze norm beschrijft onder andere de inhoud van een handleiding. Voor iedere handleiding is het belangrijk dat de in deze norm beschreven indeling aanwezig is. De volgende hoofdstukken mogen volgens deze norm niet ontbreken:
- Technische specificaties
- Waarschuwingen
- Installatie
- Ingebruikname
- Onderhoud
3. Verzamelen van productinformatie
Wanneer de inhoud in grote lijnen is vastgelegd, kan de handleiding worden ingevuld met de eerder genoemde informatie afkomstig van de experts. Daarnaast dient bij het ontwerpen van iedere handleiding zoveel mogelijk andere informatie over het product te worden verzameld, zoals eventuele CAD bestanden, marketing documentatie, risico analyses enzovoort. De ontwerper van de handleiding luistert, analyseert, selecteert, begrijpt en stelt zichzelf vragen bij het verwerven van de informatie.
Bij het ontwerpen van een handleiding is het te allen tijde van groot belang op de hoogte te zijn van alle verplichtingen ten aanzien van aansprakelijkheid en productveiligheid. Hier worden namelijk ook vaak eisen gesteld aan de product documentatie en om deze reden zijn deze verplichtingen van invloed op de inhoud van de handleiding.
Op consumentenproducten is de Richtlijn Algemene Productveiligheid 2001/95/EG van toepassing. Een richtlijn die is opgesteld om consumenten te beschermen tegen gebrekkige producten. Ook een gebrekkige handleiding wordt volgens deze richtlijn beschouwd als een gebrek aan het product. Voor professionele producten worden veelal eisen gesteld aan een handleiding middels ‘CE richtlijnen’. ‘CE’ staat hierbij voor “Conformité Européenne”
4. Teksten schrijven
Wanneer de informatie compleet en overzichtelijk is, kan deze worden omgezet naar begrijpelijke teksten. In de meeste gevallen wordt de productinformatie voor de handleiding geredigeerd. Waar technische informatie doorgaans te complex is voor de doelgroep, zijn marketingteksten vaak weer niet instructief genoeg. De handleiding wordt uiteindelijk geschreven voor de gebruiker en deze doelgroep moet een centrale rol blijven spelen bij het ontwerpen van een goede handleiding. De nodige informatie moet immers accuraat en effectief naar de gebruiker gecommuniceerd worden.
De twee principes die een aanzienlijke rol spelen in het effectief overbrengen van informatie zijn: minimalisme en Simplified Technical English (STE). Het STE reduceert de hoeveelheid tekst, door overbodige informatie uit zinnen te elimineren. Dit levert gemiddeld een reductie van 30% op. Het STE is vastgelegd in de ASD- STE100 norm. De principes van het minimalisme zorgen ervoor dat de tijd benodigd om iets te leren met 30% afneemt en dat de opslag van informatie met 25% toeneemt.
Teksten ondersteunen met illustraties is vaak een goede optie. In sommige gevallen kunnen illustraties teksten zelfs geheel vervangen. Illustraties vervangen woorden en reduceren hierdoor de vertaalkosten. Daarnaast vertelt een goede illustratie meer dan 1000 woorden. Om de leesprestaties en begrijpelijkheid te bevorderen, is het belangrijk een goed balans te vinden tussen tekst, illustraties en witruimte. Probeer deze balans bij het ontwerpen van een handleiding dus op te zoeken!
5. De handleiding samenstellen
De handleiding als papieren document geniet wellicht nog steeds de meeste bekendheid, maar ‘online’ en ‘on device’ handleidingen winnen echter aan populariteit. Voor de publicatie van deze verschillende outputvormen bestaan diverse pakketten. Deze authoring/ editing/ publishing pakketten maken gebruik van een database waarin teksten worden georganiseerd. Een goed modulair beheer van deze teksten (met bijbehorende vertalingen) stimuleert hergebruik waardoor de vertaalkosten aanzienlijk gedrukt worden. De meest gebruikte pakketten in de wereld van technische documentatie en het ontwerpen van handleidingen zijn FrameMaker en Author-it.
Werkwijze om een handleiding te ontwerpen
Welke vorm de handleiding ook heeft, bij het ontwerpen van de handleiding volgen wij altijd de volgende stappen:
