Technische documentatie schrijven Hoe maak ik een goede start in 8 stappen?

Technische documentatie schrijven Hoe maak ik een goede start in 8 stappen? Door: Author-it Software Corporation BV

Technische documentatie schrijven

Hoe maak ik een goede start in 8 stappen?

De meeste mensen die aan de slag gaan met het schrijven van technische documentatie voor een product, dienst of een softwarepakket zijn geneigd dit te gaan doen met een tool uit de stal van Microsoft. En dan voornamelijk met Word omdat bijna iedereen hier mee bekend is.

In de basis is daar niets mis mee als het gaat om een eenvoudig document.

Doorgewinterde Word gebruikers weten de prachtigste documenten op te leveren, aangekleed met foto’s, uitsneden uit AutoCAD en diagrammen.

Wij van Author-it willen dit creatieve proces niet ontmoedigen, maar we geven u wel een paar zaken ter overdenking.

Denk eens aan het volgende;

  • Waar staat de content nadat het is gemaakt en staat het daar veilig?
  • Kan iemand het gewenst of ongevraagd aanpassen?
  • Wil, en kun je iedere keer zoveel energie steken in dit creatieve proces?
  • Moet het worden vertaald? En naar hoeveel talen?
  • Zou je naast Pdf en print, deze (aangepaste) documentatie ook willen gebruiken voor een ander medium?
  • Wat gebeurt er als de werkdruk hoog wordt hoe verdeel je dan het werk?
  • Wat gebeurt er als de schrijver de onderneming verlaat?

Maar goed, terug naar waar het eigenlijk om gaat: Het leesbaar maken van technische documentatie.

1-Definieer uw doelgroep

De benadering en de samenstelling van een tekst is doelgroep afhankelijk. Dit lijkt erg voor de hand te liggen, maar je moet als schrijver telkens weer teruglezen met in gedachten de lezer van je document. Luisteren naar je doelgroep, analyseren, begrijpen, vragen stellen en selecteren zijn van onmisbaar belang bij deze stap.

2-Schrijf de technische documentatie

Probeer gebruik te maken van een  template zodat je logisch kan handelen. Technische communicatie wordt door tekom Europ , de Europese organisatie voor technisch schrijvers, gedefinieerd als de kunst van het accuraat, op juiste manier en effectief kunnen overbrengen van feitelijke informatie aan bepaalde doelgroepen voor specifieke doeleinden.

3-Simplificeer en reduceer de teksten

Zelf als u denkt uw doelgroep goed te kennen, voorkom dan dat de lezer afhaakt of de tekst verkeerd interpreteert. Gebruik bijvoorbeeld weinig of geen afkortingen.

Wanneer u de teksten in het Engels opzet gebruik dan Simplified Technical English (STE) dit is een handig hulpmiddel om overbodige, moeilijke en verwarrende woorden en zinsdelen uit uw technische documentatie te elimineren.

Sommige technische documentatie wordt pas gelezen tijdens een noodgeval. (Hoe bedien ik de brandblusser?) Lijvige en vage teksten moeten worden vermeden. Beschrijf iets punctueel. Gebruik actiepunten of nummers en houdt het kort.

4-Bepaal de inhoud van de technische documentatie.

Voordat u begint aan het schrijven van de technische documentatie is het van belang dat u alle informatie heeft verzameld bij de experts. Vervolgens is het doel van technische documentatie de gebruiker te vertellen hoe het product op een veilige en juiste manier kan worden gebruikt.

In de EU zijn er richtlijnen / normen voor gebruikershandleidingen.

Schrijven van gebruikershandleidingen (NEN5509)

Om te voldoen aan de eisen van de Europese richtlijnen en normen, moeten bedrijven documentatie maken. Wat er gemaakt moet worden zijn;

  • De verklaringen van overeenstemming.
  • De gebruikershandleiding.
  • Het technisch (constructie) dossier.
  • Werkinstructies voor het eigen machinepark. 

En algemeen zijn er zaken die in elke technische documentatie terugkomen.

  • Een beschrijving van het product
  • Technische specificaties
  • Voorzorgsmaatregelen
  • Instructies voor de installatie en ingebruikname.
  • Onderhoud, storingen en defecten

5-illustreer de technische documentatie

Door het toevoegen van foto’s of illustraties die de teksten in uw technische documentatie ondersteunen of vervangen, kan de tijd die een gebruiker nodig heeft om iets te leren en juist te handelen sterk worden verminderd. Daarbij wordt de hoeveelheid tekst gereduceerd, en deels vervangen door afbeeldingen. Dit maakt de technische documentatie niet alleen prettiger en interessanter, maar het zorgt ook voor lagere vertaalkosten.

6-Vertaal de technische documentatie

Technische documentatie moet in veel gevallen ook worden vertaald. Soms wordt dit puur gedaan om aan de wetgeving te voldoen, of 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 over het vertalen van technische documentatie.

In ieder geval zou het vertaalbureau een vertaalgeheugen van uw content moeten ondersteunen en kennis hebben van lokalisatie. Dit laatste is van belang voor de context in een bepaalde taal.

7-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 softwareprogramma’s voor het opmaken van technische documentatie zijn o.a. Adobe InDesign, of FrameMaker,  of de meer voor het doel ontworpen,  Author-it en MadCap Flare.

8-Publiceer de technische documentatie

Het aanleveren van een papieren handleiding is voor de meeste producten verplicht.

Deze verplichting kan echter ook een voordeel zijn. Zo heeft een bedrijf met goede documentatie een veel betere positie bij claims en andere juridische kwesties.

Het kan ook een voordeel opleveren om een digitale handleiding ter beschikking te stellen. Dit soort handleidingen, meestal in de vorm van een klantportaal of een klant servicecenter,  bieden de gebruiker de mogelijkheid om de technische documentatie ook via de computer, tablet of smartphone te raadplegen. Het grote voordeel is dat je als leverancier de informatie kan aanpassen en kan voorzien van video-instructies en animaties.

Maar er zijn meer voordelen zoals;

  • Een imagoverbetering.
  • Tevreden klanten.
  • Goede recensies.
  • Een minder belaste servicedienst.
  • Snellere overdracht en beschikbaarheid van informatie.
  • Handiger en beter inwerken van nieuwe medewerkers.
  • Een veilige werkomgeving met veiligere machines.

 

 

Ga voor meer informatie over Author-it en een demo naar onze website. 

Of bel 0628981436.