Technische documentatie: de complete gids
(2024 update)

Wij helpen u om duidelijke technische documentatie te maken

Wat is technische documentatie?

Technische documentatie is de beschrijving van een product, machine, softwareapplicatie
en/of proces.

Technische documentatie is een breed begrip. Gebruiksaanwijzingen, technische datasheets, montagehandleidingen, werkinstructies, installatiehandleidingen, veiligheidsinstructies, onderhoudsinstructies, procesbeschrijvingen, onderdelenlijsten en technische tekeningen vallen allemaal onder de noemer technische documentatie.

Het verschil tussen interne technische documentatie en externe technische documentatie

In veel Europese regelgeving wordt met technische documentatie ook wel het technisch dossier bedoeld. Het technisch dossier bevat naast de handleiding technische documentatie bijvoorbeeld ook testrapporten, de risicoanalyse en de conformiteitsverklaring.

Het samenstellen van het technisch dossier is de vijfde stap in het CE-markeringsproces. Daarover later meer.

Een andere manier om naar het door elkaar gebruiken van de termen technische documentatie en technisch dossier te kijken, is door onderscheid te maken tussen interne en externe technische documentatie.

De interne technische documentatie beschrijft het product gedurende zijn levenscyclus. De fabrikant voldoet hiermee aan zijn bewijsverplichtingen aan organisaties en aan wettelijke eisen. De interne technische documentatie vormt de basis voor de externe technische documentatie en bevat informatie voor een groot aantal verschillende vakgebieden.

De interne documentatie biedt de mogelijkheid om de kennis en knowhow van een bedrijf te verzamelen, te verspreiden en op te slaan. Het is dus meer dan een verplichte oefening.

(afbeelding)

De externe technische documentatie (ook gebruikersdocumentatie of gebruikersinformatie genoemd) is een uittreksel van de interne documentatie en richt zich op de gebruiker, eindgebruiker, reparatiedienstverlener en onderhoudsmonteur.

De externe technische documentatie bevat de informatie die relevant is bij het gebruik van het product. Wetten en richtlijnen definiëren de reikwijdte van de te verstrekken informatie in meer detail. De externe technische documentatie is primair bedoeld voor de gebruiker zodat hij het product gebruikt in overeenstemming met de beoogde functie.

Alle gebruikers, zoals installateurs, reparatiedienstverleners en operators, hebben de technische documentatie nodig om hun werkzaamheden veilig en met het gewenste resultaat uit te voeren.

In deze gids wordt met ‘technische documentatie’ niet het technisch dossier bedoeld, maar de productbeschrijving in de vorm van onder andere gebruiksaanwijzingen en installatie-instructies.

Wat zijn de voordelen van goede technische documentatie?

Waarborging van een veilig en efficiënt gebruik

Het belangrijkste aspect voor de gebruiker van de (externe) technische documentatie is om over alle informatie te beschikken die hij nodig heeft om een ​​product te gebruiken. Vooral bij complexe producten waarvan de functionaliteit op het eerste gezicht niet duidelijk is, is het van cruciaal belang dat de verstrekte informatie volledig is.

Goede technische documentatie zorgt ervoor dat de gebruiker het apparaat, de software, de machine of het systeem te allen tijde veilig kan gebruiken.

Vermindering van aansprakelijkheid

Als het product verkeerd wordt gebruikt of als acties een storing veroorzaken, kunnen mensen en eigendommen worden geschaad. De fabrikant moet dit risico door middel van passende ontwerpmaatregelen tot een aanvaardbaar niveau terugbrengen.

Vaak kunnen echter niet alle risico’s worden geëlimineerd en blijft er een restrisico over voor de gebruiker. De technische documentatie moet daarom eventuele restrisico’s voor de gebruiker zichtbaar maken en uitleggen hoe het product veilig kan worden gebruikt.

In de gebruiksaanwijzing staan bijvoorbeeld veiligheids- en waarschuwingsinstructies voor situaties die een gevaar vormen. De technische documentatie bevat ook maatregelen hoe veilig om te gaan met een gevaarlijke situatie.

