Instructies

De focus voor dit hoofdstuk is een van de belangrijkste van alle toepassingen van technisch schrijven-instructies. Zoals u weet, wordt in instructies stap voor stap uitgelegd hoe u iets moet doen: hoe u iets moet bouwen, bedienen, repareren of onderhouden.

Lees de voorbeelden.

Instructies

Een van de meest voorkomende en een van de belangrijkste toepassingen van technisch schrijven zijn instructies – stap voor stap wordt uitgelegd hoe u iets moet doen: iets in elkaar zetten, iets bedienen, iets repareren of routineonderhoud aan iets plegen. Maar voor iets dat zo eenvoudig en intuïtief lijkt, behoren instructies tot de slechtst geschreven documenten die je kunt vinden. Net als ik heb je waarschijnlijk veel woedende ervaringen gehad met slecht geschreven instructies. Wat volgt in dit hoofdstuk is misschien niet een fool-proof, goof-proof gids voor het schrijven van instructies, maar het zal je laten zien wat professionals beschouwen als de beste technieken.

Ultimately, good instruction writing requires:

• Clear, eenvoudig schrijven
• Een grondig begrip van de procedure in al zijn technische details
• Uw vermogen om uzelf in de plaats van de lezer te stellen, de persoon die uw instructies probeert te gebruiken
• Uw vermogen om de procedure in groot detail te visualiseren en dat bewustzijn op papier vast te leggen
• Finitief, uw bereidheid om die extra afstand te gaan en uw instructies te testen op het soort persoon waarvoor u ze hebt geschreven.

U hebt nu waarschijnlijk koppen, lijsten en speciale mededelingen bestudeerd – het schrijven van een reeks instructies met deze hulpmiddelen lijkt waarschijnlijk vanzelfsprekend. Deel de discussie op in genummerde verticale lijsten en voeg wat speciale notities toe op de voor de hand liggende punten en je bent klaar! Nou ja, niet helemaal, maar het is een goed begin. Dit hoofdstuk gaat in op enkele kenmerken van instructies die ze ingewikkelder kunnen maken. U kunt op uw beurt deze overwegingen gebruiken om uw eigen instructies te plannen.

Enkele voorrondes

Aan het begin van een project om instructies te schrijven, is het belangrijk om de structuur of kenmerken te bepalen van de specifieke procedure waarover u gaat schrijven.

Doelgroep en situatie. Bepaal al vroeg in het proces het publiek en de situatie van uw instructies. Vergeet niet dat het definiëren van een publiek inhoudt dat de mate van bekendheid met het onderwerp moet worden vastgesteld, evenals andere details. Zie de bespreking van doelgroepen en de stappen die je kunt gebruiken bij het definiëren van doelgroepen.

Het belangrijkste is dat je, als je een schrijfcursus volgt, een beschrijving van je publiek moet schrijven en die bij je instructies moet voegen. Zo kan uw docent uw instructies beoordelen op hun juistheid voor het beoogde publiek. En vergeet ook niet dat het in een cursus technisch schrijven de voorkeur verdient om voor een niet-gespecialiseerd publiek te schrijven – een veel grotere uitdaging voor jou als schrijver.

Aantal taken. Hoeveel taken zijn er in de procedure waar u over schrijft? Laten we de term procedure gebruiken om te verwijzen naar de hele reeks activiteiten die uw instructies moeten bespreken. Een taak is een semi-onafhankelijke groep van handelingen binnen de procedure: bijvoorbeeld, het instellen van de klok op een magnetron is een taak in de grote algemene procedure van het bedienen van een magnetron.

Een eenvoudige procedure zoals het verversen van de olie in een auto bevat slechts één taak; er zijn geen semi-onafhankelijke groeperingen van activiteiten. Een meer complexe procedure zoals het gebruik van een magnetron bevat tal van dergelijke semi-onafhankelijke taken: het instellen van de klok; het instellen van het vermogen; het gebruik van de timer; het schoonmaken en onderhouden van de magnetron, onder anderen. (De instructies voor het gebruik van een fototoestel zijn geordend naar taken.)

