U zoekt op: {{ keyword }}

Wij helpen je om een heldere handleiding te maken

#1 Bepaald de doelgroep
#2 Verzamel alle informatie
#3 Bepaal een logische structuur
#4 Schrijf heldere instructies
#5 Maak duidelijke illustraties
#6 Voldoe aan de wettelijke vereisten
#7 Implementeer de veiligheids-waarschuwingen
#8 Maak een fantastische lay-out content
#9 Bepaal het format
#10 Vertaal de handleiding
#11 Manage de content

Verkoop je producten zorgeloos met een handleiding die aan de wettelijke eisen voldoet, die gebruiksvriendelijk is door heldere teksten en illustraties, en ook nog eens mooi is vormgegeven. De meeste bedrijven richten zich alleen op het maken van teksten, waarbij design en compliance weinig tot geen aandacht krijgen. Lees verder als je wilt weten hoe wij een handleiding maken, zoals de handleiding voor de Gazelle Faraday D5?

handleiding Gazelle

En met illustraties zoals in deze handleiding voor Electrolux?

handleiding electrolux

En die aan de wettelijke eisen voldoet zoals de machinehandleiding voor Van der Waay Machinebouw?

handleiding van der waay machinebouw

Met een onlinehandleiding, zoals die voor Vogel's?

online help

 VRAAG EEN OFFERTE AAN


Deze 11 stappen helpen je om een
gebruiksvriendelijke handleiding te maken

 

 

1

Bepaald de doelgroep 

De eerste stap bij het maken van elke handleiding is het definiëren van de gebruikers. Dit doen we door vragen te stellen als:

  • Wie zijn de gebruikers?
  • Wat is typerend voor de gebruikers?
  • Welke talen spreken ze?
  • Wat is hun achtergrond?
  • Wat is hun leeftijd, geslacht, …?
  • Gebruiken ze het product professioneel, commercieel of privé?
  • Welke technische ervaringen, kwalificaties, opleiding, training en kennis hebben ze?
  • Welke taken moeten ze uitvoeren?
  • Hoe vaak voeren ze die taken uit?
  • In welke omgeving wordt het product gebruikt?
  • Hebben gebruikers toegang tot internet?
  • Staan gebruikers onder druk?

Hoe meer we weten over de gebruikers, hoe beter we kunnen bepalen wat belangrijk voor hen is. Hiermee voorkomen we dat er zaken worden uitgelegd die de gebruiker al weet of niet relevant zijn.

Bovendien zijn het vaak de gebruikers die bepalen wat voor soort handleiding er nodig is. Wil je klantenservicemedewerkers ondersteuning bieden met een onlinetool? Of een installatiehandleiding maken voor een technicus? Of wordt het een gebruiksaanwijzing voor een consument?

Meestal beschrijven we de gebruikers in de inleiding van de handleiding, zoals in het volgende voorbeeld.

Deze handleiding is bedoeld voor de eindgebruiker van de [naam machine]. De eindgebruiker kan worden omschreven als elke persoon die rechtstreeks met de machine omgaat. Eindgebruikers zijn doorgaans, maar niet uitsluitend:

  • Installateurs
  • Uitvoerders
  • Onderhoudstechnici
  • Demontagepersoneel
In dit voorbeeld kun je goed zien dat er voor een product verschillende soorten gebruikers kunnen bestaan. Gebruikers (ongeacht de doelgroep) lezen vaak een handleiding pas op het moment dat ze iets gedaan moeten krijgen of een probleem willen oplossen.

Deze taken of problemen zijn altijd specifiek voor die doelgroep, zoals:

  • Hoe bevestig ik het onderstel van mijn magnetron?
  • Hoe vervang ik de matrijs van mijn machine?
  • Wat betekent het rode, knipperende ledlampje?
  • Kan ik mijn monitor reinigen met allesreiniger?
  • Hoe voeg ik een nieuwe gebruiker toe?

Door vooraf de doelgroepen te bepalen, verzamelen we de juiste informatie voor verschillende gebruikers van hetzelfde product. Bovendien helpt het om consistente handleidingen te maken, waardoor een handleiding blijft aanvoelen als een geheel.


2

Verzamel alle informatie

Bij het maken van een handleiding, zorgen we er altijd voor dat we het product 100% begrijpen.

Dit doen we door het product te gebruiken en te analyseren, experts te interviewen en bestaand materiaal te bestuderen.

We installeren het product, drukken op alle knoppen, openen klepjes, identificeren signalen, klikken door wizards, en ga zo maar door.

Vaak is er al aardig wat informatie beschikbaar, zoals bestaande handleidingen, een risicoanalyse of marketinginformatie. Ook deze informatie bestuderen we, zodat we een volledig begrip hebben van de werking van het product gedurende de totale levenscyclus: van aankoop tot verwijdering.

Kritisch zijn is een onderdeel van onze taak. Daarom gebruiken we alleen informatie die we volledig begrijpen en kunnen valideren.