Het verstrekken van juiste informatie in de gebruiksaanwijzing minimaliseert het risico van aansprakelijkheid voor schade aan personen of eigendommen.

Verhoging positieve klantervaring

Als het gaat om klantenbinding voor een bepaald product of merk, is de gebruikservaring van de klant van groot belang voor de fabrikant. Na aanschaf van een product is de technische documentatie het eerste hulpmiddel voor de gebruiker om ondersteuning te krijgen bij de bediening en hantering.

Bovendien is het vaak het laatste contactmoment van de fabrikant met de klant. Daarna is het aan de klant om zelfstandig aan de slag te gaan.

Onduidelijke instructies en onvolledige informatie schaden het vertrouwen van de klant. Gestructureerde en volledige technische documentatie biedt zekerheid en speelt een belangrijke rol bij het evalueren van de eigen aankoopbeslissing.

Geef de gebruiker gerichte begeleiding in de gebruiksaanwijzing en zorg ervoor dat de informatie aan zijn behoeften voldoet. Dit vormt immers de basis voor een hoge klanttevredenheid en daarmee het succes van je bedrijf op de lange termijn.

Wij helpen bij het ontwikkelen van gebruiksvriendelijke technische documentatie.

NEEM CONTACT OP

Wat is het verband tussen technische documentatie en de CE-markering?

De CE-markering is verplicht voor veel producten die op de Europese markt worden gebracht. Producten die onder CE-markering vallen, zijn onder andere machines, medische hulpmiddelen, speelgoed, elektrische apparatuur en persoonlijke beschermingsmiddelen.

Met de CE-markering verklaart de fabrikant dat zijn product voldoet aan de relevante Europese regelgeving en dat de vereiste beoordeling is uitgevoerd om de conformiteit aan te tonen. CE-markeringsrichtlijnen en -verordeningen bevatten essentiële eisen voor veiligheid, gezondheid en milieu.

De externe technische documentatie is het bewijs dat de conformiteitsbeoordeling juist is uitgevoerd en dat het product aan de relevante regelgeving voldoet. Nadat de technische documentatie is samengesteld, brengt de fabrikant de CE-markering op een duidelijk zichtbare en blijvende manier op het product aan. Vervolgens stelt hij de conformiteitsverklaring op waarmee hij aangeeft dat zijn product in overeenstemming is met de wettelijke vereisten.

Het opstellen van de technische documentatie is stap 5 in het CE-markeringsproces. Wat er in de technische documentatie moet staan, is vastgelegd in richtlijnen en verordeningen.

De meeste richtlijnen en verordeningen verplichten de fabrikant een kopie van de technische documentatie of gebruiksaanwijzing in een technisch dossier op te nemen. De technische documentatie is dus in veel gevallen een integraal onderdeel van het CE-markeringsproces.

Waarom is de technische documentatie zo’n wezenlijk onderdeel van het technisch dossier?

Het doel van de technische documentatie is de gebruiker te ondersteunen bij het veilig en efficiënt kunnen gebruiken van een product. De technische documentatie is dus een middel om aan het doel van CE-markering bij te dragen: het verbeteren van de veiligheid, gezondheid en het milieu.

Vragen over het CE-markeringsproces?

NEEM CONTACT OP

Aansprakelijkheid door gebrekkige technische documentatie

Door het aanbrengen van de CE-markering en het ondertekenen van de conformiteitsverklaring neemt de fabrikant de volledige verantwoordelijkheid voor eventuele gebreken aan het product op zich.

Als een product niet in overeenstemming blijkt te zijn met de vereisten, kan elke fabrikant aansprakelijk worden gesteld voor schade die wordt veroorzaakt door een defect product. Door ervoor te zorgen dat een product voldoet aan alle actuele veiligheidseisen, voorkomt de fabrikant dus elke aansprakelijkheidsclaim.

