Als het aankomt op het schrijven van een technische handleiding voor je product, lijkt het allemaal zo makkelijk. In een inleiding vertel je iets over het product, je zet een leuk plaatje neer met een legenda voor de knoppen of de bediening, en je begint te schrijven over hoe je het product moet gebruiken.
Simpel toch? Je checkt nog even de technische handleiding van een concurrerend product en concludeert dat het een geslaagde manual is. Nog even een blokje met contactgegevens erbij, en klaar.
Of toch niet?
Bij het schrijven van een goede handleiding voor gebruikers of installateurs komt veel meer kijken. Alleen het gebruik van het product omschrijven bijvoorbeeld is wettelijk al onvoldoende. Vaak gaat het echter zelfs bij het omschrijven van de stappen voor de gebruiker al faliekant mis.
In deze blog lees je de vijf klassieke fouten die het vaakst voorkomen bij een technische handleiding schrijven.
1. Voldoen aan de wet- en regelgeving bij een technische handleiding schrijven
De eerste klinkt ook meteen als de meest ongrijpbare. Wet- en regelgeving? Voor handleidingen? Waaraan moet het dan voldoen precies, en waarom?
De Machinerichtlijn
Voor ieder product dat op de markt gebracht wordt, geldt dat het moet voldoen aan de Machinerichtlijn. Dit is een wet die voorschrijft dat er o.a. altijd een gebruikershandleiding en een verklaring van overeenstemming moet worden meegeleverd. Deze garanderen een veilig product binnen de gestelde normen.
Maar wacht, een verklaring van overeenstemming? Klinkt onbekend. Het klinkt waarschijnlijk een stuk bekender in de oren als je het omschrijft als een certificaat met de CE-markering. Dit certificaat garandeert dat het product voldoet aan alle essentiële veiligheids- en gezondheidseisen. Kortom: een product dat veilig gebruikt kan en mag worden.
En de handleiding zelf dan, wat zegt de Machinerichtlijn daarover?
Daarover kunnen we lange stukken schrijven, want alle vereiste onderdelen van een technische handleiding worden in deze wet uitgebreid benoemd. Het komt erop neer dat niet alleen het gebruik (de bediening) van het product moet worden omschreven, maar ook zaken omtrent:
- Veiligheid;
- Bedoeld en onbedoeld gebruik;
- Transport en opslag;
- Montage en installatie;
- Inbedrijfsstelling;
- Storingen en hoe deze op te lossen;
- Onderhoud;
- Demontage en afdanken.
Pas als al deze onderwerpen op een juiste manier aan bod zijn gekomen, weet je dat je handleiding in ieder geval voldoet aan alle wettelijke vereisten.
De NEN 5509
Naast de Machinerichtlijn bestaat er ook een NEN-normering voor handleidingen, de NEN 5509. De NEN 5509 geeft voorschriften over de inhoud, de structuur en de gebruikte formuleringen binnen een handleiding.
Wanneer je handleiding opgesteld is volgens de NEN 5509-normen dat heb je de garantie dat deze aan de hoogste kwaliteitseisen voldoet en voor de beoogde eindgebruiker perfect bruikbaar is. En dat is uiteindelijk het doel van iedere handleiding.
Al onze handleidingen voldoen aan de machinerichtlijn en NEN 5509-normen.
Daarnaast verzorgen wij de Cursus NEN 5509 en Machinerichtlijn voor technisch auteurs binnen onze Foxiz Academie.
2. Taalgebruik bij een technische handleiding schrijven
Taal lijkt zo’n makkelijk onderwerp, maar ook iets wat ontzettend moeilijk blijkt als je op de details gaat letten. Zelfs de meest bedreven auteurs hebben nog regelmatig hoofdbrekens over taalkwesties. Is deze omschrijving écht helder genoeg? Of kan deze alsnog verkeerd begrepen worden?
Op het vlak van taal kan er makkelijk veel misgaan in een handleiding.
Spel- en schrijffouten
Dit is natuurlijk een open deur die je aan zag komen. Het gebruik van foutloos Nederlands of Engels is cruciaal. Matige spelling of verkeerd toegepaste grammatica leveren niet alleen een amateuristisch beeld, het kan er ook voor zorgen dat instructies niet juist begrepen worden. En ook een foutloze vertaling van teksten wordt zo een haast onmogelijke klus.
Te lange zinnen
Zeg nou zelf, als je het eerlijk bekijkt zonder er al te lang over na te denken, wat vind je nu echt makkelijker lezen als je nadenkt over instructies die voor een eindgebruiker een duidelijk beeld moeten geven over het al dan niet toepassen van veiligheidsmaatregelen voordat een product in gebruik wordt genomen?
Dat was in theorie een correcte zin, maar volledig ongeschikt voor een handleiding.
Leesbaarheid is key. In een handleiding is het ultieme doel om zinnen zo kort en begrijpelijk mogelijk te maken. Daarbij moet natuurlijk nooit belangrijke informatie worden weggelaten, want dat kan dan weer gevaarlijke situaties opleveren.
Taalniveau
Taalniveau is ook een aandachtspunt. Wanneer je woorden gebruikt die veel mensen als moeilijk ervaren, loop je de kans dat de handleiding niet begrepen, of erger, niet gelezen wordt.
Het Gemeenschappelijk Europees Referentiekader is een richtlijn om het niveau van taalbeheersing te beoordelen. Afhankelijk van de beoogde lezer van de handleiding is het goed om het taalniveau aan te passen aan deze lezer.
Meer leren? Binnen de Foxiz Academie geven wij de cursus Schrijfwijzer, waarin we aandacht besteden aan alle facetten van correct Nederlands taalgebruik binnen handleidingen.
3. Geschreven voor de verkeerde lezer
Iedereen heeft een eigen expertise en hobby’s. En binnen je eigen interessegebied ken je vaak ieder specifiek detail van dat onderwerp, met de bijbehorende terminologie. Dat is echter bij het schrijven van technische handleidingen heel riskant. Want zal de lezer je nog wel kunnen volgen als je het hebt over aanhaalmomenten, gorden, de WVGS of ppm?
Of andersom: zou je voor een ervaren automonteur echt nog in 10 stappen het gebruik van een krik moeten omschrijven?
Bij het schrijven van een handleiding is het van groot belang dat je lezer, ongeacht diens achtergrond en kennis, je altijd moet kunnen begrijpen. Enerzijds moet je nieuwe onderwerpen op een heldere manier omschrijven. Anderzijds kant moet je vakmensen zeker ook niet frustreren door veronderstelde kennis te uitgebreid te herhalen.
Sommige handleidingen zijn voor algemene nieuwe gebruikers. Andere teksten zijn alleen bedoeld voor ervaren en opgeleide installateurs die echt wel weten hoe al hun gereedschappen werken.
Kortom: het kennen van je doelgroep is een belangrijk uitgangspunt bij het schrijven van je technische teksten.
De cursus Doelgroepgericht Schrijven binnen de Foxiz Academie geeft uitgebreide informatie over hoe je teksten het best passend kunnen maken voor de beoogde lezer.
4. Verkeerd gebruik van afbeeldingen
Afbeeldingen maken het makkelijker, toch?
Niets is minder waar. Wij kennen allemaal de visuele instructies van de kasten die je zelf thuis in elkaar kunt zetten. Stap-voor-stap leggen opeenvolgende afbeeldingen uit hoe je tot een goed eindresultaat komt.
Maar de praktijk leert dat afbeeldingen misschien nog wel de lastigste onderdelen van een handleiding zijn. Een afbeelding hoef je nooit te vertalen, dat is een feit, maar afbeeldingen maken die voor zichzelf spreken zonder begeleidende tekst is razend ingewikkeld.
Om die reden zijn instructies altijd voorzien van afbeeldingen en andersom. Tekst en afbeeldingen zijn de ideale aanvulling op elkaar. Een plaatje zegt weliswaar meer dan 1000 woorden, maar teksten die omschrijven wat je ziet en wat je ermee kunt doen zijn onmisbaar.
Er zijn enkele basisbeginselen rond afbeeldingen die ervoor zorgen dat ze een meerwaarde hebben voor je teksten. We sommen er een paar op.
Stijl
Zorg ervoor dat al je afbeeldingen een vergelijkbare stijl hebben. Als je foto’s, illustraties en lijntekeningen door elkaar gebruikt, geeft dat een onrustig beeld. Kies voor één type illustratie en wijk daar niet vanaf.
Formaat en positie
Als je afbeeldingen een wisselend formaat hebben, geeft dat ook een rommelig resultaat. Je kunt beter kiezen voor 2 of 3 standaardformaten voor een afbeelding in je document en houd je daar ook aan. Ook een voorspelbare positie van de illustratie op de pagina geeft rust. Alle illustraties in je teksten links plaatsen of juist centreren geeft een rustig en consistent beeld. De keuze maakt hierbij niet zozeer uit, zolang je keuze maar consequent gevolgd wordt.
Ademruimte
Afbeeldingen en teksten gaan het mooiste samen zolang er genoeg witruimte is. Een tekst té dicht bij een afbeelding plaatsen ziet er nodeloos druk uit. Elke afbeelding heeft ‘ademruimte’ nodig. Stel voor jezelf vast hoeveel witruimte je gaat hanteren rondom afbeeldingen, en pas dit bij alle gebruikte afbeeldingen toe.
Bijschriften, legenda’s en aanpijlingen
Een afbeelding wordt nog nuttiger wanneer deze is voorzien van de nodige informatie ter verduidelijking. Je maakt het daarmee voor de lezer een stuk makkelijker om alles te begrijpen. Drie aandachtspunten die maar al te vaak vergeten worden zijn de bijschriften, aanpijlingen en legenda’s.
Een bijschrift is een korte tekst onder de afbeelding die omschrijft wat er getoond wordt.
Een aanpijling is een lijn richting een bepaald onderdeel van de afbeelding, voorzien van een uniek nummer. In de tekst kun je daarmee handig verwijzen naar deze afbeelding en dit nummer. Dit is de krachtigste manier van uitleg geven.
Een legenda geeft weer waar specifieke nummers vanuit een aanpijling naar verwijzen. Deze zijn vooral handig om een totaaloverzicht van een product te geven voordat er in de details wordt gedoken.
Te veel of te weinig details
De begrijpelijkheid van een afbeelding staat of valt met hoe duidelijk deze in de eerste indruk is. Een afbeelding met veel details – die op dat moment in het verhaal niet van belang zijn – werkt slecht. Houd altijd in de gaten welk onderwerp er behandeld wordt en welk niveau van detail in een afbeelding op dat moment optimaal is. Zo creëer je een ideale combinatie van teksten en afbeeldingen die elkaar versterken.
Afbeeldingen zijn een vak apart. Om die reden hebben wij in onze Foxiz Academie voor technisch schrijvers een uitgebreide cursus Beeldtaal. In deze cursus leer je alle bouwstenen en finesses rond het perfect gebruiken van afbeeldingen in je documentatie.
5. Opmaak en scanbaarheid van je document tijdens een technische handleiding schrijven
Een tekst moet uitnodigen om te lezen. Prettig uitziende teksten hebben allemaal een overeenkomst: er is aandacht besteed aan de opmaak, indeling en scanbaarheid.
Hoe schrijf je een tekst die er aantrekkelijk uitziet?
Duidelijke hoofdstukken en paragrafen van technische handleiding schrijven
Om te beginnen kies je vooraf voor een hoofdstukindeling.
Binnen de hoofdstukken maak je gebruik van paragrafen. En binnen paragrafen pas je alinea’s toe. En o ja, beperk het aantal zinnen per alinea, liefst tot hooguit vijf korte zinnen.
Met deze indeling bouw je een tekst op die voldoende ademruimte heeft tussen alle verschillende onderdelen. Witregels tussen alinea’s, paragrafen en hoofdstukken zijn vergelijkbaar met ademruimte tussen zinnen die je uitspreekt. Je ratelt niet door, maar neemt even adempauze tussendoor. Dat geldt ook voor teksten op papier.
Het grote voordeel van het toepassen van hoofdstukken en paragrafen is dat je je document makkelijker scanbaar maakt. Als iemand zoekt naar een specifiek onderwerp, die eenvoudig en snel terug te vinden is door naar de gekozen kopjes te kijken.
Vergeet de nummering niet van een technische handleiding schrijven
Op verschillende plekken is het toepassen van een nummering onmisbaar: bij alle kopjes en op iedere pagina.
Vooral bij manuals en andere technische teksten is het van cruciaal belang dat de lezer snel terug kan vinden wat hij of zij zoekt. Pas bij ieder kopje (hoofdstukken en paragrafen) daarom naast de titels ook een oplopende en logische nummering toe. Zo neem je je lezer mee door het document.
Ook de paginanummering is natuurlijk een logische toevoeging.
Inhoudsopgaven
Wanneer je duidelijke titels hebt gekozen en ook bij bijvoorbeeld afbeeldingen genummerde bijschriften hebt toegepast, dan is een index de volgende logische stap.
Iedere handleiding heeft een inhoudsopgave of index nodig. De meeste tekstverwerkers genereren die automatisch voor je. Maar wist je dat je ook van afbeeldingen of tabellen een inhoudsopgave kunt maken? Dat geeft voor specifieke zoekbehoeften nog meer overzicht voor de lezer.
MS-Word is je vriend
Binnen tekstverwerkers, zoals Microsoft Word, bestaan er vele opmaakstijlen en mogelijkheden om je document te verbeteren. Alles omtrent titels, bijschriften, opmaak, nummering en wat je verder nog kunt bedenken kun je in deze software terugvinden.
Voor een uitgebreide blik op de vele geavanceerde opties die het opmaken van documentatie makkelijker maken, hebben wij binnen de Foxiz Academie de cursus Microsoft Word.
6. Conclusie van een technisch handleiding schrijven
Hoewel een tekst schrijven voor een gebruiker zo makkelijk lijkt, komt er nog veel bij kijken. Als je de wet- en regelgeving volgt, zit je juridisch gegarandeerd veilig. Daarnaast is het van groot belang dat je consistent te werk gaat binnen je document: houd het simpel, overzichtelijk en eenvormig, zonder belangrijke details over het hoofd te zien.
Door het toepassen van deze basisregels heb je een stevig fundament voor een document dat indruk maakt bij de lezer en dat zijn doel bereikt!
Meer weten?
Wil je meer weten over het vak van technisch schrijver? Foxiz kan je helpen. Ons motto is niet voor niets: ‘Foxiz maakt techniek begrijpelijk’. De Foxiz Academie heeft een aanbod van verschillende cursussen voor de (beginnende) technisch schrijver. Op onze website vind je hierover alle informatie.
Over Foxiz
Het team van Foxiz bestaat uit projectmanagers, technisch schrijvers, technisch tekenaars en vertalers die graag nét een stapje extra zetten. Wij maken documentatie voor een veilige en correcte bediening, bij onderhoudstaken en ten behoeve van assemblage en installatie. Wij kunnen je helpen bij al jouw vragen en verzorgen graag, indien gewenst, jouw technische documentatie.