Deze website houdt statistieken van uw bezoek bij. Wij gebruiken hiervoor Google Analytics, maar zonder persoonlijke gegevens door te geven. Geef hier uw keuze aan:
Toestaan Eén keer toestaan Blokkeren

Xplain

We explain everything

Tips & trucs: handleiding schrijven

Hebt u de opdracht gekregen om een handleiding schrijven bij uw product of machine en weet u niet waar u moet beginnen? Hieronder vindt u een aantal tips, waarmee we u een handje op weg hopen te helpen.

Tip 1: Bepaal uw doelgroep

Als u niet weet voor wie u de handleiding schrijft, wordt het lastig. Het is namelijk nogal een verschil of u een handleiding schrijft voor ervaren, hoog opgeleide gebruikers of juist voor lager opgeleide of nieuwe gebruikers. De eerst groep zal de handleiding vooral als naslag bij problemen gebruiken. In dat geval hoeft u bijvoorbeeld niet alle begrippen en functies uitgebreid uit te leggen. In het geval van lager opgeleide of nieuwe gebruikers kan extra uitleg juist zinvol zijn.

Tip 2: Zorg voor een goede structuur

Helaas is de doorsnee handleidingengebruiker erg ongeduldig en wil snel geholpen worden. Het is belangrijk dat de structuur van de handleiding duidelijk is. Daarvoor zijn er trucs:

  • Zorg dat de hoofdindeling van uw 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.

Tip 3: Gebruik verschillende opmaak voor informatiesoorten

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.

Gebruik voor instructieve teksten 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 gebruikt u 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.

Tip 4: Schrijf actief

Instructies schrijft u altijd in de gebiedende wijs. Elke andere vorm kan leiden tot onduidelijkheid. Als u 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 u: ‘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.

Tip 5: Kort en bondig

Voor alle teksten geldt: schrijf kort en bondig. Maar dit geldt met name voor handleidingen. Hoe minder overbodige informatie, hoe duidelijker de tekst. Schrap dus alle overbodige informatie uit de handleiding, maar leg vooral de zaken zo kernachtig mogelijk uit.

Tip 6: Gebruik illustraties

Het spreekwoord zegt niet voor niets: ‘Een plaatje zegt meer dan duizend woorden’. Sommige onderwerpen zijn zonder illustraties vrijwel niet uit te leggen. Documentatie bij machines en apparaten zijn alleen bruikbaar door deze te voorzien van tekeningen, foto’s en andere illustraties. Maar ook voor softwarehandleidingen geldt dat u vooral veel schermafdrukken moet gebruiken. Let er dan wel op, dat deze schermafdrukken gevuld zijn met de juiste informatie.

Tip 7: Laat uw handleiding beoordelen

Als u alle bovenstaande tips heeft gevolgd, heeft u natuurlijk de perfecte handleiding. Maar is dat wel zo? Schrijvers, hoe ervaren ook, doen er goed aan hun handleidingen af en toe door een ander laten lezen en dan het liefst door een eindgebruiker. De schrijver moet steeds opnieuw proberen zich te verplaatsen in de gedachtewereld van de uiteindelijke gebruiker. En dat is niet altijd makkelijk!

Tip 8: Raadpleeg een specialist

Tot slot: het schrijven van handleidingen is een vak apart. Daar zult u achter komen als u zelf aan de slag gaat. Technisch schrijvers hebben zich helemaal op dit vak toegelegd. Het kan zeker geen kwaad eens te rade te gaan bij een technisch schrijver met uw vragen op het gebied van handleidingen. Xplain helpt u graag een handje verder!

Meer informatie

Wilt u meer weten over handleidingen schrijven? Neemt u dan gerust contact met ons op.