1 Schrijf instructies Wat zijn instructies? Instructies zijn aanwijzingen ...

Schrijf instructies
Wat zijn instructies?
Instructies zijn aanwijzingen. Ze vertellen de gebruiker hoe een technische procedure
uitgevoerd moet worden: hoe men bijvoorbeeld een beeldscherm moet aansluiten, hoe men in
UNIX moet inloggen; of hoe een pomp gereinigd moet worden.
Een handleiding is een leidraad of een verzameling van instructies.
Zijn instructies en procedures hetzelfde?
Instructies zijn gebaseerd op procedures, maar zijn meestal erg verschillend geschreven.
Een ‘procedure’ is een reeks van opeenvolgende stappen om een vooropgesteld doel te
bereiken. In een wetenschappelijke uiteenzetting of een technisch rapport bijvoorbeeld,
vertelt het proceduregedeelte met voldoende nauwkeurigheid wat de onderzoeker deed zodat
een andere getrainde werknemer de stappen kan herhalen en vergelijkbare resultaten
bekomen.
Instructies daarentegen, zijn niet geschreven voor getraind personeel, maar voor beginners.
Het inhoudelijke deel van de instructies is gelijk aan de procedure – de reeks opeenvolgende
stappen om een doel te bereiken. Maar de wijze waarop deze procedure is geschreven
verandert wanneer tot het doelpubliek beginners behoren. Het gebruik van details, pagina
indeling, manier van aanspreken, en woordenschat zal veranderen.
Drie manieren waarin instructies verschillen van procedures
Visueel onderscheidende stappen
Beginners die van de taak naar de aanwijzingen en terug springen hebben er vaak nood aan
elke instructie op zich te zien. Dit betekent dikwijls een genummerde lijst van stappen, of op
zijn minst zichtbaar te onderscheiden delen van gegroepeerde stappen. Mensen die instructies
volgen zullen problemen hebben wanneer ze geconfronteerd worden met een ‘muur van
letters’ (Figuur 1a). Gebruik maken van witte ruimtes om elke stap te scheiden zal hen helpen
om elke fase van de instructies bij te houden (Figuur 1b). Dit in tegenstelling tot een
procedurebeschrijving in een rapport, dat geschreven mag zijn in doorlopende, vertellende
paragrafen.
Ondersteunende tips
De schrijver van instructies moet vaak hints en tips bijvoegen om beginners in de juiste
richting te sturen. Een kleurverandering bijvoorbeeld, die beginners kan helpen verzekeren
dat ze op het juiste spoor zitten, is geen noodzakelijke stap in de procedure, maar zeer nuttige
informatie voor beginners (Figuur 2b).
1

Directe aanspreking
Bij instructies spreekt de schrijver de lezer direct aan, zeggend “Doe dit” in plaats van “Dit
gebeurt”. Deze verandering, heel helpend voor beginners die de aanwijzingen volgen, is
overbodig in een procedure.
Om kraken in beton te herstellen, kotter in de scheur, zodat het onder het oppervlak verbreedt.
Maak dan het betonoppervlak goed schoon met een staalborstel. Meng daarna een
hoeveelheid mortel volgens de aanwijzingen op de verpakking. Meng het epoxy beton met de
mortel volgens de aanwijzingen op de epoxy verpakking. Breng het mengsel in de scheur,
gebruikmakend van de truweel.
(a)
1. Kotter in de scheur, zodat het onder het oppervlak verbreedt.
2. Maak het betonoppervlak goed schoon met een staalborstel.
3. Meng een hoeveelheid mortel volgens de aanwijzingen op de verpakking. Meng het
epoxy beton met de mortel volgens de aanwijzingen op de epoxy verpakking.
4. Breng het mengsel in de scheur, gebruikmakend van de truweel.
Figuur 1: Geef elke stap een zichtbaar verschillend uiterlijk
(a) De stappen lopen door elkaar; (b) Herschikte versie
Goede instructies zijn weldoordacht
(b)
Instructies worden meestal geschreven dóór professionals vóór leken. Wanneer experts voor
beginners schrijven, moeten ze niet alleen methodisch maar ook doordacht zijn. Welke
informatie zal de beginner nodig hebben? In welke volgorde? Welke woorden hebben een
verklaring nodig? Welke afbeeldingen zullen helpen?
Een vaakvoorkomend probleem voor de expert is om over het hoofd van de beginner te
schrijven, door belangrijke details in te korten of weg te laten.
2

