Technische documentatie is een ruim begrip, waarmee veel verschillende soorten documenten, applicaties of andere vormen van informatie over producten en diensten worden aangeduid. Denk bijvoorbeeld aan gebruikershandleidingen, installatiehandleidingen, onderhoudshandleidingen, werkbeschrijvingen en onderdelencatalogussen. Deze informatie dient zo ontworpen te worden, dat gebruikers precies weten hoe een product of dienst gemaakt, gebruikt of onderhouden moet worden.
En hoewel technische documentatie tegenwoordig op tal van manieren wordt gepubliceerd, begint het nog steeds vaak bij een enorme stapel informatie en een hoop schrijfwerk. Daar komt de technisch schrijver in beeld. Deze zorgt ervoor dat informatie wordt verwerkt tot documentatie die past bij de doelgroep, consistent is opgebouwd, voldoet aan de verplichte wet- en regelgeving, het doel van de documentatie reflecteert en daar waar nodig ook ruimte maakt voor visueel materiaal.
Doelgroep en veiligheid als uitgangspunten
Technische documentatie begint met de gebruiker. Of het nu een bouwer, monteur of eindgebruiker is: aan de hand van technische documentatie kan iedereen veilig, efficiënt en effectief aan de slag met een product. Wanneer technische documentatie gecreëerd wordt, is het bepalen van de doelgroep dan ook de eerste stap.
De gebruiker van een huishoudelijk apparaat verschilt natuurlijk wezenlijk van een ervaren monteur van een grote organisatie die zware machines onderhoudt. Dit heeft ook invloed op de benodigde technische documentatie. Hoewel beide gericht zijn op juist en veilig gebruik, is een gebruikershandleiding voor een blender veel eenvoudiger te lezen en begrijpen dan een onderhoudsbeschrijving voor de monteur die machines draaiende moet houden. Deze doelgroep bepaalt uiteindelijk ook hoe de technische documentatie gepubliceerd moet worden.
Begrijpelijkheid en doel
Het is de taak van een technisch schrijver om ervoor te zorgen dat alle informatie die nodig is voor goede technische documentatie op zo’n manier wordt omschreven, dat de gebruiker deze zo goed en veilig mogelijk kan gebruiken. En dat kan alleen wanneer de documentatie op het leesniveau van de gebruiker is geschreven en de gebruiker de documentatie ook daadwerkelijk kan begrijpen.
Er is niet veel inhoudelijke kennis van de werking van een blender nodig om te kunnen begrijpen hoe er veilig mee omgegaan moet worden. De aan- en uitknop en het weghouden van uw handen bij de scherpe onderdelen wanneer ze draaien, zal genoeg zijn om er fruit mee te kunnen pureren. Er is echter een grote hoeveelheid aan inhoudelijke kennis nodig om zware machines op een goede en veilige manier te onderhouden. Toch is het de kunst om dit onderhoudsproces zodanig te omschrijven, dat het voor de onderhoudsmonteur hetzelfde leest als de gebruikshandleiding bij de blender.
Daarnaast is het belangrijk dat de documentatie wordt geschreven met het oog op het documentatiedoel. Wilt u processen stroomlijnen? Wilt u dat werknemers hun werkzaamheden zo eenduidig mogelijk uitvoeren? Gaat het om ontwikkeling of onderhoud? Ook het doel heeft invloed op de uiteindelijke documentatie en de manier waarop het uiteindelijk gepubliceerd wordt.
Illustraties
Daarnaast is het bij technische documentatie vaak goed om informatie te illustreren, bijvoorbeeld aan de hand van afbeeldingen en symbolen. Visueel materiaal kan de technische documentatie duidelijker maken. Afhankelijk van de doelgroep en de publicatievorm van de documentatie kunnen er bijvoorbeeld productfoto’s, instructietekeningen, instructievideo’s of 3D-tekeningen worden toegevoegd. Waar de technisch schrijvers zorgen voor een overzichtelijke en heldere tekst, zorgen technisch tekenaars en dtp’ers voor de visuele ondersteuning van deze teksten.
Wanneer technische documentatie perfect aansluit bij de doelgroep, deze goed en veilig met een product kunnen werken (al dan niet door illustraties) en het doel bereikt wordt, verhoogt dit ook de klantervaring en uw reputatie als productontwikkelaar en organisatie als geheel.
DCT en technische documentatie
Juist omdat technische documentatie zo’n ruim begrip is en zoveel verschillende zaken omvat, kan het een enorme uitdaging lijken.
Bent u geïnteresseerd in onze diensten en weet u wat uw uitdaging is? Door middel van het onderstaande formulier geeft u eenvoudig aan waarbij DCT u kan helpen, ook wanneer u juist nog niet precies weet waar we u bij van dienst kunnen zijn.
