#1. Definieer uw doelgroep

Om de informatie in de technische documentatie op een begrijpelijke manier naar de gebruiker te kunnen communiceren, is het van belang dat u uw doelgroep definieert en bedenkt op wat voor manier die doelgroep het beste benaderd kan worden. Een professioneel installateur bijvoorbeeld, vraagt om een compleet andere benadering (en dus een andere manier van schrijven) dan de standaard consument.

#2. Bepaal de inhoud van de technische documentatie

Het doel van technische documentatie is altijd hetzelfde, namelijk de gebruiker vertellen hoe het product op een veilige en accurate manier gebruikt kan worden. Bij de meeste producten zijn dan ook veel overeenkomsten in de inhoud van de technische documentatie te vinden.

In Nederland hebben we een norm voor gebruikershandleidingen (NEN5509), waarin u verschillende richtlijnen vindt met betrekking tot de minimale inhoud van uw technische documentatie. Zaken als een beschrijving van het product, technische specificaties, voorzorgsmaatregelen, instructies voor de installatie en ingebruikname, onderhoud, storingen en defecten komen in elke technische documentatie terug.

 

#3. Verzamel alle informatie

Het spreekt voor zich dat u pas kunt beginnen met het schrijven van uw technische documentatie wanneer u alle benodigde informatie heeft verzameld. Hiervoor dient u met verschillende experts op het gebied van elektronica, mechanica en installatietechniek in gesprek te gaan. Luisteren, analyseren, begrijpen, vragen stellen en selecteren zijn van essentieel belang bij deze stap.

#4. Schrijf de technische documentatie

Technische communicatie wordt door TC Europe, de Europese organisatie voor technisch schrijvers, gedefinieerd als de kunst van het accuraat, op juiste wijze en effectief kunnen overbrengen van feitelijke informatie aan bepaalde doelgroepen voor specifieke doeleinden. Dit is natuurlijk van essentieel belang voor degenen die de technische documentatie schrijft. De schrijver moet niet alleen een uitstekende beheersing van de taal hebben, maar ook de materie kunnen begrijpen en weten hoe deze op de juiste manier naar de doelgroep gecommuniceerd kan worden.

#5. Reduceer de content

Omdat de inhoud van de technische documentatie op effectieve wijze moet aansluiten op de gebruiker, verdienen korte en straight to the point teksten de voorkeur. Deze creëert u door de principes van het minimalisme toe te passen. Dat betekent o.a. dat de teksten voornamelijk gericht moeten zijn op de acties die de gebruiker uit moet voeren, en dat de gebruiker zelf de acties moet kunnen selecteren die op zijn of haar situatie van toepassing zijn.

#6. Simplificeer de teksten

In bepaalde gevallen kan het verkeerd interpreteren van zinnen in de technische documentatie ernstige gevolgen hebben. Het spreekt voor zich dat dit voorkomen moet worden. Simplified Technical English (STE) is een handig hulpmiddel om overbodige, moeilijke en verwarrende woorden en zinsdelen uit uw technische documentatie te elimineren.

#7. Illustreer de technische documentatie

Door het toevoegen van illustraties die de teksten in uw technische documentatie ondersteunen of vervangen, kan de tijd die een gebruiker nodig heeft om iets te leren drastisch worden verkort. Daarbij wordt de hoeveelheid tekst gereduceerd, wat de technische documentatie niet alleen prettiger en interessanter maakt om door te nemen maar ook zorgt voor lagere vertaalkosten.

#8. Vertaal de technische documentatie

Technische documentatie moet in veel gevallen ook vertaald worden. Soms wordt dit puur gedaan om aan de wetgeving te voldoen, soms omdat het een gebruiksvriendelijke informatieoverdracht bevorderd. Ongeacht uw redenen om uw technische documentatie te laten vertalen, het is van belang dat u een vertaler of vertaalbureau inschakelt dat beschikt over de nodige kennis en expertise met betrekking tot het vertalen van technische documentatie.

#9. Maak de technische documentatie op

Zodra de content van uw technische documentatie gereed is, is het tijd om alles netjes op te maken en van de juiste vormgeving te voorzien. Veel gebruikte software programma’s voor het opmaken van technische documentatie zijn o.a. Adobe InDesign, Adobe FrameMaker, Author-it en MadCap Flare.

#10. Publiceer de technische documentatie

Het aanleveren van een papieren handleiding is voor de meeste producten verplicht. Echter biedt het ook voordelen om een digitale handleiding (online of on device) ter beschikking te stellen. Dit soort handleidingen bieden de gebruiker de mogelijkheid om de technische documentatie ook via de computer, tablet of smartphone te raadplegen, en kunnen indien gewenst ook worden uitgebreid met (3D) animaties.


Vraag direct een offerte aan!

Vraag een offerte aan