Een handleiding laten maken in 10 stappen

Ieder product is anders en dus is de inhoud van elke handleiding, video of online help natuurlijk ook anders. Maar het plan van aanpak voor een handleiding, evenals de onderwerpen die behandeld worden, zijn vrijwel altijd hetzelfde, of het nu om een fysiek product of software gaat. Op deze pagina vertellen we u in tien stappen wat u moet weten over een handleiding  laten maken


#1. Uw doelgroep leren kennen

Om alle informatie in de handleiding zo effectief mogelijk over te kunnen brengen, dient u gedurende het hele proces rekening te houden met uw doelgroep. Elke doelgroep heeft weer andere eigenschappen; de gebruiker van een kinderbuggy vraagt een heel andere benadering dan de installateur van een pelletkachel, om maar een voorbeeld te noemen. Een handleiding laten maken voor consumenten betekent dat er zo min mogelijk jargon gebruikt moet worden, zodat de informatie op een begrijpelijke wijze gecommuniceerd kan worden zonder dat er afbreuk wordt gedaan aan feitelijkheden.

#2. Relevante richtlijnen onderzoeken

Bij een handleiding laten maken dient u rekening te houden met de Europese regelgeving die van toepassing is op handleidingen. De Richtlijn voor Productaansprakelijkheid (85/374/EEG) beschermt de consument tegen schade als gevolg van een gebrekkig product. Omdat de handleiding als een integraal onderdeel van het product wordt beschouwd, kunt u als producent niet alleen aansprakelijk worden gesteld voor een gebrekkig product, maar ook voor een gebrekkige handleiding.

Bent u verplicht een CE-markering op uw product aan te brengen? Dan dient u tevens rekening te houden met de CE-richtlijnen die op het betreffende product van toepassing zijn.

Handleiding maken

#3. De indeling van de handleiding bepalen

In de Nederlandse norm voor gebruikershandleidingen (NEN5509) wordt o.a. de inhoud, structuur en presentatie van een goede handleiding beschreven. De Europese richtlijnen verplichten u om bij een handleiding laten maken bepaalde elementen in ieder geval op te nemen. Hierbij kunt u denken aan een hoofdstuk technische specificaties, een hoofdstuk veiligheidswaarschuwingen, een hoofdstuk over de installatie en een hoofdstuk over het onderhoud. Ook de minimale vereisten met betrekking tot bijvoorbeeld de grootte van het gebruikte font worden beschreven.

#4. Informatie over het product verzamelen

Bij een handleiding laten maken is het van essentieel belang om vooraf zoveel mogelijk informatie over het betreffende product te verzamelen bij de experts binnen de organisatie. Hierbij kunt u denken aan technische specificaties, installatie-instructies, CAD bestanden en marketing documentatie. Wanneer u in gesprek gaat met de betreffende experts, is het de kunst om niet alleen goed te luisteren, maar ook de informatie te analyseren en te begrijpen, en vragen te stellen ter bevestiging.

#5. De teksten laten schrijven

Een handleiding laten maken, en dan met name het schrijven van effectieve instructieve teksten is een vak apart en wordt in de meeste gevallen dan ook uitbesteedt aan een specialist. Tijdens het schrijven van de teksten dient de schrijver zich constant bewust te zijn van de doelgroep waarvoor de handleiding wordt gemaakt, zodat de informatie op een begrijpelijke manier naar hen gecommuniceerd kan worden. In veel gevallen dient de verzamelde informatie over het product sterk geredigeerd te worden. Technische beschrijvingen bijvoorbeeld, zijn te complex en bevatten teveel jargon voor de doelgroep. De gebruiker moet aan de titels van de hoofdstukken direct kunnen afleiden waar het betreffende hoofdstuk over gaat.

#6. Een korte en bondige handleiding laten maken

Overbodige informatie dient geëlimineerd te worden. Door gebruik te maken van de principes van het minimalisme en Simplified Technical English (STE) kan de hoeveelheid tekst gereduceerd worden, waardoor de gebruiker minder inspanning hoeft te leveren om dingen aan te leren en minder tijd nodig heeft om informatie op te nemen.

 

#7. Illustraties voor de handleiding laten maken

Bekijk waar u teksten (gedeeltelijk) kunt vervangen door illustraties. Deze zijn vaak niet alleen duidelijker voor de gebruiker, maar zorgen ook voor een reductie van de hoeveelheid tekst en dus een besparing bij het vertalen. Instructies met betrekking tot de montage of installatie van het product zijn vaak geheel te vervangen door illustraties. Dit wordt bijvoorbeeld ook toegepast bij de handleidingen van IKEA producten. Omdat handleidingen vaak gekopieerd worden en de kwaliteit van foto’s daardoor sterk achteruit gaat, verdienen simpele illustraties de voorkeur. Wilt u een digitale handleiding laten maken, dan kunt u eventueel overwegen om (3D) animaties toe te voegen.

#8. Een vertaling van de handleiding laten maken

De beslissingen voor een handleiding laten maken in meerdere talen kan worden genomen om de gebruiksvriendelijkheid van de productondersteuning te bevorderen, of puur om aan de regelgeving te voldoen. Een goede vertaling van een handleiding laten maken dient altijd door een specialist gedaan te worden. Deze dient niet alleen voldoende kennis van de talen te hebben maar ook van de materie. Door zowel de originele content als de vertalingen goed te beheren kan hergebruik gestimuleerd worden, wat een aanzienlijke kostenbesparing kan opleveren.

#9. De juiste software kiezen voor een handleiding laten maken

Er zijn tal van software programma’s die gebruikt kunnen worden bij een handleiding laten maken en het samenstellen, vormgeven, organiseren, publiceren en beheren van handleidingen gemakkelijker maken. Hierbij kunt u denken aan bijvoorbeeld Adobe InDesign, Adobe FrameMaker, Author-it en MacCap Flare.

#10. De daadwerkelijke handleiding laten maken

Er worden die vormen van output onderscheiden, namelijk print, online en on device. Geprinte handleidingen zijn het meest gebruikt maar worden steeds vaker vervangen of aangevuld door online handleidingen. U kunt er uiteraard ook voor kiezen om uw handleiding op een CD-rom aan te leveren. Wilt u een online of on device handleiding laten maken, dan heeft u de vrijheid om de informatie in de handleiding aan te vullen met animaties.


Vraag direct een offerte aan!

Vraag een offerte aan