De aansprakelijkheid voor producten met gebreken is uiteengezet in Richtlijn 85/374/EEG, de productaansprakelijkheidsrichtlijn.

Om te bepalen of een product gebreken heeft, wordt onder andere het volgende beschouwd:

• verkoopliteratuur en andere marketingtools;
• schriftelijke instructies, technische documentatie en waarschuwingen die bij het product worden geleverd;
• productgebruik dat redelijkerwijs mag worden verwacht;
• tijdstip waarop de producent het product op de markt heeft gebracht.

Kortom: een fabrikant zal zeer waarschijnlijk verantwoordelijk worden gehouden wanneer er een verband is tussen een gebrekkig product en de geleden schade. Gebrekkige en onduidelijke technische documentatie kan in deze beoordeling worden meegenomen.

Wat zijn de wettelijke eisen aan de technische documentatie?

Europese CE-richtlijnen en -verordeningen

De verplichting om duidelijke technische documentatie bij een product te leveren, is bepaald in (CE-)richtlijnen en verordeningen. De kenmerken van een product bepalen welke richtlijnen en verordeningen van toepassing zijn.

Typische richtlijnen en verordeningen zijn de Verordening Medische hulpmiddelen (EU 2017/745), de Laagspanningsrichtlijn (2014/35/EU) en de Machinerichtlijn (2006/42/EG).

Een product kan onder meerdere richtlijnen vallen. Zo kan een ‘Industry 4.0’-machine onder de Machinerichtlijn (2006/42/EG), de EMC-richtlijn (2014/30/EU), de RoHS-richtlijn (2011/65/EU) en de richtlijn voor radioapparatuur (2015/53/EU) vallen.

De richtlijnen en normen kunnen ook eisen aan de inhoud van de technische documentatie stellen. Zo beschrijft de Machinerichtlijn met name in Sectie 1.7.4.2 wat er in de technische documentatie moet worden opgenomen. De Verordening Medische hulpmiddelen geeft de eisen aan de technische documentatie in Artikel 23.

Wil je meer weten over het bepalen van de richtlijnen die van toepassing zijn?

NEEM CONTACT OP

Richtlijn Algemene Productveiligheid

Als een product niet onder specifieke regelgeving valt, dan is de Richtlijn Algemene Productveiligheid 2001/95/EG van toepassing. De belangrijkste set regels in Nederland voor de levering van producten is de Productveiligheidswet.

De Richtlijn Algemene Productveiligheid stelt dat alle producten die op de markt worden gebracht, veilig moeten zijn. Een veilig product is een product dat onder normale en/of redelijkerwijs te verwachten gebruiksomstandigheden geen enkel risico of beperkte risico’s levert.

Hierbij moet niet alleen rekening worden gehouden met de kenmerken van het product, maar ook met onder andere de technische documentatie.

Is een product met bijbehorende technische documentatie gebrekkig, dan geldt de Productaansprakelijkheidsrichtlijn die de fabrikant aansprakelijk stelt.

Gebruik van productnormen voor technische documentatie

Normen kunnen worden gebruikt om technisch aan de eis van een richtlijn of verordening te voldoen. Een richtlijn of verordening heeft betrekking op een hele productgroep (bijvoorbeeld speelgoed) of een eigenschap van producten (elektromagnetische compatibiliteit).

Een norm heeft betrekking op een specifiek product (bijvoorbeeld schommels) of een bepaald concept of principe (bijvoorbeeld de technische documentatie).

Een voorbeeld

De Speelgoedrichtlijn eist dat speelgoed de ‘vereiste mechanische sterkte’ heeft. Wat dit technisch betekent, is voor een kinderfietsje anders dan voor een schommel. Daarom zijn er productnormen ontwikkeld die kwantificeren wat mechanische sterkte voor een schommel of voor een kinderfietsje is.

Nog een voorbeeld

