‚Äč
U zoekt op: {{ keyword }}

Gebruiksaanwijzingen maken: de complete gids

Ferry Vermeulen Gebruiksaanwijzingen

In dit artikel laat ik je zien hoe wij een gebruiksvriendelijke, aantrekkelijke EN rechtsconforme gebruiksaanwijzing voor onze klanten maken.

Na het lezen van dit artikel zal je in staat zijn om zelf een gebruikershandleiding te schrijven, zonder dat je hiervoor een studie in technische communicatie, ontwerp EN rechten nodig hebt. Bovendien zal het schrijven van handleidingen veel sneller gaan dan op de gebruikelijke manier!

Je hoeft alleen maar de stappen van het INSTRKTIV-5-STEP-USER-MANUAL-PROCES te volgen.

Of, zoals wij het intern noemen, de I LUV MANUALS-TECHNIEK (L=Liability (aansprakelijkheid), U=USABILITY (bruikbaarheid) en V=Visibility (zichtbaarheid).

De sleutel tot een succesvolle klantervaring is dat je gebruikers precies weten hoe ze een product veilig, effectief en efficiënt kunnen gebruiken. Door eindgebruikers professionele instructies te bieden, krijg je tevredenere klanten, verlaag je de aansprakelijkheid en verlaag je de kosten voor de klantenservice.

Wil je weten hoe je een gebruiksaanwijzing schrijft waarmee je op iedereen indruk maakt, zoals dit voorbeeld dat we gemaakt hebben voor AEG/Electrolux?

Of deze beknopte gebruiksaanwijzing voor LIDL?

Of deze handleiding voor Gazelle?

Of deze gebruiksaanwijzingen en online help?



En wat dacht je van deze voorbeelden?

gebruiksaanwijzing

Lees dan verder.

INHOUDSOPGAVE

Hoe we de ‘I LUV Manuals-techniek’ gebruiken om de klanttevredenheid met 63% te verhogen en meer
Hoofdstuk 1 – Hoe schrijf ik een gebruiksaanwijzing waarin mijn gebruikers eenvoudig informatie kunnen vinden?
HOOFDSTUK 2 – Hoe schrijf ik een duidelijke gebruiksaanwijzing die voor een veilig gebruik van het product zorgt?
HOOFDSTUK 3 - Hoe maak ik duidelijk beeldmateriaal?
HOOFDSTUK 4 - Hoe presenteer ik mijn gebruiksaanwijzing?
HOOFDSTUK 5 – Hoe kan ik mijn gebruiksaanwijzing voltooien en verspreiden?

 

ZOEK JE EEN TEMPLATE DIE ALLE WETTELIJK VERPLICHTE ONDERDELEN BEVAT?

Neem de kortste weg naar een handleiding die aan alle wettelijke eisen voldoet. Wij hebben templates ontwikkeld voor machines,  medische apparatuur en elektronische apparaten die alle wettelijke elementen bevatten. Een handleiding maken wordt zo een invuloefening.

HIER KOPEN!

Hoe we de ‘I LUV Manuals-techniek’ gebruiken om de klanttevredenheid met 63% te verhogen en meer

Wanneer een van de volgende zaken op jouw bedrijf van toepassing is:

  • Je hebt een gebruikershandleiding nodig voor je product... En wel nu meteen!
  • Je klantenservice is overbelast;
  • Je gebruikers zijn ontevreden;
  • Je product is niet door de certificeringstests gekomen omdat de gebruiksaanwijzing niet conform is;
  • Je maakt je zorgen over jullie aansprakelijkheid omdat de gebruiksaanwijzing niet voldoet en/of niet alle veiligheidswaarschuwingen bevat;
  • Je wilt een goed uitziende gebruiksaanwijzing die bijdraagt aan een betere gebruikservaring;
  • Je bent teveel tijd kwijt aan je gebruikershandleidingen en vraagt je af of je efficiënter kunt werken. Per slot van rekening zijn de meeste van je handleidingen voor X% identiek. 

Kunnen we met de I LUV Manuals-techniek:

  • De klanttevredenheid verhogen met 63%
  • Het aantal telefoontjes, e-mails en chatgesprekken met wel 71% verlagen
  • De aansprakelijkheid met 98% verminderen
  • Zorgen dat we voor alle conformiteitstesten slagen
  • Zorgen dat we aan alle douanevoorschriften voldoen

Laten we direct aan de slag gaan!

Hoofdstuk 1 – Hoe schrijf ik een gebruiksaanwijzing waarin mijn gebruikers eenvoudig informatie kunnen vinden?

Om ervoor te zorgen dat je gebruikers eenvoudig de benodigde informatie kunnen vinden, moet je ervoor zorgen dat informatie op een gestructureerde manier wordt weergegeven. 

Niet-gestructureerde informatie kan erg verwarrend zijn. Daarom is het belangrijk om te identificeren wat belangrijk is en welke informatie triviaal is.

Wanneer je de inhoud voor je gebruikers goed organiseert, bespaar je ze veel tijd en moeite bij het leren over en oplossen van problemen waarvoor ze een oplossing zoeken. 

Wanneer de informatie niet goed is georganiseerd, zullen gebruikers het sneller opgeven. En wat misschien nog wel erger is, ze hebben een negatieve ervaring met je merk.

Voorzie in de behoefte aan informatie door kennis over je gebruiker te verzamelen

Om je gebruikers het juiste materiaal te kunnen bieden, is het belangrijk dat je jezelf verdiept in het onderwerp en de gebruiker.

Ga er nooit vanuit dat een gebruiker eerdere ervaring of productkennis heeft, voordat je daadwerkelijk weet wie je gebruikers zijn. 

Stel jezelf vragen zoals:

  • Wat beschrijft de gebruiker? Wat is hun leeftijd, geslacht, enz.?
  • Welke taken moeten ze uitvoeren?
  • Waarom wordt de taak uitgevoerd?
  • Hoe vaak wordt de taak uitgevoerd?
  • In welke omgeving wordt het product gebruikt?
  • Welke taal spreken ze?
  • Staat de gebruiker onder stress?
  • Wat is hun achtergrond?
  • Wordt het product professioneel, commercieel of particulier gebruikt?  
  • Welke technische ervaringen, kwalificaties, opleiding, training, kennis of vaardigheden hebben ze? (bijvoorbeeld: wanneer je informatie over een software-update schrijft, heeft de gebruiker waarschijnlijk al ervaring met de software);
  • Zijn er hulpmiddelen beschikbaar, indien van toepassing?
  • Heeft de gebruiker toegang tot internet?

Waarom is dit belangrijk? Laten we eens naar het volgende voorbeeld kijken.

De NS (Nederlandse Spoorwegen) overwoog om al haar bestaande papieren documentatie over treinen om te zetten naar online documentatie en video's.

Het afspelen van een video vereist meestal een snelle internetverbinding. Hoewel de ontvangst in Nederland vrij goed is, is snel internet niet altijd beschikbaar wanneer de trein op het Nederlandse platteland rijdt. 

En wanneer een trein defect raakt in een tunnel is de kans groot dat er helemaal geen internet is en dus geen toegang tot informatie.

Hierdoor besloten ze om alle informatie elektronisch beschikbaar te maken, maar dan in offline formaat.

Door het stellen van de juiste vragen die je helpen identificeren wie de lezer is en waar en hoe informatie geconsumeerd wordt, kan je beter inspelen op hun informatiebehoeften. 

Vergeet ook niet om rekening te houden met de behoeften van gehandicapte gebruikers. Mogelijk zijn er gebruikers die slechtziend of kleurenblind zijn. Misschien wil je voor deze groep gebruikers alternatieve gebruiksaanwijzingen maken in braille, met grote letters of audio.

Creëer een persona om de gebruiker beter te begrijpen 

Zelf ben ik een groot fan van het visualiseren van dingen en daarom moedig ik mensen altijd aan om een persona te creëren.

Een persona is een visueel gepresenteerd gebruikersprofiel waarin enkele redelijke veronderstellingen over de karakteristieken van je gebruikers worden gedaan. 

Tijdens mijn masteropleiding Industrial Design Engineering heb ik geleerd hoe je persona’s kunt creëren. Het creëren van persona's is niet alleen belangrijk bij het ontwikkelen van gebruikershandleidingen, maar ook in de beginfase van de ontwikkeling van een product of software. 

Hoe creëer ik een persona:

  1. Stel jezelf de juiste vragen om de gebruiker te identificeren en te leren kennen.
  2. Zoek online of in tijdschriften naar afbeeldingen die de gebruiker, zijn/haar hobby's, de omgeving, hun vaardigheden, etc. representeren.
  3. Gebruik fotobewerkingssoftware of een ouderwetse schaar en papier om een collage van je gebruiker te maken.
  4. Schrijf in je gebruiksaanwijzing een inleiding die de gebruiker beschrijft. Bijvoorbeeld:

Deze instructies zijn bedoeld voor de eindgebruiker van de [naam van de machine]. De eindgebruiker kan worden beschreven als elke persoon die direct met de machine te maken heeft. De eindgebruiker is meestal (maar niet beperkt tot):

  • Een installateur
  • Onderhoudspersoneel of monteurs
  • Een operator
  • Ontmantelingspersoneel

De machine mag uitsluitend worden gebruikt door een erkende, goed gekwalificeerde en bekwame persoon van 18 jaar of ouder, die:

  • Deze gebruiksaanwijzing heeft gelezen en begrepen
  • Bekend is met de bediening van soortgelijke apparatuur
  • Weet hoe deze machines moeten worden bediend
  • Zich bewust is van alle mogelijke gevaren en daarnaar handelt
  • Getraind en bevoegd is om op hoogte te werken
  • Een spuitvergunning heeft, indien van toepassing

De vereiste onderhouds- en/of inspectiewerkzaamheden zoals vermeld in deze gebruiksaanwijzing zijn toegestaan door de hiervoor genoemde personen, tenzij duidelijk aangegeven is wanneer dit niet is toegestaan. 

Uitzonderingen hierop zijn de meegeleverde hijs- en klimmaterialen en persoonlijke beschermingsmiddelen. Deze moeten altijd geïnspecteerd en gecertificeerd worden door erkende bedrijven/instanties.

Het doel van dit document is om de eindgebruiker vertrouwd te maken met de installatie, het gebruik en het onderhoud van de machines.


Persona voor de gebruiker van de IsoVox-opnamestudio

Door meer te weten te komen over je gebruikers kun je de informatie aanpassen aan hun behoeften. Dit zorgt ervoor dat je zowel je eigen tijd als die van de gebruiker niet verspilt door dingen uit te leggen die de lezer al weet of irrelevant zijn. 

Een veelgemaakte fout is dat gebruiksaanwijzingen vaak marketing- of verkoopinformatie bevatten. Dit leidt de gebruiker af bij het vinden van de informatie die hij echt nodig heeft.

Meestal lezen gebruikers een gebruiksaanwijzing als ze iets voor elkaar willen krijgen of een probleem willen oplossen. Ze willen bijvoorbeeld de nieuwste versie van hun antivirussoftware installeren, brood bakken of de betekenis van het knipperende lampje bovenop hun machine vinden.

Als je goed weet waar je gebruikers behoefte aan hebben, kun je consistentere handleidingen schrijven. Het helpt je de juiste informatie te selecteren en te focussen op de taken die door de gebruiker moeten worden voltooid.

Gebruik technische kennis, maar niet teveel

Dit lijkt misschien logisch, maar technische kennis is de sleutel tot het schrijven van goede instructies waar je gebruikers echt iets aan hebben. 

Bij een gebruiksaanwijzingen schrijven voor een camera zorgt het weten hoe de wisselwerking van de sluitertijd en het diafragma werkt er bijvoorbeeld voor dat het gemakkelijker is om elke functie te beschrijven in relatie tot het geheel.

In veel bedrijven worden de gebruiksaanwijzingen geschreven door iemand van marketing of R&D. 

Ik wil niet stereotyperen, maar marketingmensen beschikken vaak niet over de juiste technische kennis om dingen goed uit te leggen.

Aan de andere kant gebruiken hun technisch onderlegde collega's van R&D de gebruikershandleiding vaak als een middel om aan de buitenwereld te laten zien hoe geavanceerd hun uitvinding wel niet is door deze vol te zetten met onbegrijpelijke en irrelevante terminologie, formules of procesbeschrijvingen. 

Technische mensen zijn dus niet altijd de juiste mensen om klanten uit te leggen hoe ze een product moeten gebruiken.

Zowel te weinig als te veel technische kennis kan een nadeel zijn. 

Het is de taak van de technisch schrijver om technische informatie op een duidelijke, gestructureerde manier met de gebruiker van een product te delen.

Een technische opleiding, achtergrond, ervaring en communicatievaardigheden helpen technisch schrijvers om dit succesvol te kunnen doen. 

Verdiep je in het product door het uitgebreid te proberen en beschikbare informatie te bestuderen

Wanneer je een gebruiksaanwijzing schrijft moet je het product waarvoor je deze schrijft voor 100% begrijpen.

De beste manier om dat te doen is door het product zelf te gebruiken: probeer het te installeren, druk op alle knopjes, open klepjes, identificeer de alarmsignalen, enzovoort. WAARSCHUWING! Let hierbij altijd op je eigen veiligheid!

Mogelijk is er al enige informatie beschikbaar, zoals bestaande handleidingen, een risicoanalyse of marketinginformatie. Bestudeer deze informatie aandachtig en doorloop in je hoofd de volledige levenscyclus van het product, van aankoop tot weggooien.

Handige vragen zijn:

  • Wat is het beoogde gebruik?
  • Wat zijn de namen van de belangrijkste onderdelen?
  • Hoe wordt het product aan de eindgebruiker geleverd?
  • Hoe vervoer en bewaar ik het product?
  • Hoe installeer/monteer ik het product?
  • Hoe stel ik het product in bedrijf/maak ik het gereed voor gebruik?
  • Hoe gebruik ik het product?
  • Hoe wijzig ik de instellingen?
  • Hoe onderhoud ik het product?
  • Hoe repareer ik het product?
  • Wat zijn mogelijke fouten en hoe los ik deze op?
  • Hoe ontmantel ik het product en voer ik het af?
  • Zijn er reserveonderdelen beschikbaar?
  • Wat zijn de technische specificaties?
  • Welke risico's kom ik tegen tijdens de verschillende fasen van de levenscyclus van het product?

Door een praktische aanpak te gebruiken (bijv. het product zelf proberen), krijg je een beter idee van welk soort informatie aan de gebruiker moet worden gecommuniceerd.

Als dingen onduidelijk zijn, kan het een goed idee zijn om op internet of in bestaande, soortgelijke gebruiksaanwijzingen naar informatie te zoeken. Door andere producthandleidingen te lezen kan je zien hoe andere technisch schrijvers oplossingen voor soortgelijke problemen gevonden hebben. Maar let op...

Vertrouw vooral op jezelf en niet volledig op wat anderen doen. Wees kritisch en gebruik alleen informatie die je volledig begrijpt en kunt valideren. 

Bestaand materiaal is misschien ook niet altijd even duidelijk. Vaak zie je een gebrek aan structuur, inconsistentie of vage instructies. Daar zullen we later dieper op ingaan.

Bij het bestuderen van bestaand materiaal kom je waarschijnlijk overeenkomsten en verschillen tegen.

Je product bevat mogelijk niet alle functies die je in bestaand materiaal vindt. Let op de verschillen. Wat maakt jouw product uniek? Welke functies zijn identiek? Welke informatie kan je gebruiken om je eigen product beter te begrijpen? 

Naarmate je langzaam een volledig beeld van je eigen product krijgt, zal je steeds meer vragen krijgen. Niet alles zal meteen duidelijk zijn, noteer daarom alle onduidelijkheden. Deze worden in de volgende stap opgelost.

Praat met experts om het product voor 100% te begrijpen

De beste manier om antwoord te krijgen op je vragen is door met de mensen te praten die het product het beste kennen.

Meestal zijn dit mensen die meegeholpen hebben bij de ontwikkeling van het product, of deskundigen die bij andere fasen van de levenscyclus van het product betrokken zijn. In het Engels noemen we deze mensen subject-matter experts, ofwel SME's (vakinhoudelijke deskundigen in het Nederlands).

Wat is een SME precies?

Een SME is iemand met een diepgaande kennis van een bepaald domein (dit kan een taak of onderwerp zijn). SME's kunnen werktuigbouwkundigen, industrieel ontwerpers, programmeurs of elektrotechnisch ingenieurs zijn. Of helpdeskpersoneel, onderhoudspersoneel of installateurs. 

Maar ook managers, wetenschappelijke onderzoekers, testers, dealers of bedrijfseigenaren kunnen over diepgaande vakkennis beschikken en de subject-matter expert zijn die je nodig hebt.

Hieronder volgen enkele tips voor het stellen van vragen aan SME's:

Zorg ervoor dat je je goed bent voorbereid. Bestudeer het onderwerp grondig en maak een lijstje met duidelijke vragen.

Verzamel al je vragen en plan een afspraak in. SME’s zijn waardevol voor een bedrijf vanwege hun kennis en hun tijd is vaak kostbaar. Houd hier rekening mee bij het stellen van vragen. Verspil hun tijd niet.

De meeste technische SME's voelen zich meer op hun gemak in de wereld van cijfers, processen en technische beginselen dan woorden. Ze houden zich liever bezig met zaken voor elkaar krijgen en het behalen van resultaten, dan met het praten over hoe ze deze zaken voor elkaar krijgen. Mogelijk gebruiken ze veel jargon. Echter heb je die cijfers, technische termen, enz. niet altijd nodig om duidelijke gebruiksinformatie te kunnen schrijven. Vraag je SME daarom niet om jargon te vermijden. Als technisch schrijver is het jouw taak om de juiste vragen te stellen over de betekenis van bepaalde termen en om te beslissen welke informatie je wilt gebruiken. Zorg ervoor dat SME’s zich op hun gemak voelen en gewaardeerd worden voor kun kennis en waardevolle informatie.

Raadpleeg eerst bestaand materiaal voordat je vragen stelt. Zo voorkom je dat je je geloofwaardigheid verliest in de ogen van een scherpzinnige ingenieur.

Stel je vragen in een persoonlijk gesprek met de SME. Of middels een telefoongesprek. Soms wordt je gevraagd om je vragen in een e-mail of spreadsheet te zetten. Mijn ervaring is dat dit een project alleen maar vertraagt: antwoorden op vragen leiden tot nieuwe vragen. Het is jouw taak om door te vragen tot je alles begrijpt.

Zorg ervoor dat je het gesprek opneemt. Ik gebruik meestal mijn mobiele telefoon om een video op te nemen van het gesprek of wanneer we de volledige werking van een product doornemen. Hiermee voorkom je dat je tijdens een tweede gesprek (onzinnige) vragen stelt of onzin opschrijft in de ogen van de SME.   

Gedurende het gesprek zullen SME's automatisch de juiste namen voor de productelementen gebruiken. Een beeldscherm kan bijvoorbeeld een 'bedieningspaneel’ genoemd worden en niet een 'bedieningsscherm'. Wellicht herinner je je dit later niet allemaal, maar door opgenomen materiaal terug te kijken kan je deze informatie eenvoudig achterhalen. Dit voorkomt veel frustratie. Wanneer je vragen online stelt via een videoconferentie en/of een sessie met gedeeld scherm, zorg er dan voor dat je een schermopname maakt.

Vraag SME's ook om je werk te beoordelen. Hun kennis en feedback is essentieel voor het schrijven van duidelijke gebruiksinformatie.

Los de problemen van de gebruiker op

Een ding dat ik nog wat meer wil benadrukken is het belang van het oplossen van de problemen van de gebruiker. Dit moet zowel het uitgangspunt zijn voor het stellen van vragen aan SME’s als het in kaart brengen, structureren en organiseren van informatie (zie volgende paragrafen).

De gebruikers waarvoor je schrijft kunnen gedurende de levenscyclus van het product tegen verschillende problemen aanlopen. Deze problemen willen ze oplossen. En daar hebben ze jouw hulp voor nodig.

Dus wanneer je met SME’s praat, informatie verzamelt, enz. moet je altijd proberen om de problemen te achterhalen waarmee de gebruikers te maken kunnen krijgen.

Gebruikelijke problemen zijn vergelijkbaar met de hierboven beschreven vragen en hebben te maken met de installatie, het gebruik, onderhoud, de reparatie, de reiniging en het weggooien van het product. 

Problemen kunnen heel specifiek zijn, zoals:

  • Hoe bevestig ik de voetjes aan mijn magnetron?
  • Hoe vervang ik de gietvorm van mijn machines?
  • Wat betekent het rood knipperende led-lampje?
  • Mag ik de behuizing van mijn product met een schoonmaakmiddel reinigen?

Soms is het probleem van de gebruiker erg complex en kan het voor de lezer moeilijk zijn om de informatie tot zich te nemen. In dat geval kan je de informatie opdelen in stukjes (chunks). 

Zo hebben we bijvoorbeeld wel eens een gebruiksaanwijzing gemaakt voor een machine genaamd de Roof Washer. Eén van de belangrijkste stappen die de gebruiker moest uitvoeren was het gereedmaken van de Roof Washer voor gebruik.

Het belangrijkste probleem was dus: Hoe maak ik de Roof Washer gereed voor gebruik?

Aangezien dit een heel uitgebreid onderwerp was, besloten we de informatie in de volgende stukjes op te delen:

  • De inhoud van de levering controleren
  • Het mobiele platform gereed maken
  • De Roof Washer gereed maken
  • De Top Cleaner bovenop de kas plaatsen
  • Het aanpassen van het mobiele platform
  • Het aanpassen van de Roof Washer
    • Aanpassing van de hoofdborstels
    • Aanpassing van de optionele raambeveiligingsschakelaar
    • Aanpassing van de optionele gootborstel
    • Aanpassing van de voorwielhendels

Je begint hier dus eigenlijk al met het creëren van topics. Schrijven op basis van topics is van essentieel belang voor het schrijven van duidelijke instructies.

De informatie in kaart brengen, structureren en organiseren

Je bent nu waarschijnlijk helemaal overstelpt met informatie: van het gebruik van het product en het analyseren van alle beschikbare documentatie, tot de informatie die je van de SME’s hebt gekregen. 

De informatie bestaat uit een beschrijving van de problemen die gebruikers willen oplossen, oplossingen voor deze problemen, maar ook allerlei andere soorten informatie zoals bedradingsschema's, lijsten met reserveonderdelen, enz. 

Eén van de meest uitdagende taken van een technisch schrijver is om alle informatie te verzamelen, die te analyseren, te bepalen wat relevant is, informatie te verwijderen, te organiseren en te structureren.

Hoe verwerk en organiseer ik deze informatie allemaal? 

Dat is vrijwel onmogelijk zonder de informatie eerst in kaart te brengen. Je doel hierbij is om alleen de informatie te bewaren die bruikbaar is voor het schrijven van de topics die de vragen van de gebruiker beantwoorden.

Deze topics moeten duidelijk worden georganiseerd en identificeerbaar zijn in de inhoudsopgave of menustructuur en de levenscyclus van het product volgen (zie volgende paragraaf).

Maar voordat je deze definitieve, goed doordachte (inderdaad, dit moet een meesterwerk worden) inhoudsopgave kan opstellen, moet je eerst alle informatie structureren en organiseren.

Hieronder enkele methoden en hulpmiddelen die je daarbij kunnen helpen:

  1. Stel de inhoudsopgave op terwijl je bezig bent.
  2. Gebruik mind mapping.
  3. Gebruik information mapping-technieken.
  4. Gebruik ouderwetse post-its.

 
Voorbeeld van een mindmap

Alle methoden zijn gebaseerd op de volgende principes:

  • Verdeel alle relevante informatie onder in kleine en hanteerbare stukjes.
  • Beperk elk stukje informatie tot één onderwerp.
  • Label elk stukje informatie zodat je eenvoudig de inhoud kunt identificeren, d.w.z. dat het label de inhoud beschrijft. Het is bijvoorbeeld beter om ‘Het updaten van de software’ te labelen met Installatie en niet met Gebruik.
  • Organiseer en structureer de informatie. Zorg ervoor dat je consistent bent bij het organiseren, indelen en rangschikken van de informatie (en wees consistent bij het gebruik van terminologie).

Op deze manier kan je topics steeds verder definiëren.

Een topic geeft antwoord op één vraag van de gebruiker. Gebruikers willen namelijk maar één probleem tegelijk oplossen, niet meerdere. Dat kan verwarrend zijn. 

Wanneer de gebruiker het eerste probleem heeft opgelost, zal hij verdergaan naar het volgende topic en het volgende probleem oplossen.

Elke topic krijgt zijn eigen plek in de gebruikershandleiding. Een topic kan worden gebruikt als hoofdstuk of (deel-)paragraaf. Of misschien past een topic beter in een andere gebruiksaanwijzing die moet worden gemaakt. Laten we hier verder naar kijken. 

In de norm 82079-1:2019 Voorbereiding van gebruik van instructies, wordt informatie gestructureerd rondom informatietypen en informatieproducten.

Een andere manier voor het visualiseren van de relatie tussen verschillende informatiesoorten, zoals topics en instructies, is door middel van het volgende model:

information types

Naast de positie van een topic in het grotere plaatje, laat dit model ook zien hoe een topic wordt opgedeeld in een procedure. 

Laten we eens kijken hoe zo’n gestructureerde stap-voor-stap-procedure eruit ziet.

Informatieproducten

Alle ‘gebruiksinformatie’ bestaat in wezen uit informatie op basis van drie typen: 

  • Instructieve informatie
  • Conceptuele informatie 
  • Referentie-informatie.

Deze informatie wordt vervolgens gestructureerd rondom verschillende informatieproducten die in verschillende media kunnen worden geselecteerd, gepresenteerd en afgeleverd om aan de behoeften van verschillende soorten gebruikers te voldoen.

Gebruiksaanwijzing 

Een gebruiksaanwijzing is één soort informatieproduct. Andere soorten zijn installatiehandleidingen, onderhoudshandleidingen, online help, enzovoort. 

Een geprinte gebruiksaanwijzing is een volledig papieren boekje waarin het gebruik van een bepaald product wordt beschreven. Het bevat alle nodige topics, instructies en stappen om de problemen van een gebruiker op te lossen. 

 

Topics

Gebruikershandleidingen worden gestructureerd rondom topics. Elke topic geeft antwoord op een vraag van de gebruiker. 

Een topic kan conceptueel zijn (zoals een beschrijving van hoe een proces werkt), referentieel (zoals een onderhoudsschema) of instructioneel (zoals procedures en veiligheidsinstructies).

Voorbeelden van instructionele topics zijn “aan de slag”, “het vervangen van de batterij” of “het bakken van pannenkoeken”.

Topics moeten op logische wijze worden gegroepeerd.

Instructies

Als een topic erg complex is, kan het uit meerdere stukjes bestaan. Deze stukjes worden in het bovenstaande model van informatietypen als instructies aangegeven. Instructies zijn in feite deeltopics.

Het hierboven beschreven topic over de voorbereiding en afstelling van een machine is opgedeeld in verschillende (deel)instructies, zoals “Het aanpassen van de hoofdborstels” en “Het aanpassen van de optionele raambeschermingsschakelaar". 

Stappen

Een stap is een gedetailleerde beschrijving voor een instructie. Instructies bevatten verschillende stappen. Samen beschrijven ze het stappenproces voor het uitvoeren van een bepaalde taak. 

Elke instructie heeft een duidelijk doel, dat altijd taakgericht en relevant moet zijn (volgens minimalistische principes). 

Laten we eens naar het volgende voorbeeld kijken.

Op deze pagina uit een “drone-handleiding” worden twee stappen weergegeven. Dit zijn twee van de zes stappen voor de instructie of het deeltopic Het installeren van de drone. Elke stap is taakgericht en verduidelijkt met illustraties.

De illustraties zorgen ervoor dat de gebruiker beter begrijpt wat er moet worden gedaan. 

De gebruiker volgt de stappen door de instructies te lezen. In het volgende hoofdstuk vind je meer informatie over het schrijven van duidelijke instructies. 

Als je wilt dat je instructies effectief zijn, moet je proberen om niet meer dan 10-12 stappen te gebruiken. Als je wilt dat gebruikers een taak onthouden, kan je het beste 5-7 stappen gebruiken. Dit is het magische aantal objecten dat een gemiddelde mens in zijn kortetermijngeheugen kan vasthouden (Miller, 1956

Indien nodig kan een stap worden aangevuld met veiligheidswaarschuwingen, tips met een meer uitgebreide beschrijving van het uitvoeren van de stap of het herkennen van fouten wanneer een stap verkeerd uitgevoerd is.

Het is van cruciaal belang dat informatietypen zoals waarschuwingen, stappen, foutherkenning en tips een consistente opmaak hebben en steeds op dezelfde manier worden gepresenteerd. 

Een consistente opmaak zorgt ervoor dat gebruikers informatie eenvoudig kunnen vinden en herkennen. Wanneer een veiligheidswaarschuwing een duidelijke opmaak heeft, trekt dit bijvoorbeeld meer aandacht naar de veiligheidsboodschap, aangezien de gebruiker deze herkent als een veiligheidsboodschap.

Laten we het nog even kort samenvatten.

We hebben verschillende methoden en modellen besproken die je helpen bij het in kaart brengen, structureren en organiseren van informatie. 

Er is niet één manier die het beste werkt, maar ik denk dat een combinatie van de bovengenoemde technieken, met een goede theoretische achtergrond, de manier is om duidelijke gebruiksaanwijzingen te schrijven. 

Het laatste dat ik wil bespreken is de overeenkomst die ik heb gevonden tussen het informatie-ontwikkelingsproces en het productontwikkelingsproces

Het proces van het verzamelen en structureren van informatie is behoorlijk vergelijkbaar met onderstaande modellen die ik op de universiteit heb geleerd die gebruikt worden voor innovatieprocessen. 

 
Het linker model beschrijft de basiscyclus voor productontwerp. Het begint met een beschrijving van de functie die een product of dienst moet vervullen.

Na een uitgebreide analyse van sterke punten, kansen, zwakke punten en bedreigingen kan je een aantal criteria opstellen (lijst met eisen). Door vervolgens een proces van synthese, simulatie/prototyping, evaluatie en technische uitwerking te volgen, krijg je uiteindelijk een ontwerp dat gereed is voor massaproductie.

Het rechter model beschrijft het proces van onderzoek, het genereren van ideeën, conceptcreatie en realisatie. Elk van deze fasen wordt gekenmerkt door een divergentie- en convergentieproces. Eerst moet je verschillende alternatieven verzamelen, voordat je de beste kunt kiezen.

Als ik dit model zou toepassen op het proces van het creëren van gebruikersinstructies, ziet dat er als volgt uit:

Topics organiseren voor eenvoudige navigatie

Ik wil graag wat verder ingaan op het belang van een inhoudsopgave en dus de manier waarop je topics worden georganiseerd in de gebruikershandleiding.

De inhoudsopgave moet heel zorgvuldig worden samengesteld. Het moet een goed doordacht kunstwerk zijn. De inhoudsopgave is namelijk de ruggengraat van je gebruikershandleiding! 

Waarom speelt de inhoudsopgave zo'n belangrijke rol?

Wanneer je gebruikers tegen een probleem aanlopen en de gebruiksaanwijzing raadplegen om antwoord op hun vragen te vinden, zullen ze waarschijnlijk eerst naar de inhoudsopgave gaan om te kijken waar ze dat antwoord kunnen vinden.

Een duidelijke inhoudsopgave helpt de gebruiker meteen de juiste instructie te vinden, zonder dat hij hiervoor door alle pagina’s van de gebruiksaanwijzing hoeft te bladeren.

Zelf organiseer ik de topics in de inhoudsopgave graag op basis van de behoeften van mijn gebruikers en het doel van de informatie, volgens de levenscyclus van het product.

Meestal begin ik met een standaard inhoudsopgave. Bij het verzamelen van informatie, zoals in de vorige onderdelen wordt beschreven, schrijf ik de namen van mijn topics op post-its. Vervolgens label ik deze post-its, plak ik ze op de muur, of creëer ik een online mindmap.

 
Voorbeeld van een standaard inhoudsopgave

Wanneer ik denk dat ik alles heb, voeg ik mijn productspecifieke topics toe aan de standaard inhoudsopgave, organiseer ik deze en stel ik mijn definitieve inhoudsopgave vast. Meestal bespreken we de inhoudsopgave daarna met het bedrijf dat ons ingehuurd heeft.

Wat ook belangrijk is om ervoor te zorgen dat je gebruikers eenvoudig oplossingen kunnen vinden via de inhoudsopgave, is het kiezen van de juiste naam voor je kopteksten. Hier zullen we later dieper op ingaan.

Ik wil ook nog even zeggen dat de onderdelen over het in kaart brengen, organiseren en structureren van informatie behoorlijk theoretisch zijn, maar voor een goede technische schrijver is dit één van de meest essentiële vaardigheden. 

De enige manier om te weten of je je werk goed hebt gedaan, is door te controleren of gebruikers snel en eenvoudig de informatie kunnen vinden die ze nodig hebben. Zo niet, dan heb je waarschijnlijk iets verkeerd gedaan in het proces van het in kaart brengen en organiseren van de informatie.

HOOFDSTUK 2 – Hoe schrijf ik een duidelijke gebruiksaanwijzing die voor een veilig gebruik van het product zorgt?

Zodra we onze topics hebben vastgesteld en gestructureerd om de inhoudsopgave vast te kunnen stellen (of de menustructuur voor online help), kunnen we beginnen met het daadwerkelijke schrijven van de inhoud.

Het belangrijkste doel hierbij is om een gebruikershandleiding te schrijven die een veilig, efficiënt en effectief gebruik van het product mogelijk maakt.

Laten we dit eens verder analyseren.

Bereik je doelgroep door jargon te vermijden

Gebruikershandleidingen die worden geschreven door techneuten bevatten vaak erg veel vakjargon.

Wat is jargon precies?

Jargon is onnodig gecompliceerde taal die meestal wordt gebruikt om indruk te maken in plaats van te informeren.

Dit betekent niet dat je geen technisch termen mag gebruiken. Soms heb je deze juist nodig om een product goed uit te leggen.

Het uitgangspunt moet zijn om zo duidelijk mogelijke instructies te schrijven. Het gebruik van terminologie die geen deel uitmaakt van de gebruikelijke woordenschat van je lezer draagt daar niet aan bij. 

Laten we eens naar het volgende voorbeeld kijken:

Je kunt prima zeggen “Draai de onderste nabijheidsschakelaar stevig aan”. Het gebruik van ‘onderste nabijheidsschakelaar’ is gewoon een noodzakelijk gebruik van een technische term.  

Zodra je echter zegt “Pas voldoende draaimoment op de onderste nabijheidsschakelaar toe om ervoor te zorgen dat de nabijheidsschakelaar stevig aan de helling bevestigd wordt en zo, dat het onder extreme weersomstandigheden niet kan loskomen”, gebruik je te veel jargon.  

Vaak zijn specifieke termen nuttig en kunnen ze zelfs de enige bekende terminologie zijn voor een bepaalde doelgroep. In die gevallen is het gebruik ervan de duidelijkste manier om met je doelgroep te communiceren. 

Als je lezers echter specialisten zijn, kan het gebruik van meer dan alleen de noodzakelijke technische termen juist leiden tot misverstanden en de lezer verwarren. 

Eén van de meest gehoorde klachten over gebruikersinstructies is het gebruik van te veel jargon. De schrijver van een gebruikershandleiding realiseert zich vaak niet dat de lezer niet dezelfde achtergrond of productkennis heeft.

Daarom is het kennen van je doelgroep zo belangrijk.

Wanneer je echt geen andere manier kunt vinden om een concept uit te leggen dan door het gebruik van jargon, kan je de betekenis van de gebruikte termen (inclusief de afkortingen) uitleggen in een verklarende woordenlijst.

Vergeet niet dat je een gebruiksaanwijzing schrijft om het gebruik van een technisch product te communiceren, niet om indruk te maken. Als je je dat goed realiseert, zal je automatisch minder jargon gebruiken. 

Gebruik betekenisvolle kopteksten om gebruikers te helpen vinden wat ze zoeken

Een koptekst is een titel aan de kop van een pagina of onderdeel van een boek.

De beschrijving van je topic is een koptekst en wordt dus vermeld in de inhoudsopgave. Lezers raadplegen de inhoudsopgave om zo snel mogelijk naar het onderdeel te gaan dat de informatie bevat waar ze naar op zoek zijn.

In dit voorbeeld zie je een koptekst die de inhoud duidelijk beschrijft.

 
Kopteksten in gebruikershandleidingen hebben verschillende belangrijke functies:

  • Ze bieden een organisatorisch overzicht van de gebruiksaanwijzing;
  • Ze tonen de logische structuur van de productinformatie, op basis van de levenscyclus van het product;
  • Ze tonen de hiërarchische relatie van topics (kopteksten, onderverdelingen);
  • Ze zorgen ervoor dat de lezer snel naar de juiste pagina kan navigeren;
  • Ze zorgen ervoor dat de lezer niet-interessante informatie kan overslaan.

Een koptekst geeft de grenzen tussen de topics en deeltopics van een gebruiksaanwijzing aan. Een goede koptekst dekt de volledige inhoud van de topic.

Het is belangrijk om je koptekst zorgvuldig te kiezen en een consistente stijl en opmaak te gebruiken, zodat gebruikers eenvoudig de informatie kunnen vinden waarnaar ze op zoek zijn.

Probeer met maximaal drie koptekstniveaus te werken: kopteksten op het eerste, tweede en derde niveau. Overdrijf niet met het aantal koptekstniveaus.

Kijk eens naar de volgende voorbeelden:

Zie je dat de formulering van de kopteksten consistent is? De koptekst op het eerste niveau vertelt waar het hele hoofdstuk over gaat, de kopteksten op het tweede niveau gebruiken het woord hoe en de kopteksten op het derde niveau gebruiken naamwoordgroepen.

Zorg ervoor dat je kopteksten zo formuleert dat ze voor zich spreken. De koptekst Hoe bak ik pannenkoeken is veel meer gebruikersgericht dan Het gebruik van de MagicMix2000.

Door een duidelijke stijl te gebruiken voor je kopteksten, kan de lezer eenvoudig het niveau van een topic identificeren. Soms is de stijl echter al bepaald door de huisstijlrichtlijnen van een bedrijf.

Als er geen huisstijl is, kan je zelf de opmaak van de kopteksten kiezen. Hoewel dit niet de enige juiste manier is, geef ik hieronder een stijlvoorbeeld:

  • Schrijf de kopteksten op het eerste niveau volledig in hoofdletters;
  • Schrijf van kopteksten op het tweede niveau alleen het eerste woord en alle eigennamen en werkwoorden met een hoofdletter;
  • Schrijf van kopteksten op het derde niveau alleen het eerste woord met een hoofdletter.

Let er echter op dat deze stijl niet in alle talen kan worden gebruikt. In het Duits moeten zelfstandige naamwoorden bijvoorbeeld altijd met een hoofdletter geschreven worden.

Beschrijf het 'beoogde gebruik' om je aansprakelijkheid te verminderen

Een duidelijke gebruiksaanwijzing beschrijft de functie van een product en hoe deze moet worden gebruikt gedurende de verwachte levensduur van het product. 

In het beoogde gebruik van een product, machine of apparaat vermeld je het doel van je product.

Een duidelijke beschrijving van het beoogde gebruik vormt de basis van iedere gebruiksaanwijzing en bepaalt (samen met andere gebruiksbeperkingen, zoals technische of milieubeperkingen) het veilige toepassingsgebied van je product: de basis voor het waarborgen van een veilig, efficiënt en effectief productgebruik.

De beschrijving van het beoogde gebruik vermindert bovendien je aansprakelijkheid en is het uitgangspunt voor de verdere inhoud van de gebruikershandleiding.

Zodra je het beoogde gebruik hebt vastgesteld kan je de juiste veiligheids- en gebruikersinformatie verstrekken voor het beoogde gebruik van het product.

Wetgeving inzake productveiligheid, zoals richtlijnen en normen, vereist dat de meeste producten een beschrijving van het beoogde gebruik bevatten.

De internationale norm voor gebruiksinformatie IEC/IEEE 82079-1:2019) bevat de volgende definitie voor het beoogde gebruik: 

An exhaustive range of functions or foreseen applications defined and designed by the supplier of the product

Enkele voorbeelden van het beoogde gebruik:

En deze:

Naast het beoogde gebruik, wil je misschien ook een beschrijving van redelijkerwijs te voorzien oneigenlijk gebruik toevoegen.

Wat is redelijkerwijs te voorzien oneigenlijk gebruik?

In de IEC/IEEE 82079-1:2019 wordt de volgende definitie voor redelijkerwijs te voorzien oneigenlijk gebruik gegeven:

The use of a product or system in a way not intended by the supplier, but which can result from readily predictable human behaviour

Enkele voorbeelden:

  • Het gebruik van een agressief schoonmaakmiddel in een omgeving waar voedsel wordt verwerkt.
  • Het gebruik van een automatische toegangspoort om personen te verplaatsen (kinderen die erop staan wanneer de poort opent of sluit).

Voorbeeld van redelijkerwijs te voorzien misbruik van een helikopterplatform

Wanneer je weinig tot geen aandacht besteed aan het beschrijven van redelijkerwijs te voorzien oneigenlijk gebruik, kan dit van invloed zijn op je aansprakelijkheid.

Wanneer het bijvoorbeeld redelijkerwijs te voorzien is dat een bepaald koelsysteem dat in ziekenhuizen gebruikt wordt, ook als een systeem voor het koelen van organen gebruikt kan worden, moet dit in de instructies beschreven worden. 

Niet te voorzien oneigenlijk gebruik hoeft niet in de instructies te worden opgenomen omdat dit over het algemeen geen invloed heeft op je aansprakelijkheid.



Redelijk te voorzien oneigenlijk gebruik of niet te voorzien oneigenlijk gebruik
?

Zorg voor duidelijke, heldere en begrijpelijke gebruikershandleidingen

Zoals eerder besproken, bestaat een gebruiksaanwijzing uit verschillende soorten informatie die een specifiek doel dienen, genaamd informatietypen

Voorbeelden van informatietypen zijn onderwerpen/kopteksten, beschrijvingen, doelen, vereisten, voorwaarden, acties, resultaten, waarschuwingen, aansporingen en herinneringen, voorbeelden en bijschriften. 

Wanneer je een consistente opmaak gebruikt voor verschillende informatietypen, zal je lezer deze bewust of onbewust herkennen en ze koppelen aan de functie van dat informatietype.

De indeling van het informatietype maakt het gemakkelijk om onderscheid te maken tussen de verschillende informatie-elementen. Een andere indeling zorgt ervoor dat de lezer verschillende soorten informatietypen uit elkaar kan houden.

Zie onderstaand voorbeeld waarbij de koptekst, instructietitel, instructies, productelementen en illustraties allemaal informatietypen zijn die door de hele gebruiksaanwijzing heen een consistente opmaak hebben.

En dit voorbeeld waarin de kopteksten, waarschuwingen/meldingen, contextuele informatie, instructietitel, instructies, productelementen en illustraties allemaal informatietypen zijn met een consistente opmaak.

Welke informatietypen kan je hier onderscheiden?

 
Nog een ding om op te letten bij het maken van duidelijke handleidingen is het vermijden van vage woorden. Voorbeelden van dergelijke woorden zijn dingen, delen en spullen. Het gebruik van deze woorden maakt je gebruiksaanwijzing onduidelijk.

Als je toch de neiging hebt om deze woorden te gebruiken, heb je waarschijnlijk nog niet voldoende informatie over het onderwerp verzameld. Vraag dan iemand om hulp of zoek naar eenduidige alternatieven.

Door eenduidige woorden te gebruiken, help je gebruikers een actie zo veilig, snel en goed mogelijk te voltooien.

Een actiegerichte aanpak heeft over het algemeen de voorkeur. Gebruikers leren sneller als ze een actie moeten uitvoeren.

Ik raad je bovendien aan om gebruik te maken van Simplified Technical English voor het schrijven van eenduidige teksten.

Instructies schrijven: biedt gebruikers een mogelijkheid om dingen voor elkaar te krijgen

Je kunt acties uitlokken door weinig conceptuele informatie te geven en te focussen op het verstrekken van procedures: gebruikers willen dingen voor elkaar krijgen en niet erover lezen.

Hier is een interessante paradox:

De beste manier om te leren is door een actie uit te voeren. Echter moeten gebruikers vaak eerst iets leren voordat ze een actie kunnen uitvoeren.

Eén van de grootste vaardigheden die een technisch schrijver moet ontwikkelen is het vermogen om een passend evenwicht te vinden tussen enerzijds het ondersteunen van de directe acties van de lezer en anderzijds het verstrekken van belangrijke conceptuele informatie aan de lezer. 

Kijk naar dit voorbeeld op basis van minimalistische principes, dat dit evenwicht bevat:

Of dit minimalistische voorbeeld: 

In veel conventionele gebruikersdocumentatie wordt niet veel prioriteit gegeven aan ondersteunende acties die een gebruiker aan het begin van de gebruiksaanwijzing moet uitvoeren.

Veel gebruiksaanwijzingen beginnen met uitleg, technische gegevens, veiligheidsinstructies, procesbeschrijvingen, enz. Dit kan in sommige gevallen absoluut waardevolle informatie zijn, maar leidt de gebruikers vooral af van het bereiken van hun doel.

Probeer alleen strikt noodzakelijke must know-informatie (noodzakelijk om te weten) in een gebruiksaanwijzing op te nemen en beschouw alle nice to know-informatie (leuk om te weten) als overbodig.

Wanneer je erin slaagt om het kort te houden, brengt de gebruiksaanwijzing over dat de taak van de gebruiker niet veel moeite vereist, en relatief eenvoudig uit te voeren is. 

De gebruiksaanwijzing stimuleert een gebruiker om relevante voorkennis te gebruiken en meer zelf na te denken wanneer je niet alles uitlegt.

Wanneer je de vaardigheid beheerst van het minimaliseren van achtergrondinformatie en precies voldoende informatie verstrekt zodat de gebruiker een taak kan voltooien of een concept kan begrijpen, worden je instructies veel duidelijker.

Veel gebruikershandleidingen bevatten instructies die onvolledig of onjuist zijn. Om dit te voorkomen, kan je het beste tijdens het schrijven alle stappen zelf uitvoeren.

Dit zorgt ervoor dat wat je schrijft de juiste manier is om dingen uit te voeren en helpt je te focussen op de must know-informatie. Ook zorgt het ervoor dat het minder waarschijnlijk is dat je iets vergeet en dat de kwaliteit van de informatie beter is.

Soms is het niet mogelijk om het stappenplan zelf uit te voeren, bijv. wanneer het product gevaarlijke of complexe apparatuur betreft. In die gevallen moet je alle stappen met een SME bespreken, ze zorgvuldig overwegen en nadien schriftelijk laten controleren. 

Zorg ervoor dat stappenplannen in de juiste volgorde staan en de timing en volgorde van de daadwerkelijke handelingen volgen.

Ook binnen een zin moet je de juiste volgorde volgen. Laten we eens naar het onderstaande voorbeeld kijken.

Om Duits in te stellen als uw standaardtaal, selecteert u Duits wanneer u klikt op Taal in het menu Bestand.

...is veel gebruikersonvriendelijker dan…

Om Duits te selecteren als uw standaardtaal: 

  1. Ga naar Bestand>Taal.
  2. Selecteer Duits.

Dit voorbeeld bevat visuele tussenstappen: de stappen zijn genummerd met 1, 2, enz. Door tussenstappen te gebruiken, maak je gebruikers duidelijk dat het nodig is dat de stappen één voor één gevolgd worden. Als alternatief kan je zelfs 'stap 1', ‘stap 2', enz. toevoegen.

Vrij simpel toch?

Maak de instructies niet te lang. Korte, eenvoudige zinnen met slechts één instructie, of per zin maximaal een klein aantal nauw verwante instructies werken het best. 

Schrijf de stappen zodanig op dat ze een taak voltooien, wat betekent dat je de gebruiker precies vertelt wat hij/zij moet doen om één enkele taak te voltooien. 

Vermijd het onbewust creëren van een dood spoor en zorg ervoor dat de gebruiker, na het doorlopen van de stappen van een bepaalde topic, het probleem opgelost heeft: topic moet een duidelijk begin en einde hebben, in tegenstelling tot een boek, dat je van begin tot einde leest.

Gebruik de actieve vorm om stappen te schrijven die gemakkelijker te begrijpen zijn

Zorg ervoor dat de informatie die je geeft zo eenvoudig en kort mogelijk is. Instructies moeten in de tegenwoordige tijd en in de actieve vorm geschreven worden, met sterke werkwoorden.

De actieve vorm legt de nadruk bij de gebruiker en instructies die in de actieve vorm zijn geschreven, zijn gemakkelijker te lezen en te begrijpen. 

In zinnen met een actieve vorm zijn het onderwerp en het werkwoord altijd duidelijk. Bijvoorbeeld: 

“Sluit een toetsenbord aan op een USB-poort van het externe apparaat.”

In deze zin is aansluiten het actieve werkwoord en zijn toetsenbord, USB-poort en externe apparaat allemaal onderwerpen.

Laten we die zin eens in de passieve vorm schrijven:

“Er moet een toetsenbord op een USB-poort van het externe apparaat aangesloten worden.”

Het is in de actieve vorm veel duidelijker dat de lezer degene is die de beschreven actie moet uitvoeren.

Door het gebruik van de actieve vorm worden je instructies duidelijker, korter en directer.

Nog wat voorbeelden:

En deze:

En onlangs zag ik deze nog in een kantoorruimte:

 
Iets anders om rekening mee te houden bij het 'ontwerpen' van stappen, is om niet voor elke reactie van een product of systeem een afzonderlijke stap te maken. Bijvoorbeeld, maak van “Het menu instellingen opent” geen afzonderlijke stap. 

Wat je wel kunt doen is reacties van producten of systemen (indien nodig) opnemen in de stap die de reactie heeft veroorzaakt. 

Je kunt de reactie ook aan het begin van de volgende stap vermelden.

Twee voorbeelden:

Om Duits te selecteren als uw standaardtaal:

  1. Klik op de knop TAAL. Het taalvenster wordt geopend.
  2. Selecteer Duits.
  3. Klik op OPSLAAN.

Om Duits te selecteren als uw standaardtaal: 

  1. Klik op de knop TAAL
  2. Selecteer Duits in het taalmenu. 
  3. Klik op OPSLAAN.

Beperk het gebruik van kruisverwijzingen om verwarring te voorkomen

Zo nu en dan wil je misschien kruisverwijzingen toevoegen aan je instructies. 

Misschien wil je een verwijzing maken naar een reeks stappen die elders in de gebruikershandleiding staat vermeld. Of wil je naar een hele topic verwijzen.

Voorbeeld van een kruisverwijzing naar de volledige topic Veiligheidsinformatie

Over het algemeen moet je kruisverwijzingen tot een minimum proberen te beperken. Het is niet heel gebruiksvriendelijk om je gebruikers steeds door de hele gebruiksaanwijzing te laten bladeren en dit werkt alleen maar verwarrend.

Het is over het algemeen prima om te verwijzen naar een volledige topic (zoals in het bovenstaande voorbeeld) die een aanvulling is op een bepaalde topic, maar wel op zichzelf staat. 

Het verwijzen naar een reeks stappen, zoals in het onderstaande voorbeeld, wordt niet aanbevolen.

Om de accu van uw eBike gereed te maken voor gebruik:

  1. Druk op de aan/uit-knop om de accu in te schakelen. Wanneer ten minste één led, maar niet alle leds van de accu-indicator gaat branden, moet de accu opgeladen worden. 
  2. Laad de accu op. Zie 2.1.2. Het opladen van de accu.

Gebruik een stijlgids om meer aandacht op details te vestigen

Het belang van consistentie heb ik al meerdere keren benadrukt, maar toch wil ik het hier nogmaals benoemen: het is van cruciaal belang dat termen, productelementen en eenheden op een consistente manier worden gebruikt. 

Gebruik altijd consistente terminologie in de gebruikershandleiding, op de verpakking, in andere bijkomstige materialen en op het product zelf (markering en etikettering).

En zinnen moeten natuurlijk grammaticaal correct zijn, geschreven zijn voor het doelpubliek en zo min mogelijk jargon bevatten.

Vermijd bovendien het gebruik van afkortingen en acroniemen, tenzij er verondersteld mag worden dat deze bekend zijn bij het publiek waar je voor schrijft. Als je wel besluit afkortingen of acroniemen te gebruiken, leg ze dan uit wanneer ze voor het eerst worden gebruikt of neem ze op in een woordenlijst. 

Laat marketingtaal achterwege: je schrijft een gebruikershandleiding, geen promotiemateriaal. De gebruiker heeft het product al gekocht.

Alle bovenstaande richtlijnen kunnen in een stijlgids worden geplaatst. Een stijlgids zorgt voor consistentie en stimuleert om alle details zorgvuldig te overwegen: de aanwezigheid van een stijlgids dwingt je om elke afzonderlijke zin nog eens goed te bekijken. 

Een stijlgids verbetert ook de begrijpelijkheid van de handleiding. 

Bekijk dit online voorbeeld van een stijlgids, de stijlgids van IBM of de stijlgids van SAP.

Wanneer je eenmaal je eigen stijlgids hebt opgesteld die bijvoorbeeld gericht is op schrijfstijl, formulering, consistent gebruik van termen, manieren om de lezers aan te spreken en tekstontwerp en pagina-indeling (dit bespreken we later), moet je ervoor zorgen dat je deze op de hele gebruiksaanwijzing toepast.

Waarborg de veiligheid van de gebruiker door woorden zoals moeten, mogen, dienen en kunnen op de juiste manier te gebruiken

Het juiste woordgebruik voor het aangeven van eisen en aanbevelingen is gestandaardiseerd in de Amerikaanse norm ANSI Z535.5.

Ondanks dat dit een Amerikaanse norm is, pas ik deze vaak ook toe op de gebruiksaanwijzingen die we voor andere markten schrijven.

De ANSI-norm stelt dat de juiste werkwoordsvorm voor het aangeven van een vereiste shall is (in het Nederlands mag). Het woord shall (mag) wordt geacht verplichtend te zijn. Het universeel aanvaarde gebruik van must (moet) in plaats van shall (mag) wordt door de norm niet erkend.

Bijvoorbeeld: Het product mag alleen worden gebruikt door personen die de gebruiksaanwijzing helemaal hebben gelezen en de inhoud ervan hebben begrepen.

De juiste werkwoordsvorm voor het aangeven van een aanbeveling, zoals gedefinieerd door de ANSI, is should (dient). Of om te spreken in ANSI-terminologie: dient wordt geacht adviserend te zijn.

Bijvoorbeeld: Na elk gebruik, dient het apparaat van de netspanning ontkoppeld te worden.

Wanneer er veel vrijheid van gedrag is of wanneer er geen garantie is dat er iets gebeurt, kan je het woord may (kan) gebruiken. Dit woord wordt als vrijblijvend opgevat. Het gebruik van might (zou kunnen) is niet toegestaan.

Bijvoorbeeld: Sommige personen kunnen een milde tinteling ervaren bij het eerste gebruik van het apparaat.

Ik heb een situatie meegemaakt waar de Amerikaanse douane een machine weigerde omdat de gebruiksaanwijzing deze woorden niet juist gebruikte.

Maak gebruik van probleemoplossing om je gebruiker tijd, frustratie en onrust te besparen

Ongeacht hoe goed een product of stukje software is ontworpen, er gaan ongetwijfeld dingen verkeerd tijdens gebruik. Als technisch schrijver moet je hier goed op letten.

Gebruikers van producten maken veel eenvoudige fouten. Het kan erg veel tijd kosten om die fouten te corrigeren. Volgens onderzoek [1], besteden gebruikers gemiddeld 25% tot 50% van hun tijd aan het corrigeren van fouten.

Daarom is het belangrijk om probleemoplossingsinformatie toe te voegen aan instructies die gebruikers mogelijk verkeerd zouden kunnen interpreteren.

Het verstrekken van probleemoplossingsinformatie EN het op de juiste plaats verstrekken van probleemoplossingsinformatie is één van de meest onderschatte aspecten van gebruikersdocumentatie. Er zijn verschillende manieren waarop goed ontworpen gebruikershandleidingen kunnen voorkomen dat gebruikers fouten maken.

Bijvoorbeeld door het verstrekken van een veilige reeks stappen, het gebruiken van korte en eenvoudige zinnen, het minimaliseren van jargon, het gebruiken van actieve werkwoorden, enz.

Maar hoe weet je nu welke probleemoplossingsinformatie je moet verstrekken?

Onderzoek [1] heeft aangetoond dat zelfs ervaren technisch schrijvers niet altijd kunnen voorspellen welke problemen er ontstaan wanneer hun documentatie wordt gebruikt. 

De beste manier om erachter te komen met welke problemen gebruikers te maken krijgen is door usability testing (testen van de bruikbaarheid). Zie Gebruikersonderzoek uitvoeren om te controleren wat je hebt geschreven.

Wanneer je de meest voorkomende problemen hebt gevonden, kan je probleemoplossingsinformatie aan je gebruiksaanwijzing toevoegen door een model te gebruiken met de volgende fasen: 

  • Identificeren het probleem;
  • Benoemen van het probleem; 
  • Verwerken van probleemoplossingsinformatie. 

Met andere woorden: zorg er bij het opstellen van probleemoplossingsinformatie voor dat het de gebruiker ondersteunt bij het opsporen, diagnosticeren en corrigeren van fouten.

Laten we eens naar een oud voorbeeld kijken:

 

Probleemoplossingsinformatie zoals gepresenteerd in een minimalistische gebruiksaanwijzing over WordPerfect.

Probleemoplossingsinformatie is het meest effectief wanneer deze zo dicht mogelijk bij de bron staat waar en wanneer het probleem zich voordoet. Dit is vaak direct na een bepaalde instructie.

Door op deze plaats probleemoplossingsinformatie te verstrekken, kan het probleem hopelijk worden gedetecteerd en opgelost, voordat het voor verdere problemen kan zorgen.

Een afzonderlijk hoofdstuk voor probleemoplossing, wat niet ongewoon is, is niet verkeerd, maar maakt het voor een gebruiker moeilijker om de informatie te verkrijgen en te begrijpen, aangezien deze niet in de juiste context staat. 

Wanneer je probleemoplossing op de juiste plaats verstrekt, bespaar je je gebruiker veel tijd, frustratie EN onrust bij het leren gebruiken van het product. 

Goed foutenbeheer zorgt er bovendien voor dat het leren gebruiken van het product effectiever wordt.

In deze podcast ga ik daar verder op in:

Let op de veiligheidsinstructies en stimuleer veilig gebruik

Mijn favoriete onderwerp is veiligheid. Waarom?

Ten eerste omdat het te maken heeft met naleving, wat een onderwerp is dat vaak over het hoofd wordt gezien door de meeste technische schrijvers. Alhoewel ik ze dat niet kwalijk kan nemen.

Het is behoorlijk moeilijk om informatie te vinden over naleving, productveiligheid en wat je precies in een gebruiksaanwijzing moet opnemen. De websites hierover kunnen behoorlijk overweldigend zijn.

Ten tweede houd ik van de tegenstrijdigheid tussen het creëren van zowel een conforme als gebruiksvriendelijke handleiding. 

Sommige technisch schrijvers waarschuwen te veel. Ik heb gebruikershandleidingen gezien met alleen maar waarschuwingen en vrijwel geen enkele instructie. 

Te veel waarschuwen staat loodrecht op een actiegerichte aanpak. Hoe denk je dat de gebruikerservaring is wanneer in een gebruiksaanwijzing van 40 pagina's de eerste daadwerkelijke instructie pas op pagina 32 staat, na meer dan 30 pagina's met waarschuwingen en procesbeschrijvingen?

Hier bestaat echter een oplossing voor die de gulden middenweg kiest!

Ten eerste wil ik uitleggen waarom er waarschuwingen in handleidingen moeten worden opgenomen.

Ongeacht hoe goed en veilig een product is ontworpen, vaak zijn er risico’s verbonden aan het gebruik van een product. Risico's kunnen worden geïdentificeerd door het uitvoeren van een risicoanalyse. 

Er is algemeen afgesproken (in internationale normen) dat er drie manieren zijn om die risico's te beperken:

Je kunt het ontwerp van het product aanpassen, het product of de gebruiker voorzien van veiligheidsmaatregelen (zoals veiligheidsvoorzieningen, persoonlijke beschermingsmiddelen) of veiligheidsinstructies verstrekken. 

Deze drie risicobeperkende maatregelen moeten in deze specifieke volgorde worden overwogen. Een gebruiksaanwijzing mag dus nooit worden gebruikt om te waarschuwen voor risico's wanneer het ontwerp verbeterd kan worden.

Als vuistregel moet je een waarschuwing geven waar het risico het hoogst is.

Bij een gebruikershandleiding kunnen er vier typen veiligheidsinstructies worden onderscheiden: aanvullende richtlijnen, gegroepeerde veiligheidsinstructies, veiligheidsinstructies voor een bepaalde sectie en ingesloten veiligheidsinstructies (zie dit bericht voor meer informatie hierover).

Zoals de naam al doet vermoeden, worden veiligheidsinstructies voor een bepaalde sectie aan het begin van een specifieke sectie geplaatst.

Voor de bruikbaarheid ervan kan je twee dingen doen. 

Je kunt bijvoorbeeld alle veiligheidswaarschuwingen opsommen die op die specifieke sectie betrekking hebben. 

Gezien het aantal waarschuwingen lijkt het gebruik van deze elektrische tandenborstel net zo gevaarlijk als werken in een kerncentrale. 

Maar een meer gebruiksvriendelijke manier is:

Ik wil niet suggereren dat je helemaal geen waarschuwingen moet gebruiken, maar in veel gevallen is het zeker mogelijk om het aantal waarschuwingen drastisch te verlagen.

Als je toch besluit om een waarschuwing te gebruiken in plaats van een instructie, zorg er dan voor dat je die waarschuwing goed opbouwt. 

Een goede waarschuwing bestaat uit drie onderdelen: 

  • Het soort en de bron van het gevaar;
  • De gevolgen bij niet-naleving;
  • Maatregelen om het gevaar te voorkomen.

Een waarschuwing wordt voorafgegaan door het signaalwoord Gevaar, Waarschuwing, Let op of Opmerking.

Tegenwoordig zijn de betekenissen van signaalwoorden vergelijkbaar in de verschillende beschikbare normen die de risiconiveaus beschrijven. 

 

ISO 3864-2

ANSI Z535.6

GEVAAR

Dit signaalwoord wordt gebruikt om een direct gevaarlijke situatie aan te geven die, indien niet vermeden, zal leiden tot de dood of ernstig letsel

Geeft een gevaarlijke situatie aan die, indien niet vermeden, zal leiden tot de dood of ernstig letsel. 

WAARSCHUWING

Dit signaalwoord wordt gebruikt om een mogelijk gevaarlijke situatie aan te geven die, indien niet vermeden, kan leiden tot de dood of ernstig letsel

Geeft een gevaarlijke situatie aan die, indien niet vermeden, kan leiden tot de dood of ernstig letsel.

LET OP

Dit signaalwoord wordt gebruikt om een mogelijk gevaarlijke situatie aan te geven die, indien niet vermeden, kan leiden tot licht of middelzwaar letsel.

Geeft een gevaarlijke situatie aan die, indien niet vermeden, kan leiden tot licht of middelzwaar letsel. 

OPMERKING

-

Duidt op informatie die belangrijk wordt geacht, maar niet op gevaar betrekking heeft.

En dit is hoe een veiligheidspaneel voor risico’s eruit moeten zien volgens ISO 3864 en ANSI:

ISO 3864-2 ANSI Z535
 

Aangezien ANSI ook de ISO-veiligheidspanelen heeft overgenomen, kan je ze veilig gebruiken voor verschillende markten.

Vermijd juridische valkuilen en stel je gebruiksaanwijzing conform de wet op

Afhankelijk van het product waar je voor schrijft kan het zijn dat er wettelijke vereisten zijn voor de inhoud, presentatie en opmaak van de gebruikershandleiding.

Deze kunnen afkomstig zijn van federale wetten in de VS, richtlijnen of verordeningen in de EU of soortgelijke wetgeving in andere landen of staten.

Normen kunnen worden gebruikt, zo niet verplicht worden gesteld, om aan de wettelijke eisen te voldoen.

Medische hulpmiddelen behoren bijvoorbeeld tot de zwaarst gereguleerde producten. In de VS is er de Guidance on Medical Device Patient Labelling, terwijl in de EU vereisten ten aanzien van gebruiksinstructies worden gegeven in de Richtlijn voor medische hulpmiddelen.

Door te voldoen aan wettelijke vereisten en normen toe te passen, weet je zeker dat je gebruiksaanwijzing rechtsconform is.

Hierdoor vermijd je mogelijke juridische valkuilen, komt je product gemakkelijker door de douane en eventuele testen, verminder je je aansprakelijkheid, behaal je mogelijk concurrentievoordeel en zorg je ervoor dat je gebruikers het product veiliger kunnen gebruiken.

Over het algemeen kan je het volgende proces volgen voor rechtsconforme handleidingen:

  • Identificeren van wetgeving (wetten/richtlijnen);
  • Identificeren van normen;
  • Identificeren van de wettelijke vereisten en normen die op het product van toepassing zijn;
  • Toevoegen van wettelijke inhoud aan de handleiding.

Voor zowel de Amerikaanse markt als de Europese markt heb ik dit proces uitgebreid beschreven. 

Ook kunnen deze templates je wellicht helpen bij het maken van rechtsconforme handleidingen voor je machines, elektronische apparaten, speelgoed, medische apparatuur, enz.

De gebruiksaanwijzing dient ook, net al de conformitietsverklaring en andere  documenten, in het technisch dossier te worden opgenomen.

Voeg navigatie-elementen toe om de vindbaarheid van informatie in je gebruiksaanwijzing te optimaliseren

Een essentieel onderdeel van een duidelijke gebruiksaanwijzing is de manier waarop je gebruiker naar de benodigde informatie kan navigeren. 

Een groot deel hiervan is al in het vorige hoofdstuk besproken. Maar er is meer nodig dan enkel het toevoegen van een inhoudsopgave, paginanummering, duidelijke kopteksten en een logische structuur.

In plaats van topics te rangschikken volgens de levenscyclus van een product (van uitpakken tot weggooien), wil je ze wellicht opsplitsen en rangschikken op gebruiksvolgorde, expertiseniveau (beginner of expert), functionele categorie of gebruiksfrequentie.

De volgorde van topics bepaalt grotendeels hoe snel gebruikers vinden waar ze naar op zoek zijn.

Je kunt deze rangschikking coderen met tabbladen of kleuren of je kunt het belang van bepaalde informatietypen benadrukken met contrast, kleur, schakering en vetgedrukte tekst, afhankelijk van hoe je je gebruiksaanwijzing presenteert (zie hoofdstuk 4).

Een andere manier om je gebruiker naar de juiste informatie te leiden is door het opnemen van een index of woordenlijst.

Een index is een alfabetische lijst met namen, trefwoorden, productelementen, levenscyclusfasen, enz. met verwijzing naar de pagina's waarop ze genoemd worden.

Zorg ervoor dat de index ook de meest voorkomende synoniemen bevat. 



Voorbeeld van een index

Een woordenlijst is een alfabetische lijst met woorden die betrekking hebben op het specifieke onderwerp waarover je schrijft, inclusief een korte uitleg. Het is dus eigenlijk een klein woordenboek.

 
Voorbeeld van een woordenlijst

Een ander voorbeeld van een woordenlijst

Controleer je gebruiksaanwijzing op fouten, deel 1

Nadat je al deze tips en voorbeelden voor het schrijven van de inhoud van je gebruiksaanwijzing hebt gebruikt, is het tijd om je werk te controleren.

Je hebt nu een conceptversie van je gebruikershandleiding. Intern noemen we deze versie het ontwerp van de tekstuele inhoud (deze term zou ook wel in de woordenlijst mogen, lol).

Vraag alle personen met diepgaande technische productkennis die informatie bijgedragen hebben om het werk tot dusverre te controleren. 

Ik werk hiervoor het liefst met een technical authoring tool of simpelweg met Google Doc. 

Gebruik hun feedback vervolgens om de gebruiksaanwijzing te optimaliseren. 

HOOFDSTUK 3 - Hoe maak ik duidelijk beeldmateriaal?

Als ik het over beeldmateriaal in gebruiksaanwijzingen heb, bedoel ik veel meer dan alleen screenshots of illustraties.

Beeldmateriaal omvat alle soorten grafische weergaven, zoals lijntekeningen, foto's, screenshots, video, symbolen, tabellen, grafieken, afbeeldingen en infographics.

Deze dienen allemaal een ander doel.

Gebruik illustraties om de tekst te verrijken

Je kunt lijnillustraties gebruiken voor het ondersteunen, vervangen of uitbreiden van tekst en om een chronologische volgorde van een te volgen proces of stappen te presenteren. 

Zorg ervoor dat de illustraties die je in je gebruikershandleiding plaatst logisch en begrijpelijk zijn.

Illustraties om een reeks stappen te beschrijven

Door illustraties zo dicht mogelijk bij de tekst te plaatsen waarop ze betrekking hebben, is het voor de gebruiker duidelijk bij welke tekstuele instructie ze horen. Zorg ervoor dat tekst en illustraties die bij elkaar horen tegelijkertijd zichtbaar zijn en dat ze elkaar ondersteunen om de begrijpelijkheid te verbeteren.

In tegenstelling tot foto’s heb je met illustraties veel meer vrijheid om je op belangrijke details te richten. Zo kan je minder relevante informatie gemakkelijk achterwege laten of bepaalde onderdelen juist vergroten.

Een voordeel van het volledig vervangen van tekst door illustraties, is dat illustraties niet vertaald hoeven te worden. Houd er wel rekening mee dat het creëren van begrijpelijke illustraties een vak apart is.

Hoewel er veel tools beschikbaar zijn die je kunt gebruiken, kan het een goed idee zijn om ze door een competente grafisch kunstenaar of technisch illustrator te laten maken. 

Houd bij het maken van illustraties rekening met de afdrukkwaliteit of de schermresolutie. Illustraties op schermen vereisen een resolutie van 72 dpi en voor afdrukken kan je het beste resoluties van minimaal 300 dpi gebruiken. 

Voeg genummerde bijschriften aan illustraties toe, zodat het voor de gebruiker duidelijk is waar de illustratie over gaat en deze gemakkelijk te identificeren is wanneer daar in de tekst naar wordt verwezen. 

Illustraties kunnen ook worden gebruikt om productonderdelen en hoofdfuncties te identificeren, een schematische versie van je product weer te geven of bijvoorbeeld het elektrische schema.

 
Illustratie die de belangrijkste productonderdelen aangeeft

Soms worden er foto's gebruikt in plaats van illustraties. Zelf gebruik ik echter liever lijnillustraties, omdat die vaak veel duidelijker zijn. 

 

Gebruik van een foto in een gebruiksaanwijzing die onze klant heeft gemaakt

 

Gebruik van een illustratie in een gebruiksaanwijzing die wij hebben gemaakt

Bij het maken van illustraties kan je eenvoudig irrelevante informatie weglaten of belangrijke informatie benadrukken. Met foto's is dat vaak ingewikkelder.

Screenshots kunnen worden gebruikt voor het visueel weergeven van de gebruikersinterface van een bedieningspaneel, software op een computer of een app. 

Screenshots kunnen ook worden gebruikt om een overzicht te bieden van functionaliteiten, te laten zien wat er moet worden gedaan, of om het resultaat van een bepaalde actie te weer te geven.

Screenshot met een overzicht van de belangrijkste functionaliteiten

Uitleg over het gebruik van een app in een gebruiksaanwijzing

Gebruik tabellen om gegevens te organiseren

Tabellen kunnen worden gebruikt om cijfers of tekst op een overzichtelijke manier te organiseren. Technische gegevens zijn bijvoorbeeld beter leesbaar wanneer ze in een tabel worden gepresenteerd. In veel gevallen kan een tabel de tekst volledig vervangen.

Zorg ervoor dat je tabellen duidelijk, informatief en op een consistente manier opstelt. Plaats tabellen waar mogelijk altijd naast de relevante tekst. Bij wijze van uitzondering kunnen referentietabellen (zoals een lijst met reserveonderdelen) als bijlagen worden toegevoegd.

Technische gegevens gepresenteerd in een tabel

Overweeg om video te gebruiken in plaats van illustraties

Video of animatie kan vele doelen dienen.

Als je iets duidelijk wilt demonstreren of een beweging, toestand of kracht wilt laten zien kan je het beste video gebruiken. Aangezien video steeds populairder wordt, is het ook een goede optie wanneer je doel is om zoveel mogelijk mensen te bereiken.

Video kan realistisch zijn (gefilmd met een camera), een 3D-animatie of een geïllustreerde animatie, zolang ze maar kort en relevant zijn.

Voorbeeld van een realistische videohandleiding

 

 

Voorbeeld van een 3D-animatie

Voorbeeld van een uitlegvideo in tekenfilmstijl 

Je kunt gesynchroniseerde gesproken of geschreven tekst, of beide, toevoegen om de video te begeleiden.   

Gebruik interactieve animaties om de effectiviteit en efficiëntie te verhogen

Een andere steeds belangrijkere vorm van animatie, is interactieve animatie. Interactieve animatie kan het best worden omschreven als een reeks visuele en auditieve elementen. Dit soort animatie is zeer geschikt om complexe processen uit te leggen, zoals een reeks installatie-instructies.

Wanneer correct toegepast (volgens minimalistische principes), zijn video en interactieve animatie vaak effectiever dan elke andere vorm van instructies.

Onderzoek toont aan dat kijkers informatie langer onthouden (waardoor het effectiever wordt) en dat kijkers sneller leren (waardoor het efficiënter wordt).



Voorbeeld van een online interactieve animatie volgens minimalistische principes

Houd er wel rekening mee dat voor video een stabiele internetverbinding nodig is. Dit maakt het een minder geschikte optie voor gebieden met een slechte ontvangst.

Let er ook op dat voor sommige producten of in bepaalde landen een papieren gebruiksaanwijzing verplicht kan zijn. Ga er dus niet zomaar vanuit dat je een papieren gebruiksaanwijzing door een video kan vervangen.

Kijk als voorbeeld maar eens naar deze ongelooflijk grappige video van de vliegmaatschappij Virgin America, waarin ze hun veiligheidsinstructies presenteren.

Gebruik infographics, afbeeldingen, grafieken en diagrammen om patronen te laten zien, gegevens te organiseren en te visualiseren, verbanden te tonen, overzichten te creëren, enzovoort.

Gebruik symbolen als je taalonafhankelijk wilt communiceren

In gebruikershandleidingen worden vaak symbolen, pictogrammen en veiligheidstekens gebruikt. Ze worden gekenmerkt door een vooraf gedefinieerde en duidelijk identificeerbare betekenis en worden gebruikt om informatie taalonafhankelijk over te brengen.

De betekenis wordt gecreëerd door een combinatie van kleur en geometrische vorm.

Veel symbolen, pictogrammen en tekens zijn gestandaardiseerd. Enkele veel gebruikte normen zijn:

  • ISO 7010 - Grafische symbolen – Veiligheidskleuren en -tekens – Geregistreerde veiligheidstekens
  • ISO 3864 - Grafische symbolen – Veiligheidskleuren en -tekens
  • ANSI Z535.6 - Productveiligheidsinformatie in producthandleidingen, instructies en andere bijkomstige materialen
  • IEC 60617 - Grafische symbolen voor diagrammen
  • ISO 14617 - Grafische symbolen voor diagrammen
  • ISO 5807 - Informatieverwerking – Documentatiesymbolen en -conventies voor gegevens-, programma- en systeemstroomdiagrammen, programmanetwerkdiagrammen en systeembrondiagrammen

Stroomdiagramsymbolen volgens ISO 5807

 

Veiligheidspanelen volgens ISO 3864

Veiligheidspanelen volgens ANSI Z535.6

Wanneer een grafisch concept wordt weergegeven door een grafisch symbool dat in een norm geregistreerd is, wordt het ten zeerste aanbevolen om dat symbool te gebruiken. 

Voorbeelden van duidelijke pictogrammen volgens ISO 7010

Voor het weergeven van objecten of functies kunnen pictogrammen gebruikt worden. Zorg ervoor dat elk pictogram uniek is en consistent wordt gebruikt. Gebruik nooit verschillende pictogrammen voor hetzelfde object of dezelfde functie. 

Lees dit artikel voor meer informatie over wanneer je het beste tekst of beeldmateriaal kunt gebruiken.

HOOFDSTUK 4 - Hoe presenteer ik mijn gebruiksaanwijzing?

Gelukkig zien steeds meer bedrijven het belang in van zowel een aantrekkelijk ontwerp als het gebruik van verschillende media om de informatie op de lezer over te brengen. 

‘User experience’ (gebruikerservaring) wordt steeds populairder! Daarom is een gebruiksaanwijzing van Samsung, Delonghi, Philips of Huawei vaak goed te begrijpen.

Handleidingen in gebrekkig Chinees-Engels of een eenvoudige MS Word-handleiding, die is geschreven en opgemaakt door één van de ingenieurs, zijn binnenkort iets van het verleden. 

Er zijn veel manieren om het gebruik van een product aan een gebruiker te communiceren. Bepaal het medium voor de informatie op basis van de behoeften van het doelpubliek.

Zorg ervoor dat het medium gedurende de beoogde levensduur van het product eenvoudige toegang biedt tot de informatie. Houd daarom altijd rekening met de levensduur van het product en vermeld de levensduur eventueel in de gebruikershandleiding. 

Voorbeelden van mogelijke media voor gebruikersinstructies zijn tekst, beeldmateriaal (foto's, veiligheidstekens, grafische symbolen en illustraties), video (inclusief hulpmiddelen zoals audio en ondertitels), animaties, spraak, braille, augmented reality, virtual reality, brochures of gebonden boekjes met tekst, illustraties en informatie op de verpakking of het product zelf.

Hoewel de regelgeving steeds minder strikt wordt, moet je ervoor zorgen dat je te allen tijde op de hoogte bent van alle wettelijke vereisten met betrekking tot de publicatievorm in het land waarin je het product verkoopt. Lees ook dit artikel over online publicatie.

Door gebruik te maken van een technical authoring tool kan je met dezelfde single-sourced (enkelvoudige bron) inhoud zowel online als geprinte gebruikersinstructies creëren.

 
Single-sourcing met MadCap Flare

Ongeacht het gekozen medium is het ook belangrijk om de informatie voor zowel het medium als het doelpubliek aan te passen.

Een gebruiker met een visuele beperking heeft bijvoorbeeld baat bij een groter lettertype.

Laten we nog wat andere ontwerpbeginselen bekijken.

Maak doelgericht en effectief gebruik van kleur.

Zorg voor veel witruimte.

Gebruik een duidelijk, leesbaar schreefloos (sans-serif) lettertype. Zorg ervoor dat de grootte van het lettertype aansluit op de behoeften van het publiek. Vermijd het gebruik van meerdere lettertypen.

Gebruik een vetgedrukt, cursief of courier-lettertype voor terminologie, referentie-informatie of andere input.  

Hier wordt een vetgedrukt lettertype gebruikt om de productelementen aan te geven

Cursieve tekst kan gebruikt worden om andere secties aan te geven.

Gebruik waar nodig lettergewicht om belangrijk tekst te markeren.

Zorg voor een hoog contrast tussen tekst en achtergrond. Zwarte tekst op een witte achtergrond werkt het beste.

Maak consequent gebruik van kleurcodering en pas, indien nodig, normen toe.

Gebruik voor elke pagina een consistente lay-out.

Raadpleeg voor informatie die op internet beschikbaar wordt gemaakt de ISO/IEC 40500:2012 voor toegankelijkheidsrichtlijnen met betrekking tot de navigatie en presentatie van inhoud. 

Eventuele informatie die op het product wordt afgedrukt of gegraveerd, moet leesbaar blijven gedurende de levensduur van het product.

Wanneer informatie alleen op de verpakking van het product of in materialen die het product begeleiden wordt gegeven, moet je ervoor zorgen dat deze duurzaam zijn. De materialen moeten bestand zijn tegen regelmatig gebruik gedurende de levensduur van het product en in een omgeving waarvoor het product bedoeld is om te gebruiken.

Overweeg ook de taal van je gebruikershandleiding. 

Het is algemeen aanvaard, en in de meeste gevallen zelfs verplicht, om de instructies te verstrekken in de taal van het land waar het product verkocht wordt. 

 
Voor eenvoudige verspreiding worden deze instructies in 24 talen verstrekt

HOOFDSTUK 5 – Hoe kan ik mijn gebruiksaanwijzing voltooien en verspreiden?

In hoofdstuk 2 (tekst) en 3 (beeldmateriaal) hebben we de inhoud van de gebruiksaanwijzing behandeld en in hoofdstuk 4 de vorm, dus het wordt nu tijd voor de laatste fase.

Het eerste wat je nu moet doen is je gebruiksaanwijzing proeflezen. Proeflezen is het inhoudelijk controleren van de gebruiksaanwijzing op fouten.

Je kunt dit uitbesteden, wat ik persoonlijk zou aanraden, of zelf doen.

Soms kan het lastig zijn om je eigen werk te proeflezen en eventuele fouten te herkennen. Wanneer je je eigen werk doorleest, lezen je hersenen het namelijk zoals het geschreven had moeten zijn. Dit wordt cognitieve blindheid genoemd.

De meeste professionele vertaalbureaus bieden proefleesdiensten aan.

En misschien moet de gebruikershandleiding ook wel vertaald worden naar de taal van je doelpubliek.

Nadat het proeflezen is voltooid, heb je een goed uitgangspunt voor de vertalingen. Over het algemeen is een gebruiksaanwijzing in het Engels vaak het beste uitgangspunt voor een vertaling. 

Waarom?

Omdat het in de Engelse taal eenvoudiger is om duidelijke instructieve zinnen te maken, zoals ‘Push the On/Off button’ (Druk op de aan/uit-knop). In het Duits is dit bijvoorbeeld ‘Drücken Sie den Ein/Aus Schalter’.

Als de brontaal Duits zou zijn, had de vertaler deze zin misschien verkeerd geïnterpreteerd en vertaald als ‘U kunt nu op de aan/uit-knop drukken’, omdat de vertaler het woord ‘Sie’ in een zin wil gebruiken en misschien niet weet dat de zin met een actief werkwoord moet beginnen. 

Bovendien is vertalen vanuit het Engels naar een andere taal goedkoper, aangezien Engels de meest gesproken tweede taal ter wereld is. Het is gemakkelijker om iemand te vinden die vanuit het Engels naar het Nederlands vertaalt dan vanuit het Nederlands naar het Engels.

Wanneer je een vertaler zoekt voor je handleiding, probeer er dan een te vinden met vergelijkbare vertaalervaring.

Dit kan een vertaler zijn die ervaring heeft met het vertalen van technisch materiaal, het vertalen van vergelijkbare producten of het vertalen van gebruikershandleidingen.

Wanneer de gebruiksaanwijzing in meerdere talen moet worden vertaald, kan je veel tijd besparen door een vertaalbureau in te schakelen, aangezien zij vaak het complexe projectmanagement kunnen overnemen.

Overweeg ook om de vertaler of het vertaalbureau te vragen naar hun kwaliteitsprocedures en wie de tekst na de vertaling gaat corrigeren. 

Veelgebruikte normen in de vertaalindustrie zijn ISO 17100 voor vertaaldiensten en ISO 9001 voor kwaliteitsmanagementsystemen.

Ook is er de IEC/IEEE 82079-1:2019, die competentievereisten voor vertalers van technische documenten biedt. 

Volgens de norm moeten vertalers over basiscompetenties beschikken, zoals vermeld in vaardigheidsniveau 1, zowel de brontaal als de doeltaal vloeiend spreken, moedertaalsprekers van de doeltaal zijn en bekend zijn met het type product en eventuele productspecifieke terminologie.

Omdat je zelf al weet wie je publiek is en hoe het product werkt, kan je de kwaliteit van de vertalingen verbeteren door de vertaler of het vertaalbureau een woordenlijst te verstrekken of een lijst met termen die je wilt gebruiken.

Zoek een vertaler die direct vanuit het MS Word-, Google Doc- of InDesign-bestand kan werken of zoek een vertaalbureau dat ook de DTP-werkzaamheden kan verrichten. 

De tool die je gebruikt voor het creëren van je uiteindelijke gebruiksaanwijzing bepaalt grotendeels hoe de output, de DTP en het vertaalproces wordt georganiseerd.

Tools zoals Word en InDesign worden het meest gebruikt voor handleidingen. 

Wanneer je verschillende handleidingen voor soortgelijke producten en/of in verschillende talen moet creëren, kan het een groot voordeel zijn om een CCMS te gebruiken. De meeste van deze tools zijn gebaseerd op industriestandaarden, zoals XML, CSS en XLIFF

Enkele van de beschikbare tools zijn Paligo, MadCap Flare, Author-it, Framemaker, Oxygen XML en SCHEMA ST4. 

Deze tools hebben als uitgangspunt het hergebruiken van inhoud. Door de inhoud duidelijk van de vorm te scheiden, kan het output-proces worden geautomatiseerd, terwijl er bij InDesign vaak nog veel tijd aan DTP moet worden besteed. 

Bovendien bieden de meeste CMS- of CCMS-tools voor technisch schrijven de mogelijkheid om met dezelfde inhoud zowel online als geprinte output te creëren.

Vergeet bij het afdrukken van je gebruiksaanwijzing niet om een papiersoort te gebruiken die bij de kwaliteit van het product past.

Nadat je de instructies hebt voltooid en gepubliceerd, of misschien voordat je dit gaat doen, kan je een bruikbaarheidstest uitvoeren om te controleren of je gebruikers ook daadwerkelijk begrijpen wat je hebt opgeschreven.

Gebruik hiervoor echte gebruikers die je publiek vertegenwoordigen en niet ontwerpers of productexperts.

Houd de deelnemers aan het gebruikersonderzoek goed in de gaten wanneer ze de gebruiksaanwijzing gebruiken om een bepaalde handeling uit te voeren. 

Kijk waar ze er snel doorheen bladeren, wanneer ze in de war raken, wanneer ze volledig de weg kwijtraken of wanneer het ze niet lukt om een taak uit te voeren. Je kunt het onderzoek ook opnemen en later analyseren.

Luister goed naar wat de gebruikers te zeggen hebben en gebruik deze informatie vervolgens om je gebruiksaanwijzing te verbeteren en eventuele probleemoplossingsinformatie toe te voegen (zie Maak gebruik van probleemoplossing om je gebruiker tijd, frustratie en onrust te besparen).

Om een geweldige eerste indruk te maken heb je misschien besloten om doelgericht en effectief gebruik te maken van kleur of contrast. Of kleurcodering voor een betere navigatie. 

Bij het gebruik van kleur of contrast, moet je niet vergeten rekening te houden met de behoeften van een gebruikers met een handicap, zoals visuele beperkingen of kleurenblindheid. 

Test tijdens het bruikbaarheidsonderzoek ook het gebruik van kleuren in je handleiding, zodat je zeker weet dat gebruikers met kleurenblindheid ze ook begrijpen. 

Overweeg om voor gebruikers met een handicap alternatieve handleidingen aan te bieden in braille, een druk met grote letters, audio, enz.

Conclusie

Het is duidelijk dat er veel komt kijken bij het schrijven van een gebruikershandleiding. En ik heb alleen nog maar over de belangrijkste onderwerpen gehad!

Als je écht goede instructies wilt schrijven, zul je veel moeten oefenen.

Of zoals Macolm Gladwell in zijn bestseller “Outliers” beschrijft, er is meer dan 10.000 uur nodig om een vaardigheid te beheersen. 

Ik hoop dat ik je met deze samenvatting een aantal nuttige tips heb kunnen gegeven voor het schrijven van een goede gebruikershandleiding.

Ook hoop ik dat je door de tips in dit artikel op te volgen en de voorbeelden te bekijken, vanaf nu nog betere gebruiksinformatie kunt creëren.

Dus neem alle informatie in je op voor geweldige instructies!

Ik zou het erg op prijs stellen als je hieronder een opmerking achterlaat als je dit artikel nuttig vindt.

WIL JE WETEN HOE JE EEN RECHTSGELDIGE HANDLEIDING VOOR DE EU MAAKT?

Stap-voor-stap methode voor het maken van een rechtsgeldige handleiding en om valkuilen te voorkomen.

LEES ARTIKEL