Op deze manier ontstaat er stapsgewijs een compleet beeld van het product. Alle resterende vragen leggen we voor aan de experts om het product voor 100% te begrijpen.

De gebruikerstaken zijn het uitgangspunt voor het verzamelen van alle informatie en de interviews met de SMEs (Subject Matter Experts) van de opdrachtgever. Alle verzamelde informatie organiseren we in de volgende stap van het proces.


3

Bepaal een logische structuur

Voor een handleiding is een duidelijke structuur van cruciaal belang.

De informatie die in de vorige stap is verzameld en al deels geanalyseerd, moet goed en logisch worden georganiseerd, in duidelijke topics waardoor gebruikers gemakkelijk de antwoorden kunnen vinden op hun vragen.

inhoudsopgave maken

In technische communicatie is topic-based schrijven een modulaire benadering van contentcreatie, waarbij de content is gestructureerd rond onderwerpen (topics) die kunnen worden gemengd en hergebruikt in verschillende contexten. Een topic heeft een duidelijk begin en einde.

Het organiseren van de informatie rondom topics is een van de meest uitdagende taken van een technisch auteur. De verzamelde informatie moet worden geanalyseerd, begrepen, geselecteerd, verwijderd, georganiseerd en gestructureerd.

topics maken

Wanneer een gebruikerstaak te complex is en een lezer moeite heeft om de informatie tot zich te nemen, wordt het onderwerp opgesplitst in deelonderwerpen.

Zo maakten we bijvoorbeeld een installatie- en bedieningshandleiding voor een machine die glazen daken van kassen reinigt: de Roof Washer. Het gebruiksklaar maken van deze machine was een van de belangrijkste gebruikerstaken.

Omdat dit voor deze machine een enorm topic zou worden, hebben we de informatie opgedeeld in verschillende deelonderwerpen:

  • De inhoud van de verpakking controleren
  • Het mobiele platform voorbereiden
  • De Roof Washer voorbereiden
  • De Roof Washer op de kas plaatsen
  • Hoe stel ik het mobiele platform af?
  • Hoe stel ik de Roof Washer af?
  • De hoofdborstels afstellen
  • De raambeveiligingsschakelaar afstellen (optioneel)
  • De gootborstel afstellen (optioneel)
  • De hendels van de voorwielschakelaar afstellen

Idealiter worden alle topics duidelijk en herkenbaar in de inhoudsopgave of menustructuur georganiseerd, aan de hand van de levenscyclus van het product. Een topic kan een hoofdstuk of een (sub)paragraaf zijn.

Wanneer gebruikers een probleem ondervinden en de handleiding raadplegen om daar een antwoord op te vinden, zullen ze zeer waarschijnlijk naar de inhoudsopgave gaan om te zien waar ze dat antwoord kunnen vinden.

Een duidelijke inhoudsopgave helpt snel de juiste informatie te vinden

Een duidelijke inhoudsopgave helpt de gebruiker snel de juiste instructies te vinden, zonder de hele handleiding door te hoeven spitten.

Het heeft dus onze voorkeur om de onderwerpen in een inhoudsopgave te organiseren op basis van de behoeften van de gebruikers en aan de hand van de levenscyclus van het product.

Vaak gebruiken we een standaardinhoudsopgave als basis. Tijdens het verzamelen van alle informatie en het bepalen van de onderwerpen, zoals beschreven in Stap 2, vullen we de inhoudsopgave aan met product specifieke onderwerpen.

standaard inhoudsopgave
Voorbeeld van een standaard inhoudsopgave

We gebruiken verschillende methoden en tools, zoals mindmaps, information maps of gewoon Post-It’s om de inhoud te structureren en te organiseren. Maar het kan ook voorkomen dat een inhoudsopgave on the go ontstaat.

mindmap

Voorbeeld van een mindmap voor een softwarehandleiding

Een ander punt dat van cruciaal belang is om gebruikers snel oplossingen te laten vinden via de inhoudsopgave, is om een goede, betekenisvolle kop voor elk hoofdstuk te kiezen.

De koppen van alle hoofdstukken worden in de inhoudsopgave opgenomen. De inhoudsopgave wordt door gebruikers geraadpleegd. Het is belangrijk om gebruikers te ondersteunen om zo snel mogelijk het onderwerp te vinden dat de informatie bevat die zij in de handleiding zoeken.

betekenisvolle kop

Voorbeeld van een kop die de inhoud duidelijk dekt

Koppen in een handleiding hebben meerdere, belangrijke functies:

  • Ze bieden een organisatorisch overzicht van de handleiding.
  • Ze tonen de logische structuur van de productinformatie, gebaseerd op de levenscyclus van het product.
  • Ze tonen de hiërarchische relatie van onderwerpen (koppen, sub-koppen).
  • Ze stellen de gebruiker in staat om snel naar de juiste pagina te navigeren.
  • Ze stellen de gebruiker in staat om over te slaan wat niet van toepassing is.

