Onze technisch schrijvers en illustratoren staan voor u klaar

Direct contact met een expert →

Leestijd: +/- 8 minuten

Werkwijze om een gebruikershandleiding te maken

Gaat u een gebruikshandleiding maken? Welke vorm uw gebruikershandleiding ook krijgt, steeds doorlopen wij de volgende fasen:

Aandachtspunten bij het maken van een gebruikershandleiding

Waarop moet u letten als u een gebruikershandleiding samenstelt? Er zijn in ieder geval altijd tien aandachtspunten die bij ons de revue passeren. Misschien vereisen ze niet alle tien actie. Maar we gaan ze wel altijd alle tien na.

1. Ken de doelgroep van uw handleiding

Zorg ervoor dat u uw productinformatie op een accurate en effectieve manier overbrengt op uw doelgroep. Elke doelgroep verschilt. Het is van belang dit constant in gedachten te houden. Een consument spreekt u heel anders aan dan een technicus!

Als u ons vraagt aan de slag te gaan met uw gebruikershandleiding, spreken we eerst met uw experts – bijvoorbeeld uw marketeers, ontwerpers en installateurs. De informatie van deze deskundigen vormt samen de gebundelde kennis die noodzakelijk is om een professionele handleiding op te zetten. Echter: elke expert spreekt zijn eigen vaktaal. De kunst is om dit jargon te vertalen naar begrijpelijke teksten zonder afbreuk te doen aan de juistheid van de informatie.

Verder laten we ons altijd leiden door de volgende punten:

• Elimineer overbodige informatie. Schrijf ‘to the point’, dus zo beknopt mogelijk.
• Zorg ervoor dat de benodigde inspanning voor de gebruiker minimaal is.
• Schrijf een overzichtelijke inhoudsopgave. Navigatie is belangrijk! Maak in een ‘heading’ meteen duidelijk om welke actie het gaat. Schrijf dus “Een verbinding maken met de USB-poort” en houd het niet bij een vage vermelding als “Verbinding maken”.

2. Ga alle relevante richtlijnen na

Wanneer een product gebreken vertoont, moet de producent of importeur rekening houden met aansprakelijkheidsstelling. Dit staat beschreven in de Richtlijn voor Productaansprakelijkheid (85/374/EEG). Een gebruikershandleiding is een integraal onderdeel van het product. Een gebrek in de gebruikershandleiding kan dus ook leiden tot aansprakelijkheidsstelling.

Bovendien moeten, volgens de CE-richtlijnen, eventuele restrisico’s van een product altijd een duidelijke vermelding krijgen in een handleiding. Zo verplicht de Machinerichtlijn dat naast het beoogde gebruik van een machine ook het “voorzienbare verkeerde” gebruik in de handleiding aan de orde komt. Als het bijvoorbeeld voorzienbaar is dat een hand in een gevaarlijke trechter van een machine terechtkomt, moet er een waarschuwingssymbool op de machine komen – naast een waarschuwing in de gebruikershandleiding!

Daarnaast dienen zaken als stabiele ligging en het geluidsniveau aan bod te komen. In sommige gevallen stellen richtlijnen zelfs eisen aan de vertalingen van de handleiding. De opsteller van een gebruikershandleiding moet van al deze verplichtingen op de hoogte zijn.

3. Bepaal de indeling van uw document

Om een product goed en veilig te gebruiken, is het enorm belangrijk dat de gebruikershandleiding volledig is. Gelukig zijn er normen beschikbaar die een goed handvat bieden voor het opstellen van een correcte, volledige handleiding. De Nederlandse norm voor het opstellen van gebruikershandleidingen is de NEN5509.

In deze norm komen de inhoud, formulering, structuur en presentatie van een verantwoord opgezette handleiding aan bod. Met andere woorden: de norm gaat in op de indeling waaraan elke handleiding moet voldoen. Volgens de norm NEN5509 dienen veiligheidswaarschuwingen, installatievoorschriften, gebruiksinstructies en onderhoudsgegevens in elke handleiding centraal te staan. Dit geldt ook voor een opsomming van de technische specificaties. Daarnaast stelt de norm eisen aan bijvoorbeeld de titelpagina en het voorwoord.

4. Verzamel productinformatie

Het is essentieel om zoveel mogelijk productinformatie te verzamelen voordat de eerste letter van een gebruikershandleiding op papier komt. Denk hierbij aan installatiegegevens, technische specificaties, eventuele CAD-bestanden, marketingdocumentatie, enzovoort. 

5. Schrijf effectieve en instructieve teksten

Teksten moeten effectief en instructief zijn. Daarbij hanteren wij drie principes: het Simplified Technical English (STE), het principe van het minimalisme en het zogenaamde topic-based authoring.

Simplified Technical English

STE is een versie van het Engels waarbij dubbelzinnigheid niet meer mag voorkomen. Een gestyleerd voorbeeld levert een treffende illustratie. Als een monteur een bepaalde taak moet uitvoeren, gebruikt STE niet het werkwoord ‘to carry out’, maar ‘to do’. ‘To carry’ betekent ‘dragen’ en zou verwarring kunnen stichten: moet je als monteur een testprocedure ‘uitdragen’ (‘to carry out’) ofwel uitleggen aan je collega’s? Of moet je de testprocedure gewoon zelf doen? Om dit soort misverstanden te voorkomen, gaat het STE uit van een aantal strikte regels die bovendien flink kortere teksten opleveren.

