Stap 1 Doelgroep bepalen
Productinformatie moet duidelijk en nauwkeurig worden gecommuniceerd naar de gebruiker. Verschillende gebruikersgroepen hebben echter verschillende behoeften en voorkeuren. Een handleiding moet hierop aansluiten. Zo heeft een gemiddelde consument hele andere behoeften en basiskennis dan de installateur van een machine. Dit resulteert in verschillende benaderingen:
- Consumenten verwachten eenvoudige, stapsgewijze instructies met duidelijke afbeeldingen.
- Installateurs van complexe machines, zoals een waterzuiveringsinstallatie, hebben juist gedetailleerde technische informatie nodig.
Door de handleiding af te stemmen op de doelgroep, wordt de informatie effectiever.
Stap 2 Conformiteitsonderzoek doen
Het is belangrijk om te weten aan welke normen en richtlijnen een product moet voldoen, omdat deze vaak ook eisen stellen aan de handleiding. In een conformiteitsonderzoek wordt bepaald welke specifieke handleidinggerelateerde eisen van toepassing zijn. Deze eisen worden vervolgens gebruikt bij het samenstellen en toetsen van de handleiding.
Welke eisen worden er gesteld aan een handleiding
Richtlijnen kunnen dus eisen bevatten met betrekking tot de handleiding. De Machinerichtlijn (2006/42/EG) verplicht bijvoorbeeld dat een handleiding niet alleen het beoogde gebruik van de machine beschrijft, maar ook waarschuwt voor voorzienbaar verkeerd gebruik. Dit betekent dat de handleiding ook mogelijke risico’s moet beschrijven die kunnen ontstaan door verkeerd gebruik, voor zover dit redelijkerwijs te verwachten is. In het geval van bijvoorbeeld een elektrische zaag moet de handleiding niet alleen uitleggen hoe deze veilig te gebruiken is, maar ook waarschuwen dat de zaag niet geschikt is voor het snijden van bepaalde materialen, zoals gehard staal, omdat dit gevaarlijke situaties kan opleveren of de machine kan beschadigen.
Daarnaast moet een handleiding volgens de Machinerichtlijn informatie bevatten over zaken als:
- Geluidsniveau: Dit geldt bijvoorbeeld voor machines zoals een bladblazer, zodat de gebruiker weet of gehoorbescherming nodig is.
- De fabrikant: Het gaat hier om de naam en contactgegevens van de fabrikant, zodat gebruikers bij vragen of garantieclaims makkelijk contact kunnen opnemen.
- Vertalingen: Veel Europese richtlijnen, waaronder de Machinerichtlijn, verplichten dat de handleiding beschikbaar is in de officiële taal of talen van het land waar het product op de markt wordt gebracht en/of in bedrijf wordt gesteld.
Juridische gevolgen van een slechte handleiding
Bij het maken van een handleiding is het goed om te beseffen dat een handleiding niet zomaar een extra toevoeging is; de Richtlijn 2024/2853 (opvolger van Richtlijn voor Productaansprakelijkheid 85/374/EEG) beschouwt de handleiding en bijbehorende veiligheidsinformatie als onderdeel van het product. Als de handleiding onvolledig, onjuist of onduidelijk geschreven is, en dit leidt tot schade of letsel, dan kan de producent aansprakelijk worden gesteld. Zelfs als het product technisch in orde is.
Een duidelijke, complete handleiding helpt dus niet alleen de gebruiker, maar kan een bedrijf ook tegen juridische claims beschermen.
Leest u ons artikel ‘Wettelijke eisen aan een handleiding’ voor meer informatie. Roept u toch liever de hulp in van een specialist? Manualise maakt al meer dan 15 jaar handleidingen die voldoen aan wet- en regelgeving.
Stap 3 Productinformatie verzamelen
Zodra de doelgroep van de handleiding duidelijk is, kan het verzamelen van de juiste productinformatie beginnen. Het is essentieel om zoveel mogelijk gedetailleerde informatie over het product te verzamelen. Deze informatie kan worden verkregen door in gesprek te gaan met experts binnen de organisatie, zoals productontwikkelaars, technici of de klantenservice.
Bij het verzamelen van de informatie is het belangrijk om goed te luisteren naar de experts, de verkregen gegevens goed te analyseren en te begrijpen. Het doel van deze fase is ervoor te zorgen dat de handleiding straks alle benodigde en relevante informatie bevat voor de beoogde doelgroep.
Stap 4 Documentstructuur vastleggen
Een goedgeorganiseerde handleiding zorgt ervoor dat een gebruiker de benodigde informatie snel kan vinden en dat hij belangrijke waarschuwingen en veiligheidsinstructies niet over het hoofd ziet. Dit om het risico op fouten of ongelukken te verminderen. Het bepalen van de indeling is dus een belangrijke stap bij het maken van een handleiding.
Bepalen van de indeling van de handleiding
Normen vormen een nuttige richtlijn bij het maken van handleidingen. De NEN5509 is de Nederlandse norm voor het opstellen van technische gebruikershandleidingen. Deze norm biedt richtlijnen voor de inhoud, structuur, formulering en presentatie van handleidingen voor zowel professionele als niet-professionele gebruikers.
De norm behandelt onder andere een aanbevolen indeling voor een handleiding. Belangrijke onderdelen zijn bijvoorbeeld veiligheidswaarschuwingen, technische specificaties, installatie, gebruik en onderhoud. Daarnaast bevat de norm specificaties voor elementen zoals de titelpagina, het voorwoord en de lettergrootte.
Stap 5 Effectieve en instructieve teksten schrijven
Bij het maken van een handleiding werken technisch schrijvers samen met verschillende experts, zoals werktuigbouwkundigen, elektrotechnici, industrieel ontwerpers, installateurs, onderhoudstechnici en marketingexperts. Ieder van hen heeft diepgaande kennis van een specifiek vakgebied, maar gebruikt ook eigen jargon. De uitdaging bij het schrijven van een handleiding is om deze specialistische informatie begrijpelijk te maken voor de beoogde gebruiker, zonder afbreuk te doen aan de nauwkeurigheid van de inhoud.
Praktische richtlijnen voor een effectieve handleiding:
- Houd het kort en krachtig. Vermijd overbodige informatie en kom direct ter zake. Voorbeeld: In plaats van “De stroomvoorziening wordt gerealiseerd via een voedingskabel die aangesloten dient te worden op een 230V stopcontact.” volstaat “Steek de stekker in een 230V stopcontact.”
- Maak de handleiding gebruiksvriendelijk. De lezer moet zonder veel moeite de juiste informatie vinden en begrijpen. Dit betekent duidelijke stappen, korte zinnen en een logische opbouw.
Voorbeeld: Instructies voor een koffiezetapparaat kunnen beter geformuleerd worden als “Vul het waterreservoir tot de max-lijn.” in plaats van “Controleer of het waterniveau zich binnen de aangegeven toleranties bevindt.” - Goede navigatie is cruciaal. Zorg ervoor dat gebruikers snel vinden wat ze nodig hebben. Een heldere inhoudsopgave en duidelijke koppen helpen hierbij.
Voorbeeld: Een hoofdstuk met de titel “Hoe verbind ik mijn apparaat?” is duidelijker en aantrekkelijker dan “Bluetooth-connectiviteit”.
Door deze principes toe te passen, wordt een handleiding niet alleen informatief, maar ook praktisch en goed leesbaar voor de gebruiker.
Simplified Technical English: een handig hulpmiddel
Simplified Technical English (STE) is een ander nuttig hulpmiddel voor effectief en efficiënt schrijven. In STE wordt gebruik gemaakt van een beperkte (gecontroleerde) woordenschat, gestandaardiseerde woordkeuze en zinsopbouw. Waardoor overbodige informatie geëlimineerd wordt en handleidingen duidelijker en begrijpelijker worden.
Voor meer informatie over STE verwijzen we u graag naar https://asd-ste100.org/.
Wilt u meer weten over het schrijven van goede instructieteksten? Leest u dan ons artikel ‘Een instructie schrijven moeilijk?’ waarin we u in 3 stappen laten zien hoe u heldere instructies schrijft.
Stap 6 Illustraties maken
Illustraties maken instructies niet alleen overzichtelijker, maar ze kunnen tekst ook overbodig maken. Zoals bij de handleidingen van IKEA, waar duidelijke tekeningen zonder tekst de gebruiker stap voor stap door het proces leiden.
Gebruik liever geen foto’s in handleidingen. Foto’s bevatten vaak te veel details die afleiden van de kern. Een technische tekening of lijnillustratie is veel effectiever, omdat daarin alleen de essentiële onderdelen worden weergegeven. Denk bijvoorbeeld aan een instructie voor het vervangen van een printertoner: een eenvoudige lijntekening kan precies aangeven welk klepje moet worden geopend en waar de toner moet worden geplaatst, zonder de afleiding van achtergrondkleuren of schaduwen zoals bij een foto.
Meer over dit onderwerp leest u in ons artikel ‘Illustratie laten maken’ waarin we dieper in gaan op doel, doelgroep, illustratiestijlen, illustratietechnieken en aandachtspunten bij het maken van illustraties.
Stap 7 Vertalen en lokaliseren
Door internationalisering moeten handleidingen vaak worden vertaald. Soms gebeurt dit om de gebruiker zo goed mogelijk te ondersteunen en de gebruiksvriendelijkheid te vergroten. In andere gevallen is vertaling wettelijk verplicht, zoals bij de verkoop van machines binnen de Europese Unie, waar de handleiding in de officiële taal van het betreffende land beschikbaar moet zijn.
Vertalen is een specialistisch vak, dus het kiezen van een betrouwbaar vertaalbureau is cruciaal. Een goed bureau beschikt over technische kennis en zorgt voor consistent taalgebruik. Dit is belangrijk bij de vertaling van een handleiding voor bijvoorbeeld een medisch apparaat, waarbij foutieve of inconsistente terminologie risico’s kan opleveren voor de gebruiker.
Bij terugkerende vertaalopdrachten kan een vertaalbureau gebruikmaken van een vertaalgeheugen. Dit systeem slaat eerder vertaalde teksten op, zodat hergebruik mogelijk is. Hierdoor blijven termen consistent en worden kosten bespaar: niet elke tekst hoeft opnieuw vertaald te worden.
Wilt u meer weten? Lees dan ons artikel ‘Handleidingen vertalen’.
Stap 8 Vorm en stijl vastleggen
In stap 4 is de documentstructuur vastgelegd. De volgende stap die van belang is bij het maken van een handleiding is het standaardiseren van de opmaak. Dit zorgt voor herkenbaarheid en een goede leesbaarheid, waardoor lezers de informatie beter tot zich nemen. Dit helpt om fouten of ongelukken te voorkomen.
Aandachtspunten bij het vastleggen van de vorm en stijl zijn:
- Zorg voor een duidelijke en consistente lay-out, zodat de gebruiker snel de benodigde informatie vindt.
- Gebruik genummerde lijsten (1, 2, 3) voor stapsgewijze instructies en bullet points voor opsommingen van kenmerken of opties.
- Maak veiligheidsteksten goed herkenbaar door middel van kleur en symbolen, zodat waarschuwingen direct opvallen.
- Zorg voor voldoende witruimte tussen tekstblokken en afbeeldingen om de leesbaarheid te verbeteren en een gestructureerde uitstraling te creëren.
Stap 9 Inhoud samenstellen
De handleiding wordt vervolgens samengesteld door vorm en inhoud te combineren. Controleer na het samenstellen:
- de visuele elementen (zijn de afbeeldingen en tabellen correct geplaatst, zijn ze scherp en goed leesbaar, etc.)
- verwijzingen en kruisverwijzingen (kloppen inhoudsopgave, waarschuwingen, interne links, etc.)
Laat na het samenstellen van de inhoud een proeflezer of gebruiker meekijken. Hun feedback is vaak waardevol voor het verbeteren van de handleiding.
Stap 10 Handleiding publiceren en distribueren
Naast een gedrukte handleiding kan er ook vraag zijn naar een digitale versie van de handleiding. Met behulp van single source software kan met dezelfde inhoud zowel een printformaat (zoals PDF) als digitale formaten (bijvoorbeeld HTML5, WebHelp, EPUB of DITA) worden gemaakt. Dit zorgt ervoor dat de informatie eenvoudig toegankelijk is via desktop, tablet of smartphone.
Wanneer de handleiding is afgerond, kan de gewenste output worden gegenereerd. Als de handleiding digitaal wordt aangeboden, is het belangrijk te controleren of de inhoud goed leesbaar is op verschillende schermformaten en of interactieve elementen, zoals hyperlinks, goed functioneren. Slecht presterende of moeilijk leesbare documenten kunnen de gebruikerservaring negatief beïnvloeden en de tevredenheid over het product verminderen.
Zelf aan de slag met het maken van een handleiding (gratis stappenplan met checklist)
Bent u van plan om een of meerdere handleidingen te maken? Manualise biedt single source software onder licentie aan, zodat u op een efficiënte manier zelf aan de slag kunt. Daarnaast hebben wij hebben de informatie uit dit artikel voor u omgezet in een compact overzicht met aandachtspunten. Download hier het gratis stappenplan met checklist:
Roept u toch liever de hulp in van een specialist? Manualise maakt al meer dan 15 jaar gebruiksvriendelijke handleidingen voor uiteenlopende klanten.
