Technische documentatie in 3 stappen

Wat is technische documentatie

Technische documentatie bevat informatie die nodig is om een product of systeem te begrijpen en op een veilige en correcte manier te installeren, gebruiken, beheren of onderhouden. Denk hierbij bijvoorbeeld aan gebruikers- en installatiehandleidingen, technische specificaties, opleidingsmateriaal of werkinstructies.

Technische documentatie is vaak een vereiste om te voldoen aan wet- en regelgeving. Daarnaast biedt het ook praktische voordelen. Door gebruikers duidelijke instructies en informatie te geven, hebben ze minder ondersteuning nodig omdat ze zelf antwoorden kunnen vinden als ze bijvoorbeeld vastlopen bij het gebruik van een product of dienst. Dit vermindert het aantal vragen aan de klantenservice of andere ondersteuningsafdelingen. Ook draagt goede documentatie bij aan een betere gebruikerservaring en minder frustraties. Iets dat leidt tot een hogere tevredenheid.
Tot slot biedt technische documentatie ook voordelen binnen organisaties: goed geschreven opleidingsmateriaal of werkinstructies zorgen voor een efficiënte overdracht van kennis, waardoor processen soepeler verlopen.

Het belang en de voordelen van technische documentatie zijn nu duidelijk, maar hoe maakt u een goede handleiding, werkinstructie of opleidingsmateriaal?

Werkwijze om goede technische documentatie te maken

Welke vorm de documentatie ook heeft, bij het maken worden vaak de volgende stappen doorlopen:

Hieronder lichten we elke stap toe en geven we aan waar op gelet moet worden.

Stap 1 Bepalen van de inhoud

Deze eerste stap bestaat uit de volgende substappen:

1. Doelgroep bepalen
2. Productinformatie verzamelen
3. Documentatie schrijven, illustraties maken en vertalen van de technische documentatie

Doelgroep bepalen

Voordat de productinformatie verzameld kan worden, moet duidelijk zijn voor wie de documentatie bedoeld is. Het kennen van de gebruiker is van groot belang. Elke doelgroep heeft specifieke behoeften, voorkeuren en kennisniveaus. Dit heeft invloed op de manier waarop de documentatie geschreven wordt en dus ook op welke informatie verzameld moet worden.

Voor het maken van goede technische documentatie is het belangrijk om te weten welk niveau van voorkennis de gebruikers hebben. We onderscheiden drie niveaus, en elk niveau vereist een andere aanpak:

• Beginners (geen of minimale voorkennis)
  Dit zijn gebruikers die weinig of geen ervaring hebben met het product of systeem. Zij kennen vaak de basisfunctionaliteiten of termen niet.
  Deze gebruikers hebben duidelijke, stapsgewijze uitleg nodig in eenvoudige taal, aangevuld met afbeeldingen, iconen en diagrammen. Vermijd in de documentatie vakjargon en geef antwoorden op veelvoorkomende, eenvoudige vragen en problemen.
• Gemiddeld (enige ervaring, maar geen diepgaande technische kennis)
  Dit zijn gebruikers met basiskennis of gevorderde kennis van het product of systeem. Zij  begrijpen vaak de kernfunctionaliteiten.
  Ze hebben duidelijke informatie nodig die hen helpt om meer geavanceerdere functies te begrijpen. Geef in de instructies praktische voorbeelden en geef antwoord op complexere vragen en problemen, zonder te veel technische uitleg. Verwijs eventueel naar gedetailleerdere secties voor gebruikers die meer willen weten.
• Expert (diepgaande kennis en ervaring)
  Dit zijn gebruikers die zeer bekwaam zijn en uitgebreide ervaring hebben met het product of systeem. Zij begrijpen de technische details.
  Deze doelgroep heeft gedetailleerde, technische documentatie nodig die hen helpt bij geavanceerde instellingen of het oplossen van complexe problemen. Zorg dat de uitleg minimalistisch is (zonder onnodige details).

Als de doelgroep is bepaald, kan een besluit worden genomen over de vorm waarin de documentatie gepubliceerd en verspreid zal worden. Wordt de documentatie digitaal aangeboden, als gedrukte handleiding of wellicht beide?

Productinformatie verzamelen

Zodra duidelijk is voor welke doelgroep de documentatie bedoeld is, kan begonnen worden met het verzamelen van de juiste productinformatie. Dit kan door experts, zoals productontwikkelaars, te raadplegen, door het product te testen of door bestaande documentatie te bekijken. Ook kan gebruikersfeedback waardevolle inzichten opleveren. Daarnaast kunnen klantenservice en andere ondersteuningsafdelingen een belangrijke bron van informatie vormen.

Documentatie schrijven

Omdat de inhoud van technische documentatie met name door het product zelf bepaald wordt, is deze vanzelfsprekend voor ieder product anders. Echter, het doel van de documentatie is vrijwel altijd hetzelfde. Namelijk de gebruiker nauwkeurige en effectieve instructies geven over hoe het product veilig en op een goede manier gebruikt kan worden.