Een kop geeft de grens aan tussen de onderwerpen en de deelonderwerpen van een handleiding. Daarbij dekt een goede kop de volledige inhoud van het topic. Het is daarom van belang om een betekenisvolle koptekst te gebruiken en een consistente stijl en opmaak toe te passen, zodat gebruikers gemakkelijk de informatie vinden die ze zoeken.

De kop ‘Hoe maak ik pannenkoeken?’ is bijvoorbeeld veel gebruikersvriendelijker dan ‘De MagicMix2000 gebruiken’.


4

Schrijf heldere instructies

Ons hoofddoel is om handleidingen te maken die een ​​veilig, efficiënt en effectief gebruik van een product kunnen garanderen.

Het uitgangspunt hierbij is om instructies te maken die zo helder mogelijk zijn. Om dit voor elkaar te krijgen, zijn er enkele zaken waar we rekening mee moeten houden. 

Vermijd jargon

Allereerst proberen we als we een handleiding maken het gebruik te vermijden van terminologie die geen deel uitmaakt van het vocabulaire van de lezer.

Bekijk het volgende voorbeeld:

Je kunt gerust zeggen: “Draai de onderste naderingsschakelaar stevig vast.” Het gebruik van onderste naderingsschakelaar is een noodzakelijk gebruik van een technische term. 

Je gebruikt echter te veel jargon, wanneer je zegt: “Oefen voldoende torsie uit op de onderste naderingsschakelaar om ervoor te zorgen dat het geheel van naderingsschakelaars stevig aan de oprijplaat is bevestigd en losraken onder extreme weersomstandigheden niet mogelijk is.”

Overdadig jargon komt vaak voor in handleidingen die door technici zijn geschreven.

De meeste technisch experts voelen zich meer op hun gemak in een wereld van cijfers, processen en technische principes dan in een wereld van woorden. Zij houden zich liever bezig met dingen voor elkaar krijgen en resultaten behalen, dan met het communiceren over de manier waarop dat gedaan moet worden.

Al die cijfers, technische termen en ingewikkelde zinnen zijn niet altijd nodig om duidelijk informatie te verschaffen. We zien het als onze taak om technische informatie te fileren, terminologie te verduidelijken, relevante informatie te selecteren, en de communicatie hiervan aan te passen aan de gebruiker (zie Stap 1).

Kies de informatiebronnen weloverwogen

Handleidingen bestaan in principe uit drie soorten informatie:

  • Instructieve informatie
  • Conceptuele informatie
  • Referentie-informatie

Instructieve informatie bestaat meestal uit een reeks stappen die de gebruikers opdragen bepaalde handelingen te verrichten. Ook veiligheidsinstructies worden beschouwd als instructieve informatie.

Soms heeft een gebruiker achtergrondinformatie of een korte uitleg nodig, om de instructies te begrijpen of de relevatie ervan te bepalen. Dit soort informatie wordt contextuele informatie genoemd.

instructieve en conceptuele infromatieInstructieve informatie

conceptuele informatie
Contextuele en instructieve informatie

Referentie-informatie verwijst de gebruiker naar aanvullende informatie.

Elk topic kan een combinatie van instructieve, contextuele en referentie-informatie bevatten.

Een van de belangrijkste vaardigheden van een technisch communicatiespecialist is om een goede balans te vinden tussen de verschillende soorten informatie. Een balans tussen het verschaffen van hulp bij het uitvoeren van handelingen enerzijds, en het verstrekken van essentiële conceptuele informatie anderzijds.

Schrijf taakgerichte instructies

Gebruikers willen dingen gedaan krijgen en er niet eindeloos over lezen. Om die reden moeten instructies een duidelijk doel hebben, taakgericht en to the point zijn. Dit is ook terug te vinden in de principes van het minimalisme.

Een taakgerichte benadering is het uitgangspunt bij zowel het maken van een handleiding in zijn geheel, als voor de afzonderlijke stappen die daarin worden beschreven. Een gebruiker moet altijd zo snel mogelijk worden ondersteund om een actie te voltooien.

Door contextuele informatie spaarzaam in te zetten en de focus te verleggen naar de procedure, kan een gebruiker worden verleid om in actie te komen.

Bekijk het volgende voorbeeld.

taakgerichte benadering

Deze pagina van de handleiding van een drone bevat twee stappen. Dit zijn de laatste twee van de zes stappen in het installatieproces. Elke stap is zuiver taakgericht.

Plaats instructies in de juiste volgorde

Creëer opeenvolgende stappen die in de juiste volgorde worden geplaatst. Volg daarbij de timing van de taak die moet worden uitgevoerd.

Houd ook binnen een enkele zin de juiste volgorde aan.

Bekijk het volgende voorbeeld.

De instructie …

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

… is veel gebruiksonvriendelijker dan …

Om Duits als uw standaardtaal te selecteren:

  1. Ga naar Bestand > Taal
  2. Selecteer Duits

Schrijf duidelijke instructies

