Een handleiding maken in 10 stappen volgens Manualise
Een aantal elementen komt bij het maken van iedere handleiding vrijwel altijd terug. Een goede kennis of aanpak hiervan draagt bij aan de kwaliteit van de handleiding. De onderstaande opsomming beschrijft beknopt deze elementen.
1. Handleiding maken? Ken uw doelgroep!
De productinformatie dient op een accurate en effectieve manier te worden gecommuniceerd richting de gebruiker of doelgroep. Hierbij is het belangrijk om te weten dat iedere doelgroep zijn eigen eigenschappen heeft, waar bij het maken van de handleiding rekening mee gehouden moet worden. Zo heeft een gemiddelde consument hele andere eigenschappen dan de installateur van bijvoorbeeld een waterzuiveringsmachine. Dit resulteert in een andere benadering.
Bij het maken van een handleiding wordt meestal gesproken met meerdere experts, zoals engineers (werktuigbouwkundigen, elektrotechnici, industrieel ontwerpers), installateurs, onderhoudstechnici, marketing experts etc. Al deze experts leveren informatie over het product aan. En al deze experts gebruiken hun eigen jargon. Bij het maken van de handleiding is het de kunst om al deze informatie dusdanig naar de beoogde doelroep te communiceren dat zij het begrijpen, zonder afbreuk te moeten doen aan de feitelijkheid van de informatie.
Verder geldt voor iedere gebruiker en voor het maken van iedere handleiding:
- Elimineer overbodige info. Schrijf to the point. Of zoals Albert Einstein zei: “Everything should be made as simple as possile, but not simpler”.
- De gebruiker dient zo weinig mogelijk inspanning te moeten leveren (maar een beetje mag wel volgens de principes van het minimalisme)
- Navigatie is belangrijk. Inhoudsopgaven moeten duidelijk maken welke informatie op de betreffende bladzijde gevonden gaat worden. Headings moeten duidelijk maken waarom de gebruiker tijd moet investeren om dat onderdeel te lezen. Gebruik bijvoorbeeld een heading als How to connect to a device in plaats van Bluetooth Connectivity.
2. Onderzoek de relevante richtlijnen
De Richtlijn voor Productaansprakelijkheid 85/374/EEG beschermt de consument tegen schade als gevolg van een gebrekkig product. Wanneer een product een gebrek vertoont kan de producent (of importeur) aansprakelijk worden gesteld. Een handleiding wordt gezien als integraal onderdeel van het product. Een onvoldoende doeltreffende handleiding kan dus betekenen dat het product als gebrekkig wordt beoordeeld.
Daarnaast verplichten CE-richtlijnen het dat eventuele restrisico’s van een product worden beschreven in een handleiding. Het is daarom essentieel om op de hoogte te zijn van de richtlijnen die op het product van toepassing zijn. Zijn deze richtlijnen bekend, dan kan hieruit worden afgeleid waar rekening mee moet worden gehouden bij het maken van de handleiding. Zo verplicht de machinerichtlijn onder andere om zowel het beoogde gebruik als het voorzienbare verkeerde gebruik op te nemen in de handleiding. Daarnaast dient informatie over het geluidsniveau, de stabiliteit, de fabrikant enz. te worden opgenomen. De machinerichtlijn en een aantal andere richtlijnen stellen ook eisen aan de vertalingen van de handleiding.
3. Bepaal de indeling van de handleiding
Een handleiding dient volledig te zijn en een goed en veilig gebruik te stimuleren. Vaak verplichten de richtlijnen bepaalde elementen op te nemen. In vele gevallen laten de richtlijnen ook ruimte open voor een verdere eigen interpretatie. Een handvat voor het maken van eenn goede handleiding is door het gebruik van normen. De NEN5509 is de Nederlandse norm voor gebruikershandleidingen. Deze norm beschrijft de inhoud, structuur, formulering en presentatie van handleidingen. Er wordt een indeling beschreven die in een goede handleiding aanwezig zou moeten zijn. Minimaal op te nemen onderdelen zijn volgens de norm bijvoorbeeld een hoofdstuk veiligheidswaarschuwingen, technische specificaties, installatie, gebruik en onderhoud. Maar ook stelt de norm een minimum aan vereisten voor bijvoorbeeld de titelpagina of het voorwoord en de lettergrootte.
4. Verzamel productinformatie
Voor het maken van een handleiding is het zaak zoveel mogelijk productinformatie te verzamelen, zoals technische specificaties, installatieplannen, marketing documentatie, eventuele CAD bestanden etc. Deze informatie wordt verworven door experts binnen desbetreffende organisatie te spreken. Het is de kunst goed te luisteren, de informatie te analyseren en begrijpen, vragen te stellen ter bevestiging van gedachtes en te kunnen selecteren.
5. Schrijf effectieve en instructieve teksten
Als alle informatie is verzameld en geselecteerd, kan deze gebruikt worden voor het genereren van teksten. Het constant bewustzijn van de doelroep waarvoor de handleiding gemaakt wordt is essentieel. De informatie dient namelijk begrijpelijk naar de doelgroep te worden gecommuniceerd. Over het algemeen moet dan ook de al aanwezige productinformatie geredigeerd worden. Vaak is het namelijk zo dat marketingteksten niet accuraat genoeg zijn en technische beschrijvingen niet begrijpelijk genoeg voor de doelgroep. De principes van het minimalisme en Simplified Technical English (STE) kunnen helpen de informatie effectiever en beter over te brengen. Als STE correct wordt gebruikt, biedt het een bedrijf alle voordelen van standaardisatie: Uniformiteit, verhoogde productiviteit en kostenbesparing. Toepassing van minimalisme zorgt voor een reductie van de trainingstijd met zo’n 30% en dat het tot zich kunnen nemen van informatie door de gebruiker met 25% verbetert.
6. De handleiding kort en bondig maken (reduceer) tekst
Niemand wil graag veel lezen in een handleiding en niemand zit te wachten op veel vertaalkosten. Illustraties vervangen woorden, vertellen meer dan (1000) woorden en hoeven natuurlijk niet vertaald te worden. Ook het eerder besproken STE reduceert tekst. Zinnen bevatten vaak overbodige woorden en informatie. Door de principes uit de STE norm (de ASD-STE100) toe te passen wordt al het overbodige geëlimineerd wat gemiddeld een reductie van wel 30% oplevert.
7. Illustraties/ animaties voor de handleiding maken
Naast dat illustraties tekst reduceren, worden instructies veel duidelijker door middel van een afbeelding dan van alleen een omschrijving in woorden. Montage- en installatie instructies zijn meestal volledig te vervangen voor afbeeldingen, zodat een IKEA-achtige handleiding ontstaat. Vermijd het gebruik van foto’s in een handleiding. Soms worden handleiding gekopieerd, waardoor de kwaliteit van een foto drastisch achteruit gaat. Daarnaast bevat een foto te veel overbodige informatie, waardoor deze onduidelijk wordt. Bij het maken van een goede illustratie kan gekozen worden welke productinformatie of –details weg te laten, zodat de aandacht volledig kan gaan naar de beoogde handeling. Illustraties zorgen ook voor een vriendelijk ogende handleiding die prettiger is om te lezen. De CAD bestanden die gebruikt worden om illustraties te maken worden overigens ook steeds vaker toegepast om 3D animaties te maken die het gebruik van een product uitleggen. Een QR code op een machineonderdeel kan zo de reparateur direct verinden met een animatie over hoe het betreffende onderdeel te vervangen.
8. Vertalen/ lokaliseren
Vanwege internationalisering dient een handleiding vaak vertaald te worden. Soms wordt de beslissing om te vertalen uit het oogpunt van goede en gebruiksvriendelijke productondersteuning genomen en soms puur om aan de wetgeving te voldoen. Vertalen is een vak apart en daarom dient het vertaalbureau met zorg te worden uitgezocht. Kennis van de materie hebben en consequent taalgebruik zijn belangrijke aspecten. Bij repeterende projecten kan het vertaalbureau een beroep doen op het vertaalgeheugen. Ook door een goed beheer van vertaalde teksten kan hergebruik gestimuleerd worden, waardoor aanzienlijke kosten worden bespaard.
9. Organiseren en documenteren
Er bestaan vele programma’s om slim om te gaan met het maken en beheren van handleidingen. Enkele van deze zogenaamde authoring/editing/ publishing programma’s zijn Autor-it, MacCap Flare en FrameMaker Deze pakketten zijn sterk in het organiseren van informatie. Hiermee wordt bedoeld dat informatie modulair kan worden opgeslagen om hergebruik te stimuleren. Wij hebben ook eigen software ontwikkeld om tekstmodules op te slaan. Deze software sluit beter aan bij de hogere eisen van enkele van onze klanten op het gebied van de grafische vormgeving van de handleiding.
10. Output genereren (de daadwerkelijke handleiding maken)
De productinformatie wordt met behulp van software tools omgezet tot een handleiding. We onderscheiden drie vormen van output, te weten print, online en on device. Bij online en on device handleidingen kan, naast het gebruik van 2D tekeningen, ook gewerkt worden met 3D animaties.
