Handleidingen: Een procedure en richtlijnen
Auteur: ir. P.B. Flier
Gepubliceerd in: Handboek Technisch Documenteren, Ten Hagen & Stam, Den Haag, 1997.
Handleidingen vormen niet zelden een bron van ergernis. Eigenlijk is dat raar omdat het gebruiken van een handleiding als zijnde een ‘probleemoplosser’ een feest zou moeten zijn. De praktijk leert helaas dat handleidingen eerder problemen veroorzaken dan oplossen. Dat komt doordat veel makers van handleidingen volledigheid nastreven terwijl een gebruiker vooral effectief wil zijn.
Inleiding
Het maken van effectieve documentatie draait om twee dingen: bepalen wat er nodig is en wat er mogelijk is. Wanneer de mogelijkheden beperkt zijn is het essentieel deze te onderkennen en daar binnen te blijven. Als de mogelijkheden onbeperkt zijn, bestaat vooral het gevaar dat je meer doet dan nodig is; een manco waar onder meer veel handleidingen aan leiden.
Een goede handleiding is precies de doorsnede van wat de gebruiker nodig heeft en wat technisch mogelijk is. Om dit te bereiken is een procedure ontwikkeld die uitkomst kan bieden bij het bepalen wat mogelijk en nodig is voor een handleiding. Aan de hand van deze procedure kan een handleiding stap voor stap worden opgezet. In de toelichting van de verschillende stappen komt tevens een aantal praktische richtlijnen naar voren voor het maken van een handleiding, die aansluitend op een rij zijn gezet.
Procedure voor het maken van een handleiding
1. Definieer de doelstelling van de handleiding
Een effectieve handleiding ondersteunt de uitvoering van bepaalde taken door antwoord te geven op vragen van degenen die de taken willen uitvoeren.
In de doelstelling van een handleiding dient omschreven te worden welke taken de handleiding zal ondersteunen en wie deze taken zal uitvoeren. Voorop staat dat de doelstelling haalbaar moet zijn. In eerste instantie zal de doelstelling globaal worden omschreven; hij zal specifieker worden naarmate meer inzicht wordt verkregen in de gebruiker.
2 Maak kennis met de gebruikers van de handleiding
Bij het maken een handleiding is het essentieel om bekend te raken met de mensen die de handleiding zullen gebruiken. Een handleiding dient ter ondersteuning van bepaalde taken en gaat er dus vanuit dat de gebruiker van de handleiding iets moet leren. Uitgangspunt voor een handleiding moet dan ook zijn om dit leerproces zo effectief mogelijk te laten verlopen. Hierbij zijn twee vragen van belang. Welke relevante kennis heeft de gebruiker al en hoe kan de gebruiker zich nieuwe kennis eigen maken?
Welke kennis de gebruiker al heeft is essentieel om vast te stellen welke informatie de handleiding daar nog aan toe moet voegen. Praktisch gezien moeten we er achter komen hoe de gebruiker de taken die de handleiding moet ondersteunen - of soortgelijke taken - nu uitvoert of zal gaan uitvoeren.
Hoe de gebruiker zich nieuwe kennis eigen kan maken heeft gevolgen voor de vormgeving van de informatie in de handleiding. Hieruit volgt immers welke middelen ons ter beschikking staan om de gebruiker iets te leren.
Wanneer de maker en de gebruiker van een handleiding verschillen qua opleiding en/of achtergrond, is een gedegen doelgroeponderzoek nodig om de maker meer inzicht te geven in het ontwerpprobleem. Aan de hand van observaties en interviews kunnen de relevante eigenschappen van de gebruiker in kaart worden gebracht. Door deze eigenschappen vervolgens te generaliseren kan een gebruikersprofiel worden geformuleerd waarin de standaardgebruiker en zijn omgeving worden gekarakteriseerd. Omdat eigenschappen binnen een doelgroep vaak uiteen zullen lopen, dient hierbij de keuze gemaakt te worden op welke gebruiker de handleiding optimaal afgestemd zal worden; een beginner of een gevorderde.
3 Selecteer het medium
Er staan de maker van een handleiding meerdere media ter beschikking om informatie uit te wisselen met de gebruiker. Tegenwoordig komen we handleidingen tegen op audio- en video-cassettes, op computerschijfjes en cd’s en kunnen we ze zelfs direct ‘downloaden’ van het internet. Ook schaalmodellen kunnen als handleiding dienen bij bijvoorbeeld bouw- en constructietaken. De meest gehanteerde media zijn nog steeds de ‘papieren’ of ‘gedrukte’ media, zoals boeken, instructiekaarten of posters. Hierop kunnen alle vormen van visuele informatie in zwart-wit of kleur worden gedrukt, zoals foto’s, illustraties en tekst.
Het grootste voordeel van de papieren media ten opzichte van andere media is de mogelijkheid van relatief goedkope vermenigvuldiging en verspreiding op grote schaal. Daar komt bij dat papier, in tegenstelling tot de audio-visuele media en de computer, niet afhankelijk is van bijbehorende apparatuur. Iedereen kan papier bekijken terwijl lang niet iedereen beschikt over een videorecorder of een computer. Een nadeel van papier is dat bepaalde soorten informatie, bijvoorbeeld over bewegingen (aerobics), geluid (talen) of andere in de tijd verlopende processen minder effectief overgedragen kunnen worden.
Tijdens het doelgroeponderzoek dient bekeken te worden met welke media de gebruiker ervaring heeft en of hij beschikt over de voor sommige media vereiste apparatuur. Zoniet, dan is de keuze voor papier snel gemaakt. Verder hangt de keuze van het medium af van de reikwijdte die de handleiding moet hebben; hoeveel mensen ermee bereikt moeten worden en waar zij zich bevinden.
4 Bepaal de codes
Ieder medium kent zijn eigen specifieke codes. Welke coderingen geschikt zijn hangt af van de kennis en de voorkeur van de gebruiker. Binnen het doelgroeponderzoek kunnen kennis en voorkeur van gebruikers voor verschillende codes op diverse manieren geanalyseerd worden.
Eén mogelijkheid is om informatie ten behoeve van de uitvoering van een bepaalde taak op verschillende manieren te coderen. Vervolgens kan bekeken worden welke (combinatie van) codes leiden tot een snelle of nauwkeurige uitvoering van de taak.
Een eenvoudiger methode is om de gebruiker een aantal soorten tekeningen en een stukje tekst voor te leggen en hem te vragen welke hij begrijpt en aan welke hij de voorkeur geeft. Hierbij dient men zich te realiseren dat informatie op deze manier ‘geïsoleerd’ wordt gepresenteerd terwijl informatie in een handleiding altijd in een context staat. Begrip van en voorkeur voor afzonderlijke tekeningen hoeft nog niets te zeggen over de effectiviteit van dezelfde tekeningen in een context.
Als algemene richtlijn geldt dat informatie zoveel mogelijk gevisualiseerd dient te worden. Illustraties verhogen de motivatie van de gebruiker en maken de handleiding toegankelijker. Bovendien kunnen we visuele informatie makkelijker onthouden en sneller begrijpen dan tekstuele informatie.
Ondanks dit algemene gegeven speelt voorkeur binnen een cultuur ook een grote rol. Zo blijken Amerikaanse handleidinggebruikers tekst-georiënteerde instrukties te prefereren boven visuele instrukties, terwijl in Japan precies het omgekeerde blijkt te gelden [Miyoshi, 1992].
5 Bepaal de informatie-inhoud
De inhoud van de handleiding moet afgestemd worden op de behoeften en vaardigheden van de toekomstige gebruiker. Daatoe is het belangrijk om als maker van een handleiding niet zelf te bedenken wat er over het onderwerp allemaal verteld kan worden, maar de vraag te stellen welke informatie de gebruiker nodig heeft.
Een eenvoudige manier om hier een aanzet toe te geven is door een imaginaire dialoog aan te gaan met de gebruiker, op het moment dat deze de handleiding in handen krijgt. Door je een beeld te vormen van de vragen die de gebruiker achtereenvolgens zal stellen, ontstaat een hoofdindeling voor de handleiding die is gebaseerd op gebruikersvragen.
Wanneer duidelijk is welke codes de maker van een handleiding ter beschikking staan (stap 4) en welke informatie de gebruiker nodig heeft, moet bekeken worden of deze informatie met behulp van de beschikbare codes vormgegeven kan worden. Met andere woorden: informatie die de gebruiker wel nodig heeft maar die binnen het medium niet begrijpelijk vormgegeven kan worden, moet niet in de handleiding worden opgenomen. Hiervoor zal uitgeweken moeten worden naar een ander medium.
6 Categoriseer de informatie-inhoud
Een duidelijke handleiding heeft een consequente struktuur en vormgeving. Om informatie in een handleiding consequent te structureren en vorm te geven, moet het eerst mogelijk zijn er vat op te krijgen. Een methode hiervoor is om binnen de totale hoeveelheid informatie verschillende categorieën aan te wijzen. Aan de hand van een indeling in categorieën wordt het mogelijk om stukken informatie die we onderweg tegenkomen makkelijker uit elkaar te halen, door ze te herkennen en te benoemen. Consequentie in struktuur en vorm kan vervolgens worden gerealiseerd door informatie uit eenzelfde categorie op eenzelfde manier te struktureren en vorm te geven.
Een aantal categorieën van informatie die in veel handleidingen voorkomen zijn procedures, waarschuwingen, verwijzingen en voorbeelden. Hoe de informatie-inhoud van een handleiding het beste in categorieën kan worden opgedeeld zal per toepassing verschillen. Belangrijk is wel om het aantal categorieën niet te groot te maken omdat er anders teveel overlap ontstaat waardoor de indeling zijn praktische waarde verliest.
7 Bepaal de structuur van de handleiding
De structuur van een handleiding bepaalt waar een gebruiker informatie kan vinden. Daarbij wil een gebruiker niet graven in informatie maar hij wil vinden. Is het medium een boek dan probeert hij dat meestal door in de index te kijken of door de handleiding al bladerend door te nemen; niet door hem van voor naar achter door te lezen. Maak de structuur van een handleiding daarom toegankelijk, doorzichtig en consequent.
Bij een handleiding kunnen drie struktuur-componenten onderscheiden worden; een seriële, een parallelle en een relationele component. De seriële component komt tot uiting in de inhoudsopgave, de parallele component in de pagina lay-out en de relationele component heeft betrekking op verwijzingen.
Het struktureren van de handleiding begint met het bepalen van de seriële component, waarvan de eerste aanzet al is gegeven bij het vaststellen van de informatie-inhoud (stap 5). Deze informatie wordt verder opgedeeld in hoofdstukken of modules. Voor iedere module moet vervolgens bekeken worden of deze verder kan worden opgedeeld in steeds kleinere modules, totdat er uiteindelijk ‘hapklare’ stukjes informatie ontstaan. Door alle modules in een logische volgorde te zetten ontstaat vanzelf een gedetailleerde inhoudsopgave.
De pagina-layout komt tot stand door te bepalen welke informatie de gebruiker in één oogopslag nodig heeft; deze informatie moet op één paar pagina’s beschikbaar zijn. Lukt dit niet, of dient een stuk informatie parallel aan meerdere stukken informatie in de handleiding aangeboden te worden, dan kan overwogen worden uitvouwpagina’s of verwijzingen te gebruiken. Bedenk hierbij dat een heldere struktuur verwijzingen in een handleiding tot een minimum terug kan brengen of zelfs overbodig kan maken.
8 Pas de codes consequent toe
In deze stap komt de informatie op papier te staan. Voor elke categorie van informatie moet bepaald worden welke code of combinatie van codes zich het beste leent om de informatie vorm te geven.
Wanneer iedere code steeds op dezelfde manier gebruikt wordt, zal de gebruiker de handleiding snel leren doorzien en codes die hij niet kent makkelijker kunnen aanleren. Hiervoor is het ook belangrijk dat de struktuur van de handleiding zo snel mogelijk zichtbaar gemaakt wordt. Door de hele handleiding heen moeten duidelijke aanwijzingen geplaatst worden die het oriënteren en navigeren vergemakkelijken.
9 Evalueer de handleiding
Wanneer een eerste versie van de handleiding voltooid is, kan door middel van een tweede doelgroeponderzoek bekeken worden of de handleiding de juiste problemen oplost en geen nieuwe oproept. De handleiding kan het beste getest worden in een context die de toekomstige gebruiker in zijn omgeving zo dicht mogelijk benadert. Idealiter is dit bij de echte gebruikers in hun eigen omgeving.
Maak mensen tijdens een evaluatie duidelijk dat je niet de mensen zelf aan het testen bent maar de handleiding. Ga er bij het evalueren vanuit dat de handleiding in geen enkel opzicht deugt en wees dankbaar voor iedere op- of aanmerking die kan leiden tot verbetering. Hanteer een open vraagstelling en let goed op: het zijn veeleer de kleine op- of aanmerkingen van een individuele gebruiker die inzicht verschaffen dan de statistische resultaten van een heel onderzoek.
Richtlijnen voor het maken van een handleiding
1. Gebruik een exogene benadering om de inhoud van de handleiding vast te stellen. Bekijk en onderzoek vanuit het perspectief van de gebruiker welke informatie nodig is (exogeen) in plaats van zelf te bedenken wat je allemaal over het onderwerp kunt vertellen (endogeen).
2. Maak informatie specifiek, concreet en letterlijk. De onderwerpen in de handleiding en de gebruikte illustraties en tekst dienen direct te corresponderen met de ervaring en interesse van de gebruikers.
3. Leg nooit uit wat duidelijk gemaakt kan worden. Deze richtlijn slaat vooral terug op het systeem (product of proces) waar de handleiding bij hoort. Duidelijkheid kan niet aan een systeem toegevoegd worden door een handleiding; een handleiding is alleen een bron van informatie. Duidelijkheid moet vanaf het begin in het systeem worden ingebouwd [Horton, 1993]. Daarom is het zo belangrijk dat er reeds tijdens de productontwikkeling over een gebruikershandleiding wordt nagedacht, en niet, zoals vaak gebeurt, op het moment dat het product al af is.
4. Maak de handleiding zo non-technisch mogelijk. Gebruik geen technische tekeningen of terminologie in een handleiding, tenzij je er zeker van bent dat de doelgroep ermee overweg kan. Zelfs dán geldt dat als het niet noodzakelijk is, het beter achterwege gelaten kan worden [Holstein Schoff, 1991]
5. Gebruik één dominante methode om van A naar B te gaan. Gebruikers van handleidingen neigen één methode te volgen bij complexe procedures. Indien de gebruiker meer dan één alternatief geboden wordt voor het oplossen van complexe problemen, leidt dit vaak tot verwarring en daarmee tot vertraging van het leerproces [van der Meij, 1992].
6. Maak taken en doelen van procedures duidelijk. Wanneer gebruikers bepaalde procedures volgen, dient het duidelijk te zijn wat ze te doen staat en wat het resultaat zal zijn. Vereenvoudig procedures, beperk het aantal stappen en maak een opeenvolging van stappen in een procedure duidelijk.
7. Maak informatie traceerbaar. Een handleiding dient een gebruiker altijd de snelste weg te tonen naar de informatie die hij zoekt. Maak de structuur van de handleiding daarom zo snel mogelijk zichtbaar en zet door de hele handleiding heen duidelijke aanwijzingen die het oriënteren en navigeren vergemakkelijken.
8. Deel de handleiding op in segmenten alsof het antwoorden zijn op vragen van gebruikers. Omdat een handleiding antwoorden moet geven op gebruikersvragen, kan dat besef gebruikt worden bij het bepalen van de structuur van de handleiding.
9. Maak het plezierig voor de gebruiker. De meeste handleidingen veroorzaken een hoop ergernis bij de gebruiker, terwijl het gebruiken van een handleiding als zijnde een ‘probleemoplosser’ plezier zou moeten geven. Naast een goede inhoud en structuur kan ook goede vormgeving hieraan bijdragen. Maak bladzijden toegankelijk en uitnodigend, geef plaatjes voldoende ruimte en hou het vooral simpel.
10. Probeer informatie zoveel mogelijk te visualiseren. Illustraties verhogen de motivatie van de gebruikers en maken de handleiding toegankelijker. Bovendien kunnen we visuele informatie makkelijker onthouden en sneller begrijpen dan tekstuele informatie.
Zie ook: Communicatie - een praktisch perspectief
Bronnen
Flier, P.B., Toward an Appropriate Educational Technology - Concept for a Manual for the Production of a Tricycle for Persons with a Disability in Developing Countries, Faculty of Industrial Design Engineering, Delft University of Technology, Delft, 1995.
Floreak, M.J., Designing for the real world: using research to turn a ‘target audience’ into real people, Technical Communication, 1989d.
Holstein Schoff, G. & Robinson, P.A., Writing and Designing Manuals, Lewis Publishers, Chelsea, 1991.
Horton, W., Let’s do away with manuals...before they do away with us, Technical Communication, 1993a.
Meij, H. van der, De handleiding als ergonomisch ontwerp, Tijdschrift voor Ergonomie, oktober 1992.
Miyoshi, T., Changing the recipe for the mix of visuals and text in manuals for different cultures, Proceedings of the 39th Annual Conference of the Society for Technical Communication, Atlanta, 1992.
| Lid worden of sponsoren? Klik hier, elke bijdrage is zeer welkom!
Jamani is aan-
gesloten bij:
Met dank aan alle leden van Jamani en:
|
