Gebruikershandleiding schrijven?


Gebruikershandleiding schrijven?

Een goede gebruikershandleiding is op een dusdanige manier geschreven dat deze informatie van een product overbrengt op de gebruiker er van. Onder producten verstaan we apparaten, machines, installaties en software. Wanneer u een gebruikershandleiding gaat schrijven, dienen alle gebruikersaspecten te worden uitgelegd. Denk aan installatie, montage, bediening, ingebruikname, storingen en transport. Gebruikershandleidingen schrijven is de expertise van Manualise. Hieronder staat beknopt omschreven hoe wij in grote lijnen te werk gaan.

Vraag direct een offerte aan >

Een gebruikershandleiding schrijven in 5 stappen

Er zijn een aantal aspecten waar bij het schrijven van een gebruikershandleiding te allen tijde rekening mee moet worden gehouden. Deze aspecten zijn algemeen toepasbaar hoe verschillend het product, apparaat of de software ook is. En aangezien een sterke kennis en kunde van deze aspecten het eindresultaat aanzienlijk verhoogt, doet iedereen er bij het schrijven van een handleiding verstandig aan van deze aspecten op de hoogte te zijn.  Ze staan hieronder overzichtelijk opgesomd en nader beschreven.

Een gebruikershandleiding schrijven in 5 stappen:

1.  Een gebruikershandleiding schrijven? Weet voor wie u schrijft!

Het voornaamste doel bij het schrijven van een gebruikershandleiding  is de informatie over het product op een accurate en effectieve wijze naar de gebruiker wordt gecommuniceerd. Het is hierbij van enorm belang dat er rekening mee wordt gehouden dat ieder type gebruiker zijn eigen kenmerken heeft. Eindgebruikers in bijvoorbeeld een bejaardentehuis stellen immers hele andere eisen aan een gebruikershandleiding dan de monteur van een domotica systeem.

Voordat het schrijven van een gebruikershandleiding van start gaat, dient er allereerst gesproken te worden met diverse betrokken experts. Dit mogen experts zijn uit allerlei soorten vakgebieden. Denk bijvoorbeeld aan industrieel ontwerpers, elektrotechnici, communicatieadviseurs, werktuigbouwkundigen of onderhoudstechnici. Deze experts leveren productinformatie aan waarbij een ieder van hen zijn eigen jargon zal gebruiken. Aan de schrijver van de gebruikershandleiding de taak om deze vaktaal op een begrijpelijke manier te herschrijven zonder af te doen aan de feitelijkheid van de verstrekte informatie.

2.  Schrijf de inhoudsopgave

Ter vergelijking doet de schrijver van de gebruikershandleiding er verstandig aan om een tiental goede handleidingen naast elkaar te leggen om overeenkomsten inzichtelijk te maken. Een goede handleiding draagt er zorg voor dat de gebruiker het product goed en veilig kan gebruiken. Oftewel overeenkomstig het bedoelde gebruik. Dat is vrijwel onmogelijk zonder volledig te zijn. De norm die in Nederland gebruikt wordt voor gebruikershandleidingen is de NEN5509, die onder andere de inhoud en indeling van een handleiding beschrijft. Volgens deze norm zou iedere handleiding moeten voldoen aan de beschreven indeling. De indeling bestaat volgens deze norm uit hoofdstukken als installatie, technische specificaties, waarschuwingen, ingebruikname en onderhoud. Daarnaast worden in deze norm ook bepaalde aanduidingen en lettergroottes aanbevolen. De inhoudsopgave vormt de rode draad voor de gehele handleiding en de hulp van deze norm is dus essentieel bij het schrijven van een gebruikershandleiding.

3.  Verzamelen van de productinformatie

Zodra de inhoud is vastgelegd, kan deze worden ingevuld met informatie afkomstig van de eerder besproken experts. Het is van enorm belang bij het schrijven van iedere gebruikershandleiding dat er zoveel mogelijk informatie over het product en het gebruik ervan verzameld wordt. Denk aan eventuele CAD bestanden, risico analyses, marketing documentatie enzovoort. De schrijver van een gebruikershandleiding luistert, analyseert, selecteert, begrijpt en stelt de juiste vragen bij het verwerven en verwerken van deze informatie.