Een goede structuur en indeling zijn hierbij van belang. Gebruik een logische opbouw met duidelijke hoofdstukken en secties. De NEN5509 biedt houvast voor de inhoud, formulering, structuur en presentatie van handleidingen. Een goede technische handleiding dient volgens deze norm minstens de volgende inhoud te bevatten:

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

Let op: besteed voldoende aandacht aan het onderwerp ‘storingen’, omdat handleidingen juist op deze momenten het vaakst worden geraadpleegd.

Formulering van de teksten

Naast een bepaalde inhoud is het ook belangrijk om de formulering van de teksten in de gaten te houden. Zorg ervoor dat de inhoud van technische documentatie:

• Consistent is.
  Zorg dat terminologie consequent doorgevoerd wordt in het document.
• Voor de doelgroep te begrijpen is.
  Vertaal technologie en features van producten naar begrijpelijke, effectieve instructies in een taal passend bij de doelgroep (zie het kopje ‘Doelgroep bepalen’).
• Kort en ‘to the point’ is.
  Zorg ervoor dat de gebruiker zo min mogelijk inspanning kost om de informatie tot zich te nemen.
• In balans is.
  Visuele en tekstuele content dienen elkaar te ondersteunen.

En vergeet niet dat er vanuit wet- en regelgeving ook eisen aan de technische documentatie gesteld kunnen worden.

Leest u ons artikel over technisch schrijven als u meer wilt weten. Roept u toch liever de hulp in van een specialist? Manualise maakt al meer dan 15 jaar gebruiksvriendelijke technische documentatie conform wet- en regelgeving.

Neem direct contact op →

Illustraties maken

