Inhoudsopgave
Werkwijze om een gebruikershandleiding te maken
Gaat u een gebruikshandleiding maken? Welke vorm een gebruikershandleiding ook krijgt, wij doorlopen altijd de volgende fasen:
Fase 1 – Bepalen van de inhoud
Eerst brengen we alle productinformatie in kaart. We creëren een heldere structuur zodat de inhoud optimaal toegankelijk is voor de gebruiker. Daarna starten onze technisch schrijvers en illustratoren met het schrijven van de teksten en het maken van illustraties.
Fase 2 – Vastleggen van vorm en stijl
We bepalen de visuele vorm en stijl van de handleiding, waarbij we rekening houden met huisstijl en andere wensen.
Fase 3 – Daadwerkelijk samenstellen
Nu de inhoud en vorm zijn vastgelegd, stellen we de daadwerkelijke handleiding samen door inhoud en vorm bij elkaar te brengen.
Gebruikershandleiding maken: 10 aandachtspunten
Waarop moet u letten als u een gebruikershandleiding gaat maken? Wij hebben 10 aandachtspunten voor u op een rijtje gezet:
- Ken uw doelgroep
- Raadpleeg relevante richtlijnen
- Bepaal een logische structuur
- Verzamel uitgebreide productinformatie
- Schrijf duidelijke en instructieve teksten
- Gebruik ondersteunende afbeeldingen
- Kies voor gerichte illustraties of animaties
- Vertaal en lokaliseer indien nodig
- Archiveer herbruikbare content
- Bied de handleiding aan in de gewenste vorm(en)
Zo zorgt u voor een effectieve en gebruiksvriendelijke handleiding.
Ken uw doelgroep
Een handleiding moet aansluiten bij de kennis en behoeften van de gebruiker. Een technicus vereist andere informatie dan een consument. Bijvoorbeeld, een installateur heeft gedetailleerde technische specificaties nodig, terwijl een eindgebruiker gebaat is bij eenvoudige instructies voor dagelijks gebruik.
Gebruikershandleiding maken? Raadpleeg relevante richtlijnen!
Gebruikershandleidingen moeten, afhankelijk van de productcategorie, voldoen aan specifieke wettelijke eisen. Voor machines geldt bijvoorbeeld de Machinerichtlijn (2006/42/EG), die voorschrijft dat alle restrisico’s én voorzienbaar verkeerd gebruik duidelijk in de handleiding moeten worden vermeld. Als een machine bij verkeerd gebruik gevaar kan opleveren, moet dit expliciet worden aangegeven en voorzien zijn van passende waarschuwingen.
Bepaal een logische structuur
Een overzichtelijke indeling helpt gebruikers snel de benodigde informatie te vinden. De NEN5509 biedt richtlijnen voor de structuur van handleidingen, inclusief onderdelen zoals veiligheidsinstructies, installatieprocedures en onderhoudsinformatie. Een duidelijke inhoudsopgave en consistente hoofdstukindeling zijn hierbij essentieel.
Verzamel uitgebreide productinformatie
Voordat u begint met schrijven, is het belangrijk om alle relevante productgegevens te verzamelen. Dit omvat technische specificaties, installatie-instructies, onderhoudsprocedures en eventuele CAD-bestanden. Deze informatie vormt de basis voor een accurate en volledige handleiding.
Schrijf duidelijke en instructieve teksten
Nu kunt u van start met het daadwerkelijke ‘gebruikershandleiding maken’: het creëren van content. Waar moet u op letten bij het schrijven van teksten?
Effectieve handleidingen maken gebruik van:
- Simplified Technical English (STE): Een gestandaardiseerde vorm van Engels die ambiguïteit (dubbelzinnigheid) vermindert.
Voorbeeld: in plaats van te schrijven “Check the oil level”, schrijft u volgens STE “Make sure the oil level is between the minimum and maximum marks.” - Minimalisme: Beperk de informatie tot wat strikt noodzakelijk is. Leg bijvoorbeeld uit hoe olie bij te vullen, zonder uit te weiden over waarom dit belangrijk is.
- Topic-based authoring: Structuur de informatie in zelfstandige, herbruikbare blokken, zoals ‘veiligheid’ of ‘onderhoud’. Dit maakt het eenvoudiger om informatie te beheren en aan te passen.
Gebruik ondersteunende afbeeldingen
Beelden kunnen complexe instructies verduidelijken en daarmee een groter succes van de gebruikershandleidingen maken. Een goed ontworpen illustratie kan meerdere stappen in één oogopslag weergeven, wat de tekstuele uitleg aanvult en soms zelfs vervangt. Dit is vooral nuttig bij montage-instructies of het identificeren van onderdelen.
Kies voor gerichte illustraties of animaties
Illustraties, zoals lijntekeningen, zijn vaak effectiever dan foto’s omdat ze de aandacht vestigen op essentiële details zonder afleiding. Animaties kunnen dynamische processen tonen, zoals het correct aansluiten van kabels, en zijn toegankelijk via QR-codes op het apparaat.
Vertaal en lokaliseer indien nodig
Als uw product in meerdere landen wordt verkocht, moet de handleiding beschikbaar zijn in de officiële taal van elk land. Bijvoorbeeld, een machine die in Nederland wordt verkocht, moet een Nederlandstalige handleiding hebben. Specialistische vertalers zorgen ervoor dat technische termen correct worden overgebracht en dat culturele nuances worden gerespecteerd. Dit laatste wordt lokaliseren genoemd.
Gaat u meer dan één gebruikershandleiding maken? Archiveer herbruikbare content!
Gebruik software om teksten en illustraties op te slaan in herbruikbare modules. Dit maakt het eenvoudiger om handleidingen te updaten of aan te passen voor verschillende producten, zonder telkens vanaf nul te beginnen.
Manualise biedt single source software onder licentie aan, zodat u op een efficiënte manier zelf aan de slag kunt.
Bied de handleiding aan in de gewenste vorm(en)
Afhankelijk van de behoeften van uw gebruikers, kunt u de handleiding aanbieden in diverse formats:
- Print: Een fysieke handleiding die bij het product wordt geleverd.
- Online: Een digitale versie op uw website of via een app.
- On-device: Een handleiding die direct toegankelijk is via het apparaat zelf, bijvoorbeeld via een ingebouwd scherm of QR-code.
Door deze aandachtspunten te volgen, zorgt u voor een gebruikershandleiding die niet alleen voldoet aan wettelijke eisen, maar ook bijdraagt aan een positieve gebruikservaring en een professioneel imago van uw product.
Zelf een gebruikershandleiding maken (gratis stappenplan met aandachtspunten)
Gaat u meer dan één gebruikershandleiding maken? Zoals eerder gezegd: Manualise biedt single source software onder licentie aan, zodat u op een efficiënte manier zelf aan de slag kunt. Informeert u naar de mogelijkheden.
Daarnaast hebben wij de informatie over een gebruikershandleiding maken uit dit artikel voor u samengevat in een compact overzicht met aandachtspunten. Download hier het gratis stappenplan met checklist:
Besteedt u het maken van uw documentatie toch liever uit? Manualise heeft al meer dan 15 jaar ervaring met het specialisme (handleiding of) gebruikershandleiding maken. Dit doen wij voor uiteenlopende producttypes en voor uiteenlopende klanten.