Minimalisme

Het minimalisme gaat uit van een minimaal gebruik van informatie. Als iemand olie moet bijvullen is het niet nodig uit te leggen waarom het bijvullen van de olie zo belangrijk is. Die informatie kan buiten de gebruikershandleiding blijven. In de handleiding moet wel kort en krachtig staan hoe dat bijvullen in zijn werk gaat en met welk interval.

Topic-based authoring

Topic-based authoring houdt in dat we informatie opdelen in losse blokken. Op deze manier worden blokken makkelijk herplaatsbaar. Denk aan informatieblokken zoals ‘veiligheid’ en ‘onderhoud’. Beide kunnen overigens ook aparte hoofdstukken betreffen waarin dan weer een nadere verdeling in blokken plaatsvindt. Zo kan in een hoofdstuk ‘Onderhoud’ het steeds herbruikbare blok ‘Chemisch afval’ voorkomen.

Toepassing van deze drie principes levert doorgaans een reductie op van 30% trainingstijd voor monteurs. Het absorptievermogen van de gebruiker stijgt doorgaans met 25%.

6. Vergelijking de verhouding tekst/beeld

Een plaatje zegt meer dan 1.000 woorden! Deze uitdrukking nemen wij graag ter harte. Bij de samenstelling van een gebruikershandleiding gaan we voortdurend na of een afbeelding niet effectiever is dan tekst.

Afbeeldingen geven vaak in een enkele keer een aantal stappen weer en leiden dus sneller tot begrip. Tijdens het schrijfproces is het daarom raadzaam om de teksthoeveelheid zoveel mogelijk te beperken. Simplified Technical English, het minimalisme en topic-based authoring uit aandachtspunt 5 zorgen daar al voor. Maar misschien is wel helemaal geen tekst nodig! Dat scheelt ook alvast in de vertaalkosten…

7. Gebruik gerichte illustraties of animaties

Velen onder ons zijn ermee vertrouwd: de IKEA-tekeningen die ons vertellen hoe we een stoel of kast in elkaar moeten zetten. Waarom zijn de IKEA-tekeningen zo’n succes? Dat komt voor een groot deel omdat u in tekeningen kunt benadrukken wat belangrijk is. Aan welke ring moet u draaien en in welke richting? Een goed opgezette tekening vertelt u dat meteen. Een foto wordt door zijn overdaad aan informatie al snel een zoekplaatje. Daarom raden wij het gebruik van foto’s af. Bovendien kopiëren gebruikers nogal eens handleidingen. Foto’s worden dan steeds minder duidelijk.

Wat voor illustraties geldt, geldt ook voor animaties. Net als illustraties, zijn animaties relatief makkelijk te halen uit uw bestaande CAD-bestanden. Met bewegende beelden benadrukken animaties welke acties nodig zijn en in welke volgorde (draaien naar links en daarna naar rechts? Of klikken naar rechts en daarna naar links?). Via een QR-code op een machineonderdeel kan een reparateur zelfs direct de animatie oproepen met de gewenste actie.

8. Vertaal en lokaliseer, indien nodig

Vaak bent u verplicht om uw gebruikershandleiding te vertalen, bijvoorbeeld vanwege Europese wetgeving. Vertaling kan ook een bewuste keuze zijn: iemand in zijn moedertaal aanspreken komt vriendelijk en professioneel over.

Vertalen is echter een vak apart, zeker als het op technische termen aankomt. Een vliegtuig daalt weliswaar, maar het stijgt niet – het klimt. “Gear down” betekent in de luchtvaartwereld niet “Versnelling lager” maar “Landingsgestel uit”. Kortom: het is altijd belangrijk om gespecialiseerde vertaalbureaus in te schakelen. Kennis van de materie is bittere noodzaak. Dat komt ook tot uiting in lokalisering. Als in de originele Britse handleiding de auto’s links rijden (en het stuur rechts zit) is het goed deze situatie aan te passen voor gebruik in rechts rijdende landen.

9. Archiveer herbruikbare teksten en illustraties

Om gebruikershandleidingen op te stellen en te beheren bestaan er flink wat programma’s. Wij noemen: MadCap, FrameMaker en Author-It, alle drie pakketten die sterk zijn in het opstellen en daarna organiseren van technische documentatie. Bij die organisatie gaat het met name om de herbruikbaarheid van teksten en illustraties.

Uiteraard maakt Manualise gebruik van dergelijke software. Zo zijn we officieel dealer van MadCap. Maar we ontwikkelen ook eigen software als we denken dat we daarmee een kosteneffectieve oplossing voor onze klanten kunnen bieden. Herbruikbaarheid staat altijd volop.

10. Genereer de output in de gewenste vorm(en)

Met onze softwaregereedschappen zetten wij uw productinformatie om in een gebruikershandleiding in de door u gewenste vorm(en). We onderscheiden drie outputvormen: print, online en offline ‘on device’. In de laatste twee gevallen is het mogelijk 2D-tekeningen of 3D-animaties te tonen.