Handleiding voor het schrijven van een handleiding
Wanneer bent u nog eens rustig gaan zitten om een gebruiksaanwijzing te lezen, gewoon voor de lol? Nooit? Uiteraard weet ik dat niemand handleidingen echt leest. Iedereen wil graag zo snel mogelijk aan de slag. De handleiding is slechts het laatste redmiddel als we iets echt niet opgelost of geïnstalleerd krijgen. En dat heeft niet alleen met de gebruiker te maken. Handleidingen zelf zijn vaak te simplistisch om van enig nut te zijn, of te technisch om te begrijpen. Onderzoek toont aan dat 40% van alle klachten bij technische helpdesks komt van gebruikers die gebrekkige gebruiksaanwijzingen hebben.
Maar hoe schrijft u dan een goede gebruiksaanwijzing? Enkele tips:
• Zorg voor een duidelijk kader. Elke keer dat u iets nieuws leert kennen, gaat u door een mentaal proces waarbij uw geest zich een idee vormt van de nieuwigheid. Don Norman noemt dit het mental model. Zonder een duidelijk kader gaat dit proces heel moeizaam.
• Handleidingen moeten niet enkel tonen hoe een programma werkt, maar ook waarvoor het dient. Dat wil anderzijds niet zeggen dat een handleiding voor een belastingsplanner alle wetten over belastingen moet bevatten.
• Maak de handleiding niet te lang. Toon de basisfunctionaliteiten en zorg dat de gebruiker meteen aan de slag kan. Het document moet ‘diagonaal’ gelezen kunnen worden
• Oefen op modulair in plaats van lineair schrijven: zorg voor één gedachte per paragraaf, duidelijk afgebakende onderwerpen en links tussen gerelateerde onderwerpen.
• Gebruik een aangepast register en een aangepaste stijl om nuttige informatie voor uw doelpubliek op een heldere manier te brengen.
• Overweeg het gebruik van flowcharts, foto’s en illustraties in plaats van grote hoeveelheden tekst.
• Ontwerp een goede lay-out voor uw handleiding. Maak een template zodat u tijd bespaart en op de inhoud kan focussen.
• Last but not least: overweeg een professionele technisch schrijver in te huren. Een goede technisch schrijver kan technische teksten schrijven op een bondige en duidelijke manier.
De grootste misvatting over technisch schrijven is dat het een beschrijvend, mechanisch proces is. De waarheid is echter dat de kernfunctie aanleren is. Gebruikers hebben weinig aan beschrijvingen, maar des te meer aan procedures, die stap voor stap vertellen hoe ze bepaalde taken moeten uitvoeren.
Hoewel het ontwerpen en ontwikkelen van goede documentatie tijd en inspanning (en een goede technisch schrijver) vragen, zijn goede gebruiksaanwijzingen op het einde van de rit een meerwaarde, eerder dan een kostenpost. Ze maken vaak het verschil tussen een handige gebruiker die het maximale uit uw product haalt en iemand die onzeker is en veel fouten maakt – en uw helpdesk om de haverklap lastigvalt.
