Wanneer een technische handleiding maken?

Een technische handleiding wordt over het algemeen bij een product verschaft om een veilig en juist gebruik te stimuleren. Als producent dient u namelijk te waarschuwen tegen "niet in het ontwerp uitgesloten" risico's. Deze informatie heeft vaak automatisch de vorm van een handleiding, met name omdat het nog steeds verplicht is een papieren document bij het product te voegen.

Vaak hebben de verplichtingen omtrent handleidingen te maken met CE markering. Door een CE markering aan te brengen verklaart de producent dat het product voldoet aan de daarvoor geldende richtlijnen binnen de EU. Deze richtlijnen zijn opgenomen in de wetten van alle individuele lidstaten. Richtlijnen (en dus ook de wetten) verplichten de producent ook de nodige informatie te verschaffen voor een veilig en juist gebruik. Soms hoeft een product niet CE gekeurd te worden. Afhankelijk van het product kan het dan toch verstandig zijn om een handleiding bij het product te verschaffen, bijvoorbeeld vanwege de productaansprakelijkheid.

Inhoud van een technische handleiding

Vanzelfsprekend is de inhoud van iedere technische handleiding anders omdat deze met name door het product wordt bepaald. Het doel van een handleiding is echter meestal hetzelfde: de gebruiker instructies geven hoe het product goed en veilig gebruikt kan worden. De NEN5509 (of de internationale IEC 82079) geeft een minimum aan normen voor de informatieve inhoud, de structuur, de formulering en de presentatie van handleidingen. Volgens deze norm dient een goede technische handleiding ten minste de volgende inhoud te bevatten:

• Technische specificaties
• Voorzorgsmaatregelen en veiligheidsinstructies
• Beschrijving van het product; samenstelling van het product
• Montage, installatie, ingebruikname
• Beschrijving van de bediening, wijze van gebruik
• Onderhoud en onderhoudsschema
• Buitenbedrijfstelling
• Demontage, sloop, opslag en transport
• Storingen en reparatie
• Milieu
• Afdanken

Waar rekening mee te houden?

Het schrijven van een goede technische handleiding is een vak! Technisch schrijvers, documentalisten, handleidingen ontwerpers en dergelijke dienen een waslijst van eigenschappen te bezitten, zoals kwaliteitsdrang, analytisch denkvermogen, sociale vaardigheden ten behoeve van communicatie tussen experts en leken, nieuwsgierigheid, oog voor detail etc. etc. De volgende aspecten verdienen speciale aandacht bij een goede instructie, gebruiksaanwijzing of het schrijven en maken van een handleiding.

Productinformatie verzamelen

U dient in staat te zijn de juiste informatie op te zoeken en te identificeren. Vaak dient u hiervoor meerdere experts te raadplegen, zoals experts op het gebied van mechanica, elektronica, installatietechniek, software, user-interfaces, wetgeving en aansprakelijkheid, etc. etc.

Handleiding schrijven

Het schrijven, ook wel aangeduid met technische communicatie, is één van de belangrijkste aspecten bij een goede en begrijpbare technische handleiding. Volgens de overkoepelende Europese organisatie TCeurope is Technisch Communicatie de kunst en wetenschap van "het accuraat, op juiste wijze en effectief kunnen overbrengen van feitelijke informatie aan bepaalde doelgroepen voor specifieke doeleinden". Het is van belang dat u volledige kennis heeft van de taal waarin u schrijft, inclusief spelling, grammatica en opbouw. Enkele belangrijke begrippen die u kunnen helpen bij een goede technische communicatie zijn Simplified Technical English (STE), Minimalisme en kennis van de doelgroep (zie onder aan deze pagina).

Illustraties

Het is een cliché, maar plaatjes zeggen meer dan 1000 woorden. De waarde van goede illustraties wordt nog eens extra goed onderstreept door het feit dat 1,1 miljoen Nederlanders niet goed blijkt te kunnen lezen. Met een informatieve afbeelding kan op een meer effectieve manier worden uitgelegd hoe iets werkt of hoe iets uitgevoerd dient te worden. Onderzoek naar informatieoverdracht heeft aangetoond dat met illustraties de tijd om iets te leren wordt verkort en dat de aandacht van de gebruiker beter vast gehouden kan worden. Een ander groot voordeel van illustraties is het toevoegen van levendigheid en kleur aan technische handleidingen. Ook de grafische vormgeving van het document an sich helpt hier bij. Illustraties voorkomen eindeloos verklarende teksten en hoeven niet vertaald te worden. Denk maar eens aan de handleiding van het bekende Zweeds woonwarenhuis.

Technische handleiding vertalen

Als de technische handleiding dan eindelijk min of meer zijn vorm heeft gekregen, dient deze vaak vertaald te worden. Het is van belang om altijd samen te werken met een vertaalbureau dat bekend is met technische handleidingen vertalen, het liefst zelfs met een bureau dat op de hoogte is van uw bedrijfstak. Consequent taalgebruik is erg belangrijk in een handleiding. Als uw vertaalbureau het zelf niet initieert, zorg er dan voor dat het juiste jargon in alle talen wordt uitgewisseld. Indien het jargon niet bekend is kan het vertaalbureau worden gevraagd om een keuze te maken die vervolgens met de doelgroep geklankbord kan worden. Bij repeterende vertaalopdrachten zal het vertaalbureau de juiste terminolgie uit het vertaalgeheugen kunnen halen. Dit wordt terminologie management genoemd.

Tools gebruiken

Voor het effectief kunnen maken, beheren en publiceren van technische handleidingen bestaan diverse tools. De meeste tools hebben als uitgangspunt het stimuleren van hergebruik van teksten en het effectief kunnen samenstellen van documentatie. Enkele belangrijke termen zijn DITA en xml. Voorbeelden van software pakketten voor het maken, beheren en publiceren van technische handleidingen zijn onder andere Framemaker, Madcap Flare en Adobe Indesign.

