1. Home
2. Schakel een technisch schrijver in voor technische documenten

Schakel een technisch schrijver in voor technische documenten

Technisch schrijven of technical writing is een vak op zich. Er bestaan cursussen voor, er worden normen en richtlijnen uitgeschreven om wereldwijd uniformiteit te creëren … Kortom, het is een vak dat geleerd kan worden. Een technische of wetenschappelijke achtergrond is echter onmisbaar om gebruikershandleidingen of instructies te schrijven. Dat is ook een vereiste bij DocWriter: al onze technical writers hebben een technische basis en schoolden zich bij tot technisch schrijver. Zo is onze zaakvoerder, Stefaan Veys, eigenlijk industrieel ingenieur elektromechanica en Certified Expert Machinery Safety en is collega Peter Bettens master in de scheikunde én preventieadvieseur.

Wat is het verschil tussen een copywriter en een technical writer?

Dat is een vraag die we vaak krijgen. Hoewel een copywriter het er, mits een goede briefing, misschien ook niet slecht van af zou brengen wat technische handleidingen betreft, zijn er toch erg grote verschillen met het vak ‘technisch schrijven’. Zo zal een copywriter de machine, de software of het product eerder willen verkopen, terwijl een technisch schrijver enkel uitlegt hoe de machine, software of het product precies werkt. Het is onze taak om minimalistisch te schrijven, geen synoniemen maar steeds dezelfde termen te gebruiken en elke vorm van subjectiviteit te vermijden. Alleen zo kunnen gebruiksaanwijzingen slechts op één manier geïnterpreteerd worden. Dat is erg belangrijk om fouten, ongevallen én aansprakelijkheid te vermijden!

Met onderstaand voorbeeld tonen we duidelijk het verschil tussen een copywriter en een technisch schrijver:

Geschreven door een copywriter

Mijn allerliefste tante Marleen,
Heel erg bedankt voor de wondermooie nieuwe fiets die ik heb gekregen voor mijn verjaardag. Het ziet er echt een superstevige fiets uit. Ik kan niet geloven dat je nog wist dat blauw mijn absolute lievelingskleur is. Ik zal steeds aan je denken als ik fiets. Ik bewonder enorm de tijd en de inspanning die je hebt genomen om deze fiets uit te kiezen.
Veel liefs, je neef,
Stefaan

Geschreven door een technical writer

Tante Marleen,
Bedankt voor de fiets. Hij is:

• Mooi
• Robuust
• Blauw

Groeten,
Stefaan

Conclusie: een technisch schrijver schrijft zeer neutraal en objectief, gebruikt geen ‘gevoelswoorden’ en zorgt ervoor dat de tekst maar op één manier begrepen kan worden.

Een handleiding laten schrijven door een technisch schrijver, hoe begin je eraan?

Voordat een technical writer een handleiding kan beginnen schrijven, of het nu om een complexe machine, software of speelgoed gaat, werkt hij zich eerst grondig in. Om de werking te doorgronden, vraagt hij toegang tot al het mogelijke achtergrondmateriaal, zoals technische tekeningen of renders, elektrische, hydraulische en pneumatische schema’s, de software, documentatie van vorige versies, screenshots, … .
We doen ook beroep op de mondelinge uitleg van gespecialiseerde gebruikers of de machine-ontwerpers en software-programmeurs. We nemen foto’s, filmen, doen schermopnames om deze informatie vast te leggen en vullen indien nodig gaandeweg deze informatie aan met online meetings. Hoe vroeger onze betrokkenheid in een project, hoe meer we ook onze eigen input kunnen geven: niet zelden worden er op ons aangeven of door onze vragen over onduidelijkheden, kleine aanpassingen doorgevoerd in bijvoorbeeld een veiligheidsaspect van een machine of de user interface van software.

Wat kost een technical writer?

Vooraleer dieper in te gaan op hoe we concreet onze kosten aanrekenen, is het belangrijk stil te staan hoe een technical writer kosten bespaart voor uw bedrijf en dus de Return On Investment of opbrengst van uw product vergroot.

Een handleiding geschreven door een professional verlaagt de kosten door het ontlasten van uw support-afdeling op verschillende manieren: eenvoudigere en duidelijkere instructies en focus naar de gebruiker, betere doorzoekbaarheid van de handleiding en de webhelp, efficiënt opvolgen en snel publiceren van updates van nieuwe productversies, efficiënt vertalen, …

Minimalisme, eenduidigheid in terminologie, taalonafhankelijke afbeeldingen en versiebeheer, kennis van de werkwijze van en goede samenwerking met technische vertaalbureaus verlagen de kost én verhogen de kwaliteit van uw vertalingen drastisch.

Voor eenvoudige toestellen kunnen we op basis van onze ervaring een tijdsinschatting maken, maar voor grotere of complexere machines stellen we een voorstudie voor om een correcte offerte te kunnen opmaken. Vaak hangt het af van:

• hoe ingewikkeld de machine in elkaar zit;
• welke beschikbare achtergrondinformatie we krijgen (zoals het technisch constructiedossier of risicoanalyse);
• de mogelijkheid om al dan niet bestaande tekeningen te gebruiken;
• of er al is nagedacht over het onderhoud van de machine (wij kunnen dit ook opstellen, indien nodig);
• de taal waarin de brondocumentatie moet worden geschreven;
• of er al een huisstijl of template is;
• of er al is nagedacht over het softwarepakket waarin de handleiding moet worden geschreven;
• ...

Voor software is het vaak eenvoudiger om een goede inschatting te maken. We bekijken de software en lijsten op hoeveel concepten, taken en referentietopics er beschreven moeten worden. We houden ook rekening met de complexiteit van de software. Op basis van deze inventaris en onze eerdere ervaring, kunnen we een projectprijs voorstellen.

Bezig met de ontwikkeling van een nieuwe machine of innovatieve software? Wij zijn graag uw partner en geven vrijblijvend advies over de technische documenten die u nodig heeft om in orde te zijn en uw product op de markt te kunnen brengen. Neem gerust contact met ons op.