De Machinerichtlijn stelt dat bij een machine technische documentatie wordt geleverd. De Machinerichtlijn geeft zelfs algemene eisen aan wat er in de technische documentatie moet staan. De Europese geharmoniseerde norm EN ISO 20607 beschrijft in detail waaraan de technische documentatie voor machines moet voldoen.

In tegenstelling tot richtlijnen en verordeningen zijn normen meestal niet bindend, maar kunnen wettelijk bindend worden als toepasselijke richtlijnen en wetten dit voorschrijven.

Wil je meer weten over het bepalen van de normen die van toepassing zijn op je product?

NEEM CONTACT OP

Norm EN 82079-1 voor gebruiksaanwijzingen

De Europese norm EN 82079-1 is de belangrijkste norm voor het opstellen van gebruiksaanwijzingen en kan dus worden gebruikt bij het maken van de technische documentatie. De norm geeft belangrijke principes voor de structuur, inhoud en presentatie van instructies.

De norm beschrijft het doel van gebruiksinformatie als volgt:

Gebruiksinformatie geeft de beoogde gebruiker de nodige informatie om een product veilig, efficiënt en doelgericht te gaan gebruiken.

Het is belangrijk te vermelden dat de EN 82079-1 een zogenoemde horizontale norm is: hij geldt niet alleen voor een specifiek product of een specifieke sector, maar omvat ook sectoroverstijgende regels voor bijna alle industrietakken: van speelgoed tot medische apparaten en van elektrische apparatuur tot machines.

Gebruik(er)svriendelijkheid van de technische documentatie

De NEN EN ISO 9241 is een meerdelige norm voor ergonomie van mens-computerinteractie.

Usability wordt in de NEN EN ISO 9241 gedefinieerd als: ‘(…) the extent to which a product can be used by specified users to achieve specified goals with effectiveness, efficiency, and satisfaction in a specified context of use.’

De gebruikersinformatie speelt daarbij een centrale rol, vooral bij complexe en aan veiligheid gerelateerde producten.

In technische documentatie wint usability al geruime tijd aan betekenis. Dit is onder andere te zien in innovaties op het gebied van wettelijke eisen voor medische hulpmiddelen in de vorm van de Verordening voor Medische Hulpmiddelen.

Om schade door bedieningsfouten tot een minimum te beperken, moet de bruikbaarheid van technische documentatie door ervaren redacteuren in een meertraps proces worden gecontroleerd en geoptimaliseerd op het gebied van schrijfstijl, terminologie, doelgroep en wijze van aanbieden.

Ook de NEN EN IEC/IEEE 82079-1:2020 houdt veel meer rekening met gebruiksvriendelijkheid in technische documentatie, bijvoorbeeld doordat de principes van minimalisme (in technische communicatie) in de norm zijn opgenomen.

Eisen aan de inhoud van technische documentatie voor bepaalde productgroepen

Technische documentatie voor machines

De 20607-standaard is gebaseerd op de 82079-standaard en moet worden gezien als een aanvulling op de 82079-standaard die aanvullende richtlijnen bevat voor het ontwikkelen van technische documentatie specifiek voor machines.

Veel eisen die zijn beschreven in de 82079-standaard, zijn niet herhaald in de 20607-standaard, zoals het schrijven van duidelijke teksten of het toepassen van de principes van minimalisme.

De 20607-norm geeft veiligheidsspecificaties voor de technische documentatie van machines die specifieker zijn dan de 82079-norm. Er is bovendien een sterke relatie tussen de ISO 12100-norm voor risicobeoordeling en risicovermindering.

De norm 20607 dekt alle bepalingen uit Sectie 1.7.4.2 van de Machinerichtlijn en dekt de richtlijn dus volledig (behalve de eis ten aanzien van geluidsemissie; die eis wordt gedekt door andere normen).

Volgens de 20607-norm is de technische documentatie in overeenstemming met de norm, bedoeld om de lezers op een zodanige manier te informeren dat ze na het lezen van de technische documentatie op de hoogte zijn hoe de machine veilig te gebruiken volgens de beoogde functie gedurende de volledige levenscyclus van de machine.