Sommige instructies hebben slechts één enkele taak, maar hebben vele stappen binnen die ene taak. Stelt u zich bijvoorbeeld een reeks instructies voor het in elkaar zetten van een schommel voor kinderen voor. In mijn eigen ervaring waren er meer dan 130 stappen! Dat kan een beetje ontmoedigend zijn. Een goede aanpak is om gelijksoortige en verwante stappen in fasen te groeperen, en bij elke nieuwe fase de stappen te hernummeren. Een fase is dan een groep van gelijksoortige stappen binnen een enkele-taak-procedure. In het voorbeeld van de schommelset zou het opzetten van het frame een fase zijn; het verankeren van het ding in de grond zou een andere zijn; het in elkaar zetten van de schommeldoos zou nog een andere zijn.

Beste benadering van de stap-voor-stap discussie. Een andere overweging, die je misschien niet in een vroeg stadium kunt bepalen, is hoe je je instructies moet richten. Voor de meeste instructies kunt u zich richten op taken, of u kunt zich richten op gereedschappen (of kenmerken van gereedschappen).

In een taakbenadering (ook bekend als taakgerichtheid) voor instructies over het gebruik van een telefoonantwoorddienst, zou je deze secties hebben:

• uw begroeting opnemen
• uw berichten afspelen
• uw berichten opslaan
• uw berichten doorsturen
• uw berichten verwijderen, enzovoort

Dit zijn taken-de typische dingen die we met het apparaat zouden willen doen. Voor verdere discussie, zie het hoofdstuk over taakanalyse.

Aan de andere kant, in een gereedschapsbenadering van instructies voor het gebruik van een fotokopieerapparaat, zouden er deze onwaarschijnlijke secties zijn:

• kopieerknop
• annuleerknop
• vergroot/verkleinknop
• collate/stapleerknop
• kopieerformaatknop, enzovoort

Als u een set instructies volgens dit plan zou ontwerpen, zou u stappen schrijven voor het gebruik van elke knop of functie van het fotokopieerapparaat. Instructies volgens deze gereedschapsbenadering zijn moeilijk te laten werken. Soms komt de naam van de knop niet helemaal overeen met de taak waarmee hij wordt geassocieerd; soms moet je meer dan alleen die ene knop gebruiken om de taak te volbrengen. Toch kunnen er momenten zijn dat de gereedschappen/functies aanpak de voorkeur verdient.

Taken groeperen. Het opsommen van taken is misschien niet alles wat u moet doen. Er kunnen zoveel taken zijn dat u ze moet groeperen, zodat lezers de afzonderlijke taken gemakkelijker kunnen vinden. Bijvoorbeeld, de volgende zijn veel voorkomende groeperingen van taken in instructies:

1. uitpakken en installatietaken
2. taken voor installeren en aanpassen
3. basisbedieningstaken
4. routinematige onderhoudstaken
5. taken voor het oplossen van problemen; enzovoort

Gemeenschappelijke secties in instructies

Hierna volgt een overzicht van de secties die u vaak in instructies zult aantreffen. Ga er niet van uit dat ze allemaal in de instructies moeten voorkomen die u schrijft, noch dat ze in de hier gepresenteerde volgorde moeten voorkomen, noch dat dit de enige mogelijke secties in een serie instructies zijn.

Terwijl u het volgende leest over veel voorkomende secties in instructies, bekijkt u de voorbeeldinstructies.

Schematische weergave van instructies. Onthoud dat dit een typisch of algemeen model is voor de inhoud en organisatie – er zijn vele andere mogelijk.

Inleiding. Plan de inleiding van uw instructies zorgvuldig. Zorg ervoor dat het de volgende dingen doet (maar niet noodzakelijkerwijs in deze volgorde) die van toepassing zijn op uw specifieke instructies:

• Geef aan wat de specifieke taken of procedure zijn die moeten worden uitgelegd en wat de reikwijdte is (wat niet wordt behandeld).
• Geef aan wat het publiek aan kennis en achtergrond nodig heeft om de instructies te begrijpen.
• Geef een algemeen idee van de procedure en wat ermee wordt bereikt.
• Geef aan onder welke omstandigheden deze instructies wel (of niet) moeten worden gebruikt.
• Geef een overzicht van de inhoud van de instructies.

