Home Nieuws Contact Services


logo


Documentatie schrijven.

Documentatie, een handleiding of een service-manual schrijven is niet iets dat je even snel doet. Je zult je taal goed moeten kennen en gebruiken maar ook voldoende kennis en begrip moeten hebben van het apparaat waarover je een document moet schrijven.

Daarnaast zul je het nodige moeten weten omtrent wet en regelgeving zoals bijvoorbeeld de Machinerichtlijn, NEN3140 en. NEN5509

Tenslotte zul je je ook moeten verdiepen in de doelgroep waarvoor je gaat schrijven. Is dat een groep vakmensen die allerlei vaktermen gebruiken en het soort apparaat waarover je schrijft goed kennen, of is de handleiding juist bedoeld voor de consument en is de aspirant gebruiker waarschijnlijk nog totaal niet bekend, met het apparaat, bijvoorbeeld omdat het iets nieuws betreft. Dat maakt nogal wat uit qua stijl van schrijven en taalgebruik.

Een goede handleiding is duidelijk, overzichtelijk, en vertelt de lezer alles wat hij of zij moet weten over het apparaat waarover het gaat. Dat wil zeggen: van aanvoer en installeren van het apparaat, tot en met het afkoppelen en afvoeren van het apparaat en als wat daar tussen in zit.
Wat is de functie van het apparaat, wat is juist en wat onjuist of oneigenlijk gebruikt en wat zijn de eventuele gevaren bij (onjuist) gebruik en hoe daarmee om te gaan.

Foto's en of illustraties zullen de tekst moeten ondersteunen en verduidelijken en niet slechts opsmuk moeten zijn.

Als ik een documentatie voor u moet schrijven zal ik beginnen met heel veel te vragen. Daarnaast zal ik het apparaat waarover ik moet schrijven van onder tot boven en van binnen en van buiten moeten bestuderen.
Dit kan afhankelijk van waar het omgaat van enkele uren tot enkele weken duren.
Ook zal ik u altijd vragen mij zoveel mogelijk bestaande (marketing en sales) informatie ter hand te stellen en zal ik machinebouwers, installateurs en (ervaren) gebruikers willen spreken.
Gaat het om een service- of onderhoudshandleiding dan zal ik me echt in de techniek moet verdiepen.

Het resultaat zal hopelijk een document zijn waar u tevreden over bent, dat duidelijk is voor de lezer ⁄ gebruiker en dat, zoveel mogelijk, voldoet aan NEN5509.