Technisch schrijven – hoe doe je dat?

Hoe leg je een ‘moeilijk’ technisch verhaal uit aan mensen die geen technische achtergrond hebben? Hoe schrijf je een handleiding die wél gelezen wordt? Hoe leg je bedrijfskritische informatie vast zodat je eigen medewerkers – of hun opvolgers – er baat bij hebben? Kortom: technisch schrijven – hoe doe je dat?

Als ik uitleg wat ik doe als technisch schrijver, dan krijg ik vaak als reactie terug: “ah, handleidingen” of “je schrijft dus in Jip-en-Janneke-taal”. En dat klopt maar ten dele. Handleidingen en instructies vormen een fractie van alle documentatie die ik verzorg om het werken met technische apparaten, processen en software gemakkelijker te maken – kortweg technisch schrijven. En van de taal van Annie M.G. Schmidts jeugdhelden is al helemaal geen sprake …

Geen Jip-en-Janneke-taal, maar op maat
Technisch schrijven doe je voor een bepaalde doelgroep, en de manier van schrijven pas je hierop aan. Dit heb ik in het onderstaande schema aangegeven. Als een bedrijf mij inhuurt om ‘technisch te schrijven’, dan heb ik steeds drie mogelijke doelgroepen voor ogen: nieuwelingen, gebruikers en de eigen medewerkers. Zo zijn de gebruikers (van de producten, diensten of software die het bedrijf levert) gebaat bij alles wat ze nodig hebben om ‘er mee te leren werken’: van gebruikersinstructies om aan de slag te gaan, tot online hulp voor als je met problemen zit. Maar je wilt ook toekomstige gebruikers of nieuwelingen interesseren voor wat het bedrijf aan het doen is: ‘laat weten dat het bestaat’. Bijvoorbeeld door artikelen in vaktijdschriften of boeken te schrijven over nieuwe technische ontwikkelingen binnen het bedrijf. En dan is er nog een derde groep: de eigen medewerkers van het bedrijf. Als er medewerkers bij het bedrijf vertrekken, dan is het voor de continuïteit van het bedrijf op z’n zachtst gezegd niet handig als de kennis en ervaring mee ‘wegvloeit’. Dit kun je voorkomen door alle bedrijfskritische informatie goed toegankelijk voor een volgende generatie vast te leggen.
Technisch schrijven gebeurt niet in Jip-en-Janneke-taal – eenvoudige, voor iedereen begrijpelijke taal – maar wel op maat. Weet voor wie je schrijft!
Technische documentatie volgens Betase

Vertaalslag
Als technische mensen onderling met elkaar communiceren, dan hebben ze al een bepaalde gemeenschappelijke achtergrond waarbij ze dezelfde taal spreken. En dat is uitermate handig, want je kunt zo heel efficiënt van gedachten wisselen met andere gelijkgestemden. Maar als je niet-technische mensen – denk aan (toekomstige) gebruikers van je product, maar ook eigen medewerkers zonder technische achtergrond – wilt informeren over wat er speelt, dan zul je toch eerst een vertaalslag moeten maken. Gebruik hier geen vaktaal, maar begrijpelijke taal, heldere formuleringen, met veel toelichting en hier en daar een voorbeeld. En schrijf in goed Nederlands: het document is immers een visitekaartje, en geeft een indruk van je bedrijf.
Vertalen van ‘moeilijk naar begrijpelijk’ valt dus onder technisch schrijven. Maar dat geldt eigenlijk ook voor letterlijk vertalen, van de ene naar de andere taal. Het vertalen van een bestaande buitenlandse handleiding naar het Nederlands is immers een manier om het werken met technische apparaten gemakkelijker te maken, simpelweg door de handleiding van ‘moeilijk’ Engels naar ‘gemakkelijk’ Nederlands te vertalen.

Tips ‘n’ tricks
De behoefte aan mensen die ‘moeilijke’ technische onderwerpen kunnen vertalen in hapklare brokken blijft onverminderd groot. Dat merk ik uit vragen die ik persoonlijk krijg, maar ook uit de vacatures voor technisch schrijvers of auteurs die regelmatig voorbij komen. Om niet steeds het wiel opnieuw uit te vinden geef ik hieronder – en eigenlijk ook al hierboven – een paar tips die mijzelf geholpen hebben. Soms een open deur, al dan niet ‘uit het boekje’, maar vaak ook een eyeopener voor mensen die er voor het eerst mee te maken krijgen. Het is uiteraard aan de lezers van dit artikel om deze tips wel of niet op te volgen …

Voordat je begint met schrijven …
… bedenk voor wie je schrijft en wat de boodschap is. Wil je een nieuw technisch onderzoeksresultaat duidelijk maken aan een breed publiek? Of gaat het juist om een specifiek product dat in gebruik moet worden genomen, en waarvoor stap-voor-stap instructies nodig zijn?
Geef punt voor punt aan waarover je wilt schrijven, waarbij je de rode lijn van de boodschap goed in het oog houdt. Bekijk dan welke informatie je al voorhanden hebt. En dat is soms meer dan je denkt. Zo kan de inleidende informatie uit een bestaande white paper vaak al met weinig wijzigingen gebruikt worden binnen een publicatie in een vaktijdschrift.
Vul de puntsgewijze lijst in met al bestaande informatie, en daarna wordt duidelijk wat je nog moet produceren. Zo’n schrijfproces is ook een goed moment om bestaande en eventueel achterhaalde informatie te updaten.