Zie de paragraaf over inleidingen voor verdere bespreking.

Algemene waarschuwingen, voorzichtigheid, gevaarmeldingen. Instructies moeten de lezers vaak waarschuwen voor de mogelijkheid dat zij hun apparatuur ruïneren, de procedure verknoeien, en zichzelf verwonden. Ook moeten instructies vaak belangrijke punten of uitzonderingen benadrukken. Voor deze situaties gebruik je speciale notities – notitie, waarschuwing, voorzichtigheid, en gevaar. Merk op hoe deze speciale aanwijzingen worden gebruikt in de voorbeeldinstructies hierboven.

Technische achtergrond of theorie. Aan het begin van bepaalde instructies (na de inleiding, uiteraard) kan het nodig zijn de achtergrond van de procedure te bespreken. Voor bepaalde instructies is deze achtergrond van cruciaal belang, anders hebben de stappen in de procedure geen zin. Zo hebt u misschien ervaring met die software-applets waarin u uw eigen kleuren bepaalt door met de rode, groene en blauwe schuifbalken te schuiven. Om echt te begrijpen wat u aan het doen bent, moet u enige achtergrond hebben over kleur. Op dezelfde manier kun je je voorstellen dat voor bepaalde instructies met camera’s ook enige theorie nodig is.

Uitrusting en benodigdheden. Merk op dat de meeste instructies een lijst bevatten van de dingen die je moet verzamelen voordat je met de procedure begint. Het gaat hierbij om uitrusting, het gereedschap dat u bij de procedure gebruikt (zoals mengkommen, lepels, broodpannen, hamers, boren en zagen) en benodigdheden, de dingen die bij de procedure worden verbruikt (zoals hout, verf, olie, meel en spijkers). In een gebruiksaanwijzing worden deze zaken meestal opgesomd in een eenvoudige verticale lijst of in een lijst met twee kolommen. Gebruik de lijst met twee kolommen als u aan sommige of alle artikelen specificaties moet toevoegen – bijvoorbeeld merknamen, maten, hoeveelheden, soorten, modelnummers, enzovoort.

Discussie van de stappen. Wanneer u aan het eigenlijke schrijven van de stappen toekomt, zijn er verscheidene dingen die u in gedachten moet houden: (1) de structuur en opmaak van die stappen, (2) aanvullende informatie die nodig kan zijn, en (3) het gezichtspunt en de algemene schrijfstijl.

Structuur en opmaak. Normaal gesproken stellen wij ons een reeks instructies voor als zijnde opgemaakt als verticale genummerde lijsten. En de meeste zijn dat ook. Normaal gesproken maakt u uw eigenlijke stap-voor-stap instructies op deze manier. Er zijn echter enkele variaties, en ook enkele andere overwegingen:

• Stappen met een vaste volgorde zijn stappen die in de aangegeven volgorde moeten worden uitgevoerd. Bijvoorbeeld, als u de olie in een auto te vervangen, het aftappen van de olie is een stap die moet komen voor het aanbrengen van de nieuwe olie. Dit zijn genummerde lijsten (meestal, verticaal genummerde lijsten).
• Variabele-volgorde stappen zijn stappen die kunnen worden uitgevoerd in vrijwel elke volgorde. Goede voorbeelden zijn die troubleshooting gidsen die u vertellen om dit te controleren, controleer dat waar je probeert om iets te repareren. Je kunt dit soort stappen in praktisch elke volgorde uitvoeren. Bij dit type is de lijst met opsommingstekens het geschikte formaat.
• Alternatieve stappen zijn die waarin twee of meer manieren om hetzelfde te bereiken worden gepresenteerd. Alternatieve stappen worden ook gebruikt wanneer er verschillende omstandigheden kunnen bestaan. Gebruik opsommingstekens bij dit type, met OR ingevoegd tussen de alternatieven, of de lead-in die aangeeft dat alternatieven op het punt staan te worden gepresenteerd.
• Geneste stappen. In sommige gevallen kunnen afzonderlijke stappen binnen een procedure op zichzelf al vrij complex zijn en moeten ze worden opgesplitst in substappen. In dat geval streep je verder in en volg je de substappen op als a, b, c, enzovoort.
• “Staploze” instructies. Tenslotte zijn er instructies die geen gebruik kunnen maken van een genummerde verticale lijst en die de lezer niet of nauwelijks rechtstreeks instrueren. Sommige situaties moeten zo algemeen of zo veranderlijk zijn dat er geen stappen kunnen worden aangegeven.