Doelgroep

Eén van belangrijkste punten voor goede communicatie is het kennen van uw gebruiker. Mensen hebben verschillende eigenschappen, zoals leeftijd, opleidingsniveau, geslacht, enzovoort. Hierdoor moeten ze op een andere manier benaderd worden. Wordt dit niet goed gedaan, dan bereikt de informatie niet of in mindere mate haar doel. Vraag u iedere keer weer af voor wie de handleiding wordt geschreven. Zorg dat u zich constant bewust bent van de eigenschappen van deze doelgroep. Wordt de handleiding bijvoorbeeld voor de installateur geschreven of voor de consument? En is deze eindgebruiker de bediener van een machine of de bewoner van een bejaardenflat die met een alarmsysteem moet omgaan? Veel mensen vinden een handleiding saai, moeilijk te lezen of kunnen hun antwoord niet vinden. Door u vooraf in de doelgroep te verdiepen kunt u veel van deze ergernissen voorkomen.

De inhoud van een handleiding dient:

• To the point te zijn, kort en mag weinig inspanning van de gebruiker vragen om de informatie tot zich te moeten nemen;
• Makkelijk te begrijpen zijn. Speciale aandacht dient uit te gaan naar hoofdstuk- en paragraafkoppen (headings) en introducties; deze zorgen ervoor dat informatie zijn weg zal vinden naar de gebruiker.
• Speciale aandacht aan storingen te schenken. Dit zijn de momenten dat de handleiding het meest geraadpleegd wordt.
• In balans te zijn. Visuele en tekstuele content moeten elkaar ondersteunen.
• Geleid te worden door het te behalen voordeel: technologie en features van producten moeten vertaald worden naar begrijpbare menselijke instructies. De handleiding moet voorbeelden en scenario’s bevatten.
• Warm, toegankelijk en plezierig te zijn.

Simplified Technical English (STE)

Een norm die de afgelopen jaren binnen tal van industrieën veel ruimte heeft gewonnen is het Simplified Technical English (STE). Het STE is een ingeperkte taal die woorden en zinsdelen uitsluit die te moeilijk zijn voor de doelgroep of die verwarring kunnen veroorzaken. STE draait om eenduidigheid. Deze vorm van het Engels is ontstaan in de vliegtuigindustrie, waar behoefte ontstond aan een norm die door iedereen wordt begrepen en waarbij dubbelzinnigheid wordt uitgesloten. Dit gebeurt door het principe toe te passen dat een woord slechts één betekenis mag hebben. Neem bijvoorbeeld de zin ‘Turn off engines not required’. Deze zin kan zowel geïnterpreteerd worden als ‘turn off the engines that are not required’, maar ook als ‘turning off the engines is not required at all’. Het verkeerd interpreteren van deze zin kan grote gevolgen hebben.

Een aantal basisregels uit het STE voor het schrijven van documentatie, zoals technische handleidingen, zijn:

• Kies slechts één betekenis indien er meerdere synoniemen voor een woord bestaan en gebruik die altijd! Bijvoorbeeld: commence, begin, start, originate en initiate kunnen allemaal ‘beginnen’ betekenen in het Engels. STE heeft voor start gekozen, omdat dit werkwoord de meest regelmatige vervoegingen heeft.
• Kies slechts één betekenis indien een woord meerdere betekenissen heeft. Zo wordt in het STE het Engelse ‘fall’ alleen gebruikt wanneer ‘het door de zwaartekracht naar beneden halen van iets’ wordt bedoeld. Het wordt niet gebruikt voor bijvoorbeeld ‘het ten onder gaan’ van iets.
• Woorden hebben in het Engels vaak verschillende grammaticale functies. Het STE gebruikt alleen de in het STE toegestane woordsoort van een woord. Met ‘switch’ kan het zelfstandig naamwoord ‘schakelaar’ worden bedoeld, maar ook het werkwoord ‘schakelen’. Het STE gebruikt het alleen als zelfstandig naamwoord. Voor schakelen wordt ‘turn off’ of ‘turn on’ gebruikt.

Minimalisme

De minimalistische minimalistische benadering vindt zijn oorsprong in 1982 door het werk van John Carroll. In Nederland houdt Dr. Hans van der Meij van de Universiteit Twente zich actief bezig met het minimalisme. Omdat Carroll en zijn collega’s ontevreden waren over bestaande vormen van gebruiksondersteuning (zoals technische handleidingen), hebben ze middels observaties achterhaald op welke manieren gebruiksondersteuning effectiever aansluit bij het handelen van de gebruiker. Minimalisme is een ontwerp filosofie. De vier basisprincipes van minimalisme zijn:

• Kies voor een actiegerichte benadering en ben niet te beschrijvend. Gebruikers willen dingen doen! Dit principe benadrukt de centrale rol van de gebruiker in het minimalisme.
• Leg het hulpmiddel vast in het takendomein. Een tool is een middel om een doel te bereiken. Dit principe zorgt ervoor dat de gebruiker zelf de taken selecteert die betekenisvol zijn.
• Ondersteun foutenherkenning en herstel. Vergissen is menselijk. Er zijn verschillende manieren om de bekwaamheid en comfort niveaus van de gebruiker te vergroten bij het handelen met vergissingen.
• Ondersteun de gebruiker om te doen, studeren en lokaliseren. Een aanwijzing volgens het minimalisme dient zoveel mogelijk aan te sluiten op de uiteenlopende behoeften en neigingen van de doelgroep. Dit principe sluit ook aan bij de centrale rol van de gebruiker in het minimalisme.