6 tips om een goede instructie te schrijven
Wat is een goede instructie? Eentje die gebruikt wordt… Dat klinkt makkelijk, maar kan best lastig zijn. Vaak willen we te veel kennis overdragen, waardoor het onnodig ingewikkeld wordt. Hoe het wél kan: we geven je 6 tips om snel een instructie te schrijven die direct toepasbaar is om bijvoorbeeld een storing aan een installatie, een kwaliteitsafwijking van het product of probleem met de besturingssoftware op te lossen.
Tip 1 – Kies een goede titel
De titel is het eerste wat zichtbaar is. De titel geeft voor de lezer aan bij welke situatie de instructie relevant is en moet worden uitgevoerd. Beschrijf die situatie dus. Kort en duidelijk.
Een goed voorbeeld: Opstart blijft hangen in stap 21.
Een slecht voorbeeld: Een uitgebreide beschrijving van de opstartprocedure en mogelijke oorzaken van problemen die daarbij kunnen ontstaan.
Tip 2 – Stapsgewijs
Beschrijf de acties die uitgevoerd moeten worden als genummerde lijst. Dit helpt de lezer bij de uitvoer en de communicatie naar collega’s: “Ik ben bij punt 3!”.
Tip 3 – Eerst: controle!
Vaak is het niet direct duidelijk wat de oplossing is voor een ongewenste situatie. De instructie begint dan met een aantal controlepunten: staan de setpoints goed ingesteld? Zijn de geleidingen schoon? Staat de bak tegen de aanslag aan?
Afhankelijk van de verwachte basiskennis, hoeven deze controlepunten niet verder te worden gespecificeerd: de lezer kan zich dan met de vlakke hand tegen het voorhoofd slaan, denken ‘Ooh ja, natuurlijk!’, en het probleem oplossen zonder dat iemand het doorheeft. Een verwijzing naar een andere instructie of serie handelingen kan uiteraard ook.
Tip 4 – Vervolgens: aanpassingen?
Als de controle stappen zijn uitgevoerd en die waren allemaal goed, kan het mogelijk zijn dat de lezer aanpassingen moet doen. Beschrijf zo concreet mogelijk ‘wat’ moet worden aangepast en ‘hoe’, oftewel welke handelingen moeten worden uitgevoerd. Eventueel kun je ook beschrijven waarom dat nodig is, maar houdt dat zo kort mogelijk!
Dat ‘hoe’ vraagt nog enige uitleg: welke stapgrootte? Tot hoever? Hoe bepaal ik het effect van de aanpassing? Geef hier dus meer informatie, maar op een bondige manier: “Verhoog de temperatuur in stappen van 5°C tot maximaal 90°C. Controleer na elke stap de dichtheid en stop als deze op doelwaarde is.”.
Tip 5 – Dan: het waarom
De uitleg, motivering en achtergrondinformatie is heel belangrijk om het verschil te maken tussen ‘aapjes een kunstje leren’ en de lezer iets waardevols leren over de werking en het principe van het proces. Maar geef deze kennis pas aan het einde: eerst de controlepunten en acties zodat de situatie onder controle is, en daarna de uitleg.
Tip 6 – KISS
‘Keep It Short and Simple’. Houd de instructie kort, concreet en eenvoudig. Dit is moeilijker dan het lijkt!
“Ik schrijf je een lange brief, want ik had geen tijd om hem korter te maken” Blaise Pascal, Franse filosoof
Het dwingt de schrijver namelijk om heel goed en concreet na te denken en legt de moeilijkheid van de ongewenste situatie bloot. En dat is nou precies waarom de lezer behoefte heeft aan een instructie, anders had hij het zelf wel opgelost.
Uiteraard is het aan te raden om de instructie te schrijven samen met de lezer/gebruiker. Zijn de stappen duidelijk en uitvoerbaar? Missen er nog stappen? Klopt de volgorde? Als de lezer het de eerste keer direct kan toepassen, is het een goede instructie!