Zie het hoofdstuk over lijsten voor de stijl en opmaak van deze mogelijkheden.

Aanvullende bespreking. Vaak is het niet voldoende om de lezers alleen maar te vertellen dat ze dit of dat moeten doen. Ze hebben behoefte aan extra verklarende informatie, zoals hoe het ding er voor en na de stap uit moet zien; waarom ze zich zorgen moeten maken over het doen van deze stap; welk mechanisch principe ten grondslag ligt aan wat ze aan het doen zijn; zelfs meer uitleg op microniveau van de stap – bespreking van de specifieke acties waaruit de stap bestaat.

Het probleem met aanvullende discussie is echter dat het de eigenlijke stap kan verbergen. Je wilt dat de eigenlijke stap – de specifieke acties die de lezer moet ondernemen – eruit springt. Je wilt niet dat het allemaal begraven wordt in een hoop woorden. Er zijn ten minste twee technieken om dit probleem te omzeilen: u kunt de instructie van het supplement in afzonderlijke alinea’s splitsen; of u kunt de instructie vet maken.

Het vet maken van de eigenlijke gebruikersstappen in instructies. Vetgedrukte tekst helpt om de eigenlijke actie te onderscheiden van de aanvullende informatie.

Schrijfstijl. De manier waarop u feitelijk instructies schrijft, zin voor zin, lijkt misschien in tegenspraak met wat u in eerdere schrijflessen hebt geleerd. Merk echter op hoe “echte” instructies worden geschreven – ze gebruiken veel gebiedende (commando, of direct-adres) schrijfstijl; ze gebruiken veel “u”. Dat is volkomen terecht. Je wilt je lezer onder ogen komen, haar of zijn volledige aandacht krijgen. Om die reden klinken zinnen in instructiestijl als deze: “Druk nu op de pauzeknop op het voorpaneel om het scherm tijdelijk te stoppen” en “U moet oppassen dat u niet …”

Een bijzonder probleem is het gebruik van de passieve stem in instructies. Om de een of andere vreemde reden klinken sommige instructies als volgt: “De Pauze-toets moet worden ingedrukt om de weergave tijdelijk te stoppen.” Niet alleen maken we ons zorgen over de geestelijke gezondheid van de Pause-knop, maar we vragen ons ook af wie dat ding moet indrukken (heb je het tegen mij?). Of neem dit voorbeeld: “De Timer knop is dan ingesteld op 3:00.” Nogmaals, als de persoon die deze instructies volgt, zou je dit kunnen missen; je zou kunnen denken dat het gewoon een verwijzing is naar een bestaande toestand, of je zou je kunnen afvragen: “Hebben ze het tegen mij?” Bijna net zo erg is het gebruik van de derde persoon: “De gebruiker moet dan op de pauzeknop drukken.” Het is weer de oude double-take: je kijkt de kamer rond en vraagt je af, “Wie ik?” (Voor meer details, zie passieve-stem probleem.)

Een van de typische problemen met schrijfstijl in instructies is dat mensen lijken te willen weglaten artikelen: “Druk op de pauzeknop op het voorpaneel om de weergave van informatie tijdelijk te stoppen” of “Aardbewoner, geef adres van dichtstbijzijnde pizzarestaurant.” Waarom doen we dit? Willen we stiekem allemaal robots zijn? Hoe dan ook, zorg ervoor dat u alle lidwoorden (a, an, de) en andere dergelijke woorden die we normaal zouden gebruiken in instructies.

Grafieken in instructies

Waarschijnlijk meer dan in enige andere vorm van schrijven (behalve misschien voor stripboeken), grafieken zijn van cruciaal belang voor instructies. Soms kunnen woorden de stap gewoon niet uitleggen. Illustraties zijn vaak van cruciaal belang voor het vermogen van lezers om te visualiseren wat ze moeten doen.