De inhoud van de technische documentatie voor machines wijkt vaak af van de inhoud van andere productgroepen. Voor machines moet je bijvoorbeeld een lijst met reserveonderdelen of instructies voor inbedrijfstelling in de technische documentatie bijvoegen. Voor speelgoed is dit soort informatie niet van belang.

Link shop

Podcast

Technische documentatie voor elektrische en elektronische apparaten

Elektrische en elektronische apparaten moeten vaak aan meerdere richtlijnen voldoen. De EMC-richtlijn, de Laagspanningsrichtlijn, de RED- en RoHS-richtlijn stellen allemaal eisen aan de inhoud van de technische documentatie.

Een vereiste is bijvoorbeeld een beschrijving van het beoogde gebruik in de technische documentatie op te nemen. Dit wordt zowel door de EMC-, RED- als de Laagspanningsrichtlijn vereist.

De Laagspanningsrichtlijn eist daarnaast ook nog het niet-beoogde gebruik in de technische documentatie te omschrijven. Van de RED moet(en) de frequentieband(en) waarin de radioapparatuur functioneert, in de technische documentatie worden opgenomen.

Link shop

Technische documentatie voor medische hulpmiddelen

De functie van de technische documentatie voor medische hulpmiddelen is om de gebruiker uit te leggen hoe een medisch hulpmiddel veilig en juist kan worden gebruikt.

De technische documentatie (gebruiksaanwijzing, labeling, verpakking) voor medische hulpmiddelen informeert de gebruiker over risico’s die nog steeds bestaan, ondanks het nemen van maatregelen voor inherent veilig ontwerp, borging en aanvullende bescherming.

Het niet correct waarschuwen van de gebruiker kan de fabrikant aansprakelijk stellen bij eventuele ongevallen. Daarom is de waarschuwings-/instructieplicht bij de producten geregeld en vaak verplicht.

De eisen aan de technische documentatie voor medische hulpmiddelen worden vooral benoemd in Artikel 23 van de Richtlijn Medische Hulpmiddelen (EU) 2017/745.

Podcast

Link shop

Technische documentatie voor software

Links software handleiding maken: https://instrktiv.com/nl/software-handleiding-maken/
Software is niet meer weg te denken uit ons leven. Door ontwikkelingen als Industry 4.0, AI, Meta products, Robotics, Big Data, Internet of Things, zijn software en hardware tegenwoordig ook volledig geïntegreerd.

En dan hebben we het nog niet gehad over de razendsnelle ontwikkeling van apps en onlineplatforms.

Ook bij software hoort natuurlijk goede technische documentatie, oftewel softwaredocumentatie.

Bij documentatie voor software is een afbakening van de relevante richtlijnen in beslissende mate afhankelijk van het doel waarvoor deze wordt gebruikt. Software is juridisch gezien een zelfstandig product en valt daarom onder de productaansprakelijkheids- en productveiligheidsrichtlijnen.

Naast de Europese General Data Protection Regulation (GDPR), die in Nederland de Algemene Verordening Gegevensbescherming (AVG) heet, komen ook andere eisen in aanmerking die betrekking hebben op het systeem waarmee de software communiceert. Indien nodig moet hiermee ook rekening worden gehouden in de technische documentatie van de software.

Podcast

Wat is de rol van een risicoanalyse bij de technische documentatie?

Richtlijnen en verordening zoals de Machinerichtlijn, de Laagspanningsrichtlijn en de Verordening Medische Hulpmiddelen, verplichten een risicobeoordeling voor producten uit te voeren.

Wat heeft dit te maken met de technische documentatie?

Laten we hiervoor eens kijken naar de norm voor het uitvoeren van risicobeoordelingen voor machines: de EN ISO 12100.

De risicobeoordeling zelf is onderdeel van de interne technische documentatie en hoeft normaal gesproken niet aan de klant of gebruiker te worden doorgegeven. Door middel van een risicobeoordeling kan worden vastgesteld of een product of machine geschikt is voor toelating op de markt.