Informatie in een procedurebeschrijving
Deze titratie is uitgevoerd gebruikmakend van fenolftaleïne…
Gelijkwaardige informatie in instructies
(a)
1. Gebruik fenolftaleïne voor de titratie. Je weet of je het eindpunt van de titratie bereikt
hebt wanneer de oplossing verandert van roze naar kleurloos.
Figuur 2:
(a) Een procedurebeschrijving is meestal een doorlopend verslag.
(b) Instructies delen stappen op in onderscheidbare delen en voegen tips bij zoals
kleurverandering.
(b)
De ervaren persoon vergeet vaak hoe het is voor een beginner, en eindigt in het overschatten
van de achtergrond en de ervaring van de lezer.
Bij instructies, moet de schrijver inbeelden een beginner te zijn. Wat moet deze persoon
weten? Wat is de beste volgorde om deze informatie kenbaar te maken?
Richtlijnen om instructies te schrijven
’Zorg ervoor dat de lezer gericht is op de taak’ Verzeil niet in details zonder eerst het
kaderwerk uit te tekenen voor de gebruiker. Dit zijn enkele vragen om rekening mee te
houden bij het richten van de lezer op de taak:
− Wat is het werk?
− Waarom is het nodig?
− Welk gereedschap moet bij de hand zijn?
− Welke object, proces, of doel moet de gebruiker verwachten?
Deze vragen beantwoorden kan een beknopte oriëntatie opleveren vóór de stappen, en voor
langere werken zoals een handleiding, een inleiding tot elk deel van het document.
Duid verwittigingen en waarschuwingen typografisch aan
Duid verwittigingen en waarschuwingen aan gebruikmakend van onderlijning, vakjes, vet
lettertype, of een andere opvallende combinatie van een donkerder, groter lettertype en
onderlijning.
− Gebruik ‘verwittiging’ wanneer je de lezer wil wijzen op mogelijke schade aan het
gereedschap.
3

− Gebruik ‘waarschuwing’ als je de lezer wil wijzen op mogelijke gevaren voor zichzelf.
− Plaats verwittigingen of waarschuwingen VOOR, niet in het midden van of na
aanwijzingen voor gevaarlijke stappen.
− Gebruik specifieke bewoording, geen vage bevelen. In plaats van enkel “opgepast” te
zeggen, zeg HOE moet worden opgepast (Figuur 3).
− Verdeel verwittigingen of waarschuwingen die aan het einde van een pagina vallen
niet. De verwittiging of waarschuwing moet als een alleenstaande, opvallend
zichtbare eenheid staan.
WAARSCHUWING: WEES
VOORZICHTIG BIJ HET GEBRUIK VAN
DE VERLENGSTANG
(a)
Figuur 3: Gebruik specifieke bewoordingen in waarschuwingen:
(a) vage bewoording; (b) specifieke bewoording
Orden de instructies om de volgorde van uitvoering te weerspiegelen
WAARSCHUWING: De verlengstang staat
onder spanning en zal plots losschieten als hij
losgelaten wordt. Om letsels te vermijden,
houd de vingers uit de weg van de
verlengstang wanneer je het demonteert.
Als de lezers de taken in een welbepaalde volgorde moeten uitvoeren, zorg er dan voor dat de
instructies deze volgorde weergeven (Figuur 4). Stel gegevens stapsgewijs voor, met één
instructie per stap waar mogelijk.
Verkies een actieve zinsconstructie
Vermijd: Het scherm wordt 5 duim verhoogd.
Gebruik: Verhoog het scherm 5 duim.
Verander niet van persoon in dezelfde stap
Vermijd: Druk eerst op de handel en daarna verhoogd de gebruiker het scherm.
Gebruik: Druk op de handel en verhoog daarna het scherm.
(b)
4

Een videorecorder gebruiken
Schakel de video aan. Voordat je dat doet,
schakel de zender op Zender 3. Daarvoor
moet de televisie uiteraard aangeschakeld
zijn.
(a)
Een videorecorder gebruiken
1. Schakel de televisie aan.
2. Zet de zenderkiezer op Zender 3.
3. Schakel de video aan.
Figuur 4: Orden de instructies zodat ze de volgorde van de uitvoering weerspiegelen.
(a) slecht geordend; (b) herschikte versie
Verkies positieve opdrachten boven negatieve
Negatieve opdrachten kunnen makkelijk verkeerd gelezen worden. Als het negatieve aspect
noodzakelijk is, plaats het dan NA een positieve uitdrukking van de stap en benadruk het
negatieve met onderlijning of vet lettertype.
Vermijd: Gevaarlijke afvalproducten mogen niet in de gootsteen gegoten worden. In plaats
daarvan moeten ze verzameld worden in een afvalcontainer.
Gebruik: Verzamel alle gevaarlijke afvalproducten in een container. Giet ze NOOIT in de
gootsteen.
Vermijd vaktaal
Als je voor beginners schrijft, heb je onmiddellijk te maken met het probleem van vaktaal –
gespecialiseerd taalgebruik van een bedrijfstak of beroep.
Wanneer mogelijk, verkies een algemene term boven een gespecialiseerde.
Vermijd: Start de computer op.
Gebruik: Zet de computer aan.
(b)
5

