Schrijf heldere handleidingen: 20 tips

Tekeningetjes zeggen meer dan woorden in gebruiksaanwijzingen

Het schrijven van documenten als gebruiksaanwijzingen en voorschriften is moeilijker dan je op het eerste gezicht zou denken. Voor de doe-het-zelvers volgen hier wat tips.

Stem de inhoud af op uw doelgroep. Voorschriften voor productiemedewerkers schrijf je anders dan een handleiding voor accountants. En jongeren benader je anders dan senioren.

En de volgende tip spreekt al evenzeer voor zich, maar toch: hanteer een logische opbouw !

Elementen voor de opbouw

Zo’n opbouw zou kunnen bestaan uit de volgende elementen:

  1. waarop moet je letten ? Bijvoorbeeld: welke risico’s loop je bij verkeerd gebruik van het product ? Wat kan er gebeuren als je de veiligheidsvoorschriften niet naleeft ?
  2. wat heb je nodig om aan de slag te gaan ? Je kunt denken aan gereedschap of aanvullende informatie. Of een veiligheidshelm en -bril.
  3. wat moet je doen ? Geef bij elke stap aan wat je erbij nodig hebt.
  4. soms werkt het voor bijvoorbeeld andere/volgende stappen verhelderend als je uitlegt waaróm de gebruiker iets moet doen. Of waaróm het zo werkt.
  5. hoe controleer je per stap of je het goed hebt gedaan ?
  6. wat kan er verkeerd gaan ? En hoe los je dat op ?
  7. hoe kun je het product het best onderhouden ?
  8. garantiebepalingen, adressen van verdeler en fabrikant.

Tips voor de vormgeving

  • voor bepaalde product-/marktcombinaties is het misschien interessant om een handleiding op uw website te zetten. Liefst ondersteund door (of zelfs in de vorm van) filmpjes. Geschreven handleidingen behoren tegenwoordig immers niet tot de meest gelezen lectuur…
  • gebruik in elk geval zoveel mogelijk illustraties (met begrijpelijke bijschriften). Duidelijke (en niet te kleine !) plaatjes zeggen veel meer dan woorden. Soms kun je de woorden zelfs achterwege laten. Ikea doet dat bijvoorbeeld. Het scheelt het bedrijf heel wat kostbaar vertaalwerk !
  • maak de eventuele tekst overzichtelijk en scanbaar. Gebruik om de paar alinea’s functionele tussenkopjes. (Dus niet ‘Trappers’ maar ‘Hoe monteer je de trappers ?’) Plaats witregels tussen de alinea’s. En tussen alinea’s en tussenkopjes.

Een paar schrijftips

  1. formuleer zo helder mogelijk. Vakjargon is dus taboe. Mik in principe op het begripsniveau van een brugklasser. Dan is de kans het grootst dat iedereen snapt wat u bedoelt.
  2. schrijf zo kort mogelijke zinnen (tot ca. 10 woorden). Splits zinnen met een komma. Hoe korter de zin, hoe groter de kans dat de lezer hem begrijpt.
  3. gebruik spreektaal ! Richt u tot de lezer.
  4. werk met actieve zinnen, dus zonder lijdende vormen. Niet: ‘De flut moet aan het frutsel worden geschroefd’ maar ‘Je (of u) moet de flut aan het frutsel schroeven’.
  5. laat de tekst voor alle zekerheid lezen door een brugklasser en/of een ervaren tekstschrijver.

Moet u de tekst vertalen ?

  • bent u geen native speaker of niet tweetalig opgevoed ? Ga dan niet zelf vertalen.
  • gebruik geen vertaalprogramma. Daar komen soms heel rare vertalingen uit !
  • huur een professionele vertaler in.
  • geef hem een gedegen briefing. Hoe meer hij van uw product, dienst en markt begrijpt, hoe beter zijn vertaling zal zijn. Gaat het om de gebruiksaanwijzing van bijvoorbeeld een apparaat ? Geef hem een exemplaar te leen zodat hij zijn tekst zonodig aan de praktijk kan toetsen.

Komt u er toch niet helemaal uit ?

Laatste tip: schakel dan een professionele tekstschrijver in. Natuurlijk, dat kost wat geld. Maar dat is toch beter dan uw product van een minder goede handleiding te voorzien ? Of veiligheidsinstructies op te hangen die voor meerdere uitleg vatbaar zijn ? Stel dat er ongelukken van komen. Dan zit u met de schadeclaims en de imagoschade ! Dat kost u veel meer !

Renske Cramer

Lees ook:

  1. Veiligheidsvoorschriften vormen risico op zich (mijn post van gisteren)
  2. Gebruiksaanwijzing ondergeschoven communicatie-kindje

pb7

Over Renske Cramer
Ik ben gepensioneerd communicatie- en marketingadviseur. Ik houd me bezig met dingen die nóg leuker zijn dan werken ;-)

3 Responses to Schrijf heldere handleidingen: 20 tips

  1. Pingback: Veiligheidsvoorschriften vormen risico op zich « Renske Cramer Tekstproducties

  2. Pingback: Gebruiksaanwijzing ondergeschoven communicatiekindje « Renske Cramer Tekstproducties

  3. Pingback: ‘Wetten dwingen organisaties niet tot begrijpelijke communicatie’ « Renske Cramer Tekstproducties

Geef een reactie

Vul je gegevens in of klik op een icoon om in te loggen.

WordPress.com logo

Je reageert onder je WordPress.com account. Log uit / Bijwerken )

Twitter-afbeelding

Je reageert onder je Twitter account. Log uit / Bijwerken )

Facebook foto

Je reageert onder je Facebook account. Log uit / Bijwerken )

Google+ photo

Je reageert onder je Google+ account. Log uit / Bijwerken )

Verbinden met %s