Inhoudsopgave
Wat is technisch schrijven
Technisch schrijven is meer dan alleen het schrijven van tekst. Het kent vele toepassingen en is onmisbaar in veel verschillende sectoren. Om welke toepassing het ook gaat, het draait meestal om complexe informatie die helder en gestructureerd overgebracht moet worden. Enkele toepassingen zijn:
- Gebruiksdocumentatie (zoals handleidingen en online help documentatie)
- Software-documentatie
- Trainingsmateriaal
Maar ook voor het schrijven van juridische documentatie, marketing- en verkoopdocumentatie wordt gebruik gemaakt van technisch schrijven.
Bij technisch schrijven gaat om het analyseren, structureren, visualiseren en optimaliseren van informatie. Hierin komen taal, technologie en gebruiksvriendelijkheid samen. Kortom, veel meer dan enkel het schrijven van een tekst.
Hoe schrijft u technisch
Als voorbeeld zoomen we in op het technisch schrijven van gebruiksdocumentatie. Gebruiksdocumentatie omvat alle informatie die een gebruiker nodig heeft om een product of systeem te begrijpen en op een veilige en correcte manier te installeren, bedienen en onderhouden. Daarnaast bevat deze documentatie informatie waarmee een gebruiker in staat is om problemen op te lossen.
Denk dus in dit geval bij het technisch schrijven aan het maken van bijvoorbeeld installatiehandleidingen, snelstartgidsen, softwarehandleidingen, veiligheidsdocumentatie of trainingsmateriaal.
Of het nu gaat om papieren handleidingen of digitale helpfuncties: bij technisch schrijven wordt voor het bepalen van de inhoud dezelfde aanpak gehanteerd en worden de volgende stappen doorlopen:
- Doelgroep bepalen
Het is van belang om te weten voor wie de technische documentatie bedoeld is. In het geval van gebruiksdocumentatie kan dit bijvoorbeeld een monteur, consument of medewerkers van een bedrijf zijn. Er dient vastgesteld te worden welk kennisniveau de gebruiker heeft en wat de benodigde terminologie en diepgang van de uitleg is. - Productinformatie verzamelen
Dit gaat verder dan alleen het testen van het product. Door zowel experts (bijvoorbeeld productontwikkelaars) als eindgebruikers te raadplegen, wordt waardevolle input verkregen. En vergeet ook het onderzoek in het kader van wet- en regelgeving niet: relevante normen en richtlijnen kunnen specifieke eisen stellen aan documentatie. - Documentatie schrijven en illustreren
Bij het schrijven van de documentatie is het van belang dat de inhoud consistent, begrijpelijk voor de doelgroep en ‘to the point’ is. Heldere, technische illustraties worden gebruikt om (complexe) informatie toegankelijk en begrijpelijk te maken. Samen met een logische volgorde, een goede structuur en nauwkeurigheid vormen dit de ingrediënten voor een technisch goed geschreven document.
Een technische vertaler zorgt vervolgens voor een nauwkeurige en begrijpelijke vertaling van de brontekst als het technische document in een andere taal beschikbaar moet komen.
Simplified Technical English (STE): methode voor het schrijven van documentatie
Gaat u zelf aan de slag met het technisch schrijven van documentatie? Er is een hulpmiddel waar u gebruik van kunt maken: Simplified Technical English is een gestandaardiseerde schrijfmethode voor het schrijven van technische documentatie. Het is oorspronkelijk ontworpen voor de luchtvaartindustrie, maar wordt ook in andere sectoren gebruikt. Doel is om technische documentatie duidelijker en begrijpelijker te maken, omdat o.a. dubbelzinnigheid of onduidelijkheid in sommige industrieën grote gevolgen kan hebben. In STE wordt gebruik gemaakt van een beperkte (gecontroleerde) woordenschat, gestandaardiseerde woordkeuze en zinsopbouw.
Voorbeeld en basisregels
‘Handle with care can break’ is een voorbeeld van een zin die op twee manieren geïnterpreteerd kan worden:
- Ga voorzichtig om met dit object, want het kan breken.
- Het object kan breken als u het met zorg behandeld (wat een tegenstrijdige betekenis zou hebben).
In Simplified Technical English zou een herschreven versie kunnen zijn: Handle with care. It can break.’ Of ‘Be careful. This item is fragile.’ Hierdoor wordt de betekenis ondubbelzinnig en voorkomt deze verwarring.
Het STE biedt een aantal basisregels voor het technisch schrijven. Enkele voorbeelden:
- Kies één betekenis wanneer een woord meerdere synoniemen heeft en gebruik dit woord dan consistent. Wijk niet af van de keuze. Bijvoorbeeld, de woorden ‘begin’, ‘start’, ‘commence’, ‘originate’ en ‘initiate’ betekenen allemaal ‘beginnen’. In STE is gekozen voor ‘start’, omdat dit werkwoord de meest regelmatige vervoegingen heeft.
- Kies één betekenis wanneer een woord meerdere betekenissen heeft. In STE wordt het Engelse ‘fall’ bijvoorbeeld alleen gebruikt wanneer iets door zwaartekracht naar beneden valt. Het wordt niet gebruikt in de betekenis van ‘verminderen in grootte, aantal of kracht’. Deze eenduidigheid voorkomt verwarring en mogelijke grotere gevolgen.
- In het Engels kunnen bepaalde woorden verschillende grammaticale functies hebben. Bijvoorbeeld, het woord ‘switch’ kan zowel een zelfstandig naamwoord (de fysieke schakelaar) als een werkwoord (het schakelen zelf). In STE wordt ‘switch’ in zulke gevallen alleen als zelfstandig naamwoord gebruikt. Voor het werkwoord wordt ‘turn off’ en ‘turn on’ gekozen.
Voor meer informatie over STE verwijzen we u graag naar https://asd-ste100.org/
Wat doet een technisch schrijver
Een technisch schrijver beheerst alle facetten van het vak ‘technisch schrijven’. Hij kan complexe informatie verzamelen, analyseren en presenteren, zodat de inhoud perfect aansluit op de doelgroep. Afhankelijk van de branche stemt hij de taal af op het kennisniveau van de doelgroep. Daarnaast kan hij informatie toegankelijk maken voor een breder publiek, waarbij de inhoud duidelijk en begrijpelijk gepresenteerd wordt, zodat ook gebruikers met weinig voorkennis deze goed kunnen begrijpen.
Een onmisbaar onderdeel van het presenteren van de inhoud is het maken van heldere technische illustraties die complexe informatie begrijpelijk maken. Deze illustraties moeten duidelijk, eenvoudig en consistent zijn. Een technisch schrijver zal de tekst in een illustratie zo veel mogelijk beperken en hij zorgt dat hij op de hoogte is van mogelijke richtlijnen die voor industrieën kunnen gelden.
Naast het analyseren en presenteren van informatie, is een technisch schrijver verantwoordelijk voor documenteren. In bedrijven die complexe producten ontwikkelen en moeten voldoen aan technische en wettelijke eisen – zoals in de machinebouw, automotive of farmaceutische industrie – speelt een technisch schrijver een cruciale rol bij het opstellen en beheren van een Technisch Constructie Dossier.
Technisch Constructie Dossier (TDC)
Een TDC, ook wel Technisch Dossier genoemd, is een verzameling documenten die aantoont dat een product voldoet aan de geldende wet- en regelgeving. Dit dossier bevat alle technische en administratieve gegevens over het ontwerp, de fabricage en de werking van een product. Het is alleen voor intern gebruik en is met name bedoeld voor controlerende instanties. Een TDC is verplicht voor producten die onder CE-richtlijnen vallen.
Een technisch schrijver helpt bij het correct documenteren van alle relevante productinformatie, zodat een TCD compleet, overzichtelijk en wettelijk conform is. Deze technische documentatie omvat gebruikershandleidingen, technische specificaties, risicoanalyses, test- en keuringsrapporten en onderhouds- en installatiehandleidingen en moet voldoen aan bepaalde standaarden, zoals de Machinerichtlijn (2006/42/EG) of de Laagspanningsrichting (2014/35/EU).
Manualise helpt als technisch schrijven voor u een opgave is
Gaat u voor het eerst aan de slag met technisch schrijven of wilt u uw bestaande technische documentatie verbeteren? Wij bieden uitgebreide ondersteuning bij het schrijven en professionaliseren van uw documentatie. Of het nu gaat om het uitvoeren van een conformiteitsonderzoek om te bepalen aan welke eisen uw documentatie moet voldoen, of het schrijven en maken van illustraties – onze technisch schrijvers staan voor u klaar.