Maak de instructies in handleidingen niet te lang. Korte, eenvoudige zinnen met slechts één instructie, of hoogstens een klein aantal nauw verwante commando’s per zin, werken het best.

De informatie moet zo eenvoudig en zo kort mogelijk worden verstrekt. Instructies moeten in de tegenwoordige tijd en in een actieve vorm worden geschreven, waarbij sterke werkwoorden worden gebruikt.

Een actieve stem richt zich tot gebruikers en spreekt hen direct aan. Dit maakt het voor gebruikers gemakkelijker om de instructies te lezen en te begrijpen.

Het onderwerp en het werkwoord zijn altijd duidelijk in zinnen met een actieve stem. Bijvoorbeeld:

Sluit een toetsenbord aan op de USB-poort van het apparaat.

In deze zin is ‘aansluiten’ het actieve werkwoord en zijn de woorden ‘toetsenbord’, ‘USB-poort’ en ‘apparaat’ allemaal onderwerpen.

Laten we die zin vergelijken met dezelfde zin in passieve vorm:

Er moet een toetsenbord worden aangesloten op de USB-poort van het apparaat.

Door de actieve stem in het eerste voorbeeld is het veel duidelijker dat de lezer de persoon is die de actie moet voltooien.

Door een actieve stem te gebruiken, worden instructies in de handleiding duidelijker, beknopter en directer.

actieve stem

actieve vorm

Consistentie draagt bij aan een betere gebruikerservaring

Consistentie is een van de belangrijkste kenmerken bij het maken van een duidelijke handleiding. Door bijvoorbeeld de namen van productelementen consequent te gebruiken, kan verwarring gemakkelijk worden voorkomen.

Consistentie is cruciaal

Consistentie is ook cruciaal bij de opmaak van specifieke vormen informatie, zoals bij veiligheidswaarschuwingen, opsommingen of praktische tips.

Een consistente opmaak en formulering helpen gebruikers bij het identificeren van de informatie waarnaar ze op zoek zijn. Door een eenduidige opmaak van een veiligheidswaarschuwing en het consistent gebruik van signaalwoorden (zoals GEVAAR, WAARSCHUWING en VOORZICHTIG), wordt de aandacht gevestigd op de veiligheidsmelding, omdat de gebruiker deze ook visueel zal herkennen als een veiligheidsmelding.

Wanneer informatietypen consequent worden opmaakt, zullen lezers deze (bewust of onbewust) gaan herkennen en koppelen aan de functie van het informatietype.

Bekijk dit voorbeeld van een handleiding die we voor Gazelle hebben gemaakt. De koppen, opmerkingen, contextuele informatie, instructies, productelementen en illustraties zijn allemaal informatietypen die consistent zijn opgemaakt. 

consistentie

Gebruik Simplified Technical English om ondubbelzinnige teksten te schrijven

Bij voorkeur passen we de regels van Simplified Technical English toe op onze teksten.

Het gebruik van Simplified Technical English helpt om consistente en ondubbelzinnige teksten te schrijven.

Houd er rekening mee dat de woorden die u kiest een enorme impact kunnen hebben op de betekenis of de begrijpbaarheid van uw teksten en handleidingen.

Laten we het Engelse woord ‘SET’ eens nader bekijken. Dit eenvoudige woord kan onder andere betekenen: aanpassen, afstemmen, fixeren én positioneren. Het is dus van groot belang om het woord zo te gebruiken dat de betekenis ervan altijd duidelijk is. 

Nog steeds niet overtuigd? Laten we eens kijken naar het volgende voorbeeld.

Turn off the engines not required

Deze zin kan twee dingen betekenen:

  • Zet de motoren uit die niet nodig zijn.
  • Het uitzetten van de motoren is niet nodig.

De standaard ASD-STE100 Simplified Technical English bestaat uit een woordenboek om dit soort dubbelzinnigheden te voorkomen.

Het woordenboek is een lijst van slechts 850 woorden die mogen worden gebruikt. Het woordenboek bevat vermeldingen van zowel goedgekeurde als niet-goedgekeurde woorden. De goedgekeurde woorden kunnen alleen worden gebruikt in overeenstemming met hun gespecificeerde betekenis. Het woord close kan bijvoorbeeld alleen in een van de volgende twee situaties worden gebruikt:

  • Het bedienen van een stroomonderbreker om een ​​elektrisch netwerk te maken.
  • Iets in een positie brengen waardoor verhinderd wordt dat er materialen naar binnen of naar buiten gaan.

Het woord close mag dus alleen als werkwoord worden gebruikt en niet als bijwoord. De zin “Do not go close to the test rig during the test” is een voorbeeld van ​​niet-goedgekeurd gebruik van het woord close.

We hebben ons eigen onlinewoordenboek gemaakt om te controleren of een woord is geoorloofd in handleidingen of niet: Online Technical English Dictionary.

Gebruik een stijlgids voor een consistente tone of voice

Een stijlgids helpt bij het handleiding maken om een consistente tone of voice en stijl te houden.