Plaatjes zeggen meer dan 1000 woorden. Het feit dat in 2021 alleen Nederland al 2,5 miljoen laaggeletterden telt (bron: Stichting Lezen en Schrijven, duidt de waarde van goede illustraties nog eens extra aan. Laaggeletterden zijn mensen die moeite hebben met taal en/of rekenen. Deze doelgroep is extra gebaat bij duidelijke, eenvoudige communicatie.

En dat geldt niet alleen voor deze doelgroep. Een goed gemaakte afbeelding is universeel en kan door een breed publiek worden begrepen. Heldere technische illustraties zijn essentieel om complexe informatie toegankelijk en begrijpelijk te maken. Waarom?

• Snelheid en aandachtsspanne
  Gebruikers begrijpen sneller hoe een product werkt als ze een duidelijke afbeelding zien in plaats van een lange tekst. Ook wordt de aandacht van de lezer langer vastgehouden.
• Uitstraling
  Een handleiding met goed ontworpen illustraties oogt professioneler en betrouwbaarder. Illustraties zorgen voor afwisseling en voegen mogelijk kleur toe aan technische handleidingen. Dit draagt bij aan een positieve gebruikerservaring en kan de tevredenheid over het product verhogen.

Een extra voordeel is dat technische documentatie met illustraties minder vertaalkosten met zich meebrengt. Alle informatie die in beeld omgezet is, hoeft in tegenstelling tot tekstuele uitleg, niet vertaald te worden.

Meer weten over dit onderwerp? Leest u dan ons artikel over technische illustraties.  

Vertalen van technische documenten

Wanneer een document inhoudelijk afgerond is, komen we bij het volgende onderwerp: vertalen. Omdat producten en systemen vaak in meerdere landen op de markt gebracht worden, is het belangrijk om de inhoud te vertalen naar de juiste taal of talen. Hierbij is het van belang om samen te werken met een vertaalbureau dat bekend is met het vertalen van technische documenten. Zo blijft de inhoud nauwkeurig, begrijpelijk en effectief. Een onnauwkeurige vertaling kan leiden tot misverstanden, fouten of zelfs veiligheidsrisico’s.

Wat zijn de belangrijkste aandachtspunten bij het vertalen van technische documentatie:

• Consequent taalgebruik (terminologie)
  Consistentie is – net als in de brontaal – erg belangrijk. Zorg voor het juiste jargon in alle talen. Is het jargon in een doeltaal niet bekend, dan kan een vertaalbureau een woordkeuze toetsen bij de doelgroep.
• Lokalisatie
  Een letterlijke vertaling werkt niet altijd. Veiligheidsvoorschriften en taalgebruik kunnen per regio verschillen. Houd hier rekening mee.
• Controle
  Laat de documentatie testen door een native speaker of een gebruiker uit de doelgroep om te controleren of alles duidelijk en correct is. Als in de praktijk blijkt dat bijvoorbeeld de context niet duidelijk is, dan werkt een correcte vertaling ook niet. Ook kan een foutieve vertaling juridische gevolgen hebben in bepaalde branches.

Is er sprake van repeterende vertaalopdrachten? Dan kan het bureau steeds de juiste terminologie uit het vertaalgeheugen halen. Dit wordt binnen de branche ook wel ‘terminologiemanagement’ genoemd.

Leest u ons artikel over technisch vertalen als u meer wilt weten.

Stap 2 Vastleggen van de vorm en stijl

We gaven eerder al aan dat het belangrijk is om tijdens het schrijven van handleidingen rekening te houden met de structuur. Voeg – naast een logische opbouw met duidelijke hoofdstukken – bijvoorbeeld een inhoudsopgave toe en formuleer duidelijke koppen die de inhoud van hoofdstukken of paragrafen duidelijk weergeven.

Is de structuur vastgelegd en is duidelijk hoe de documentatie gepubliceerd en verspreid zal worden, dan is de volgende stap het standaardiseren van de opmaak. Deze stap is van belang voor de herkenbaarheid en de leesbaarheid van de documentatie. Aandachtspunten bij het vastleggen van de vorm en stijl:

• Zorg voor een duidelijke en consistente lay-out.
  • Kies voor een goed leesbaar lettertype.Gebruik één lettergrootte voor normale teksten en grotere formaten voor koppen.Gebruik vaste stijlen voor koppen, alinea’s, opsommingen, waarschuwingen, tips en extra informatie.
  • Gebruik vaste stijlen voor illustraties.
• Gebruik genummerde lijsten voor stapsgewijze instructies en bullet points voor opsommingen.
• Zorg voor voldoende witruimte om de leesbaarheid te verbeteren.

Is er sprake van een serie installatiehandleidingen, technische specificaties of bijvoorbeeld meerdere werkinstructies? Maak dan gebruik van een sjabloon om consistentie te garanderen. Naast consistentie levert het gebruik van een sjabloon (of template) nog andere voordelen op:

• Is efficiënt en levert tijdsbesparing op.
• Zorgt voor minder fouten of misverstanden als er meerdere mensen aan documenten werken.
• Aanpassingen zijn eenvoudig door te voeren in alle documenten.
• Eventuele vertalingen van het brondocument kunnen volgens hetzelfde format opgemaakt worden.

Als de vorm is vastgelegd (al dan niet in een sjabloon), kan de technische documentatie samengesteld worden.  

Stap 3 Technische documentatie samenstellen en publiceren

De technische documentatie wordt nu samengesteld door vorm en inhoud samen te voegen. Na het samenstellen adviseren wij nog een aantal dingen:

• Controleer verwijzingen en kruisverwijzingen 
  Kloppen inhoudsopgave, (veiligheids)instructies, waarschuwingen, interne links, verwijzingen etc.
• Controleer visuele elementen 
  Zijn afbeeldingen en tabellen correct geplaatst, scherp, goed leesbaar en voorzien van de juiste onderschriften.  
• Verzamel feedback
  Maak gebruik van een proefgebruiker en verzamel waardevolle feedback. Daar waar nodig kan de documentatie nog aangepast worden op basis van de verkregen feedback.

Output genereren

Gebruikers willen over productinformatie beschikken op het moment dat zij die nodig hebben. Naast gedrukte documentatie, die vaak verplicht is voor CE-markering, kan er ook behoefte zijn aan digitale toegang. Met single source software kan dezelfde content zowel als geprinte versie (bijvoorbeeld PDF) als digitale versie (zoals HTML5, WebHelp, EPUB of DITA) worden gegenereerd. Hierdoor is de informatie eenvoudig toegankelijk via desktop, tablet of smartphone.

Is de gebruikersdocumentatie afgerond, dan kan overgegaan worden tot het genereren van de gewenste output. Als de documentatie digitaal beschikbaar gesteld wordt, is het van belang te checken of de documentatie op verschillende schermformaten goed leesbaar is en of interactieve elementen (zoals hyperlinks) correct zijn ingesteld. Slecht functionerende of slecht leesbare documenten dragen bij aan een negatieve gebruikerservaring en kunnen de tevredenheid over het product verlagen.

Zelf aan de slag met technische documentatie (gratis stappenplan met checklist)

Door de drie stappen toe te passen, kunt u technische documentatie niet alleen effectief maken, maar ook aantrekkelijker en toegankelijker voor de lezer. Bent u van plan om een of meerdere documenten te schrijven? Verlies hierbij dan nooit het hoofddoel uit het oog: met heldere instructies helpen om taken veilig en succesvol uit te voeren. 

Handig! Wij hebben de informatie uit dit artikel voor u omgezet in een compact overzicht met aandachtspunten. Download hier het gratis stappenplan met checklist:

Hulp van een specialist

Roept u toch liever de hulp in van een specialist? Manualise maakt al meer dan 15 jaar gebruiksvriendelijke technische documentatie voor uiteenlopende klanten. Daarnaast beschikt Manualise over single source software die ook in licentie gebruikt kan worden.

Neem direct contact op →