Bij het schrijven van een gebruikershandleiding is het te allen tijde van belang op de hoogte te zijn van de verplichtingen ten aanzien van productveiligheid en –aansprakelijkheid. Middels deze verplichtingen worden er namelijk ook vaak eisen gesteld aan de product documentatie waardoor deze dus van invloed zijn op de content van de gebruikershandleiding. Zo is er bijvoorbeeld de Richtlijn Algemene Productveiligheid (2001/95/EG), die op consumentenproducten van toepassing is en de consumenten beschermt tegen gebrekkige producten. Omdat de gebruikershandleiding wordt gezien als onderdeel van het product, kan een product ook bij een gebrekkige handleiding worden bestempeld als gebrekkig. De beoordeling van de handleidingen voor professionele producten wordt veelal gebaseerd op de CE richtlijnen.

4.  Teksten schrijven

Wanneer alle informatie verzameld, compleet en overzichtelijk is, kan het daadwerkelijke schrijven van de gebruikershandleiding beginnen. De kunst hierbij is het omzetten van de vergaarde informatie in begrijpelijke teksten voor de eindgebruikers. In de meeste gevallen wordt alle productinformatie voor de gebruikershandleiding geredigeerd, want waar marketingteksten doorgaans niet instructief genoeg zijn, is technische informatie weer niet begrijpelijk genoeg voor de doelgroep. En deze doelgroep blijft uiteraard de centrale rol spelen. Het doel is immers om de informatie accuraat en effectief te communiceren richting de gebruiker. Twee principes spelen in dit traject een belangrijke rol, te weten het minimalisme en ‘Simplified Technical English (STE). Het STE zorgt voor een reductie van de hoeveelheid tekst door overbodige informatie uit zinnen te elimineren. Dit levert gemiddeld een reductie op van maar liefst dertig procent. Het STE is vast gelegd in de ASD-STE100 norm. Met de principes van het minimalisme kan een reductie van dertig procent gerealiseerd worden op de tijd die benodigd is om iets te leren. Tegelijkertijd zorgt het ervoor dat de opslag van informatie met vijfentwintig procent toeneemt.

Illustraties kunnen worden ingezet om teksten te ondersteunen en in sommige gevallen zelfs geheel te vervangen. Hiermee worden tevens devertaalkosten gereduceerd aangezien er door de inzet van illustraties minder woorden vertaald hoeven te worden. Bovendien vertellen illustraties meer dan 1000 woorden en kan hiermee in verschillende opzichten winst behaald worden. Een goede balans tussen tekst, illustratie en witruimte zal de begrijpelijkheid en leesprestatie van de gebruiker bevorderen. Probeer bij het schrijven van een gebruikershandleiding deze balans dus goed op te zoeken!

5.  De handleiding samenstellen

De gebruikershandleiding als papieren document geniet de meeste naamsbekendheid, maar ondertussen winnen ‘online- en on device handleidingen’ behoorlijk 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 gecategoriseerd en georganiseerd. Om hergebruik te stimuleren en hiermee de vertaalkosten te beperken, is een goed modulair beheer van deze teksten zeer belangrijk. FrameMakeren Author-it zijn pakketten die veel gebruikt worden in de wereld van technische documentatie.

Werkwijze om een gebruikershandleiding te schrijven

Welke vorm de handleiding ook heeft, bij het maken van de handleiding doorlopen wij altijd de volgende stappen:

Stap 1
Inhoud bepalen

De totale productinformatie wordt in kaart gebracht. Teksten worden geschreven en de ondersteunende illustraties worden gemaakt.

Stap 2
Vastleggen stijl en presentatie

We bepalen hoe de productinformatie van de gebruikershandleiding het beste gestructureerd en georganiseerd kan worden. De visuele stijl wordt vastgelegd.

Stap 3
Gebruikershandleiding samenstellen

Nu de vorm en inhoud zijn vastgelegd gaan we de daadwerkelijke gebruikershandleiding maken door vorm en inhoud samen te voegen.

Onze referenties

Wilt u een gebruikershandleiding laten schrijven en zoekt u naar een partner die al uw zorgen uit handen neemt? Wij begeleiden onze klanten bij het maken, verbeteren en/ of beheren van hun gebruikershandleidingen. Tot onze klanten behoren onder andere:

“Ik ervaar het samenwerken met Manualise als absoluut perfect. Het contact is eerlijk en open op een professionele manier. Gestelde deadlines worden altijd gehaald.”

- Arjo van Geest , Big Green Egg Europe -


Wilt u ook uw gebruikershandleiding door ons laten maken?

Vraag direct een offerte aan >

Heeft u een vraag over een van onze diensten?
Wij beantwoorden uw vragen graag persoonlijk.