Inhoudsopgave
Een werkinstructie nader uitgelegd
Voor we het hebben over het schrijven van werkinstructies is het goed om het begrip ‘werkinstructie’ eerst nader uit te leggen. Dan wordt de relevantie van het gebruik van een stappenplan bij het schrijven van een werkinstructie ook duidelijk. Een werkinstructie heeft in het dagelijkse taalgebruik namelijk twee betekenissen.
De eerste is die van een totale werkinstructie, ofwel: een complete instructie om een apparaat te installeren, te monteren, te onderhouden en natuurlijk ook gewoon te gebruiken. In dat geval zijn ‘werkinstructie’ en ‘handleiding’ synoniemen. Ze betekenen hetzelfde. In deze context, die van de totale werkinstructie, is het gebruik van een stappenplan bij het schrijven zeer relevant.
Er is ook een andere opvatting over het begrip ‘werkinstructie’, waarbij een werkinstructie een enkelvoudige handeling is en daarmee het kleinste onderdeel van een handleiding vormt. Denk aan handelingen als “Zet de radiatorknop op stand 4” of “Klik het deksel vast”. Deze handelingen staan in een handleiding, maar zijn niet de handleiding zelf. Voor zulke enkelvoudige werkinstructies is een stappenplan voor werkinstructie schrijven niet nodig. Voor deze ‘micro-opvatting’ van een werkinstructie zijn alleen steeds terugkerende regels nodig, zoals ‘Combineer niet twee handelingen in een enkele werkinstructie’. Neem als voorbeeld “Klik op de toets OK en klik hierna op het sluitkruisje van het venster om het venster te sluiten”. Deze werkinstructie combineert twee handelingen en is daardoor lastig te volgen, met bovendien een kans dat de gebruiker de laatste handeling vergeet.
Technisch schrijvers
Om het nog wat ingewikkelder te maken: sommige technisch schrijvers noemen zo’n enkelvoudige werkinstructie een stap. Een stappenplan voor het maken van een werkinstructie is voor hen zodoende het schrijven van een verzameling bij elkaar horende werkinstructies, dus bij elkaar horende handelingen. Daarmee bedoelen ze: alle werkinstructies/handelingen die horen bij een bepaalde taak. Neem de taak ‘Tank reinigen’. Deze taak zou kunnen bestaan uit acht werkinstructies/handelingen of, in de ogen van deze technisch schrijvers, acht stappen. Vooral technisch schrijvers die uitgaan van de Information Mapping-methode vatten een stappenplan op als een taak met hooguit acht afzonderlijke werkinstructies.
Ons uitgangspunt
Een minder vaak voorkomende betekenis is stappenplan als verzameling van werkinstructies binnen een afgebakende taak. Deze betekenis sluit aan bij de eerder genoemde ‘Information Mapping’-opvatting. In dit artikel spreken we echter bij het gebruik van het hulpmiddel ‘stappenplan’ over een stappenplan voor de totale werkinstructie ofwel de totale handleiding. Dit is de meest voorkomende betekenis.
Nu ons uitgangspunt duidelijk is, kunnen we verder. Waarom zouden we gebruikmaken van een hulpmiddel bij het werkinstructie schrijven? Omdat het zorgt voor overzicht en structuur tijdens het schrijven van een handleiding. Hoe? Dat leest u in de volgende paragraaf.
Plan voor het schrijven van een werkinstructie
Een stappenplan bij werkinstructie schrijven is in feite een checklist waaraan een handleiding moet voldoen. Door elk van de stappen ‘af te vinken’ weten technisch schrijvers dat hun werkinstructie (ofwel: handleiding) aan alle eisen voldoet die je aan een werkinstructie kunt stellen.
Voorwaarde 1
De eerste voorwaarde is dat alle relevante taken in een werkinstructie moeten voorkomen. Vaak is de bediening van een apparaat niet voldoende om te kunnen spreken over een werkinstructie of handleiding. Apparaten moeten ook worden geïnstalleerd, worden schoongemaakt of worden onderhouden. Al deze taken dienen in een stappenplan werkinstructie schrijven te worden opgenomen.
Voorwaarde 2
De tweede voorwaarde is dat een stappenplan de logische volgorde aangeeft waarin een werkinstructie alle taken behandelt. De zojuist genoemde volgorde van installeren, schoonmaken en onderhouden levert een mooi voorbeeld. Door precies deze volgorde aan te houden kan het schoonmaken misschien leiden tot minder onderhoud. Uiteraard ontbreekt in dit drieluik een taak: in een stappenplan werkinstructie schrijven hoort natuurlijk ook het gebruik van het apparaat zelf. Aldus is de meest voorkomende volgorde in een stappenplan werkinstructie schrijven (hier in het geval van een printer):
- Hoofdstuk: Gebruiksklaar maken printer
- Hoofdstuk: Afdrukken met printer
- Hoofdstuk: Schoonmaken printer
- Hoofdstuk: Onderhoud plegen aan printer
- Hoofdstuk: Inleveren van lege cartridges en/of printer zelf
Deze lijst is erg compleet. Juist door het opstellen van een stappenplan komt ook de volgorde goed tot zijn recht.
Voorwaarde 3
Een derde voorwaarde die in elk stappenplan werkinstructie schrijven naar voren moet komen is: labeling. Daarmee bedoelen we dat elk hoofdstuk (= taak) en elke paragraaf in zo’n hoofdstuk (= deeltaak) een duidelijke omschrijving mee moet krijgen. Denk aan een omschrijving als ‘Afdrukken op fotopapier’. Zo’n duidelijke omschrijving is in verband met de vindbaarheid van informatie van essentieel belang. Bovengenoemd hoofdstuk 2 illustreert dat. Binnen hoofdstuk 2 is sprake van allerlei deeltaken. Een stappenplan werkinstructie schrijven zet al die deeltaken op een rijtje. Zulke deeltaken verschaffen een technisch schrijver vervolgens weer houvast:
- Afdrukken op normaal papier
- Afdrukken op fotopapier
- Tweezijdig afdrukken
- Groep bestanden achter elkaar afdrukken
Een stappenplan dient dus als een checklist om de grote lijn in een handleiding te bewaren door hoofdstukken (= taken) en paragrafen (= deeltaken) elk hun duidelijke omschrijving en volgorde mee te geven. Dit zorgt er niet alleen voor dat ontbrekende schakels snel zichtbaar worden, maar ook de volgorde in een werkinstructie/handleiding logisch blijft.
Bij de opsomming van de hoofdstukken hierboven (de taken dus) is de volgorde logisch vanwege de chronologie: eerst maak je een printer gebruiksklaar, daarna gebruik je hem pas. In de opsomming hierboven met de paragrafen 2.1-2.4 (de deeltaken dus) is de volgorde op een andere manier logisch: de opsomming begint met de meest voorkomende taak en eindigt met de minst voorkomende taak.
Stappenplan maken: don’ts
Een stappenplan voor het schrijven van werkinstructies schetst de voorwaarden waaraan een werkinstructie moet voldoen. Het schetst als het ware het raamwerk voor een handleiding. Maar daarmee zegt het nog niets over de daadwerkelijke inhoud van een werkinstructie/handleiding.
Het is heel goed om te beseffen dat een stappenplan alleen nog maar het begin vormt van een handleiding. Een raamwerk is mooi. Maar als een hoofdstuk over onderhoud niet de precieze onderhoudsintervallen aangeeft voor de verschillende onderdelen van een apparaat, schiet de werkinstructie zijn doel voorbij. Een omschrijving als “Schud tijdens regelmatig gebruik van de printer ook regelmatig de drum van de printer heen en weer” is veel te vaag. Nog afgezien van de vraag hoe je een drum uit de printer haalt, is exacte informatie nodig. Bijvoorbeeld: na elke 500 afdrukken is het nodig de drum uit de printer te halen en vijf keer 20 centimeter heen-en-weer te schudden.
Als een technisch schrijver deze informatie niet voorhanden heeft, moet hij ernaar vragen. Een grote ‘don’t’ is dus het raamwerk als voldoende te beschouwen. De invulling van het raamwerk is minstens zo belangrijk.
In dit verband is er sprake van een andere inhoudelijke ‘don’t’. Stel dat een technisch schrijver tijdens het schrijven van een printerhandleiding niet goed op de hoogte is van het verschil tussen een cartridge en een drum. Dan moet hij ook daarnaar vragen! Anders kan hij namelijk niet beoordelen of bepaalde (deel)taken in het stappenplan thuishoren. Als blijkt dat het verschil tussen cartridge en drum voor de gebruiker van de printer niet relevant is, is opname in een stappenplan werkinstructie schrijven inderdaad niet nodig. Maar die beoordeling kan een technisch schrijver pas maken als hij de materie zelf begrijpt. Wellicht is het juist wel nodig het verschil tussen beide aan te geven en aparte deeltaken voor beide op te zetten.
Kortom: bij het werkinstructie schrijven is een stappenplan dus het begin. Het zou een vergissing zijn te denken dat het stappenplan garant staat voor een inhoudelijke duidelijke werkinstructie. Terwijl een werkinstructie precies dat behoort te zijn: inhoudelijk duidelijk.
Stappenplan maken: do’s
Wat zijn de do’s in een stappenplan werkinstructie schrijven? De ingrediënten voor een stappenplan zijn al aan de orde gekomen. Wie die ingrediënten onderbrengt in een stappenplan werkinstructie schrijven, schrijft een goed stappenplan.
De ‘do’s’ zijn makkelijker samen te vatten dan de ‘don’ts’.
Het is altijd goed om voorafgaand aan het schrijven van werkinstructies het stappenplan voor te leggen aan een collega technisch schrijver. Eventueel missende schakels of onlogische volgorden komen sneller aan het licht als vier of zes ogen een blik werpen op het plan (in plaats van twee).
Een andere ‘do’ is om na het schrijven van de werkinstructie/handleiding zelf deze werkinstructie nog eens langs de meetlat van het stappenplan te leggen. Dan maakt het stappenplan zijn functie als checklist pas echt waar. Volgt de werkinstructie het plan? Staan alle onderdelen uit het stappenplan ook daadwerkelijk in de werkinstructie?
Manualise kan uw werkinstructie(s) schrijven
Manualise is een expert in het schrijven van werkinstructies, of het nu gaat om werkinstructies als complete handleidingen, werkinstructies als losse handelingen. In het eerste geval ontwikkelen wij graag met u een passend stappenplan werkinstructie schrijven. Dan heeft u een goed idee hoe wij vervolgens samen met u de handleiding kunnen invullen. Of hoe u dat helemaal zelf kunt doen.