Close

Technische documentatie: aanpakken en realiseren

Technische documentatie is van groot belang voor bedrijven. Documenten dienen te voldoen aan hoge kwaliteitseisen. Daar bovenop komen nog de nodige productherzieningen, taalversies, versiebeheer en onderhoud. Hoe pakt u documentatie binnen uw organisatie aan? Jukka Toimela, specialist in technische documentatie, vertelt alle ins en outs.

Technische documentatie binnen bedrijven


Het doel van een goede documentatie is om (technische) informatie gemakkelijk toegankelijk te maken. Op deze manier maakt de doelgroep correct, efficiënt en veilig gebruik van systemen, installaties, apparatuur, producten, software of machines. In het geval van een bedrijfsongeval is het management van het bedrijf in eerste instantie verantwoordelijk. Op momenten als deze wordt direct gekeken naar de technische documentatie.

”Veel bedrijven beschouwen technische documentatie als een noodzakelijk kwaad dat vaak pas op het allerlaatste moment aan de orde komt. In veel gevallen produceren ontwerpers en supervisors de documenten onzorgvuldig naast al hun andere taken”, vertelt Jukka Toimela met verbazing.

Documentatie vraagt om specifieke specialisten die om kunnen gaan met entiteit, voorschriften, eisen en efficiënte methoden. Hoogwaardige documenten worden pas effectief geproduceerd in samenwerking met professionele documentredacteurs en ontwerpers.

Realiseer goede technische documenten

 

Veiligheid

De belangrijkste aspecten binnen technische documentatie hebben betrekking op veiligheid. Beschrijf veiligheidsaspecten altijd in drie stappen. De risico’s die bij het product komen kijken, de inhoud van de risico’s en de manieren om risico’s te vermijden.
 

Structuur

Maak technische documenten beknopt en duidelijk met afbeeldingen ter verduidelijking. Vermeld de onderdelen in de juiste volgorde en structureer ze. Het is van belang dat het document nuttig is voor alle gebruikers.
 

Basisprincipe

Hanteer altijd het juiste basisprincipe voor een document. Deze is eenvoudig: verdeel het document in modules, waarbij versies en vertalingen apart beheerd worden.
 

Gebruikers

Houd rekening met de gebruikers van het document. Geef snel antwoord op vragen die te verwachten zijn van de gebruiker. Ga dus niet in op diepgaande vragen van een technische collega, tenzij hij een verwachte gebruiker is.
 

Afbeeldingen

Het belang van goede afbeeldingen kunnen we niet vaak genoeg benoemen. De juiste afbeeldingen vormen een essentieel onderdeel van een hoogwaardig technisch document.
 

Handleidingen

Informeer gebruikers over methoden en werkwijzen en voorzie ze van opmerkingen en advies. Een gebruikershandleiding biedt uitkomst.

Documentation

HyperSTE: de content checker software voor gestandaardiseerde documentatie

 

Een ideale tool binnen technische documentatie is de HyperSTE tool. Deze tool ondersteunt u bij het schrijven van Engelstalige teksten volgens de regels van Simplified Technical English. HyperSTE garandeert dat de bedrijfsterminologie en stijlgidsregels worden toegepast als een interactief controlesysteem voor de auteur en als een tool voor kwaliteitsmeting voor de editor.

 

Bespaar op vertaalkosten van technische documentatie met HyperDOC

 

Een tweede onmisbare tooling is HyperDOC. Het vertalen van technische documentatie brengt vaak problemen met zich mee. ”In sommige bedrijven werken ontwerpers met variërende kennis van de Engelse taal en terminologie aan de documenten. Vertalers worden voor een bijna onmogelijke taak gesteld. Taalversies leiden tot hoge kosten en zijn niet van een hoge kwaliteit”, vertelt Jukka Toimela.

Professionele documentatieschrijvers die werken met efficiënte methodes en tools bieden een oplossing. HyperDOC is één van die tools. Deze tool zorgt ervoor dat een module die in verschillende publicaties van een goed gestructureerd systeem voorkomt, slechts eenmaal vertaalt hoeft te worden. Dit zorgt voor effectiever beheer van de vertalingen van productherzieningen. We geven u een voorbeeld.

Voor versie A van het product worden Engelse en Chinese vertalingen gemaakt. Na vrijgave van de productherzieningen B en C wordt de module in de Engelse taal overeenkomstig bijgewerkt. De Chinese taalversie hoeft echter niet te worden bijgewerkt als in China uitsluitend productversie A wordt geleverd.

De gegevens worden in een vertaalgeheugen opgeslagen. Dit vertaalgeheugen geeft aan welke zinnen reeds zijn vertaald, in welke zinnen slechts kleine wijzigingen hoeven te worden aangebracht en welke zinnen volledig opnieuw moeten worden vertaald. Een zin hoeft slechts eenmaal te worden vertaald.

Hyper Doc technical documentation

De toekomst van technische documentatie
 

Papieren handleidingen en het handmatig aanpassen van documenten behoort tot het verleden. Effectief gebruik maken van digitalisering, dat is de toekomst van technische documentatie! Wilt u aan de slag met een optimalisatieslag van alle technische documentatie binnen uw bedrijf? Etteplan helpt hierbij.

Meer artikelen die u misschien interesseren