Het is cruciaal om termen, productelementen en eenheden op een consistente manier uit te drukken.

Terminologie moet zowel in de handleiding als op de verpakking, op het product zelf (markering en etiketten) en op alle overige uitingen consistent worden gebruikt.

Natuurlijk moeten zinnen grammaticaal correct zijn, geschreven worden voor de juiste doelgroep en jargon beperkt worden.

We vermijden het gebruik van afkortingen en acroniemen, tenzij er aangenomen kan worden dat de doelgroep ze kent. En indien ze worden gebruikt, dan worden termen uitgelegd wanneer ze voor het eerst in de tekst verschijnen.

 De voorgaande richtlijnen kunnen in een stijlgids worden vastgelegd. Een stijlgids zorgt voor samenhang en stimuleert om goed over alle details na te denken: de aanwezigheid van een stijlgids dwingt je om elke zin goed te bekijken.

Een stijlgids vergroot de mate van begrip van een tekst

Zodra de stijlgids is opgesteld, waarin onder andere schrijfstijl, woordgebruik, zinsopbouw, terminologie, ontwerp en lay-out (we zullen dit later bespreken) worden beschreven, kun je deze toepassen op de volledige gebruiksaanwijzing.

We hebben onze eigen stijlgids ontwikkeld die we gebruiken voor als we weer een handleiding maken.

Gebruik de ANSI Z535.6 voor duidelijke veiligheidswaarschuwingen

Het correct gebruik van woorden om eisen en aanbevelingen te communiceren, is vastgelegd in de Amerikaanse ANSI Z535.5-norm.

Ook al is het een Amerikaanse norm, we gebruiken deze norm wanneer we handleidingen voor andere markten maken.

De ANSI-standaard bepaalt dat het juiste werkwoord voor het aanduiden van een vereiste shall is. Het woord shall moet hier worden beschouwd als een verplichting. Het algemeen aanvaarde gebruik van must in plaats van shall wordt niet erkend door de norm. Bijvoorbeeld:

The product shall only be used by persons who have fully read and understood the contents of the user manual.

Het juiste werkwoord voor het aanduiden van een aanbeveling, zoals gedefinieerd in de ANSI-standaard, is should. Of om in ANSI-termen te spreken: should moet hier worden beschouwd als een advies. Bijvoorbeeld:

After each use, the device should be disconnected from the mains.

Wanneer er sprake is van een grote mate van vrijheid, of als er geen garantie bestaat dat er iets zal gebeuren, kan het woord may worden gebruikt. Dit woord moet dan worden beschouwd als iets vrijblijvends. Het gebruik van might is daarentegen niet toegestaan. Bijvoorbeeld:

Some individuals may experience a mild tingling sensation when first using the device.

Er zijn situaties bekend waarbij de Amerikaanse douane niet toestond dat een machine vanuit Nederland werd geïmporteerd, omdat de handleiding deze woorden niet correct volgens de ANSI-standaard gebruikte.

Een handleiding maken waarbij deze termen consistent zijn gebruikt, zorgt dus niet alleen voor heldere teksten, maar voorkomt ook problemen.

ANSI


5

Maak  duidelijke illustraties 

Onder visuals in handleidingen wordt meer verstaan dan screenshots of illustraties.

Visuals bevatten allerlei grafische voorstellingen, zoals lijntekeningen, foto’s, screenshots, video’s, symbolen, tabellen, grafieken en infographics.

Elk type visual dient een ander doel. 

Gebruik van de IKEA-stijl voor illustraties

We staan bekend om het maken van lijnillustraties volgens de IKEA-stijl. We gebruiken deze manier van illustreren om teksten te ondersteunen, te vervangen of aan te vullen. Maar ook om de volgorde van een proces weer te geven.

Illustraties dragen bij aan een beter begrip van wat er moet gebeuren.

illustratie maken

De volgorde van de afbeeldingen die in de handleiding worden geplaatst, moet logisch en begrijpelijk zijn.

volgorde illustraties

Vergeleken met foto’s geven illustraties veel meer mogelijkheden om te focussen op belangrijke details. Het is gemakkelijker om minder relevant beeld weg te laten of om bepaald beeld te 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 voor het maken van begrijpelijke illustraties voor je handleiding bepaalde vaardigheden nodig zijn.

Hoewel er vele tools beschikbaar zijn die hierbij kunnen helpen, is het verstandig ze te laten maken door een vaardige grafisch ontwerper of technisch illustrator.

illustraties maken

Bij het maken van illustraties wordt irrelevante informatie weggelaten en wordt belangrijke informatie benadrukt. Omdat dit een stuk ingewikkelder is om met foto’s te doen, gebruiken we ze liever niet.

Gebruik screenshots voor GUI-voorstellingen

Screenshots worden gebruikt om de interface van een bedieningspaneel, software op een desktopcomputer of een app visueel weer te geven.

Screenshots kunnen een overzicht geven van de functionaliteiten, laten zien wat er moet gebeuren, of het resultaat van een bepaalde handeling laten zien.

