Retorisch effectieve instructiehandleidingen maken

Instructiehandleidingen

Veel mensen associëren instructiehandleidingen met apparaten, computeraccessoires en producten die in elkaar gezet moeten worden (zoals meubels). Omdat we ze niet regelmatig gebruiken of ze alleen in bepaalde contexten verwachten, vergeten we gemakkelijk hoe belangrijk ze zijn. De kwaliteit van een goed ontworpen handleiding kan onopgemerkt blijven. Maar wanneer we gefrustreerd raken bij het in elkaar zetten van een boekenplank of speelgoed, of wanneer we moeten uitzoeken hoe we een bepaalde instelling van een apparaat moeten veranderen of activeren, wordt het belang van een goed ontworpen handleiding duidelijk.

Inzicht in de retorische situatie van instructiehandleidingen

Instructiehandleidingen worden, net als andere soorten teksten, gevormd door een retorische situatie. De keuzes die technisch schrijvers maken met betrekking tot inhoud en vorm hangen af van het doel van de handleiding, het beoogde publiek, en de context waarin de handleiding wordt gebruikt. Overweeg bij het schrijven van uw eigen instructiehandleiding de volgende ideeën en vragen met betrekking tot de retorische situatie.

Doel

In het algemeen is het doel van een instructiehandleiding om de gebruiker vertrouwd te maken met het product en/of om de gebruiker door een reeks stappen te leiden die leiden tot het voltooien van een taak. Elke handleiding zal echter ook een meer specifiek resultaat hebben. Als je weet wat dat specifieke resultaat is, kun je effectievere retorische beslissingen nemen over inhoud en ontwerp. Vraag jezelf af:

Wat zijn de specifieke beoogde uitkomst(en) van de instructies? (b.v. een cake bakken vanuit het niets, een airconditioner installeren, enz.)
Loopt de handleiding niet alleen als doel gebruikers te helpen het (de) belangrijkste gewenste resultaat(en) te bereiken, maar zijn er nog andere doelen die de handleiding dient? (b.v. advies geven bij het oplossen van problemen, gebruikers leren hoe ze aanvullende, eenvoudige taken kunnen uitvoeren die nodig zijn om het hoofddoel te bereiken)

Publiek

Het maken van een profiel van uw publiek (d.w.z. de primaire beoogde gebruiker van het document) is een integraal onderdeel van het maken van doordachte keuzes over reikwijdte, inhoud en ontwerp. Overweeg deze vragen over het publiek voordat u begint met schrijven:

Wat is de bekendheid of expertise van het publiek met betrekking tot het onderwerp van de handleiding?
Wat is het algemene comfortniveau van het publiek bij het leren van nieuwe vaardigheden met betrekking tot de software, apps, recepten, enzovoort? Hoe zal uw instructiehandleiding ingaan op de leerstijl, doelen en taakgerelateerde behoeften van het publiek?

Context

Denk aan context als de temporele, sociale, technologische en culturele situatie rond de creatie en het gebruik van de instructiehandleiding. De volgende vragen helpen u de context te bepalen:

Hoeveel tijd hebt u om deze handleiding te voltooien?
Zijn er tijdsbeperkingen voor de gebruiker?
Welke technologische beperkingen moet u in aanmerking nemen bij het maken van de handleiding? Denk aan uw vaardigheden met technologie en uw toegangsniveau.
Hoe krijgt uw publiek toegang tot de handleiding? (bv. publiek heeft online toegang tot handleiding via een bedrijfswebsite)
Welke aanvullende hulpmiddelen of materialen veronderstelt u dat het publiek al heeft? Hebben zij toegang tot de technologie of materialen die nodig zijn om de instructies te volgen? (Om bijvoorbeeld met succes een boekenplank te bouwen, heeft de gebruiker een hamer, een schroevendraaier en een open werkruimte nodig)
Vanuit welk cultureel perspectief schrijft u de gebruiksaanwijzing? Zal het publiek dezelfde culturele context delen? (bijv. een Duits recept dat vraagt om vanillesuiker, een ingrediënt dat niet gemakkelijk verkrijgbaar is in de Verenigde Staten, moet misschien worden aangepast voor Amerikaanse gebruikers)

Kennis van retorische situatie gebruiken om effectieve retorische keuzes te maken

Hoewel de meeste gebruiksaanwijzingen gebaseerd zijn op een aantal standaardconventies, moet elke gebruiksaanwijzing op maat worden gemaakt om een specifiek doel te bereiken voor een bepaald publiek binnen een bepaalde context. In het volgende gedeelte worden enkele gemeenschappelijke kenmerken van instructiehandleidingen besproken, terwijl ook rekening wordt gehouden met de retorische situatie en hoe deze kan vereisen dat van bepaalde conventies wordt afgeweken.

Scope

De retorische situatie helpt bij het bepalen van de hoeveelheid detail die in een instructiehandleiding moet worden opgenomen. De reikwijdte van een handleiding voor het in elkaar zetten van een bureau is bijvoorbeeld gemakkelijk te bepalen, omdat het maar één resultaat heeft: het in elkaar zetten van het bureau. Een handleiding voor een digitale spiegelreflexcamera (DSLR) kan echter zowel voor amateurs als voor meer ervaren cameragebruikers worden geschreven en moet instructies bevatten voor basistaken (bv. het installeren van de batterij en de geheugenkaart) en meer geavanceerde taken (bv,

Inhoud

Sommige standaardonderdelen van instructiehandleidingen omvatten een voorkant, een inleiding, een reeks stappen, een conclusie en een achterkant, hoewel sommige handleidingen niet al deze onderdelen gebruiken of ze op deze manier labelen. Uitgebreide voor- en achterkanten zijn bijvoorbeeld vaak te vinden in langere, meer complexe handleidingen. De meeste handleidingen bevatten echter een inleiding met informatie die nodig is om de stappen veilig en efficiënt uit te voeren. In de inleiding kan worden uitgelegd wie de taak moet uitvoeren (misschien moet de gebruiker een bepaalde vaardigheid beheersen), welke materialen nodig zijn, eventuele voorzorgsmaatregelen die de gebruiker moet nemen (veiligheidstips of andere waarschuwingen), en in sommige gevallen een schatting van hoe lang het proces zal duren (een veel voorkomend kenmerk van recepten). In sommige gevallen moet worden uitgelegd waarom de gebruiker de instructies moet volgen. In instructies voor het verversen van de olie in een auto kan bijvoorbeeld worden uitgelegd waarom de taak noodzakelijk is voor de goede werking van het voertuig.

Na dit inleidende materiaal volgt de opeenvolging van stap-voor-stap instructies. Zie de volgende paragraaf over “Taal” voor hoe u duidelijke en effectieve stappen kunt opstellen. Ten slotte kan een instructiehandleiding een “Gids voor probleemoplossing” of een sectie voor “Tips” bevatten om gebruikers te helpen veelvoorkomende problemen aan te pakken die ze kunnen tegenkomen tijdens het volgen van de instructies of na het voltooien van het proces.

Taal

De bovenstaande vragen over “Publiek” en “Context” kunnen u helpen bij het maken van effectieve taalkeuzes. In de volgende subparagrafen worden veel voorkomende taalkundige kenmerken van handleidingen toegelicht en worden tips gegeven om in dit genre duidelijk en beknopt te schrijven.

Imperatieve stemming

Instructies maken, net als opdrachten, vaak gebruik van de gebiedende wijs. Om op deze manier te schrijven, richt je je direct tot het publiek met behulp van de actieve stem en specifieke werkwoorden. Welke van de volgende zinnen geeft de duidelijkste instructie?

“Druk op de rode knop om het spel te beginnen”
“Als de rode knop wordt ingedrukt, begint het spel”
“De gebruiker moet op de knop drukken”

Hoewel een gebruiker waarschijnlijk elk van deze zinnen zou kunnen begrijpen, geeft de eerste de duidelijkste uitleg over welke actie door de gebruiker moet worden uitgevoerd. De tweede, passieve constructie geeft niet aan wie de knop moet indrukken. Het derde voorbeeld verwijst naar een vaag onderwerp, de “operator”, wat de gebruiker in verwarring kan brengen.

Woordkeuze

Bij het schrijven van instructies is een zorgvuldige afweging van woordkeuze van belang, omdat in sommige gevallen de veiligheid van de gebruiker in het geding is. Streef daarom naar duidelijkheid en beknoptheid. Om effectieve beslissingen over woordkeuze te nemen, moet u rekening houden met het deskundigheidsniveau en de culturele achtergrond van uw primaire publiek. U kunt het nodig vinden om

complexe termen te definiëren.
acroniemen te spellen wanneer ze voor het eerst worden geïntroduceerd (bijv, digital single-lens reflex camera, DSLR).
vermijd het gebruik van vergelijkingen, metaforen, jargon, of substituties die gebruikers in verwarring kunnen brengen.
gebruik klare taal, want in sommige gevallen kunnen ernstige juridische gevolgen ontstaan wanneer een reeks instructies onduidelijk is. Voor meer over duidelijke taal, zie http://www.plainlanguage.gov/index.cfm
vertalingen van de instructies in meerdere talen opnemen.
beknopte en informatieve koppen en onderkoppen gebruiken

Consistentie en parallellisme

Parallelle structuur, of parallellisme, betekent dat dezelfde grammaticale structuur wordt gebruikt om informatie of ideeën te presenteren. Parallellisme wordt vaak gebruikt om de leesbaarheid te verbeteren en consistentie te creëren.

Deze numerieke lijst van instructies bevat een stap die de parallelle structuur doorbreekt. Welke van deze stappen lijkt anders dan de andere?

Verwijder de schroef om het batterijcompartiment te openen.
Plaats de batterijen door de afbeelding op het batterijcompartiment te volgen.
Nu kunt u het compartiment sluiten, en schroef het dicht.

Stap drie breekt de parallelle structuur van de lijst omdat het niet begint met een directief werkwoord.

Maken de volgende kopjes gebruik van parallelle structuur? Waarom wel of niet?

“Batterijen installeren”
“Apparaat uitschakelen/aanzetten”
“Hoe laadt u uw apparaat op”

Ontwerp

Documentontwerp verwijst naar de manier waarop informatie is georganiseerd en gepresenteerd. Omdat afbeeldingen minder tijd kosten om te verwerken, zullen gebruikers de kwaliteit van de vormgeving eerder opmerken dan de kwaliteit van de inhoud, en daar ook op reageren. Zelfs als u ervoor kiest geen afbeeldingen of grafieken op te nemen, moet u rekening houden met de vormgeving. Minimaal betekent dit keuzes maken over lay-out, volgorde van informatie, lettergrootte, lettertype, koppen, kleur, en witruimte. Ontwerpelementen moeten de gebruiker vlot door de handleiding leiden. Dit betekent dat het document scanbaar moet zijn; een scanbaar document stelt gebruikers in staat door de inhoud te navigeren om specifieke informatie op te zoeken. Zoals bij elk document moet bij beslissingen over het ontwerp rekening worden gehouden met het publiek, het doel en het algemene gebruiksgemak.

Consistentie/Herhaling

Het gebruik van een ontwerpelement op een uniforme manier in het hele document leidt gebruikers door hen een gevoel te geven van wat ze kunnen verwachten (bijv. hetzelfde lettertype en dezelfde grootte voor alle koppen; dezelfde lay-out van pagina tot pagina).

Contrast

Het gebruik van een ontwerpelement om specifieke informatie of kenmerken van de handleiding te benadrukken (bijv. een woord met een hoofdletter schrijven om de nadruk te leggen; een kader of rand rond een item plaatsen; kleuren veranderen om de nadruk te leggen). Contrast is vooral effectief wanneer een document over de hele linie consistent is. Als er een gebrek aan consistentie is, is het moeilijker om contrast te creëren.

Uitlijning

Hiërarchie en structuur creëren door items op een pagina horizontaal en/of verticaal uit te lijnen, en dit kan worden gebruikt om balans, contrast of consistentie te helpen bereiken. Dit document maakt bijvoorbeeld gebruik van verticale uitlijning om een hiërarchie te creëren tussen de naam van een ontwerpelement, die links is uitgelijnd, en de beschrijving ervan, die is ingesprongen.

Balans

Het gelijkmatig verdelen van items over een bepaalde ruimte. Om dit te bereiken moet rekening worden gehouden met het gewicht van elk item, d.w.z. de neiging van het oog om naar een item toe te trekken. Aangezien een afbeelding bijvoorbeeld zwaarder weegt dan tekst, moet bij beslissingen over de plaatsing van afbeeldingen worden overwogen hoe het gewicht ervan kan worden afgewogen tegen andere items om visuele verwarring te voorkomen.

White Space

Het gebruik van witruimte om een professioneel, evenwichtig document te maken. In plaats van de kleur van de ruimte aan te geven, verwijst dit ontwerpelement naar een afwezigheid van afbeeldingen en tekst. Witruimte helpt bij het onderscheiden van afzonderlijke items en groepen items (d.w.z. secties van de handleiding) en maakt het scannen van documenten gemakkelijker.

Grouping/Proximity

Het plaatsen van gerelateerde afbeeldingen of inhoud dicht bij elkaar. Bijvoorbeeld het groeperen van afbeeldingen van alle materialen die nodig zijn om een bepaalde taak uit te voeren.

Kleur

Kleuren selecteren om contrast en nadruk te creëren, om lezers door de ruimte te leiden, en om een visueel aantrekkelijk document te ontwerpen. U moet rekening houden met het document als geheel om een consistent kleurenschema te maken. Als u bijvoorbeeld blauw in uw document wilt gebruiken, moet u ervoor zorgen dat het consistent wordt gebruikt en complementair is met andere kleuren in het document. Dit is met name van belang bij het integreren van kleurenafbeeldingen en/of -afbeeldingen.

Afbeeldingen

Het kiezen van geschikte afbeeldingen voor de gegeven context en het doel van de handleiding. U moet overwegen of de afbeeldingen bedoeld zijn om op zichzelf te staan of om de schriftelijke instructies aan te vullen. Overweeg soorten afbeeldingen, zoals tekeningen, foto’s en grafische illustraties en of er extra opschriften of annotaties nodig zijn om specifieke delen van de afbeelding te benadrukken. Afbeeldingen moeten zo worden gekozen dat ze andere ontwerpelementen in de handleiding aanvullen.

Conclusie

Een goede handleiding begint met een zorgvuldige overweging van de retorische situatie – doel, publiek en context. Deze informatie is de sleutel voor het maken van zowel passende als effectieve keuzes over inhoud, taal en ontwerp. In een ideale tijdslijn hebben technisch schrijvers de mogelijkheid om bruikbaarheidstests uit te voeren, die bedoeld zijn om te beoordelen hoe goed een document aan zijn doel beantwoordt. Zodra uw instructiehandleiding is getest, neemt u de ontvangen feedback op om het ontwerp en de inhoud ervan af te ronden.

Oefening 1 – Maak uzelf vertrouwd met instructiehandleidingen

De volgende website bevat verschillende voorbeelden van open-source instructiehandleidingen. Volg deze link, blader door de lijst, en kies één handleiding om grondig te bekijken. Blader door de handleiding om vertrouwd te raken met de inhoud en het ontwerp. Behandel vervolgens in een memo aan je docent of klasgenoten het volgende.

Identificeer de retorische situatie

Wie is het publiek? Hoe weet je wie het publiek is? Wat kunt u veronderstellen over het publiek op basis van de inhoud en de ontwerpkeuzes in de handleiding?
Wat is het doel van het document? Hoe weet u dat dit het primaire doel is (d.w.z., welke inhoud en ontwerpkeuzes geven het doel aan)?
Welke context vormt de basis voor de geschreven inhoud en het ontwerp van deze handleiding?

Onderzoek compositiekeuzes

Beschrijf de algemene omvang en organisatie van de handleiding. Hoe gedetailleerd is het handboek? Wat wordt er in behandeld? Hoe is de informatie georganiseerd?
Worden alle “standaard kenmerken” van de inhoud in deze handleiding behandeld? Waarom wel of waarom niet? Zijn er extra functies? Welke zijn dat en wat is hun doel?
Locate and describe examples of effective language choice. Leg uit waarom u ze effectief vindt.
Locate and describe examples of effective design. Leg uit waarom u ze effectief vindt.
Als u de auteur van deze handleiding was, wat zou u anders hebben gedaan en waarom?

Oefening 2 – Het plannen van een handleiding

Stel u voor dat u een handleiding schrijft voor een proces of product waarmee u bekend bent en ga in op de volgende aanwijzingen.

Bepaal de retorische situatie

Selecteer een publiek en maak een profielverklaring van 2 tot 3 zinnen

.profielverklaring van 3 zinnen

identificeer het specifieke doel van uw instructiehandleiding
Lijst alle belangrijke contextuele informatie die u moet overwegen

Maak een plan

Lijst de secties die u zult opnemen
Lijst de belangrijkste factoren waarmee u rekening moet houden voor uw publiek en doel (bijv.g., taalgebruik, integratie van afbeeldingen, tekstgrootte, enz.)
Maak een schets die de lay-out van het document laat zien, de plaats van geschreven gedeelten aangeeft, en laat zien waar afbeeldingen zouden worden opgenomen.