De risicobeoordeling vormt bovendien de basis voor de aan veiligheid gerelateerde informatie die de fabrikant in de externe technische documentatie aan de gebruiker moet doorgeven.

In een risicobeoordeling wordt gekeken naar de veiligheidsrisico’s die kunnen optreden. Per gevaar wordt gekeken naar de waarschijnlijkheid van optreden, de ernst van de te verwachten schade als het zich voordoet en de mogelijkheden om het gevaar te vermijden.

Er zijn drie mogelijkheden om een risico te verkleinen:

1 het product aanpassen/veiliger maken
2 veiligheidsvoorzieningen treffen
3 gebruiksaanwijzingen bij het product verstrekken

Restrisico’s die de fabrikant niet in het ontwerp of door aanvullende veiligheidsvoorzieningen kan elimineren, worden in de technische documentatie opgenomen in de vorm van veiligheids- en waarschuwingsinstructies.

Wie stelt de technische documentatie op?

De technische documentatie kan door verschillende personen worden ontwikkeld. Vaak is iemand van R&D verantwoordelijk voor de technische documentatie. Het voordeel hiervan is dat deze persoon vaak vertrouwd is met het product en relatief eenvoudig de technische documentatie kan samenstellen.

Een nadeel is dat deze persoon vaak erg ‘diep’ in het product zit en daardoor moeite kan hebben om de productinformatie op een heldere manier te communiceren aan de uiteindelijke gebruiker van het product.

Om die reden kan de technische documentatie het best worden ontwikkeld door een technisch schrijver.

Technisch schrijvers beschikken over uitstekende taal-, schrijf- en communicatievaardigheden en bovendien over een goede technische kennis. De combinatie van deze vaardigheden stelt een technisch schrijver in staat om foutloze documentatie te creëren in duidelijke bewoordingen, voor de juiste doelgroep.

Welk proces volg je voor het maken van technische documentatie?

Iedereen heeft zo zijn eigen werkwijze voor het maken van technische documentatie. Wij doorlopen het volgende proces:

• Opstellen van een plan voor het maken van de technische documentatie
• Bepalen van het wettelijk kader
• Schrijven van de teksten
• Maken van illustraties
• Maken van templates en inrichten van het CMS/CCMS
• Output genereren en vertalen

Opstellen van een plan voor het maken van technische communicatie

Voordat wordt gestart met het ontwikkelen van de technische documentatie is het verstandig een projectplan op te stellen. In het projectplan worden de eisen aan het project vastgelegd.

De volgende elementen worden in het projectplan beschreven:

• Beschrijving van de projectscope: Voor welk product wordt de technische documentatie ontwikkeld? Wat moet worden bereikt met de technische documentatie?
• Beschrijving van het gebruikersprofiel: Door wie wordt het product en dus ook de technische documentatie gebruikt? Wat zijn hun kenmerken? Wat zijn hun behoeften? Wat zijn de belangrijkste gebruikerstaken en -scenario’s? In welke omgeving werken ze? Wat zijn verdere gebruikersvereisten?
• Overzicht van de technische documentatie die moet worden ontwikkeld: Welke informatie is al aanwezig in de interne technische documentatie? Welke informatie moet nog worden uitgewerkt?
• Overzicht van de eisen aan de toegankelijkheid van de technische documentatie: Via welke media moet de technische documentatie beschikbaar zijn: online, print, video? Is de informatie voor iedereen toegankelijk?
• Overzicht van de eisen met betrekking tot vertalen en lokaliseren: In welke landen wordt het product en de technische documentatie gebruikt? Naar welke talen moet er worden vertaald?
• Eisen aan de te gebruiken tools (CMS/CCMS): Hoe wordt de informatie gemanaged? Wie moet er met de managementsystemen werken? Hoe wordt informatie uitgewisseld? Hoe wordt omgegaan met updates en nieuwe releases?
• Informatie uit de risicobeoordeling: Wat zijn de eisen met betrekking tot een veilig gebruik en productcompliance?
• Planning van het project: Wanneer moet de technische documentatie afgerond zijn? Wat zijn belangrijke mijlpalen?
• Inschatting van de projectgrootte: Hoeveel uren zijn nodig voor het ontwikkelen van de technische documentatie? Wat is het geschatte budget?
• Overzicht van teamleden, betrokkenen en hun verantwoordelijkheden: Wie zijn verantwoordelijk voor de reviews? Hoe ziet het reviewproces eruit? Wie is verantwoordelijk voor het goedkeuren van de technische documentatie?
• Overzicht van de design-, marketing- en overige eisen: Wat zijn eisen van andere stakeholders? Welke eisen worden aan de marketing en het design van de technische documentatie gesteld?

