Wat is een handleiding en waarvoor dient die?
Een handleiding (Engels: manual) is een bundeling van beschrijvende, informatieve en instructieve teksten. Maar wat is het doel van een handleiding?
In het boek Handleiding voor technisch schrijven (Couthino, 1988) schrijft dr. H.A.J.M. Lamers dat "een goede handleiding een ingewikkeld apparaat toegankelijk en begrijpelijk maakt".
Dit citaat laat zien hoe een goede handleiding technisch complexe concepten toegankelijk maakt voor gebruikers. Om deze rol effectief te vervullen, bestaan er diverse soorten handleidingen die inspelen op specifieke doelen en gebruikersbehoeften.
Soorten handleidingen
- Montagehandleiding: handleiding met als belangrijkste doel te beschrijven hoe een product veilig en correct in elkaar gezet moet worden (Engels: assembly manual / assembly instructions).
- Installatiehandleiding: documentatie die beschrijft hoe een product veilig en correct moet worden bevestigd of aangesloten in de gebruiksomgeving of installatie (Engels: installation manual).
- Bedieningshandleiding: beschrijving van hoe een product veilig, correct en gebruiksvriendelijk bediend wordt (Engels: operating manual).
- Onderhoudshandleiding: documentatie die uitlegt hoe een product veilig en correct onderhouden wordt. De onderhoudshandleiding kan onder meer bestaan uit reinigingsinstructies, smeerinstructies, bewaarinstructies en instructies voor correctief onderhoud, perfectief onderhoud, preventief onderhoud en predictief onderhoud (Engels: maintenance manual).
- Reparatiehandleiding: set teksten die beschrijven hoe een product veilig en correct kan worden gerepareerd (Engels: repair manual).
- Installateurshandleiding: deze documentatie voorziet installateurs van de nodige instructies en informatie om een product, systeem of toestel veilig en correct te installeren (Engels: installer manual).
- Monteurshandleiding: deze handleiding verstrekt technische informatie aan onderhouds- en reparatietechnici, zodat die apparaten, machines of systemen veilig en correct kunnen monteren, onderhouden en repareren, of fouten kunnen opsporen (Engels: technician manual).
- Gebruikershandleiding: deze documentatie gaat in op de dagelijkse gebruikspraktijk van het product en bevat naast een gebruiksinstructies meestal ook veiligheidsrichtlijnen en onderhoudsinstructies gericht op de gebruiker van het product (Engels: user manual).
- Eigenaarshandleiding: handleiding toegespitst op de eigenaar van het product. Deze documentatie informeert de eigenaar van het product over zijn verantwoordelijkheid voor het veilig en juist monteren, installeren, en onderhouden van het product. De handleiding bezit daarom ook een zekere juridische component (Engels: owners manual).
Snelstartgidsen
Een bijzondere verschijningsvorm van de handleiding is de zogeheten snelstartgids, ook wel introductiehandleiding of verkorte instructie genoemd. Een snelstartgids (Engels: quick-start guide) is een gids die kernachtig beschrijft hoe gebruikers een product of dienst snel en efficiënt in gebruik kunnen nemen.
voorbeeld snelstartgids (Engels)
Indeling van een handleiding
In het eerder aangehaalde boek Handleiding voor technisch schrijven stelt dr. H.A.J.M. Lamers dat "De informatie en instructies in een handleiding helder, ondubbelzinnig, correct en in de juiste volgorde beschreven moeten zijn". Maar wat verstaan we nu precies onder 'de juiste volgorde'?
- Omslag en titelblad: naam en type van het apparaat, naam van de fabrikant, versie en jaar van uitgave.
- Voorwoord: uitleg over het gebruik van de documentatie.
- Inhoudsopgave: overzicht van de afzonderlijke hoofdstuktitels met bijbehorende paginanummer. Indien van toepassing ook met een overzicht van de gebruikte afbeeldingen, tekeningen, schema’s en tabellen.
- Veiligheidsinformatie: opmerkingen en waarschuwingen met betrekking tot de veiligheid van en risico's voor gebruiker, omstanders, apparaat en omgeving. De omgang bij opslag en vervoer. Richtlijnen voor machineveiligheid en een overzicht van veiligheidspictogrammen.
- Certificeringen: overzicht van de eventuele certificeringen waaraan het product voldoet of kan voldoen en de bijbehorende voorwaarden.
- Milieu-informatie: informatie over de materialen die zijn gebruikt bij de productie van het product en de verpakking. Gegevens over het energieverbruik van het product, zoals het energielabel en eventuele energiebesparende functies. Beschrijving van mogelijke milieueffecten, zoals de uitstoot van broeikasgassen, waterverbruik e.d. Wet- en regelgeving omtrent milieubescherming en het afvoeren van apparaten aan het einde van de levenscyclus.
- Inleiding: omschrijving van het apparaat en de mogelijke toepassing(en) en beperkingen.
- In bedrijf stellen: dit deel van de handleiding beschrijft de stappen die nodig zijn om het apparaat correct en veilig te laten functioneren. Hieronder vallen onder meer instructies voor de initiële installatie, aansluitingen, en instellingen die moeten worden gecontroleerd of aangepast voordat het apparaat in gebruik kan worden genomen.
- Bedieningsmogelijkheden en beschrijving bedieningselementen: dit onderdeel van de handleiding biedt een overzicht van de verschillende manieren waarop het apparaat kan worden bediend en beschrijft de functies van knoppen en andere bedieningselementen.
- Instructies en aanwijzingen: dit deel biedt instructies en aanwijzingen voor gebruik.
- Buiten bedrijf stellen: dit deel beschrijft de stappen om het apparaat veilig uit te schakelen of buiten gebruik te stellen. Dit kan bestaan uit instructies voor het uitschakelen, loskoppelen en eventuele beveiligingsmaatregelen die moeten worden getroffen om het apparaat veilig voor te bereiden voor onderhoud of servicewerkzaamheden.
- Accessoires, gereedschappen, extra’s: dit deel geeft een overzicht van de optionele onderdelen, hulpmiddelen en extra’s die met het apparaat kunnen worden gebruikt. De sectie geeft informatie over meegeleverde accessoires en optionele uitbreidingen die de functionaliteit van het apparaat kunnen verbeteren, uitbreiden of vergemakkelijken.
- Ondersteuning: dit omvat alle ondersteuningsactiviteiten als foutopsporing/probleemoplossing, technische ondersteuning, garantieservice, onderhoud en reparaties, productvervanging, training en klantfeedback.
- Technische specificaties: dit deel van de handleiding geeft gedetailleerde informatie over de technische kenmerken van het apparaat. Het omvat specificaties zoals afmetingen, gewicht, vermogen, spanning, materialen en limieten.
- Bijlagen: tekeningen en schema’s van het apparaat, verklarende woordenlijst, index.
- Contactgegevens: de adres- en contactgegevens om contact op te nemen met de fabrikant over het product.
Voor gebruikershandleidingen in het bijzonder biedt de norm NEN 5509 waardevolle richtlijnen. Deze norm geeft eisen voor de inhoud, structuur, formulering en presentatie van gebruikershandleidingen voor producten bestemd voor zowel professionele als niet-professionele gebruikers.*
*Bron: NEN 5509:2016 nl, Normcommissie Gebruikershandleidingen, NEN.
Vertaling van originele handleiding
Een meertalige handleiding vermeldt meestal de oorspronkelijke taal waarin de handleiding is opgesteld. In het Engels wordt dit aangeduid met original instructions of original manual. Hiermee geeft de fabrikant aan dat de tekst oorspronkelijk in het Engels is opgesteld en dat de vertalingen in andere talen gebaseerd zijn op deze originele Engelse handleiding. Bij de Nederlandse vertaling staat dan iets als vertaling van de originele handleiding.
In de veiligheidssectie van handleidingen wordt deze verwijzing naar de oorspronkelijke tekst om veiligheidsredenen en juridische overwegingen vaak herhaald met een zin als: "Raadpleeg bij twijfel altijd de originele Engelse versie van deze handleiding."
Handleiding conform machinerichtlijn
Waar moet een handleiding aan voldoen? Voor veel productcategorieën stelt de EU wettelijke vertaaleisen aan de handleiding. Voor risicovolle producten eist de EU minimaal een vertaling van de gebruiksaanwijzing in de taal of talen van de EU-lidstaat waarin het product wordt aangeboden.
Wanneer een oorspronkelijke gebruiksaanwijzing in de officiële taal of talen van het land van gebruik ontbreekt, moet een vertaling in die taal of talen worden verstrekt door de fabrikant of diens gemachtigde, dan wel door degene die de machine in het bewuste taalgebied introduceert.
Compliance met EU-richtlijnen
BlacKKite volgt deze officiële richtlijn van het Europees Parlement en de Raad van de Europese Unie voor het vertalen van handleidingen. Zo voorkomt u met een vakkundig vertaalde Engelse handleiding schadeclaims en verlaagt u bovendien de druk op helpdeskmedewerkers!
Handleiding vertalen of laten maken?
Hebt u een Engelse handleiding die vertaald moet worden naar het Nederlands? Schakel dan BlacKKite in! Bekijk hier hoe ik veelvoorkomende problemen oplos bij het vertalen van handleidingen.
U kunt BlacKKite ook inschakelen voor het schrijven van uw handleiding.
Auteursprofiel