schermafbeelding

Gebruik tabellen om gegevens te ordenen

We gebruiken tabellen om numerieke of tekstuele gegevens te ordenen. Technische gegevens zijn bijvoorbeeld beter leesbaar wanneer ze in een tabel worden gepresenteerd. In veel gevallen kan een tabel een tekst volledig vervangen.

Het is belangrijk om tabellen op een duidelijke, informatieve en consistent vormgegeven manier op te bouwen.

Meestal worden tabellen bij de tekst geplaatst waar ze betrekking op hebben. Soms worden referentietabellen (zoals een lijst met reserveonderdelen) als bijlage in een handleiding geplaatst.

tabellen maken

Overweeg het gebruik van video’s in plaats van illustraties

Een video of animatie kan meerdere doelen bereiken.

Het gebruik van video kan de juiste keuze zijn wanneer het belangrijk is om iets te demonstreren, een beweging, een toestand of kracht weer te geven. Omdat het gebruik van video steeds populairder wordt, is het mogelijk om hier steeds meer mensen mee te bereiken.

 Video’s, 3D-animaties en geïllustreerde animaties kunnen zeer doeltreffend zijn, zolang ze kort en relevant zijn.


6

Voldoe aan de wettelijke vereisten

Afhankelijk van het product waarvoor de handleiding wordt gemaakt, is de kans groot dat er wettelijke vereisten zijn verbonden aan de inhoud, uitingsvorm en opmaak van de handleiding.

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

Ook normen kunnen worden gebruikt, indien niet verplicht gesteld, om te voldoen aan de (CE-)eisen.

webshop-ce

Machines en medische hulpmiddelen zijn bijvoorbeeld de meest streng gereguleerde productgroepen. In de EU zijn de eisen voor handleidingen voor deze productgroepen vastgelegd in de Machinerichtlijn en de Medical Device Regulation.

Moeten we een handleiding maken die voldoet aan de eisen van de Machinerichtlijn, dan wordt de geharmoniseerde norm EN ISO 20607:2019 (Machineveiligheid – Instructiehandboek – Algemene regels voor het opstellen) gebruikt.

Een andere belangrijke norm voor het maken van handleidigen is de IEC/IEEE 82079-1:2020 (Preparation of information for use (instructions for use) of products – Part 1: Principles and general requirements).

Door alle wettelijke eisen en relevante normen toe te passen, maken we handleidingen die aan de wet voldoen.

Hiermee worden juridische valkuilen vermeden, doorstaan producten testen en douanecontroles, wordt het risico op aansprakelijkheid verminderd, kan er een concurrentievoordeel ontstaan en kunnen gebruikers het product veiliger gebruiken.

Over het algemeen volgen we het volgende proces om handleidingen te maken die aan alle wettelijke eisen te voldoen:

  • Identificatie van wetgeving (wetten/richtlijnen)
  • Identificatie van normen
  • Identificatie van eisen van de wetgeving en normen van toepassing op het product
  • Het toevoegen van juridische content aan de handleiding

VRAAG EEN OFFERTE AAN

Vaak gebruiken we een van onze templates om een handleiding te maken voor een machine, elektronisch apparaat of medische apparatuur.

Het beoogd gebruik: het hart van de handleiding

Een heldere handleiding beschrijft hoe een product moet worden gebruikt in overeenstemming met zijn functie en binnen de verwachte levensduur van het product.

De functie van een product wordt ook wel het ‘beoogde gebruik’ van een machine of apparaat genoemd.

Een heldere beschrijving van het beoogde gebruik vormt het hart van een handleiding en bepaalt (met andere gebruiksbeperkingen, zoals technische en/of milieubeperkingen) het veilige kader waarbinnen een product kan worden gebruikt: het is de basis voor een veilig, efficiënt en effectief gebruik van het product.

De beschrijving van het beoogde gebruik omkadert de aansprakelijkheid en is het uitgangspunt voor de verdere inhoud van de handleiding.

Zodra het beoogde gebruik is vastgesteld, richten we ons op het verstrekken van veiligheids- en gebruikersinformatie voor het gebruik van het product voor dit beoogde doel.

 Wetgeving met betrekking tot de gebruiksveiligheid, zoals richtlijnen en normen, vereisen dat de meeste producten een beschrijving van het beoogde gebruik bevatten.

De eerdergenoemde IEC/IEEE 82079-1:2020 (de internationale norm voor instructies bij gebruik) geeft de volgende definitie voor het beoogde gebruik:

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

 Bekijk dit voorbeeld van het beoogde gebruik:

beoogd gebruik


7

Implementeer de veiligheids-waarschuwingen

Veiligheid is een van onze favoriete onderwerpen. Dit belangrijke aspect van compliance wordt door veel technische schrijvers en bureaus vermeden of over het hoofd gezien.

We houden van het spanningsveld dat ontstaat bij het maken van een gebruiksvriendelijke handleiding die tegelijkertijd aan de voorschriften voldoet.