Bepalen van het wettelijk kader

Afhankelijk van het product waarvoor de technische documentatie wordt ontwikkeld, kan het voorkomen dat er wettelijke vereisten zijn voor de inhoud, presentatie en opmaak.

Deze kunnen afkomstig zijn uit Europese richtlijnen of verordeningen. Ook kunnen normen worden gebruikt, zo niet verplicht worden gesteld, om aan de wettelijke eisen te voldoen.

Bij elk project is het belangrijk in kaart te brengen welke eisen de relevante richtlijnen en verordeningen aan de inhoud van de technische documentatie stellen.

Schrijven van de teksten

Voordat je begint met het schrijven van de teksten is het belangrijk dat je zowel de doelgroep als het product goed begrijpt.

Productkennis wordt opgedaan door het product te gebruiken, het product te analyseren, het interviewen van experts en het bestuderen van bestaande documentatie, waaronder al bestaande handleidingen, risicoanalyses of marketinginformatie.

Zo krijgt een technisch schrijver een volledig beeld van het product en de werking ervan: van aankoop tot verwijdering. Alle resterende vragen legt een technisch schrijver vervolgens voor aan een SME (Subject Matter Expert), om zo het product voor de volle 100% te begrijpen.

Een duidelijke structuur is van cruciaal belang voor begrijpelijke technische documentatie. De geanalyseerde informatie moet goed en logisch worden georganiseerd in duidelijke topics, waardoor gebruikers gemakkelijk antwoorden kunnen vinden op hun vragen.

Topic-based schrijven, een overzichtelijke inhoudsopgave met duidelijke koppen, heldere instructies en consistentie zijn belangrijke uitgangspunten bij het schrijven.

Maken van illustraties

In goede technische documentatie wordt beeldmateriaal ingezet om de gebruiksvriendelijkheid van de technische documentatie te vergroten. Informatie wordt vaak beter begrepen als deze visueel wordt gecommuniceerd.

Beeldmateriaal omvat alle soorten grafische weergaven, zoals lijntekeningen, foto’s, screenshots, video’s, symbolen, tabellen, grafieken, afbeeldingen en infographics.

Je kunt lijnillustraties gebruiken voor het ondersteunen, vervangen of uitbreiden van de tekst en een chronologische volgorde te presenteren van een te volgen proces of stappen.

Screenshots kunnen worden gebruikt voor het visueel weergeven van de gebruikersinterface van een bedieningspaneel, software op een computer of een app.

Tabellen kunnen worden gebruikt om cijfers of tekst op een overzichtelijke manier in de technische documentatie te organiseren. Technische gegevens zijn bijvoorbeeld beter leesbaar wanneer ze in een tabel worden gepresenteerd.

Maken van templates en inrichten van het CMS/CCMS

Wanneer je verschillende handleidingen voor soortgelijke producten en/of in verschillende talen moet creëren, kan het een groot voordeel zijn om een CMS of CCMS te gebruiken.

Door gebruik te maken van een technical authoring tool kun je met dezelfde single-sourced (enkelvoudige bron) inhoud zowel online als geprinte technische documentatie creëren.

