Technische documentatie: zo werkt het
Technische documentatie is een ruim begrip, een overkoepelende term voor veel verschillende soorten documentatie. Enkele voorbeelden van technische documentatie zijn: gebruikershandleidingen, installatiehandleidingen, onderhoudshandleidingen, werkbeschrijvingen en onderdelencatalogussen. Goede, duidelijke technische documentatie levert de lezer/gebruiker optimale kennis. Een technisch auteur dient ervoor te zorgen dat er zo veel mogelijk informatie wordt overgebracht in zo weinig mogelijk woorden: dat is effectieve communicatie. Een technisch document bestaat dan ook uit de ideale verhouding van illustraties, pictogrammen en instructies. Soms zegt een illustratie meer dan duizend woorden.
Veiligheid voorop
Technische documentatie is in de eerste plaats bedoeld voor gebruikers. Gebruikers moeten aan de hand van de technische documentatie veilig, efficiënt en effectief met systemen, installaties en machines kunnen omgaan.
Fabrikanten van deze systemen, installaties en machines moeten voldoen aan Europese wet- en regelgeving. Volgens de Europese wetgeving (Machinerichtlijn) is het verplicht om bij elke machine een gebruiksaanwijzing mee te leveren in de oorspronkelijke taal en in een van de officiële talen van het land waarin wordt geleverd. Bij een in Nederland geleverde machine moet dus altijd een Nederlandstalige handleiding worden geleverd. Ook moet de gebruikershandleiding voldoen aan een aantal eisen. Er moet bijvoorbeeld in worden beschreven waar de machine voor bedoeld is, hoe deze veilig kan worden onderhouden en welke risico’s aan het gebruik van de machine zijn verbonden.
Wie en waar
Als duidelijk is wat voor soort technische documentatie moet worden geschreven, zoals een fabricageprocedure of een instructie voor een productieproces, is het belangrijk dat de documentatie wordt afgestemd op de juiste doelgroep. Technische documentatie voor gebruikers van huishoudelijke apparatuur verschilt uiteraard van technische documentatie voor ervaren monteurs bij grote onderhoudsbedrijven. De technische documentatie voor gebruikers van huishoudelijke apparaten wordt geschreven in eenvoudige taal en de handleiding richt zich voornamelijk op veilig en juist gebruik van het geleverde product. Tegelijkertijd kan zo’n gebruikershandleiding een stuk marketingmateriaal voor de fabrikant zijn. Voor de andere doelgroep, monteurs bij grote bedrijven, bestaat de technische documentatie bijvoorbeeld uit onderhoudsbeschrijvingen en werkinstructies voor machines. Dit zijn dan bijvoorbeeld stapsgewijze beschrijvingen van ingewikkelde werkzaamheden die uitgevoerd moeten worden.
Volgens de Europese Machinerichtlijn is het verplicht om een papieren handleiding bij een machine te leveren. Maar technische documentatie verschijnt al lang niet meer alleen op papier. Handleidingen worden vaak in elektronische vorm aangeboden voor plekken waar deze met een pc, tablet, e-reader of smartphone kunnen worden gelezen.
Schrijven en vertalen
Voor het verhogen van de leesbaarheid van een tekst, maar zeker ook voor een efficiënt vertaalproces is het belangrijk om zo consistent mogelijk te zijn met de terminologie. Als in technische documentatie voor een bepaald onderdeel van een machine steeds dezelfde term wordt gebruikt, verhoogt dat de leesbaarheid van de tekst. Gebruikershandleidingen worden vaak naar verschillende talen vertaald en consistent terminologiegebruik vereenvoudigt het vertaalproces aanzienlijk. Hierdoor zijn de vertaalkosten zo laag mogelijk.
Internationale bedrijven hebben Engels als voertaal en hun technische documentatie is ook in het Engels. Eindgebruikers van deze teksten hebben niet altijd Engels als moedertaal. Daarom is het gebruik van Simplified Technical English (STE) een goede oplossing. Teksten in STE zijn eenduidig, makkelijk leesbaar en begrijpelijk.
Technische documentatie wordt vaak geschreven in een speciale auteursomgeving (XML-authoring). Met deze omgeving kan de documentatie vanuit één brontekst eenvoudig in verschillende vormen worden gepubliceerd. Met één druk op de knop kan een tekst worden omgezet naar verschillende outputbestanden zoals pdf, HTML Help-bestanden en software.
Ook het vertalen van technische documentatie wordt vereenvoudigd door het gebruik van de speciale XML-auteursomgeving. De technisch auteur kan aangeven welke tekst wel of niet moet worden vertaald. Omdat inhoud wordt hergebruikt in plaats van gekopieerd en geplakt, hoeft tekst nooit dubbel te worden vertaald. Dit kan aanzienlijke kostenbesparingen opleveren. Vertaalde inhoud hoeft ook niet handmatig te worden geordend of handmatig te worden opgemaakt per taal, dit gaat allemaal automatisch. Een ander voordeel is dat wijzigingen gemakkelijk zijn door te voeren in de technische documentatie, wat bijdraagt aan consistentere documentatie, snellere verwerking en lagere productiekosten.
Grafische ondersteuning
Een illustratie bij een instructie kan de boodschap een stuk duidelijker maken. Afhankelijk van het onderwerp, de doelgroep en de vorm kunnen in technische documentatie bijvoorbeeld foto’s, lijntekeningen, ‘exploded views’, 3D-tekeningen of filmpjes worden verwerkt. Speciale technisch tekenaars en DTP’ers zorgen voor grafische ondersteuning van technische teksten.
DCT helpt bedrijven hun informatie en technische documentatie op de meest efficiënte en effectieve manier te schrijven, beheren, vertalen en ontsluiten in meer dan 50 talen.
Lees ook onze WIKI-artikelen over: