The Acolad blog

6 tips voor het schrijven van technische teksten

Geschreven door Acolad team | 17-jun-2020 22:00:00

Heeft u ooit een instructiehandleiding gelezen en beseft dat u er geen woord van begrijpt, ook al is de tekst in het Nederlands geschreven? 


Of heeft u ooit een technische documentatiehandleiding laten vertalen, om er daarna achter te komen dat uw inbox verstopt raakt door vragen van vertalers? 

Technisch schrijven is belangrijk voor overdracht van kennis en handelingen. Door middel van een stukje tekst weten mensen in alle landen hoe men een apparaat hoort te bedienen. Of dat nu een afstandsbediening voor de TV is of een MRI-scan. Een fout is snel gemaakt, zo lazen we recent in het AD dat een 7 jaar oude vertaalfout tot een boycot van een barbecuemaker heeft geleid.Het doel van technisch schrijven is om lezers informatie te bieden over een complex of technisch onderwerp op een manier die gemakkelijk te begrijpen, kraakhelder en ondubbelzinnig is. En een van de efficiëntste manieren om dit doel te bereiken is het gebruik van controlled language.

Wat is controlled language? 

Controlled language is in wezen een beperkte vorm van een natuurlijke taal zoals Engels of Frans.  Aangezien alle natuurlijke talen andere grammaticaregels hebben, volgt hieruit dat de regels voor controlled language van taal tot taal zullen verschillen. 
In het algemeen bestaan alle controlled languages uit: 
• vereenvoudigde grammaticaregels (die beperkender zijn dan de algemene taal) 
• een beperkte woordenschat (er is slechts een betrekkelijk aantal woorden toegestaan)


Voordelen van controlled language bij vertalen 

Met controlled languages kan de vertaling van technische documentatie worden gestroomlijnd met betrekking tot tijd- en kostenefficiency: 
• Met controlled languages worden bronteksten samenhangender, gestructureerder, begrijpelijker en gemakkelijker leesbaar. 
• Een beter inzicht in de brontekst draagt bij tot het verlagen van het aantal gestelde vragen of benodigde toelichtingen die de vertalers vragen terwijl zij aan de vertaling werken. 
• Door het gebruik van controlled languages kunnen taaltechnologieën zoals  vertaalgeheugens en machinevertaling volledig worden benut dankzij de verbeterde structuur en samenhang van de bronteksten. 


Tips voor technisch schrijven  

Ongeacht welke aanpak u kiest, zijn controlled languages een kwestie van het aannemen van regels en zich eraan houden. Hier volgen enkele algemene vuistregels om technische schrijvers te helpen bij het schrijven van “gewone taal“, met het doel om het vertaalproces te optimaliseren. 


Tip #1: Gebruik geen werkwoorden in de lijdende vorm. Dus “Druk de schakelaar in” en niet “De schakelaar moet worden ingedrukt”. 
Tip #2: Gebruik de tegenwoordige tijd en voorkom hulpwerkwoorden als “zullen”. Dus niet “Druk de schakelaar in. Een lichtje zal gaan branden” maar “Druk de schakelaar in en een lichtje gaat branden“. 
Tip #3: Gebruik relatief korte zinnen. Een zin met meer dan 10 woorden is al te lang. De voorgaande zin heeft 10 woorden, precies goed! 
Tip #4: Beperk technisch jargon tot een minimum. Wees bij technische termen die u wél gebruikt consequent. We kunnen hier bijvoorbeeld “knop” gebruiken als synoniem voor “schakelaar”. Denk goed na over welke van de twee termen de doelgroep het eenvoudigst begrijpt. 
Tip #5: Voorkom het gebruik van afkortingen enerzijds, en van lange, samengestelde woorden anderzijds.
Tip #6: Probeer uitdrukkingen en zegswijzen te voorkomen. 

En, om uw teksten nog leesbaarder te maken: 

  • Wees niet bang voor ruimtes tussen de regels. Probeer niet te veel informatie op één pagina te proppen. 
  • Gebruik lijsten en opsommingen, zoals deze. 
  • Voeg tabellen, diagrammen en afbeeldingen in, maar alleen als ze een duidelijke toegevoegde waarde hebben. 


Doe ik het wel goed?

Als u twijfelt of uw technische informatie wel simpel genoeg is, overweeg dan eens een voorbeeld aan uw vertaalbureau te sturen. Die werkt dag in dag uit met documenten  waarin deze principes worden gehanteerd.


Hulpmiddelen voor technisch schrijven 

Zorg er bij het schrijven van technische documentatie voor dat u het juiste hulpmiddel voor technisch schrijven gebruikt om uw content te maken.
En let erop dat bovenstaande richtlijnen niet van toepassing zijn op welke beginnende literaire schrijver dan ook. Als Shakespeare dit advies had opgevolgd, had de befaamde regel uit zijn sonnet “Shall I compare thee to a summer’s day?…” (Zal ik jou vergelijken met een zomerdag?) er dan misschien wel zo had uitgezien: “Je bent een knapperd“. 


Meer over dit onderwerp

Om meer te weten te komen over dit onderwerp kunt u het hierna genoemde artikel of enkele stijlgidsen raadplegen. Daardoor kunt u een beter inzicht in controlled languages en helder schrijven krijgen: 
• Microsoft Manual of Style (4th Edition) – stijlgids door Microsoft. 
• The Global English Style Guide: Writing Clear, Translatable Documentation for a Global Market – stijlgids door John R. Kohl. 

Hulp nodig voor technisch project? Laat het ons weten, we helpen u graag!