Als documentatie doorschiet (of tekortschiet)

Technische Documentatie

Als Technical Writer is het mijn taak om technische documentatie te maken die begrijpelijk is, correct, actueel en aansluit bij de doelgroep. Dat klinkt overzichtelijk, maar in de praktijk betekent het vooral: voortdurend balanceren tussen te veel en te weinig. Tussen uitleggen en loslaten. Tussen “dit moet iedereen snappen” en “dit snapt niemand zonder technisch inzicht”.

Voor interne instructies gebruik ik graag veel foto’s en weinig tekst. Een aanpak die niet geheel toevallig sterk lijkt op die van een bekende blauw-gele meubelgigant. Veel plaatjes, zo min mogelijk woorden. Iedereen moet het kunnen volgen. In theorie dan.

Rond de feestdagen bouwde ik samen met mijn jongste zoon een bijkeuken. Nadat de vloer lag, begon het echte avontuur: zelf een keuken bouwen. Dat leverde een fraai pakket op aan 2D- en 3D-tekeningen, stuklijsten, montagehandleidingen en online instructievideo’s. Kortom: documentatie in alle denkbare vormen. Als Technical Writer werd ik daar licht enthousiast van. Als keukenbouwer wist ik: dit gaat nog interessant worden.

En dat werd het ook.

Zolang je precies doet wat de handleiding verwacht, is er niets aan de hand. Maar zodra een leiding nét anders loopt, een maat een paar millimeter afwijkt of de muur eigenwijs blijkt, houdt de documentatie ermee op. Dan neemt logisch nadenken het over. Dat ging bij ons één keer mis. Gevolg: opnieuw naar de blauw-gele meubelgigant voor een nieuw paneel. Leermomentje, noemen we dat dan.

Langzaam begon de keuken vorm te krijgen. De koelkast paste, de vaatwasser ook, het ladenblok liep soepel. Alleen het uitlijnen van de frontdelen van koelkast en vaatwasser bleek een soort eindbaas. In de handleiding werd dat onderwerp behandeld met de luchtigheid van: “dat spreekt voor zich”. Spoiler: dat deed het niet. Met een timmermansoog, smalle armen en enig gemompel lukte het uiteindelijk alsnog.

Na afloop verzamelde ik alle verpakkingen en documentatie. Dat bleek een indrukwekkende stapel papier. Dubbele handleidingen, veiligheidsinstructies in een indrukwekkend aantal talen en genoeg papier om een kleine bosbouwcrisis te veroorzaken. Blijkbaar gaat men er in Zweden van uit dat meer documentatie automatisch beter is. Dat is een misverstand dat ik vaker tegenkom.

Want wanneer is technische documentatie eigenlijk goed? Wat voor de één volkomen logisch is, is voor de ander pure wartaal. Of je nu werkt met plaatjes, foto’s, video’s of tekst: het succes zit niet in méér uitleg, maar in de juiste uitleg. En vooral in wat je bewust weglaat.

Goede documentatie is geen dichtgetimmerd bouwwerk, maar een steiger: stevig genoeg om op te staan, open genoeg om zelf verder te denken. En ja, dat betekent dat de gebruiker soms zelf moet nadenken. Zelfs bij een keuken.

Paul Quaedvlieg

Paul Quaedvlieg (Rometron BV)

Paul Quaedvlieg is technisch documentalist en content creator bij Rometron BV in Steenderen. Rometron ontwikkelt en produceert nauwkeurige onkruidbestrijdingstechnologie d.m.v. sensoren en geavanceerde elektronica. Alle producten inclusief PCB’s en software worden in huis ontwikkeld én geproduceerd onder de naam WEED-IT. Paul heeft een lange loopbaan op het gebied van technical writing (vooral machinebouw) en als redacteur/hoofdredacteur van een aantal technische vakbladen zoals Aandrijftechniek, Metaal Magazine en Recycling Magazine Benelux. Paul heeft een achtergrond in Werktuigbouwkunde en Technical Writing.


Lees meer van: Paul Quaedvlieg (Rometron BV)

Algemeen - Uitgelicht

Digitale Nieuwsbrief

SCHRIJF JE IN VOOR ONZE WEKELIJKSE NIEUWSBRIEVEN EN BLIJF OP DE HOOGTE VAN ALLE INDUSTRIËLE EN TECHNISCHE ONTWIKKELINGEN!

MAANDAG: EVENTS OVERZICHT
VRIJDAG: NIEUWS OVERZICHT

Door jouw inschrijving voor de nieuwsbrief, ga je akkoord met onze privacy voorwaarden.