Technische documentatie schrijven, hoe begin je eraan?

Technische documentatie schrijven, hoe begin je eraan?

De eerste stap om alle technische documentatie op te stellen voor je nieuwe machine of software, is een technisch schrijver inschakelen. Een technical writer is immers op de hoogte van alle geldende normen, richtlijnen en wettelijke verplichtingen. Bovendien is technische documentatie schrijven een vak op zich waarvoor technische schrijvers zijn opgeleid.

Wat kan ik allemaal door een technisch schrijver laten schrijven?

Kort samengevat kan je alles wat gedocumenteerd moet worden opdat een andere gebruiker het zou snappen, laten schrijven door een technical writer. Meestal gaat het over de gebruikershandleiding, een online webhelp of een set werkinstructies.
Alle informatie die beschreven moet worden, is te herleiden naar drie types: concepten, taken en referentiemateriaal. Deze moeten gescheiden aan de gebruikers worden aangeboden. Voor de verschillende gebruikers van een e-bike betekent dit bijvoorbeeld:

Hans wil weten welke velgen, spaken en banden geschikt zijn voor de fiets. Deze info vindt hij terug in de referentie ‘Technische gegevens’. Lies wil opzoeken hoe ze haar fietszadel kan verlagen en leest dit in de taak ‘De zadelhoogte instellen’. Nele wil nagaan wat remmen op de motor is en ontdekt dit in het concept ‘De motorrem’.

Elke fietser vindt zo snel (enkel) het stukje informatie dat nodig is terug. Elk blokje informatie kan bovendien verwijzen naar een verwant onderwerp. Voor onze E-biker Nele betekent dit bijvoorbeeld dat ze doorverwezen wordt naar ‘Met de motorrem remmen". Hans kan doorklikken naar ‘Een band vervangen’ of ‘Het voorwiel demonteren’.

Ik wil een handleiding laten schrijven door een professional

Fijn! Het is wel belangrijk om te weten dat het schrijven van een handleiding of instructies eerder een samenwerking is dan een eenzijdige uitvoering. Als technical writer vertrekken we van het, bij voorkeur vele, bronmateriaal dat u ons kunt bezorgen. Daarna wordt het een wisselwerking. We geven en vragen de opdrachtgever geregeld feedback.

Hoe ontvang ik mijn technische documentatie?

We spreken van bij de aanvang van de opdracht af in welk formaat u de handleiding of instructies zult ontvangen. Vaak is dat voor machines op papier, aangezien dit verplicht bij het toestel moet worden meegeleverd. Daarnaast kan de klant de handleiding ook ter beschikking stellen als pdf op de website of als artikels in kennisdatabanken (zoals Service Now, Zendesk Guide, Confluence …). Helemaal enthousiast worden we wanneer de klant de technische documentatie ook als responsive webhelp wil aanbieden op zijn supportpagina’s! Zo kan de eindgebruiker zelf antwoorden zoeken op zijn vragen of kan de supportdienst helpen zoeken naar een oplossing. Dat leidt uiteindelijk tot minder supportkosten!
Schrijven we uw handleiding niet in een gewone tekstverwerker, maar in DITA-software, dan kan je op elk moment nog alle kanten uit: je start bijvoorbeeld met een pdf en creëert later een webhelp. Inhoud en output staan immers los van elkaar!

Wat als mijn machine of software een upgrade krijgt?

U kunt uw technische documentatie gerust zelf aanpassen, maar we raden u toch aan om hiervoor opnieuw een technisch schrijver in te schakelen. Wij passen alles voor u aan, inclusief de eventuele vertalingen, en zorgen voor nieuwe outputs in pdf en online webhelp. Krijgen we ook toegang tot uw FTP-server, dan zorgen wij voor de recentste versie van alle handleidingen op uw website. U hoeft hier dus zelf niet meer wakker van te liggen en uw gebruikers hebben meteen toegang tot de nieuwe informatie.

Heeft u technische documentatie nodig? Laat uw gebruikershandleiding of instructies dan opstellen door een professional die op de hoogte is van alle normen en richtlijnen. Zo bent u zeker dat u helemaal in orde bent en niet aansprakelijk kunt worden gesteld voor ongevallen of letsels omwille van een slechte handleiding! Neem vrijblijvend contact met ons op voor meer informatie.

Wil u meer weten over het schrijven van technische documentatie?

Contacteer DocWriter