Sommige technische schrijvers willen graag te veel waarschuwingen geven. Vaak zien we handleidingen met overwegend waarschuwingen en nauwelijks instructies.

Te veel waarschuwen staat haaks op een actiegerichte aanpak (zie Stap 4). Wat ervaart een gebruiker als in een 40 pagina’s tellende handleiding de eerste echte instructie op pagina 32 staat, na meer dan 30 pagina’s met waarschuwingen en procesbeschrijvingen?

Er is een oplossing voor, die in het midden ligt!

L aten we eerst eens kijken waarom we altijd een handleidingen maken waarin waarschuwingen zijn opgenomen.

Hoe goed en veilig een product ook is ontworpen, het gebruik van een product brengt vaak bepaalde risico’s met zich mee. Deze risico’s kunnen worden geïdentificeerd door het uitvoeren van een risicoanalyse.

Over het algemeen kan (op basis van internationale normen) worden aangenomen dat er drie manieren zijn om die risico’s te verminderen: je kunt het ontwerp van het product aanpassen, het product of de gebruiker uitrusten met veiligheidsmaatregelen (zoals beveiligingen, persoonlijke beschermingsmiddelen) en veiligheidsinstructies geven.

Deze drie risicobeperkende maatregelen moeten in deze specifieke volgorde worden beschouwd. Een handleiding maken die wordt gebruikt om te waarschuwen voor risico’s wanneer het ontwerp nog kan worden verbeterd, is uit den boze.

De vuistregel is om de gebruiker te waarschuwen daar waar de kans het grootst is dat het risico zich voordoet.

Voor een handleiding betekent dit dat er vier soorten veiligheidsinstructies kunnen worden onderscheiden: aanvullende richtlijnen, gegroepeerde veiligheidsboodschappen, veiligheidsboodschappen in secties en ingesloten veiligheidsboodschappen.

Het gedeelte met gegroepeerde veiligheidsberichten (meestal het hoofdstuk VEILIGHEID) kan minder overweldigend overkomen als er alleen veiligheidsinstructies worden opgenomen die van toepassing zijn op de hele levenscyclus van het product, van installatie tot verwijdering.

Veiligheidsboodschappen in secties zijn alleen van toepassing op een specifieke sectie, bijvoorbeeld op de installatie. Ze worden meestal aan het begin van een specifieke sectie geplaatst.

sectie waarschuwing

Als het gaat om gebruiksvriendelijkheid, is het mogelijk om twee dingen te doen. Allereerst zouden alle veiligheidswaarschuwingen kunnen worden opgesomd die betrekking hebben op dat specifieke onderdeel.

veiligheidswaarschuwing maken

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

Een meer gebruiksvriendelijke aanpak zou zijn:

installatie instructie

We zeggen niet dat er helemaal geen waarschuwingen moeten worden gebruikt, maar in veel gevallen is het mogelijk om het aantal waarschuwingen drastisch te verminderen.

Ingesloten veiligheidsberichten zijn ingebed bij de daadwerkelijke instructies.

Als we besluiten een waarschuwing te geven in plaats van een instructie, zorgen we ervoor dat de waarschuwing de juiste structuur heeft.

 Een goede waarschuwing bestaat uit drie delen:

  1. het type en de bron van het gevaar;
  2. de gevolgen bij niet-naleving;
  3. maatregelen om het gevaar te vermijden.

Waarschuwingen worden voorafgegaan door de signaalwoorden ‘gevaar’, ‘waarschuwing’, ‘let op’ of ‘mededeling’.

waarschuwing

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

ansi


8

Maak een fantastische lay-out content

handleiding cover maken

Gewoon een handleiding maken en meeleveren in een simpel MS Word-document behoort tot het verleden.

Gebruikers willen vaak zowel online als in gedrukte vorm toegang hebben tot informatie. En hoe deze informatie eruitziet, is een belangrijk onderdeel van de klantervaring.

online handleiding maken

Naast een mooi ontwerp dragen ook opmaakprincipes bij aan een betere gebruikerservaring. Zoals het kiezen van het juiste lettertype en lettergrootte, doelmatig en effectief gebruik van kleur, gebruik van witruimte, contrast, enzovoort.

design handleiding maken

Voor informatie die online beschikbaar wordt gesteld, gebruiken we de ISO/IEC 40500:2012-richtlijnen voor toegankelijkheid van inhoud voor zowel presentatie als navigatie.

template handleiding maken


9

Bepaal het format

Hoewel het voor veel producten nog verplicht is om de handleiding, of in ieder geval de veiligheidsinstructies, gedrukt aan te leveren, zien we een langzame verschuiving. Voor sommige producten kunnen de instructies al volledig digitaal worden geleverd en voor andere producten kan een hybride oplossing mogelijk zijn, zodat er bespaard kan worden op afdrukkosten waardoor de impact op het milieu kan worden verminderd.

Deze ontwikkeling biedt kansen om een ​​betere gebruikerservaring te creëren door gebruik te maken van media zoals video, AR, onlinehelp of interactieve handleidingen.