In een cursus technisch schrijven kan het nodig zijn om illustraties of andere soorten afbeeldingen op te nemen – wat er normaal gesproken ook in de instructies wordt gebruikt. Het probleem kan natuurlijk zijn dat je geen toegang hebt tot afbeeldingen die geschikt zijn voor je specifieke instructies, en dat je geen vertrouwen hebt in je artistieke capaciteiten. Er zijn manieren om deze problemen te overwinnen! Kijk eens naar de suggesties in graphics. In dat hoofdstuk zie je niet alleen suggesties voor het maken van afbeeldingen, maar ook eisen voor de opmaak ervan.

Opmaak in instructies

Koppen. Maak in uw instructies goed gebruik van koppen. Normaal gesproken wil je kopjes voor elke achtergrondsectie die je hebt, de sectie over apparatuur en benodigdheden, een algemene kop voor de eigenlijke instructiesectie, en subkoppen voor de afzonderlijke taken of fasen binnen die sectie. Kijk maar eens naar de voorbeelden aan het begin van dit hoofdstuk. Zie rubrieken voor algemene vereisten.

Lijsten. Ook in instructies wordt veel gebruik gemaakt van lijsten, met name genummerde verticale lijsten voor de feitelijke stap-voor-stap-uitleg. Eenvoudige verticale lijsten of lijsten met twee kolommen zijn meestal goed voor het hoofdstuk over uitrusting en benodigdheden. Lijsten in zinnen zijn goed wanneer je een overzicht geeft van de dingen die komen gaan. Zie lijsten voor veel voorkomende eisen.

Speciale mededelingen. In instructies moet u lezers waarschuwen voor mogelijkheden waarin zij hun apparatuur kunnen beschadigen, voorraden kunnen verspillen, de hele procedure kunnen laten mislukken, zichzelf of anderen kunnen verwonden – zelfs ernstig of met dodelijke afloop. Bedrijven zijn voor het gerecht gedaagd omdat deze speciale kennisgevingen ontbraken, slecht waren geschreven of niet op hun plaats waren. Zie speciale mededelingen voor een volledige bespreking van het juiste gebruik van deze speciale mededelingen en hun opmaak en plaatsing in instructies.

Indentatie van vermeldingen in de gebruiksaanwijzing. In het eerste voorbeeld is te zien hoe de mededeling inspringt ten opzichte van de tekst van de vorige stap. In het tweede voorbeeld staat de ernstige mededeling aan het begin, vóór een van de stappen.

Nummers, afkortingen en symbolen. In instructies worden ook veel getallen, afkortingen en symbolen gebruikt. Voor richtlijnen op deze gebieden.

Revision Checklist for Instructions

Wanneer u uw instructies herleest en reviseert, let dan op problemen zoals de volgende:

• Zorg ervoor dat u echte instructies geeft – uitleg over hoe iets gebouwd, bediend of gerepareerd moet worden.
• Schrijf een goede inleiding – geef daarin de precieze procedure aan die moet worden uitgelegd, geef aan wat het publiek nodig heeft, en geef een overzicht van de inhoud.
• Zorg ervoor dat u de verschillende soorten lijsten gebruikt waar dat nodig is. Gebruik in het bijzonder genummerde verticale lijsten voor opeenvolgende stappen.
• Gebruik koppen om alle hoofdsecties af te bakenen en subkopjes voor subsecties. (Denk eraan dat er geen kop “Inleiding” nodig is tussen de titel en de eerste alinea. Gebruik in deze opdracht geen kopjes op het eerste niveau; begin met het tweede niveau.)
• Gebruik waar nodig speciale vermeldingen.
• Zorg ervoor dat je de stijl en opmaak gebruikt voor alle kopjes, lijsten, speciale vermeldingen en afbeeldingen zoals die in deze hoofdstukken worden gepresenteerd. Als dat een probleem is, neem dan contact op met je instructeur.
• Gebruik afbeeldingen om belangrijke handelingen of objecten te illustreren.
• Geef extra uitleg over de stappen als dat nodig is.
• Ontdek een sectie met een lijst van apparatuur en benodigdheden, indien nodig.

Ik stel uw gedachten, reacties, kritiek over dit hoofdstuk zeer op prijs: uw reactie-David McMurrey.