Technische handleidingen schrijven: een vak apart



Heb je er ooit bij stilgestaan bij hoeveel producten een handleiding of gebruiksaanwijzing wordt geleverd? En dan hebben we het niet alleen over het boekje met kleine letters in 10 talen dat bij je stofzuiger zit; ook bij software, games en sommige online diensten vind je een (online) handleiding. Om nog maar te zwijgen over wat je tegenkomt in de business-to-business. Welkom in de wereld van de manual!

Handleiding, gebruiksaanwijzing, manual… Allemaal namen die ongeveer hetzelfde betekenen, namelijk documentatie die jou helpt om het product waar de manual is bijgeleverd, te gebruiken. Dit worden ook wel ‘user manuals’ genoemd. Daarnaast bestaan er nog onder meer ‘installation manuals’ voor installateurs en ‘service manuals’ voor bijvoorbeeld onderhoud.

Waar moet je als bedrijf op letten?

Uitgaande van een gebruikershandleiding / user manual zijn dit zaken die je vaak daarin tegenkomt en die in bepaalde gevallen zelfs verplicht zijn:

· Beschrijving en doel van het product

· Hoe krijg je het product werkend?

· Tips voor het gebruik

· Verklaring van begrippen en symbolen

· Onderhoud

· Technische specificaties

· Wat je moet doen als het product afgevoerd wordt

· Veiligheidsmaatregelen en -waarschuwingen

· Troubleshooting / probleemoplossing / FAQ

Voor machines geldt de machinerichtlijn, die gevolgen heeft voor zowel je product zelf als de documentatie die erbij wordt geleverd. Dit is een Europese richtlijn (2006/42/EG); bij export naar landen buiten de EU moet je rekening houden met mogelijk andere wet- en regelgeving.

Technisch schrijver

Het schrijven van een manual is een specialisatie binnen het schrijversvak. Mensen die zich daarmee bezighouden worden technisch schrijvers, technisch auteurs of technical writers genoemd. Vaak wordt een technisch schrijver ingehuurd om bepaalde documentatie te schrijven en betreft het dus niet iemand van het bedrijf zelf. Om de technisch schrijver op een efficiënte manier te laten functioneren is het belangrijk om zijn/haar komst voor te bereiden en hem/haar de ruimte te geven om zich in te lezen in het product.

Wanneer de technisch schrijver eenmaal aan het werk is, moet hij/zij toegang hebben tot de -vooral technische- informatie die in de manual moet komen. Instrueer daarom tijdig de mensen met productkennis, zodat ze die kennis op vraag van de technisch schrijver kunnen overdragen.

Waarmee wordt een manual geschreven?

De eenvoudigste manier om een manual te schrijven is met Microsoft Word of een andere tekstverwerker. Voordeel hiervan is dat het een programma is dat vrijwel iedereen kent en dat mensen van uw eigen bedrijf er later ook nog simpel wijzigingen in kunnen aanbrengen. Een belangrijk nadeel van een tekstverwerker is dat de mogelijkheden voor automatisering en hergebruik van bepaalde delen zeer beperkt zijn. Bij een beknopte manual hoeft dit niet zo’n probleem te zijn, maar als een manual wat uitgebreider wordt en er varianten op komen, is een tekstverwerker minder voor de hand liggend.

Adobe InDesign is een pakket dat oorspronkelijk ontwikkeld is als opmaakprogramma in de grafische industrie en daarmee is direct de kracht van dit pakket ten opzichte van een tekstverwerker duidelijk. InDesign heeft ook de mogelijkheid om met XML te werken. XML is een standaard die veel gebruikt wordt in onder meer de uitgeverswereld. Deze ontwikkeling heeft InDesign geschikter gemaakt voor het schrijven van manuals.

Voor grotere manuals en meer hergebruik wordt veel gekozen voor een pakket dat compatible is met XML en DITA. Deze combinatie, waarbij DITA de XML-data onder andere structuur geeft bij het produceren en publiceren, kom je vaak tegen in de wereld van technisch schrijven. Je ziet dan meestal een XML-client zoals FrameMaker, Xmetal, oXygen of een van de vele andere, gecombineerd met een contentmanagementsysteem (CMS) zoals DitaToo.

Manuals in andere talen

Ben je met je product internationaal georiënteerd, dan is het uitbrengen van je manuals in andere talen een must. Daarbij is het van belang om bij het schrijven in de brontaal al rekening te houden met mogelijke andere talen. Maak je bijvoorbeeld gebruik van tekstvakken in Word of InDesign, zorg dan dat het tekstvak zo groot is dat de vertaling daarin past. Sommige talen hebben flink wat meer ruimte nodig om iets weer te geven.

Een ander aandachtspunt bij vertalingen is hoe je omgaat met illustraties. Een illustratie waarin tekst is geïntegreerd is problematisch voor een vertaalbureau. In Word of InDesign kun je die tekst beter in een tekstkader plaatsen. Nog makkelijker is het om te werken met callouts (1, 2, 3… of A, B, C…) en die onder de illustratie te verklaren. Wil je graag meer weten over de mogelijkheden van technisch schrijven door Interlingo? Neem geheel vrijblijvend contact met ons op via info@interlingo.nl of 040-21.22.321.


21 keer bekeken