Hoe wij uw handleiding maken

Omdat niet ieder product hetzelfde is, zijn de instructies om het product te gebruiken ook altijd anders. De weg om tot een rechtsconforme en gebruiksvriendelijke handleiding, online help, video of andere vorm van productinformatie te komen is echter meestal dezelfde. Lees op deze pagina wat u moet weten over een handleiding maken, of download onze whitepaper over het maken van gebruiksvriendelijke gebruiksinstructies.

 

 


#1. We verdiepen ons in uw doelgroep voordat we beginnen met een handleiding maken

Als wij een handleiding maken, dan moet de informatie in de handleiding geschreven zijn voor de specifieke doelgroep van het product. Hierbij moet de doelgroep eerst goed worden gedefinieerd, en moet bedacht worden hoe u de doelgroep het beste van informatie kan worden voorzien. De gemiddelde consument van een elektrische tandenborstel vergt een heel andere benadering dan de installateur van een CV-ketel, om maar een voorbeeld te noemen. Alle informatie moet naar de doelgroep gecommuniceerd te worden op een manier dat zij het begrijpen, zonder dat er afbreuk wordt gedaan aan belangrijke feitelijkheden.

#2. We onderzoeken de eisen uit de relevante Europese richtlijnen die betrekking hebben op een handleiding maken

Brengt u producten binnen de EU op de markt? Dan is de kans groot dat er Europese richtlijnen van toepassing zijn op uw product. Deze richtlijnen verplichten u in veel gevallen om bepaalde informatie in de handleiding op te nemen. Belangrijke richtlijnen zijn de Richtlijn inzake Algemene Productveiligheid (2001/95/EG), alsmede de CE-richtlijnen. Deze richtlijnen bepalen dat eventuele restrisico’s van het product beschreven moeten worden in de handleiding. Voordat wij beginnen met een handleiding maken, Zorgen wij dat we op de hoogte zijn van de richtlijnen die op uw product(groep) van toepassing zijn.

#3. We bepalen wat de beste indeling is voor een handleiding maken

De doelgroep waarvoor de handleiding bestemd is bepaalt welke informatie in de handleiding moet komen. Daarnaast geeft de internationale norm EN-IEC 82079-1 Preparations of Instructions for Use verdere richtlijnen voor de inhoud van de handleiding. Deze norm verstrekt informatie over een handleiding maken en beschrijft onder andere de minimaal op te nemen onderdelen en de structuur van de handleiding. Wij passen daar waar mogelijk de richtlijnen uit de 82079-1 toe.

Handleiding Maken

#4. We verzamelen de benodigde informatie voordat we de handleiding maken

Als de structuur en de indeling bepaald is, kan alle productinformatie worden verzameld. Denk hierbij aan de technische specificaties, informatie over het gebruik (installatie, bedienen, schoonmaken en repareren), 3D CAD bestanden, enzovoorts. We gaan in gesprek met de verschillende SME's (subject matter experts) die alle relevante informatie kunnen verstrekken. Hierbij is het zaak om niet alleen goed te luisteren, maar de betreffende informatie ook goed te analyseren en te begrijpen. Wij gaan de handleiding maken, dus wij moeten alles over het product te weten komen. De juiste vragen stellen is van essentieel belang!

#5. We schrijven de teksten en beginnen nu daadwerkelijk een handleiding te maken!

Zodra alle informatie is verzameld en een selectie is gemaakt van wat we wel en niet gaan gebruiken, kunnen de teksten geschreven worden. Het is belangrijk om tijdens het schrijven continu de doelgroep in het achterhoofd te houden, zodat de informatie op een voor hun begrijpelijke manier gecommuniceerd wordt. Technische beschrijvingen zijn doorgaans te complex voor de doelgroep; jargon kan bij een handleiding maken dan ook beter zoveel mogelijk achterwege worden gelaten. Door de principes van het Simplified Technical English (STE) toe te passen, kan de informatie op een duidelijke en ondubbelzinnige manier worden overgebracht. En door de titels van de hoofdstukken goed te kiezen wordt het voor de lezer in één oogopslag duidelijk waar het betreffende hoofdstuk over gaat.

#6. We redigeren bestaande teksten tot korte maar krachtige informatie

Vaak is er al bestaande content beschikbaar. Deze bestaande content moet geredigeerd worden. Een goede handleiding is kort en bondig, dus veel teksten worden gereduceerd to korte instructieve zinnnen. Informatie moet straight to the point zijn; op die manier hoeft de gebruiker slechts een minimale inspanning te leveren om de benodigde informatie te verkrijgen en begrijpen. Het elimineren van overbodige informatie zorgt er niet alleen voor dat uw handleiding overzichtelijker wordt, maar ook dat we besparen op de kosten van het vertalen. In bepaalde gevallen kan het bij een handleiding maken goed zijn om stukken tekst te vervangen door illustraties.

 

#7. We gebruiken daar waar mogelijk illustraties bij een handleiding maken

Een illustratie zegt meer dan duizend woorden. Illustraties zorgen er niet alleen voor dat de hoeveelheid tekst wordt gereduceerd, maar ook dat bijvoorbeeld instructies veel duidelijker worden en dat de handleiding vriendelijker oogt. In bepaalde gevallen kunnen montage instructies of installatie instructies zelfs volledig vervangen worden door illustraties – denk maar aan de handleidingen van IKEA. Foto’s proberen we te vermijden, omdat als handleidingen worden gekopieerd de kwaliteit van foto’s achteruit gaat waardoor ze ze niet duidelijk genoeg meer zijn.

#8. Uw handleiding maken en documenteren

Er zijn verschillende software programma’s en Content Management Systemen die gebruikt kunnen worden voor het maken, bewerken, organiseren, documenteren en publiceren van handleidingen. Enkele voorbeelden hiervan zijn Adobe InDesign, Adobe FrameMaker, MadCap Flare en Author-it. Er moet een  pakket worden gekozen dat aansluit op uw wensen en behoeften, en dar de mogelijkheid biedt tot het hergebruiken van de content; een handleiding maken zult u waarschijnlijk wel vaker moeten doen!

#9. Uw handleiding maken in meerdere talen

Een handleiding maken betekent in de meeste gevallen dat de teksten naar één of meerdere talen vertaald moeten worden. De beslissing om te vertalen wordt veelal genomen om aan de betreffende wetgevingen te voldoen, maar bevordert uiteraard ook een gebruiksvriendelijke productondersteuning. Het is belangrijk om uw vertaler(s) of vertaalbureau met de grootste zorg te selecteren. Een goede vertaler heeft niet alleen een goede taalkennis en een consequent taalgebruik, maar ook kennis van de materie. Een goede vertaling van uw handleiding maken is natuurlijk een investering, maar wanneer de betreffende vertalingen in de toekomst hergebruikt kunnen worden, kunt u weer aanzienlijk besparen op uw kosten.

#10. Uw handleiding maken en publiceren

Na een uitvoerige controle van de content is het tijd om uw handleiding daadwerkelijk te publiceren. Daarbij onderscheiden we drie vormen van ‘output,’ namelijk online, print en on device. In veel gevallen wordt de handleiding in papieren vorm én als digitale download aangeboden. Maar de keuze van de output is natuurlijk in de eerste plaats afhankelijk van het soort product.


Vraag direct een offerte aan!

Vraag een offerte aan