Inhoudsopgave
Definitie van een goede handleiding
De definitie van een goede handleiding concentreert zich maar op één woord: actiegerichtheid. Een handleiding bevat instructies om iets werkend te krijgen of werkend te houden. Dat klinkt zeer voor de hand liggend.
Toch zijn er veel handleidingen in omloop die eigenlijk helemaal niet actiegericht zijn. Het is heel goed voorstelbaar dat een handleiding eerst beschrijft waartoe een ventiel dient. Of welke voordelen dit ventiel heeft ten opzichte andere ventielen. Of welke kleurstellingen van het ventiel beschikbaar zijn. Iemand die het ventiel wil bedienen, wil repareren, wil onderhouden of wil vervangen zit niet te wachten op deze informatie. Hij of zij wil aan de slag.
Soorten handleidingen
Welke soorten handleidingen zijn er? Het antwoord luidt: er zijn zoveel handleidingen als de verschillende doelen waaraan de handleidingen moeten voldoen.
Het bekendste zijn de gebruikershandleidingen: handleidingen die het gebruik van een product of van software uitleggen. Als er een apart aan te stellen bediener nodig is voor het product, zoals een machinebankwerker, heet een gebruikershandleiding vaak een bedieningshandleiding. Maar de term ‘gebruikershandleiding’ is het meest gebruikelijk.
Wie een machine moet installeren, heeft een installatiehandleiding nodig. Deze handleidingen komen vaak voor. Een productiemachine vereist nu eenmaal een vrij uitgebreide installatie: van verankering op de vloer tot een specifieke aansluiting op het lichtnet tot het aanbrengen van veiligheidsvoorzieningen (zoals doorzichtige schermen). De installatieprocedure voor een printer past in het eerste hoofdstuk van een gebruikershandleiding. Maar de ingebruikname van een lasrobot of verkeerslicht vereist zo goed als zeker een aparte handleiding.
Soms zijn de producten zo complex dat ook speciale onderhoudshandleidingen nodig zijn. Denk aan een verkeersvliegtuig dat om de zoveel tijd een doorlicht- of opknapbeurt nodig heeft. Wanneer sprake moet zijn van een doorlichtbeurt en wanneer van een complete opknapbeurt, staat in de onderhoudshandleiding (in het Engels: maintenance manual). Deze handleidingen zijn onmisbaar voor complexe producten zoals vliegtuigen, schepen en treinen. Ze zijn ook onmisbaar voor personen- en vrachtwagens. In garagebedrijven staat dan ook menige onderhoudshandleiding op de plank.
Vaak heeft een gebruikershandleiding een afsluitend hoofdstuk ‘Probleemoplossing’. Juist voor complexe producten zijn vaak speciale handleidingen nodig die werkelijk een complete verzameling aan foutmeldingen op een rijtje zetten. Vaak heeft zo’n foutmelding een code, bijvoorbeeld EK76-AA: “Groene lampendriehoek signaleert geen vergrendeling van het landingsgestel”. In dit concrete geval geeft een storingshandleiding aan wat in de bemanning van een vliegtuig moet doen. Misschien functioneert het landingsgestel wel, maar zit de storing in de lampsignalering. Een storingshandleiding bevat instructies om achter het precieze euvel te komen en het zoveel mogelijk te verhelpen.
Criteria voor een goede handleiding
Een aantal schrijfregels maakt uit of een handleiding een hoge, middelmatige of lage kwaliteit heeft. Een voor de hand liggende schrijfregel kwam eigenlijk al eerder in dit artikel naar voren: een handleiding behoort instructies te bevatten. Achtergrondinformatie over de beschikbaarheid van ventielen in verschillende kleuren hoort niet in een handleiding, maar in een brochure. Dus: schrijf in een handleiding niet waarom de draagkracht van een vliegtuig optimaal is. Schrijf hoe je de besturingskabels veilig kunt spannen zodat de rolroeren op de vleugels veilig werken.
Hoort er dan helemaal geen achtergrondinformatie in een handleiding? De eerlijkheid gebiedt te schrijven: sommige achtergrondinfo is wel handig. Wel geldt er een voorwaarde: die achtergrondinformatie moet minimaal zijn. Bovendien moet de achtergrondinformatie het doel van de actiegerichtheid dienen. Een voorbeeld maakt dit concreet.
Stel dat het systeem om ijs van een vliegtuigvleugel af te breken een volledig nieuwe variant kent (ijs op de vleugels kan de draagkracht van de vleugels ernstig aantasten). Dan is het goed dat in de handleiding te vermelden. Zo’n nieuw systeem kan immers betekenen dat de bediening anders verloopt. Om te voorkomen dat iemand nog aan de oude manier van bedienen vasthoudt, is het goed op te merken dat het ‘ontijs’-systeem tegenwoordig met andere technische snufjes werkt. Stel dat het nieuwe systeem veel sneller werkt bij zelfs de kleinste hoeveelheden ijs. Dan weet de gebruiker – hier de piloot – dat een veel snellere activatie mogelijk is. Een snellere activatie kan alleen maar beter uitpakken om meteen vanaf het begin al het ijs van een vleugel weg te krijgen. De piloot krijgt als het ware een nieuw mentaal model mee waardoor hij anders over de noodzakelijke acties gaat denken.
Zulke achtergrondinformatie staat ten dienste van de actiegerichtheid. Maar deze informatie moet ook minimalistisch zijn, dat wil zeggen: er moet niet te veel achtergrondinfo in een handleiding staan. Dan sneeuwt de actiegerichtheid namelijk onder. Die actiegerichtheid houdt in dat in de handleiding klip-en-klaar staat: die-en-die knoppen zijn nodig om het ‘ontijs’-systeem aan te zetten.
Samengevat: geef als technisch schrijver een mentaal model wat de achtergrond is van acties, voor zover de lezer dat mentaal model nog niet zou kennen. Maar wees dan wel minimalistisch met de geboden informatie.
Wie deze middenweg bewandelt en de nadruk legt op actiegrichte instructies (“Klik de witte tuimelschakelaars tegelijk naar boven om de-icing op beide vleugels te activeren”), schrijft een goede handleiding.
Tips voor de opmaak en vormgeving van handleidingen
Tot nu toe gaat dit artikel over de inhoud van handleidingen. Maar een aantrekkelijke presentatie is minstens zo belangrijk.
‘Presentatie’ valt bij een handleiding uiteen in twee delen.
Allereerst moet de vormgeving aantrekkelijk zijn. Dit betekent bijvoorbeeld dat een handleiding een moderne, strakke uitstraling heeft die overeenkomt met de huisstijl van de fabrikant. Dergelijke afspraken komen vast te liggen in een zogenaamd ‘template’: een sjabloon met een overzicht van de gemaakte opmaakregels.
Deze opmaakregels zorgen niet alleen voor een aantrekkelijk jasje, maar dragen bij aan de leesbaarheid. Een voorbeeld: gaat de handleiding over een mobiele telefoon speciaal bedoeld voor 50-plussers, dan is het zeker een overweging waard de lettergrootte iets op te schroeven, bijvoorbeeld van 11 punts naar 12 punts.
Behalve een aantrekkelijke vormgeving die leesbaarheid afdwingt houdt ‘presentatie’ ook in: het gebruik van afbeeldingen. Mensen zijn visueel ingesteld, ze zijn van oudsher gewend te denken in beelden. Het bekende gezegde “Een plaatje zegt meer dan 1.000 woorden” komt hieruit voort. Het schrift is nog maar duizenden jaren oud. De visuele ervaring van onze voorouders is misschien wel 100 keer ouder. Kortom: een goede handleiding maakt gebruik van plaatjes als dat ook maar even kan. Plaatjes zeggen veel en dat in één keer.
Voorbeelden van goede en slechte handleidingen
Voorbeelden van goede en slechte handleidingen zijn er te over. Om te beginnen een voorbeeld van een slechte handleiding.
Een handleiding van een niet nader genoemde wasdroogcombinatie ziet er op zich goed uit. Toch blijkt bij nadere bestudering sprake van een aantal klassieke fouten:
- Als de combinatie te veel lawaai maakt, is het advies om het apparaat goed waterpas te zetten. De genoemde verwijzing naar het hoofdstuk ‘Montage’ heeft echter geen pas, want dat bevindt zich niet in de handleiding. Is er misschien sprake van een aparte (niet bijgeleverde) installatiehandleiding? Dit wordt niet duidelijk.
- De ene keer spreekt de handleiding over ‘waterontharder’ en de andere keer over ‘waterverzachter’. Bedoelt de fabrikant hier hetzelfde of gaat het om twee verschillende adviezen om de machine in goede conditie te houden?
- De hoofdstukken hebben niet altijd een duidelijke titel. Zo luiden de drie belangrijkste hoofstukken achtereenvolgens ‘
- Dagelijks gebruik
- Dagelijks gebruik: alleen drogen
- Dagelijks gebruik: wassen & drogen.
Het verschil tussen deze drie is niet meteen duidelijk. Duidelijker was geweest als onder a. had gestaan: ‘Dagelijks gebruik: alleen wassen’. Nu moet de lezer puzzelen wat onder dagelijks gebruik wordt verstaan.
- De teksten lopen voortdurend door, niet alleen na een paragraaf maar ook na een hoofdstuk. Een nieuw hoofdstuk begint dus niet op een nieuwe pagina. Zo ontstaan pagina’s vol met tekst zonder dat de lezer een duidelijk gevoel krijgt hoe de indeling van de handleiding is.
Voorbeelden van goede handleidingen zijn er natuurlijk ook. Dat zijn handleidingen waarbij verwijzingen naar andere pagina’s en handleidingen altijd kloppen. Dat is ook een handleiding waarbij de terminologie duidelijk is: dus niet de ene keer vermelding van het woord ‘deksel’ en de andere keer van het woord ‘cover’.
Neem een multifunctionele internetbox geleverd door een internetprovider. Daarin blijken gelukkig de volgende hoofdstukken duidelijk naar voren te komen: TV kijken, Op Internet surfen en Bellen. Het klinkt simpel en dat is het ook. Maar iets simpels simpel houden valt soms nog niet mee, zie het voorbeeld van de wasdroogcombinatie.
Handleiding laten schrijven door Manualise
Een handleiding die aan alle professionele en wettelijke eisen voldoet maar daarnaast vooral ook aan de wensen van de klant: dàt is het minimale streven van Manualise. Gevestigd in de TU-stad Delft, hebben alle technisch schrijvers een achtergrond in de techniek. Ze beschikken allemaal over een opleiding die techniek en taal samenbrengen. Die taal hoeft zeker niet een taal te zijn die louter bestaat uit woorden. Integendeel: Manualise beroept zich op zijn visuele instelling. Waar een plaatje het werk kan doen, gebruikt het bedrijf een afbeelding. Zodoende is het ultieme streven van dit jonge bedrijf: the best of all worlds.
