Een van de meest voorkomende en belangrijkste toepassingen van technisch schrijven is het geven van instructies, de stap-voor-stap uitleg over hoe je iets in elkaar zet, bedient, repareert of er routine-onderhoud aan pleegt. Hoewel ze intuïtief en eenvoudig te schrijven lijken, behoren instructies tot de slechtst geschreven documenten die je kunt vinden. De meesten van ons hebben waarschijnlijk veel woedende ervaringen gehad met slecht geschreven instructies. Dit hoofdstuk zal u laten zien wat professionals beschouwen als de beste technieken om instructies te geven.
Een effectieve set instructies vereist het volgende:
- Clear, precise, and simple writing
- A thorough understanding of the procedure in all its technical detail
- The ability to put yourself in the place of the reader, the person trying to use your instructions
- The ability to visualize the procedure in detail and to capture that awareness on paper
- Willingness to test your instructions on the kind of person you wrote them for.
Aan het begin van een project om een reeks instructies te schrijven, is het belangrijk om de structuur of de kenmerken te bepalen van de specifieke procedure waarover u gaat schrijven. Hier volgen enkele stappen:
Doe een zorgvuldige publieks- en taakanalyse
Vroeg in het proces, definieer het publiek en de situatie van uw instructies. Vergeet niet dat het definiëren van een publiek betekent dat u het niveau van bekendheid van uw lezers met het onderwerp vaststelt.
Bepaal het aantal taken
Hoeveel taken zijn er in de procedure waarover u 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 handelingen binnen de procedure: bijvoorbeeld, het instellen van de klok op een magnetron is één 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 complexere procedure, zoals het gebruik van een magnetron, bevat verschillende semi-onafhankelijke taken: het instellen van de klok; het instellen van het vermogensniveau; het gebruik van de timer; het schoonmaken en onderhouden van de magnetron, onder andere.
Sommige instructies hebben slechts één enkele taak, maar hebben vele stappen binnen die ene taak. Stel je bijvoorbeeld een set instructies voor het in elkaar zetten van een schommelset 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 weer een andere zijn.
3. Bepaal de beste benadering voor de stapsgewijze bespreking
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 wel taakgerichtheid genoemd) van instructies over het gebruik van een telefoonbeantwoordingsdienst, zou u 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.
Aan de andere kant, in een gereedschapsbenadering van instructies voor het gebruik van een fotokopieerapparaat, zouden er waarschijnlijk secties zijn over hoe specifieke functies te gebruiken:
- Kopieerknop
- Kopieknop
- Kopieknop vergroten/verkleinen
- Kopieknop
- Kopieerformaat knop, enzovoort
Als je een set instructies volgens dit plan zou ontwerpen, zou je 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 waarop de tools/feature benadering de voorkeur verdient.
4. Ontwerp groeperingen van taken
Het opsommen van taken is misschien niet alles wat u hoeft te 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 taakgroepen in instructies:
- Uitpakken en setup taken
- Installeren en aanpassen van taken
- Basis bedieningstaken
- Routinematige onderhoudstaken
- Troubleshooting taken.
Gemeenschappelijke secties in instructies
Hieronder volgt een overzicht van de secties die u vaak in instructies zult aantreffen. Ga er niet van uit dat elk van deze onderdelen in de instructies moet staan die u schrijft, noch dat ze in de hier gepresenteerde volgorde moeten staan, noch dat dit de enige onderdelen zijn die in een serie instructies kunnen voorkomen.
Voor alternatieve formaten, zie de voorbeeldinstructies.
Inleiding: plan de inleiding van uw instructies zorgvuldig. Deze kan een van de volgende elementen bevatten (maar niet noodzakelijkerwijs in deze volgorde):
- Geef aan welke specifieke taken of procedure moeten worden uitgelegd en wat de reikwijdte is (wat wel en 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.
Algemene waarschuwingen, voorzichtigheid, gevaren: instructies moeten de lezer vaak waarschuwen voor de mogelijkheid dat hij zijn apparatuur ruïneert, de procedure verknoeit, en zichzelf bezeert. Ook moeten instructies vaak belangrijke punten of uitzonderingen benadrukken. Voor deze situaties gebruikt u speciale aanwijzingen – noot, waarschuwing, voorzichtigheid en gevaar. Merk op hoe deze speciale instructies worden gebruikt in de voorbeeldinstructies hierboven.
Technische achtergrond of theorie: aan het begin van bepaalde soorten instructies (na de inleiding) kan een bespreking van de achtergrond met betrekking tot de procedure nodig zijn. Voor bepaalde instructies is deze achtergrond van cruciaal belang – anders hebben de stappen in de procedure geen zin. U hebt bijvoorbeeld wellicht ervaring met die software-applets waarin u uw eigen kleuren bepaalt door met 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 specificaties moet toevoegen aan sommige of alle items – bijvoorbeeld merknamen, maten, hoeveelheden, types, modelnummers, enzovoort.
Discussie van de stappen: wanneer u aan het eigenlijke schrijven van de stappen toekomt, zijn er verschillende dingen die u in gedachten moet houden: (1) de structuur en het formaat van die stappen, (2) aanvullende informatie die nodig kan zijn, en (3) het gezichtspunt en de algemene schrijfstijl.
Structuur en formaat: normaal gesproken stellen we ons een reeks instructies voor als zijnde geformatteerd 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 vervangt, is het aftappen van de olie een stap die moet komen voor het inbrengen 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 kunnen worden gebruikt in gevallen waarin individuele stappen binnen een procedure vrij complex zijn op hun eigen en moeten worden opgesplitst in sub-stappen. In dit geval, je verder inspringt en de volgorde van de sub-stappen als a, b, c, enzovoort.
- “Stap-loze” instructies. kan worden gebruikt wanneer je echt niet kunt gebruiken genummerde verticale lijst of bieden rechttoe rechtaan instructie-stijl richting van de lezer. Sommige situaties moeten zo veralgemeend of zo veranderlijk zijn dat stappen niet kunnen worden aangegeven.
Aanvullende bespreking: vaak is het niet voldoende om de lezers alleen maar te vertellen dat ze dit of dat moeten doen. Ze hebben aanvullende verklarende informatie nodig, zoals hoe het ding er voor en na de stap uit moet zien; waarom ze deze stap zouden moeten doen; welk mechanisch principe ten grondslag ligt aan wat ze doen; zelfs meer uitleg op microniveau van de stap – bespreking van de specifieke acties waaruit de stap bestaat.
Het probleem met aanvullende bespreking is echter dat het de eigenlijke stap kan verbergen. Je wilt dat de eigenlijke stap – de specifieke acties die de lezer moet ondernemen – opvalt. Je wilt niet dat het allemaal begraven wordt in een hoop woorden. Er zijn ten minste twee technieken om dit probleem te omzeilen: je kunt de instructie van het supplement in aparte alinea’s splitsen; of je kunt de instructie vet maken.
Schrijfstijl
Het vet maken van de belangrijkste gebruikersstappen kan een heel nuttige manier zijn om duidelijk aan te geven wat de lezer moet doen. Vaak is het opdrachtwerkwoord vetgedrukt; soms wordt het belangrijkste onderdeel dat wordt besproken vetgedrukt.
Het gebruik van de passieve stem in instructies kan problematisch zijn. Om een of andere vreemde reden klinken sommige instructies als volgt: “De pauzeknop moet worden ingedrukt om het scherm tijdelijk te stoppen.” Niet alleen maken we ons zorgen over de geestelijke gezondheid van de pauzeknop, maar we vragen ons ook af wie dat ding moet indrukken (ninja’s?). Het zou nuttiger zijn om aan te geven wanneer de lezer “op de pauzeknop moet drukken”. Denk eens aan dit voorbeeld: “De Timer knop is dan ingesteld op 3:00.” Nogmaals, men zou kunnen vragen, “is ingesteld door wie? Ninja’s?” De persoon die deze instructies volgt zou kunnen denken dat het gewoon een verwijzing is naar een bestaande toestand, of ze zou zich kunnen afvragen: “Hebben ze het tegen mij?” Het gebruik van de derde persoon kan ook leiden tot ongemakkelijkheid: “De gebruiker moet dan op de pauzeknop drukken.” Instructies moeten meestal worden geschreven met behulp van commando werkwoordsvormen en met behulp van “u” om volkomen duidelijk te maken wat de lezer moet doen.
Illustrating Your Instructions
Misschien meer dan in enige andere vorm van technisch schrijven, zijn afbeeldingen van cruciaal belang voor instructies. Soms kunnen woorden de stap gewoon niet uitleggen. Illustraties zijn vaak van cruciaal belang voor het vermogen van de lezers om te visualiseren wat ze verondersteld worden te doen. Zorg ervoor dat de afbeeldingen het beeld weergeven vanuit het perspectief van de lezer.
Opmaak van uw instructies
Omdat mensen zelden instructies willen lezen, maar dat vaak wel moeten, formatteer uw instructies voor onwillige leesbaarheid. Probeer ervoor te zorgen dat uw lezer ze wil lezen, of in ieder geval niet tegen het idee opziet ze te raadplegen. Een zeer leesbare opmaak zal lezers die een deel van de instructies zelf hebben uitgevogeld, in staat stellen naar het deel te springen waar ze vastlopen. Gebruik wat je hebt geleerd over koppen, lijsten, afbeeldingen en passieve ruimte om effectieve en leesbare instructies te maken:
Koppen: normaal gesproken wil je koppen 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.
Lijsten: op vergelijkbare wijze wordt in instructies veel gebruik gemaakt van lijsten, met name genummerde verticale lijsten voor de eigenlijke stap-voor-stapuitleg. Eenvoudige verticale lijsten of lijsten met twee kolommen zijn meestal goed voor de sectie apparatuur en benodigdheden. Lijsten in zinnen zijn goed wanneer u een overzicht geeft van de dingen die komen gaan.
Speciale mededelingen: het kan zijn dat u de lezers moet waarschuwen voor mogelijkheden waarbij zij hun apparatuur kunnen beschadigen, voorraden kunnen verspillen, de hele procedure kunnen laten mislukken, zichzelf of anderen kunnen verwonden – zelfs ernstig of dodelijk. Bedrijven zijn voor het gerecht gedaagd wegens het ontbreken van deze speciale kennisgevingen, wegens slecht geschreven speciale kennisgevingen, of wegens speciale kennisgevingen die 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.
Wanneer u uw instructies herleest en herziet, controleer dan of ze het volgende doen:
- Beschrijf duidelijk de exacte procedure die moet worden uitgelegd
- Bied een overzicht van de inhoud
- Geef aan wat het publiek nodig heeft
- Gebruik waar nodig verschillende soorten lijsten; Gebruik in het bijzonder genummerde lijsten voor opeenvolgende stappen
- Gebruik koppen en subkoppen om de hoofdsecties en subsecties in een logische, samenhangende volgorde te verdelen
- Gebruik waar nodig speciale mededelingen
- Gebruik afbeeldingen om belangrijke handelingen en voorwerpen te illustreren
- Gebruik waar nodig extra uitleg over de stappen
- Maak indien nodig een sectie met een lijst van apparatuur en benodigdheden.