Handleiding schrijven

Hebt u de opdracht gekregen om een handleiding schrijven bij uw product of machine en weet u niet waar u moet beginnen? Als u het werk aan Xplain uitbesteedt, krijgt u een handleiding die aan alle eisen van de wetgeving voldoet. Wij hanteren hierbij onderstaande werkwijze.

Stap 1 – Doelgroep bepalen

Het is belangrijk om te weten voor wie de handleiding bedoeld is. Het maakt nogal wat uit of een handleiding bestemd is voor ervaren, hoog opgeleide gebruikers of voor lager opgeleide of nieuwe gebruikers. De eerst groep zal de handleiding vooral als naslag bij problemen gebruiken. In dat geval hoeven bijvoorbeeld niet alle begrippen en functies uitgebreid te worden uitgelegd. In het geval van lager opgeleide of nieuwe gebruikers kan extra uitleg juist zinvol zijn. Een doelgroepanalyse is een onmisbare stap.

Stap 2 – Structuur handleiding bepalen

Helaas is de doorsnee handleidingengebruiker erg ongeduldig en wil snel geholpen worden. Het is belangrijk dat de structuur van de handleiding duidelijk is. Daarvoor passen wij de volgende trucs toe:

  • Zorg dat de hoofdindeling van de handleiding logisch en goed doordacht is. Zo zal informatie die bij elkaar hoort, ook bij elkaar komen te staan.
  • Gebruik kopjes en tussenkopjes met juist gekozen titels. In feite is een kopje een zeer bondige samenvatting van de tekst die erna komt en kan de lezer hierdoor met één oogopslag zien of de pagina voor hem relevant is.
  • Maak gebruik van verwijzingen binnen de tekst, als er ergens anders in de handleiding meer informatie is te vinden.

Stap 3 – Opmaak bepalen

Om de verschillende informatiesoorten in de tekst te kunnen onderscheiden, maken we gebruik van verschillen in opmaak. Er is onderscheid tussen conceptuele en instructieve informatie:

  • Instructieve informatie legt uit hoe de lezer bepaalde taken kan uitvoeren.
  • Conceptuele informatie legt iets uit, bijvoorbeeld uit welke onderdelen de machine bestaat of welke functionaliteit een softwarepakket bevat.

Voor instructieve teksten gebruiken wij altijd genummerde stappen. Ook reacties op een handeling krijgen een eigen opmaak, bijvoorbeeld ingesprongen of cursieve tekst. De nummering laat dan niet alleen zien dat het hier om instructieve, taakgerichte informatie gaat, maar geeft ook aan dat er een noodzakelijke volgorde is in de stappen. Voor conceptuele informatie gebruiken we lopende tekst en opsommingen. Door gebruik te maken van verschillende soorten opmaak voor verschillende informatie is ook voor de lezer duidelijker om wat voor soort informatie het gaat.

Stap 4 – Formuleren

Een actieve schrijfstijl maakt teksten duidelijker. Daarom schrijven we instructies altijd in de gebiedende wijs. Elke andere vorm kan leiden tot onduidelijkheid. Als je schrijft: ‘De rol wordt vrijgegeven door de zwarte klem los te maken en naar links te bewegen.’ weet de lezer niet of hij die klem zelf moet losmaken of dat het apparaat dit doet. Schrijft je: ‘Maak de zwarte klem los en beweeg de klem naar links om de rol vrij te geven.’, dan is het meteen duidelijk dat de lezer deze handelingen zelf moet verrichten.

Voor alle teksten geldt: schrijf kort en bondig. En dit geldt zeker voor handleidingen. Hoe minder overbodige informatie, hoe duidelijker de tekst. We leggen de zaken zo kernachtig mogelijk uit.

Stap 5 – Illustraties toevoegen

Het spreekwoord zegt niet voor niets: ‘één plaatje zegt meer dan duizend woorden’. Sommige onderwerpen zijn zonder illustraties vrijwel niet uit te leggen. Documentatie bij machines en apparaten is alleen bruikbaar door deze te voorzien van tekeningen, foto’s en andere illustraties. Maar ook voor softwarehandleidingen geldt dat er veel schermafdrukken in de handleiding staan, waarbij het wel van belang is dat deze schermafdrukken zijn gevuld met de juiste informatie.

Stap 6 – Handleiding reviewen

De laatste stap in het proces is de review. Xplain laat de handleiding altijd door een materiedeskundige of eindgebruiker beoordelen. Hoe ervaren wij ook zijn, er is altijd een eindcontrole van de opdrachtgever nodig. De opdrachtgever kent zijn product of machine ten slotte het beste!

Meer informatie

Wilt u weten hoe Xplain u kan helpen met uw documentatie? Neem dan contact met ons op voor advies op maat.

Stappenplan Handleiding Maken Xplain