Imperatieven gebruiken
Imperatieven zijn werkwoorden die bevelen geven: “ZET de machine AAN.” “ROER de
oplossing gedurende vijf minuten.” Imperatieven zijn zinvol in instructies; ze zijn een manier
om direct tot de lezer te praten zonder een berg van passieve zinsconstructies. Als je
imperatieven gebruikt, moet je voorzichtig zijn op twee grammatische punten.
1. Imperatieven zijn een “je”-vorm (tweede persoon). Verander niet naar de
“hij/zij/een”-vorm (derde persoon) in dezelfde zin.
Vermijd:
VEILIGHEIDSVOORSCHRIFTEN: Draag een veiligheidsbril gedurende alle
chemische experimenten. Men moet zich het gebruik en de plaats van
veiligheidsmateriaal eigen maken. Rook of eet niet in het laboratorium.
probleem: Er is een verandering van imperatieven “Draag” en “Rook niet” naar de
derde persoon “Men moet zich eigen maken…”
Gebruik:
VEILIGHEIDSVOORSCHRIFTEN: Draag een veiligheidsbril tijdens alle chemische
experimenten. Ken de plaats en het gebruik van veiligheidsmaterialen. Rook of eet
niet in het laboratorium.
Oplossing: Gebruik van begin tot einde imperatieven.
2. Imperatieven zijn actieve constructies. Schakel niet over van een actieve constructie
van de opdracht naar een passieve constructie in dezelfde zin.
Vermijd: Druk de handel naar beneden en daarna wordt het scherm verhoogd.
Gebruik: Druk de handel naar beneden en verhoog het scherm.
Afbeeldingen gebruiken bij instructies
Afbeeldingen zijn nuttig bij technische instructies; ze kunnen een groot schrijfgedeelte
vervangen, en beter werk verrichten. Als je afbeeldingen gebruikt, let erop de volgende
stappen te herinneren:
1. Nummer figuren; vermeld het nummer bij de eerste vermelding in de tekst. Gebruik
opeenvolgende Arabische tekens. Sla geen nummers over of nummer niet
onopeenvolgend.
2. Gebruik onderschriften, kentekens en pijltjes om figuren aan te duiden en te verklaren.
Leg alle afkortingen, acroniemen, of speciale symbolen die in de tekeningen gebruikt
worden uit.
3. Laat de titels overeenstemmen met de tekst. Zorg ervoor dat je afbeeldingen ook
werkelijk weergeven wat je wil duidelijk maken.
6

Testsessies doen
Nadat je de instructies geschreven hebt, moet je ze testen. Vind een persoon of een groep
mensen met een achtergrond die gelijkaardig is aan die van je doelgroep. Geef hen wat je
geschreven hebt, en bekijk hen terwijl ze je instructies proberen te volgen.
Herschrijf je instructies in het licht van hun moeilijkheden. Beschuldig de lezer niet als hij
een fout maakt. Vind uit hoe de instructie verbeterd kunnen worden, en pas daarna de tekst
aan zodat het duidelijker is.
Verwacht de tekst op zijn minst vier of vijf keer te verbeteren. Terwijl je het herschrijft en
aanpast, neem de volgende richtlijnen in Figuur 5 in achting.
Richtlijnen voor het herschrijven van instructies
1. Ordende je de instructies zodat ze de volgorde van gebruik weergeven?
2. Heb je geprobeerd titels, koppen en subkoppen te gebruiken om de lezer te leiden?
3. Gaf je elke stap een onderscheidend, zichtbaar uiterlijk?
4. Keek je ingekorte of weggelaten details na?
5. Sprak je de lezer direct aan?
6. Definieerde je ongewone woorden?
7. Keek je veranderingen in persoon na? Veranderingen in manier van aanspreken?
8. Keek je na of alle figuren genummerd en vermeld werden in de tekst bij de eerste
vermelding?
9. Gebruikte je titels om aan te duiden en te verklaren?
10. Gebruikte je klare taal in waarschuwingen en verwittigingen?
Figuur 5: Tien stappen bij het herschrijven van instructies
Samenvatting
Instructies zijn meestal geschreven door diegenen die weten voor diegenen die niet weten.
Het is gemakkelijk om boven de hoofde van je lezers te schrijven. Om dit te vermijden, stel
je voor wat ze moeten weten en hoe je deze informatie kan verschaffen.
7