Technical authoring tools hebben meestal de functie van een CMS met uitgebreide authoring en publishing mogelijkheden. Een CMS maakt onderscheid tussen vorm (templates) en content. Doordat dit gescheiden is, kan de output efficiënt worden samengesteld.

Output genereren en vertalen

De meeste CMS- of CCMS-tools voor technisch schrijven hebben de mogelijkheid om met dezelfde inhoud zowel online als geprinte output te creëren. Ook kunnen vertalingen gemanaged worden binnen de meeste tools.

Welke tools kun je gebruiken bij het maken van technische documentatie?

Microsoft Word (de klassieker)

Het tekstverwerkingsprogramma in de Office-suite is nog steeds een van de meest gebruikte tools voor het maken van allerlei soorten technische documentatie.

De geïntegreerde sjablonen maken een snel en efficiënt gebruik mogelijk. Microsoft Word is een kosteneffectieve tool voor het maken van technische documentatie, vooral voor kleinere redacties met weinig en niet al te gevarieerde producten.

Adobe InDesign (voor een goed design)

Adobe InDesign is een populaire tool voor het maken van visueel aantrekkelijke documenten die veel wordt gebruikt door marketingafdelingen en reclamebureaus.

Met een breed scala aan tools en tekstbewerkingsopties is InDesign vooral geschikt voor documenten met een hoge mate van maatwerk en maakt het, vooral in combinatie met andere bewerkingsprogramma’s, de professionele creatie van tijdschriften, brochures en flyers mogelijk.

(Component) Content Management Systemen (CMS/CCMS)

Contentmanagementsystemen zijn single-source publicatiesystemen die zijn bedoeld om automatisch een bijna onbeperkt aantal afzonderlijke modules te combineren tot een document volgens eigen specificaties. Deze systemen hebben meestal uitgebreide functies voor bestandsbeheer, versiebeheer en team authoring.

Contentmanagementsystemen kunnen publiceren in een breed scala aan outputformaten en zijn bestemd voor het creëren van zeer professionele technische documentatie in middelgrote tot grote bedrijven met veel productvarianten en publicatiekanalen.

Welke andere media en technologieën zijn er om technische documentatie aan te bieden?

Online en digitale technische documentatie

Doordat de wetgeving omtrent het online publiceren langzaam versoepelt en omdat steeds meer bedrijven de voordelen zien van het online aanbieden van technische documentatie, is er een sterke ontwikkeling naar het web op gang.

Video’s

Video is de laatste jaren een van de belangrijkste media geworden en wordt ook veelvuldig gebruikt bij communiceren van instructies in de technische documentatie. Het is een geweldige manier om met gebruikers te communiceren en informatie over te brengen. Video’s kunnen worden gecombineerd met online technische documentatie.

Interactieve technische documentatie

Onderzoek heeft uitgewezen dat interactieve documentatie de beste methode is om efficiënt en effectief informatie over te brengen. Uit het onderzoek is gebleken dat een gebruiker via interactieve animaties het best in staat is om instructies succesvol op te volgen en ze in een later stadium ook nog te herinneren en te reproduceren. De principles of minimalism kunnen uitstekend worden toegepast bij interactieve documentatie.

Augmented reality

Augmented reality kan de technische documentatie met klassieke instructies aanzienlijk verbeteren, waardoor de informatie intuïtiever en begrijpelijker wordt. Zo kunnen installateurs en reparateurs bijvoorbeeld vertrouwen op Augmented reality voor duidelijker installatie-instructies ter plaatse, terwijl ze het product installeren of repareren.

Voorbeelden van goede technische documentatie

https://instrktiv.com/nl/blog/tools-efficiency/technische-documentatie-voorbeeld/

Zie de volgende voorbeelden voor inspiratie om zelf goede technische documentatie te maken.

Heb je nog vragen?

Heb je vragen of ben je op zoek naar ondersteuning bij het ontwikkelen van je technische documentatie? Neem contact met ons op en we helpen je graag verder.

NEEM CONTACT OP