Beschikbare CCSM- of CSM-oplossingen (technical authoring tools) ondersteunen het maken van handleidingen of andere gebruikersinstructies in verschillende formats.

Omdat er vele manieren zijn om het gebruik van een product met de gebruiker te communiceren, is het belangrijk om het format van de informatie te bepalen op basis van de behoeften van de doelgroepen.

Het format moet gemakkelijk toegang bieden tot de informatie gedurende de beoogde levensduur van het product.


10

Vertaal de handleiding

Nu de inhoud (tekst en beeld) en structuur (template) voor de handleiding zijn gemaakt, moet de concepthandleiding worden beoordeeld.

Wij vragen onze klanten altijd om ervoor te zorgen dat alle personen met diepgaande technische productkennis die hebben bijgedragen aan het leveren van informatie, het werk beoordelen.

Het beoordelingsproces kan worden uitgevoerd via de beoordelingsfunctie van een technical authoring tool of eenvoudig via Google Docs. Nadat de feedback is gegeven, kan de handleiding worden afgerond.

Na de technische beoordeling is het tijd om de handleiding te laten proeflezen. Proeflezen is het proces van het onderzoeken van de handleiding op taalfouten.

Omdat het door cognitieve blindheid lastig is om je eigen werk te proeflezen, wordt het proeflezen door een professioneel vertaalbureau gedaan.

Zodra de proeflezing is voltooid, is het startpunt bereikt voor de vertalingen. Over het algemeen is men het erover eens dat een Engelse handleiding het beste startpunt is voor vertalingen.

Het liefst maken wij de originele handleiding in het Engels. In de Engelse taal is het namelijk gemakkelijker om duidelijke instructiezinnen te maken, zoals “Push the On/Off button”. In het Duits zou dit bijvoorbeeld “Drücken Sie den Ein/Aus Schalter” zijn.

In het laatste geval zou deze gemakkelijk vertaald kunnen worden naar: “Je kunt nu op de aan/uit-knop drukken” als een vertaler zich niet volledig bewust is van het belang om zinnen in een handleiding te beginnen met een actief werkwoord.

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

Wij zorgen er altijd voor dat een handleiding wordt vertaald door een vertaler met een vergelijkbare vertaalervaring. Dit kan een vertaler zijn die ervaring heeft met het vertalen van technische inhoud, het vertalen van vergelijkbare producten of het vertalen van handleidingen.

Om de kwaliteit van de vertalingen te verhogen, kunnen wij de vertaler of het vertaalbureau voorzien van een verklarende woorden- of een terminologielijst.

Het gebruik van een CMS of CCMS kan handig zijn wanneer een handleiding in meerdere talen moet worden gemaakt of aangepast. Een vertaalgeheugen beheert hierin de content en laat alleen de nog niet vertaalde content vertalen.


11

Manage de content

Wanneer je handleidingen nodig hebt voor vergelijkbare producten en/of in meerdere talen, kan het gebruik van een CCMS ook een groot voordeel zijn. De meeste van deze tools zijn gebaseerd op standaarden, zoals XML, CSS, TMX en XLIFF.

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

Deze tools hebben het hergebruik van content als uitgangspunt. Door de duidelijke scheiding van inhoud en vorm is het outputproces geautomatiseerd, in tegenstelling tot bijvoorbeeld Adobe InDesign, waarbij meerdere dtp-uren per handleiding nodig zijn om een handleiding op te maken.

Bovendien maken de meeste CMS- of CCMS-tools die bedoeld zijn voor technisch schrijven, het mogelijk om zowel online- als gedrukte output te creëren op basis van dezelfde inhoud.

Op basis van de wensen van onze klant kiezen wij het CMS/CCMS dat het best bij hen past.

CCMS

Wij helpen bij het maken van uw handleidingen

Planning is essentieel voor het maken van een hoogwaardige handleiding. Echter, over het maken van een handleiding wordt vaak te laat nagedacht. Een gemiste kans, omdat het vastleggen van essentiële informatie een cruciaal onderdeel is bij de ontwikkeling van een product.

Mede hierdoor hebben wij, op basis van het innovatieproces dat bij productontwikkeling wordt gebruikt, een methode ontwikkeld om binnen een relatief korte periode de perfecte handleiding te maken: het INSTRKTIV vijfstappenproces.

Dit proces bestaat uit de volgende fasen:

  1. Vaststellen van het wettelijk kader
  2. Productanalyse en het schrijven van content
  3. Illustraties maken
  4. Templates maken
  5. Output genereren

Ons team bestaat uit professionals met uiteenlopende expertises. Deze in-house experts zijn juristen, technische schrijvers en tekenaars, ontwerpers, CMS-experts, vertalers en dtp’ers.

Enthousiast geworden over de mogelijkheden?

Neem dan eens contact met ons op.

NEEM CONTACT OP



Vraag direct een offerte aan!

Vraag een offerte aan