Een handleiding schrijven in 6 stappen

De inhoud van elke handleiding is natuurlijk anders, maar het plan van aanpak voor een handleiding schrijven is bij vrijwel elk product hetzelfde. Op deze pagina vertellen we u in 6 stappen wat u moet weten over een handleiding schrijven. INSTRKTIV kan de gehele handleiding voor u ontwikkelen. Wij maken uw drukklare handleiding of digitale gebruiksinformatie, zoals Online Help.


#1. Vraag uzelf af: voor wie gaat u de handleiding schrijven?

Voor u begint met een handleiding schrijven is het belangrijk om uw doelgroep te definiëren, zodat u de informatie op een heldere manier naar de gebruiker kunt communiceren. Elk type gebruiker vereist een andere manier van schrijven; senioren bijvoorbeeld, stellen heel andere eisen aan een handleiding dan professionele installateurs. Senioren hebben doorgaans geen boodschap aan vaktaal en behoeven een handleiding die op een simpele, duidelijke manier is geschreven.

#2. De inhoudsopgave van uw handleiding schrijven

Een volledige inhoudsopgave voor uw handleiding schrijven is essentieel. Belangrijke zaken mogen niet achterwege worden laten. Daarom zijn er (internationale) normen voor handleidingen, zoals de EN IEC 82079-1 Preparations of Instructions for Use. Hierin wordt onder andere beschreven welke onderdelen er in ieder geval in een goede handleiding zouden moeten staan. Daartoe behoren een hoofdstuk met technische specificaties, een hoofdstuk over de installatie, een hoofdstuk over de ingebruikname van het product, een hoofdstuk over het onderhoud en een hoofdstuk met waarschuwingen. De norm bevat ook aanbevelingen en richtlijnen met betrekking tot lettergrootte en titelpagina’s.

Handleiding schrijven

 

#3. De productinformatie verzamelen

Alvorens u begint met de daadwerkelijke handleiding schrijven dient u in gesprek te gaan met verschillende betrokken experts, die alle benodigde informatie over het product kunnen aanleveren. Hierbij kunt u denken aan CAD bestanden, risicoanalyses en productbeschrijvingen. Het is van essentieel belang dat de schrijver alle informatie ook daadwerkelijk begrijpt; hij moet dus niet alleen goed kunnen luisteren, maar ook analyseren, selecteren en vragen stellen. Daarbij moet u bij een handleiding schrijven op de hoogte zijn van de regelgeving over het betreffende product. Op consumentengoederen is de richtlijn 2001/95/EG inzake Algemene Productveiligheid van toepassing. Deze richtlijn stelt dat alle producten die op de markt worden gebracht veilig moeten zijn. De richtlijn 85/374 inzake de aansprakelijkheid voor producten met gebreken beschermt de consument tegen producten met gebreken. Een gebrekkige handleiding zal ook als een gebrek aan het product wordt beschouwd!

#4. De teksten van uw handleiding schrijven

Zodra alle informatie is verzameld en georganiseerd, kan worden begonnen met de handleiding schrijven. In de meeste gevallen moet de verzamelde informatie geredigeerd worden; zo is technische informatie vaak veel te complex voor de doelgroep. Om de betreffende informatie op een ondubbelzinnige manier naar de gebruiker te kunnen communiceren, kunt u gebruik maken van de principes van het Simplified Technical English (STE). Door de principes van het Minimalisme toe te passen zorgt u ervoor dat de gebruiker snel wordt voorzien van heldere instructies en mogelijkheden om storingen op te lossen.

 

#5. De illustraties bij uw handleiding maken

Bij een handleiding schrijven wordt er vaak voor gekozen om stukken tekst met illustraties te ondersteunen of door illustraties te vervangen. Een afbeelding zegt tenslotte meer dan duizend woorden! Ook zorgt het toevoegen van illustraties dat er minder tekst nodig is, waardoor de vertaalkosten gereduceerd kunnen worden. De voorkeur wordt meestal gegeven aan lijnillustraties. Doordat deze illustraties een versimpelde weergave van de werkelijkheid zijn, wordt de nadruk gelegd op alleen de belangrijke zaken.  Om bewegingen aan te duiden wordt meestal met pijlen gewerkt. Details worden vaak uitvergroot door middel van een 'balloon'.  

#.6 De handleiding samenstellen en publiceren

Hoewel de meeste producten nog altijd met een papieren handleiding geleverd worden, maakt men steeds vaker gebruik van online handleidingen en zogeheten ‘on device’ handleidingen. Er zijn diverse software pakketten die geschikt zijn voor het samenstellen en publiceren van handleidingen, waaronder MadCap Flare, Adobe FrameMaker en Author-it. Door de content op een goede manier te beheren wordt hergebruik gestimuleerd, waardoor u in de toekomst aanzienlijk kunt besparen op een handleiding schrijven.


Vraag direct een offerte aan!

Vraag een offerte aan