Begin met een voorbeeld
Als je andere mensen kennis wilt laten maken met iets nieuws, bijvoorbeeld een nieuwe technische ontwikkeling, dan kun je het beste beginnen met iets wat bekend is. Want als je als lezer hier een voorstelling van kunt maken – als het ware voor je ziet – dan is het gemakkelijker om van daaruit het nieuwe te begrijpen. De drie eerste zinnen van dit artikel zijn blijkbaar prikkelend genoeg geweest om minimaal tot hier door te lezen …
Zo ben ik zelf een artikel over elektromagnetische interferentie (storing tussen elektronische componenten) begonnen met een – in die tijd, 2011 – goed bekend verschijnsel:
Stel je eens voor … je smartphone ligt op je bureau, dicht bij de speakers van je computer. Een paar seconden voordat er een telefoontje of SMS-je binnenkomt op je mobiele telefoon hoor je een zoemend geluid via de speaker. Is de speaker helderziend geworden? Nee hoor. De draad naar de speaker werkt hier als een antenne die het signaal vanuit het mobiele netwerk oppikt en versterkt. Dit is een typisch voorbeeld van elektromagnetische interferentie tussen elektronische componenten, en het laat zien dat elektromagnetische velden overal om ons heen zijn.

Weet waarover je schrijft
Dit lijkt een open deur, maar hier zit een diepere boodschap achter. In mijn optiek moet je achter de komma bekend zijn met een technisch onderwerp, om het voor de komma aan anderen te kunnen uitleggen. Als je weet voor welk publiek je schrijft, dan weet je ook wat je wel en wat je niet moet opschrijven. Maar hier zit een valkuil. Als je ergens veel van weet, dan kun je er ook te goed bekend mee zijn. Je wilt graag alles opschrijven wat je ervan weet, en dan is het soms lastig om de hoofdzaken van de bijzaken te onderscheiden …

Uitgebreid vs. beknopt
Als je nieuwelingen kennis wilt laten maken met een nieuwe technologie, dan kun je dat behoorlijk uitgebreid doen: begin met een voorbeeld, ga uit van het bekende, en neem de lezer enigszins verhalend mee de diepte in. Voor instructies geldt juist het tegenovergestelde: gebruik een lijst met genummerde commando’s – ‘doe dit, doe dat’. Schrijf bondig en to-the-point. Voor computeralgoritmen – instructies die niet voor mensen, maar voor de computer zijn bedoeld – gaat het nog een stapje verder. Behalve to-the-point moeten deze instructies ook foutloos worden geschreven, om het computerprogramma niet te laten crashen of in een oneindige lus te laten raken.

Veel plaatjes
Een tekst kan nog zo mooi zijn geschreven … als je één blad met alleen letters ziet, dan nodigt dit niet uit tot lezen. Het wordt al aantrekkelijker als je de tekst in losse blokken presenteert, met een kop erboven. Maar plaatjes vormen een échte toevoeging. Dus minimaal één afbeelding per pagina (of per schermafbeelding, als je een webtekst hebt waarbij je naar beneden scrollt). Afbeeldingen of schema’s geven een welkome afwisseling. Mensen zijn visueel ingesteld, en in een plaatje kun je direct zien hoe iets werkt – waar je anders veel woorden voor moet gebruiken. Bovendien is een afbeelding letterlijk ‘grenzeloos’: bij een eventuele vertaling van het document kun je op de vertaalkosten besparen.

Bedrijfsinterne informatie vastleggen
Voor een zzp-er is een intern kennismanagementsysteem niet per se nodig. De kennis zit ‘in het hoofd’ of is gestructureerd op de eigen computer. Voor grotere organisaties bestaan er wel systemen om de bedrijfsinterne kennis te beheren en beheersen. Behalve met tekst kun je bedrijfsinterne informatie ook steeds gemakkelijker als beeld vastleggen – de ontwikkelingen in de ICT helpen ons hierbij. Tegenwoordig is het gemakkelijk om zelf filmpjes te maken. Elke goede smartphone is een filmcamera, en de opslag van deze filmpjes op een harde schijf kost vrijwel niets meer. Denk wel na over een goed beheersysteem: tekst kun je doorzoeken als je een goede zoekfunctie hebt, met plaatjes of beeld lukt dit niet zomaar. De oplossing hiervoor is om het onderwerp in de titel weer te geven, of goede trefwoorden (‘tags’) aan het filmpje te koppelen. Desnoods kun je de inhoud van het filmpje uitschrijven, maar dat is nogal bewerkelijk.

Laat het (voorlopige) resultaat door iemand anders lezen
Bij voorkeur iemand uit de doelgroep, en kijk hoe deze ‘proefpersoon’ reageert. Bij documenten die bedoeld zijn voor nieuwelingen: begrijpt hij of zij het? Komt over wat je had bedoeld? Zit er niet te veel vaktaal in? Bij een handleiding: laat hem of haar de instructies stap voor stap uitvoeren, en bekijk het resultaat. Je zult versteld staan hoe een instructie ‘die maar op één manier kan worden opgevat’, toch multi-interpretabel blijkt te zijn …

Over dit onderwerp valt nog veel meer te schrijven, maar om het leesbaar te houden laat ik het voorlopig hierbij. Ik heb wel ideeën over verbreding of verdieping van deze interessante en veelzijdige materie, maar ik laat het graag over aan de hoeveelheid ‘views’, ‘likes’ en eventuele reacties hoe groot de werkelijke behoefte hieraan is …

Eddy Brinkman heeft een technische achtergrond en is goed bekend met chemie, materiaaltechnologie en ICT. Hij heeft meer dan 12 jaar ervaring met technisch schrijven en technische documentatie vanuit zijn bedrijf Betase BV , en is auteur van het boek ‘Kennismaken met materialen – materiaalkunde voor niet-materiaalkundigen’.

Geef een reactie

Het e-mailadres wordt niet gepubliceerd. Vereiste velden zijn gemarkeerd met *