U zoekt op: {{ keyword }}

Hoe je heldere werkinstructies maakt

Ferry Vermeulen Werkinstructies

In dit artikel laat ik zien hoe wij voor onze klanten heldere werkinstructies maken, die aan wettelijke eisen voldoen.

Werkinstructies kunnen betrekking hebben op procedures van bijvoorbeeld machines, of op andere processen binnen een organisatie. 

Goede communicatie over bijvoorbeeld het bedienen, gebruiken, onderhouden en oplossen van storingen van een machine, is de sleutel tot een veilig, effectief en efficiënt gebruik. Door personen binnen een organisatie professionele gebruiksaanwijzingente bieden, zul je tevredenere en veiligere gebruikers hebben die efficënter werken en zul je risico's beperken.

Wilt je weten hoe je goede werkinstructies kunt maken, zoals deze werkinstructies voor Sabic:

werkinstructie

Of zoals deze werkinstructie uit de handleiding voor Van der Waay Machinery?

werkinstructie

Of deze werkinstructie voor een bandingmachine:

werkinstructie voorbeeld

En deze werkinstructie voor dezelfde machine, maar dan opgenomen in de handleiding?

machine werkinstructie

Na het lezen van dit artikel ben je misschien in staat om ZELF werkinstructies schrijven, zonder een diploma in werktuigbouwkunde, technische communicatie, ontwerp EN recht te hebben.

Volg de tips voor het maken van werkinstructies uit dit artikel.

INHOUDSOPGAVE

Wat is een werkinstructie?
Wat moet er in werkinstructies staan?
Hoe schrijf ik duidelijke teksten?
Hoe kan ik duidelijke beelden maken voor mijn werkinstructies?
Hoe presenteer ik mijn werkinstructies?
Conclusie

Wil je werkinstructies combineren tot een handleiding en vraag je je af of het product - en dus ook de handleiding- aan de machinerchtlijn moet voldoen? Kijk deze video om te bepalen of dat zo is.

 

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!

Wat is een werkinstructie?

Een werkinstructie is een instructie voor een bepaalde gebruiker om specifieke taken en werkzaamheden zelfstandig uit te kunnen voeren. Werkinstructies kunnen betrekking hebben op procedures van machines of op processen binnen organisaties. Werkinstructies kunnen separaat bij een machine of installatie worden geleverd, worden opgenomen in een handleiding, per email worden verspreid, of beschikbaar worden gesteld via een kennisbank. Heldere werkinstructies zijn de basis voor een veilig en efficiënt gebruik of het effectief uitvoeren van taken.

Kenmerken van werkinstructies zijn:

  • Een werkinstructie is taak- en actiegericht.
  • Een werkinstrucie is helder beschreven zodat de bedoelde gebruiker zelfs het werk kan uitvoeren als deze dit voor het eerst doet.
  • Het detailleringsniveau van de werkinstructie sluit aan bij het kennisniveau van de bedoelde gebruiker.
  • Indien alle werkinstructies zijn gecombineerd tot één document is er vaak sprake van een handleiding of instructiehandboek. In dat geval maken de instructies vaak deel uit van de levering van een product en moet deze aan wettelijke eisen voldoen.

Ik richt me in dit artikel met name op handleidingen en werkinstructie maken voor machines en installaties. De voorbeelden die worden gebruikt, zijn of separate werkinstructies, of komen uit een handleiding waarin de werkinstructies zijn gebundeld.

Wat moet er in werkinstructies en handleidingen voor machines staan?

Laten we eerst even kijken naar het verschil tussen werkinstructies en een instructiehandboek. 

Onder instructiehandboek verstaan we een gebruikershandleiding voor een machine. Deze bestaat uit diverse instructies, zoals instructies om een machine te installeren of te gebruiken. 

Werkinstructies zijn separate instructies voor bijvoorbeeld de operator of onderhoudspersoneel. Ze bevatten belangrijke infromatie over het bedienen van een machine, of over hoe te handelen tijdens kalamiteiten. Deze informatie staat over het algemeen ook in het instructiehandboek, maar vaak wordt er gekozen voor losse werkinstructies om aan interne veiligheids-, gezondheids en omgevingsrichtlijnen te voldoen. 

Werkinstructies voor machines moeten de volgende informatie bevatten:

  • Alle informatie voor de beoogde gebruikers van de machine, zodat zij de machine tijdens de levenscyclus van de machine veilig en efficiënt kunnen gebruiken.

Er moet ook een instructiehanboek zijn om te voldoen aan wettelijke vereisten. Een instructiehandboek moet de volgende inhoud hebben:

  • Alle wettelijk verplichte inhoud (zoals beschreven in de Machinerichtlijn en relevante standaarden), waaronder:
    • Veiligheidswaarschuwingen als gevolg van de risicoanalyse;
    • Veiligheidsboodschappen zoals vereist door de normen voor het specifieke type machine;
    • Een duidelijke beschrijving van het beoogde gebruik en redelijkerwijs te voorzien verkeerd gebruik;
    • Relevante onderdelen zoals gegeven door de IEC / IEEE 82079-1: 2019 Gebruiksinstructies en ISO 20607 Machine Veiligheid - Instructie handboek - Algemene regels voor het opstellen.

Afhankelijk van de machine waarvoor je een instructiehandboek maakt, is de kans groot dat er wettelijke vereisten zijn voor de inhoud, presentatie en opmaak van de werkinstructies.

Deze kunnen afkomstig zijn van federale wetten in de VS, of richtlijnen of verordeningen in de EU.

Normen kunnen worden gebruikt, of verplicht gesteld, om aan de vereisten te voldoen.

Medische hulpmiddelen zijn bijvoorbeeld de strengst gereguleerde producten. In de VS is er de Guidance on Medical Device Patient Labelling, terwijl in de EU vereisten voor gebruiksinstructies worden gegeven in de Verordening Medische Hulpmiddelen.

Door te voldoen aan de wettelijke vereisten en normen toe te passen, kan je ervoor zorgen dat je gebruikershandleiding rechtsconform is. 

Hierdoor vermijd je juridische valkuilen, komen je machines gemakkelijker door tests en de douane, heb je minder aansprakelijkheid, meer concurrentievoordeel en kunnen je gebruikers de machine veiliger gebruiker. 

Over het algemeen kan je het volgende proces volgen, wil je conforme handleidingen of werkinstructies maken:

  • Identificeer wetgeving (wetten/richtlijnen);
  • Identificeer normen;
  • Bepaal de wettelijke vereisten en normen die van toepassing zijn op je machine;
  • Voeg wettelijke informatie toe aan de werkinstructies.

Ook kunnen deze templates je helpen bij het opstellen van conforme handboeken en werkinstructies.

Neem alle vereisten van de Machinerichtlijn op 

Volgens de machinerichtlijn moeten alle instructiehandboeken, waar van toepassing, ten minste de volgende informatie bevatten:

  1. firmanaam en volledig adres van de fabrikant en van diens gemachtigde; 
  2. typeaanduiding van de machine als aangegeven op de machine zelf, met uitzondering van het serienummer;
  3. EG-verklaring van overeenstemming, ofwel de conformiteitsverklaring;
  4. een algemene beschrijving van de machine; 
  5. de tekeningen, schema's, beschrijvingen en toelichtingen die nodig zijn voor het gebruik, onderhoud en herstellen van de machine en voor de controle op de correcte werking ervan; 
  6. een beschrijving van de werkplek(ken) die door de bedieners kan (kunnen) worden ingenomen; 
  7. een beschrijving van het beoogde gebruik van de machine; 
  8. waarschuwingen betreffende te ontraden gebruik dat, naar uit ervaring is gebleken, van de machine kan worden gemaakt;
  9. instructies voor de montage, installatie en aansluiting van de machine, met inbegrip van tekeningen, schema's en de bevestigingsmiddelen, en aanduiding van het chassis of de installatie waarop de machine moet worden gemonteerd; 
  10. instructies voor een zodanige installatie en montage dat het geluid en de trillingen worden beperkt;
  11. instructies voor de inbedrijfstelling en het gebruik van de machine en zo nodig instructies voor de opleiding van de bedieners;
  12. informatie over de restrisico's die, ondanks de geïntegreerde veiligheid bij het ontwerp van de machine en de genomen beschermingsmaatregelen en bijkomende voorzieningen, blijven bestaan;
  13. instructies inzake de door de gebruiker te nemen beschermende maatregelen, waaronder, in voorkomend geval, de te voorziene persoonlijke-beschermingsuitrusting; 
  14. de essentiële kenmerken van de gereedschappen die op de machine kunnen worden gemonteerd; 
  15. de voorwaarden waaronder de machines voldoen aan de stabiliteitseis tijdens gebruik, vervoer, montage en demontage, alsmede wanneer zij buiten bedrijf zijn, tijdens beproevingen en bij voorzienbare storingen; 
  16. instructies met het oog op een veilig vervoer, verplaatsen en opslaan, met vermelding van de massa van de machine en van de verschillende delen ervan, indien zij regelmatig afzonderlijk moeten worden vervoerd; 
  17. de te volgen werkwijze bij ongevallen of storingen; indien blokkering kan optreden, de werkwijze volgens welke de blokkering zonder risico kan worden verholpen;
  18. de beschrijving van de afstellings- en onderhoudswerkzaamheden die de gebruiker moet verrichten alsook de in acht te nemen voorkomingsmaatregelen; 
  19. instructies met het oog op een veilig afstellen en onderhoud, met inbegrip van de daarbij te nemen beschermingsmaatregelen;
  20. specificaties betreffende de te gebruiken vervangingsonderdelen, indien deze van invloed zijn op de gezondheid en de veiligheid van de bedieners; 
  21. de volgende informatie over de emissie van luchtgeluid:
    • de A-gewogen geluidsemissiedruk op de werkplekken, voor zover deze hoger is dan 70 dB(A); als het niveau lager of gelijk is aan 70 dB(A), dan moet dit worden vermeld, 
    • de maximale waarde van de C-gewogen momentane geluidsemissiedruk op de werkplekken, wanneer deze meer dan 63 Pa bedraagt (130 dB ten opzichte van 20 µPa), 
    • het A-gewogen niveau van het door de machine uitgestraalde geluidsvermogen, indien het niveau van de A-gewogen geluidsemissiedruk op de werkplekken hoger is dan 80 dB(A). 
  22. indien de machine niet-ioniserende straling kan uitzenden die gevaarlijk kan zijn voor personen, in het bijzonder personen met actieve of niet-actieve implanteerbare medische hulpmiddelen, informatie over de hoeveelheid uitgezonden straling waaraan de bediener en eventuele andere personen zijn blootgesteld.

DOWNLOAD DE CHECKLIST VOOR MACHINES EN CONTROLEER
OF JE HANDLEIDING AAN DE EISEN VOLDOET


CE marking

Deze video laat je exact zien hoe je de wettelijk verplichte inhoud voor de gebruikershandleiding voor een machine kunt bepalen:

HIER KOPEN

Voer een risicoanalyse uit en neem alle veiligheidsinstructies op

Hoe goed en veilig een machine ook is ontworpen, het gebruik van een machine brengt vaak bepaalde risico's met zich mee. Risico's kunnen worden geïdentificeerd door een risicoanalyse uit te voeren. 

Door een gestructureerde risicobeoordeling uit te voeren, worden alle gevaren in verband met het hanteren van een bepaalde machine in kaart gebracht en beoordeeld op eventuele risico's, om vervolgens het risico te kunnen verminderen.

Algemeen wordt overeengekomen (in internationale normen, zoals de ISO 12100) dat er drie manieren zijn om die risico's te verminderen:

Zo kan ervoor kiezen om het ontwerp van je machine aan te passen, de machine of gebruiker te voorzien van veiligheidsmaatregelen (zoals beveiliging, persoonlijke beschermingsmiddelen) of veiligheidsinstructies te geven. 

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

Een risicoanalyse geeft het gevaar, het risiconiveau en de risicobeperkende maatregel aan.

Wanneer de risicobeperkende maatregel het verstrekken van veiligheidsinformatie is, kan dit worden gedaan door middel van veiligheidsinstructies op de machine, bij de machine (in de vorm van werkinstructies) of door middel van een handleiding.

risicobeoordeling

Onderzoek normen en neem alle voorgeschreven veiligheidsboodschappen op in de werkinstructies

Wetgeving, zoals de machinerichtlijn, vereist dat machines veilig moeten zijn, maar geeft niet precies aan hoe veiligheid kan worden bereikt.

Daar zijn normen voor. Geharmoniseerde Europese normen geven nadere invulling aan de essentiële eisen die in de richtlijnen zijn vastgelegd. De geharmoniseerde Europese normen in het kader van de Machinerichtlijn zijn onderverdeeld in type A, B en C normen.

Type A-normen zijn fundamentele veiligheidsnormen.

Type B-normen hebben betrekking op een specifiek veiligheidsaspect en zijn van toepassing op machines waarop het afgedekte veiligheidsapparaat of veiligheidsaspect van toepassing is.

Type C-normen hebben betrekking op specifieke categorieën machines en zijn onderverdeeld in een aantal hoofdgroepen, zoals handgereedschap, elektrisch gereedschap, hijsmachines, pompen en compressoren.

Hoofdstuk 4 van een type C-norm bevat een lijst met gevaren. Hoofdstuk 7 beschrijft wat er in instructies moet worden vermeld, naast de gebruikelijke zaken zoals uitleg over de functie en bediening van de machine.

Vanuit het perspectief van de ontwerper (of fabrikant) is het raadzaam om te controleren of de in de relevante C-norm aangegeven gevaren ook daadwerkelijk aanwezig zijn bij zijn machine.

Niet alle beschreven gevaren zijn van toepassing op elke machine. Anderzijds betekent dit niet automatisch dat als een gevaar/risico niet in de norm wordt beschreven, dit niet bestaat of niet relevant is.

Beschrijf zorgvuldig het beoogde gebruik en redelijkerwijs te voorzien verkeerde gebruik

Het doel van een machine wordt ook wel het beoogde gebruik genoemd.

De volgende definitie voor het beoogde gebruik wordt gegeven door de internationale norm voor gebruiksinformatie IEC/IEEE 82079-1: 2019: 

Een uitgebreide reeks functies of voorziene toepassingen die zijn gedefinieerd en ontworpen door de leverancier van het product

Een duidelijke beschrijving van het beoogde gebruik vormt de kern van werkinstructies en bepaalt (samen met andere gebruiksbeperkingen, zoals technische of milieubeperkingen) de veilige grenzen voor het gebruik van de machine: het is de basis voor een veilig, efficiënt en effectief gebruik van machines.

werkinstructie

Een werkinstructie die de veilige gebruiksgrenzen beschrijft.

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

De Machinerichtlijn vereist een beschrijving van het beoogde gebruik en redelijkerwijs te voorzien verkeerd gebruik.

Een paar voorbeelden van beoogd gebruik:

beoogd gebruik 

En deze:


redelijkwijs te voorzien misbruik

En wat is dan redelijkerwijs te voorzien verkeerd gebruik?

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

Het gebruik van een product of systeem op een manier die niet door de leverancier is bedoeld, maar die kan voortvloeien uit gemakkelijk voorspelbaar menselijk gedrag.

Een paar voorbeelden:

  • Een agressief schoonmaakmiddel in een voedselverwerkende omgeving gebruiken.
  • Een automatische doorgang gebruiken om personen te verplaatsen (kinderen die erop staan ​​wanneer deze wordt geopend of gesloten)

beoogd gebruik 

Voorbeeld van het redelijkerwijs te voorzien verkeerde gebruik van een helikopterplatform

Wanneer je geen of te weinig aandacht besteedt aan de beschrijving van het redelijkerwijs te voorzien verkeerde gebruik, kan dit mogelijk je aansprakelijkheid beïnvloeden.

Wanneer bijvoorbeeld redelijkerwijs kan worden voorzien dat een bepaald koelsysteem dat in ziekenhuizen wordt gebruikt, kan worden gebruikt om organen te koelen, moet dit in de instructies worden beschreven. 

Onvoorzien verkeerd gebruik hoeft meestal niet in de werkinstructies te worden opgenomen, omdat dit over het algemeen geen invloed heeft op je aansprakelijkheid.

  

Redelijkerwijs te voorzien verkeerd gebruik of onvoorzien verkeerd gebruik?

Gebruik de normen 82079 en 20607 voor betere werkinstructies

De officiële naam is ‘IEC/IEEE 82079-1: 2019 Voorbereiding van gebruik van instructies - Structuur, inhoud en presentatie - Deel 1: Algemene uitgangspunten en gedetailleerde eisen'.

Het is belangrijk om te vermelden dat dit een zogenaamde horizontale norm is: deze is niet alleen van toepassing op een specifiek product of sector, maar bevat regels voor bijna alle bedrijfstakken, van speelgoed tot medische hulpmiddelen en van elektrische apparatuur tot machines.

De norm geeft vereisten voor de inhoud, structuur, kwaliteit, procedure, media en opmaak voor informatie voor gebruik.

Volgens de norm 82079 moet gebruiksinformatie de nodige informatie bieden voor gebruikers om een ​​product veilig, efficiënt en effectief te kunnen gebruiken.

De vereisten van de norm zijn onderverdeeld in de vereisten voor gebruiksinformatie (zoals werkinstructies) en de vereisten voor het informatiebeheerproces.

Zie dit artikel voor meer informatie over de toepassing van de norm 82079:

https://instrktiv.com/en/82079/

Overweeg ook om de norm ISO 20607 Machine Veiligheid - Instructie handboek - Algemene regels voor het opstellen te gebruiken. 

De huidige norm 20607 is gebaseerd op de norm 82079 en moet worden gezien als een verbetering van de norm 82079. Het bevat aanvullende richtlijnen voor het specifiek ontwikkelen van instructiehandboeken voor machines.

Als je er zeker van wilt zijn dat je aan alle wettelijke, regelgevende verplichtingen en marktverplichtingen voor machines voldoet, is het toepassen van de norm ISO 20607 een ​​absolute must.

De norm 20607 biedt veiligheidsspecificaties voor machines die specifieker zijn dan die van de norm 82079. Er is een sterke relatie tussen de norm ISO 12100 voor risicobeoordeling en risicovermindering. 

Omdat de norm ISO 12100 alleen voor machines is bedoeld, is bij de ontwikkeling van de norm 82079 geen rekening gehouden met deze norm.

Omdat de norm 82079 is ontwikkeld voor een breed scala aan producten, wordt het aan de technisch schrijver overgelaten om te beslissen welke vereisten voor een specifiek product moeten worden gebruikt, ongeacht of dit speelgoed, machines of medische hulpmiddelen zijn. Daarom wordt het toepassingsgebied van de norm 20607 beschreven als "vereisten specificeren voor de machinefabrikant voor de voorbereiding van de veiligheidsrelevante delen van werkinstructies voor machines". 

De norm 20607 omvat alle bepalingen uit paragraaf 1.7.2.4. van de Machinerichtljin en dekt de richtlijn dus volledig (behalve de eis inzake geluidsemissie, aangezien deze onder andere normen valt). 

De norm 82079 dekt niet specifiek al deze bepalingen van de Machinerichtlijn.

Omdat de norm 20607 moet worden beschouwd als een aanvulling op de norm 82079, moeten beide normen worden toegepast bij het werkinstructies maken voor machines. 

Wanneer je beide normen toepast (nadat ze geharmoniseerd zijn), creëer je het hoogst mogelijke vermoeden van overeenstemming met de overeenkomstige vereisten van de harmonisatiewetgeving.

Volgens de norm 20607 zijn werkinstructies die in overeenstemming zijn met de norm bedoeld om de lezers zo te informeren dat ze na het lezen ervan weten hoe ze de machine veilig moeten gebruiken volgens het beoogde gebruik, gedurende de volledige levenscyclus van de machine. 

Maar net als de norm 82079, biedt de norm 20607 nog steeds algemene richtlijnen om te voldoen aan de Machinerichtlijn. Het is aan de technisch schrijver om deze richtlijnen te gebruiken om duidelijke en veilige instructies voor een specifiek type machine te maken.

Als voorbeeld stelt de norm 20607 dat de werkinstructies installatie-instructies moeten bevatten. Er wordt echter niet beschreven wat deze installatie-instructies precies moeten bevatten. 

Dus, gericht op machines en ter verbetering van de norm 82079, behandelt de norm 20607 de volgende onderwerpen: 

  • inhoud en structuur van de werkinstructies;
  • taal- en formulerings-/stijlgids;
  • vorm van publicatie.

De reden dat de inhoud en structuur deel uitmaken van de norm, is om te voldoen aan paragraaf 1.7.4.2 van de Machinerichtlijn. In deze paragraaf wordt de inhoud van de instructies voor machines duidelijk beschreven.

De inhoud voor machines verschilt vaak van de inhoud voor andere productgroepen. Voor machines moet je bijvoorbeeld een lijst met reserveonderdelen of instructies voor inbedrijfstelling opnemen. Dit is bijvoorbeeld van minder belang voor speelgoed. 

De taalvereisten en vorm van publicatie verschillen ook enigszins van die van andere producten. 

De norm 20607 creëert veel meer vrijheid als het gaat om elektronische distributie van werkinstructies, vergeleken met hoe dit werd geïnterpreteerd in de Guide to Application of the Machinery Directive.

De Machinerichtlijn geeft vereisten voor de inhoud van de instructies. Ook vereist de norm ISO 12100 dat alle inhoud wordt opgenomen die tijdens de volledige levenscyclus van de machine kan worden gebruikt.

Als antwoord hierop geeft de norm 20607 een voorbeeld van hoe een handleiding kan worden gestructureerd. Met andere woorden: hoe de inhoudsopgave en dus de opbouw van de handleiding eruit zou kunnen zien. Natuurlijk moet de inhoudsopgave verder worden afgestemd op de behoeften van de gebruiker van de specifieke machine. 

Titelpagina

Inhoudsopgave

Inleiding tot/doel van deze werkinstructies

Veiligheid

  • Machinebeschrijving
  • Beoogd gebruik
  • Belangrijkste machinespecificaties 
  • Besturing en weergave van beschrijvingen
  • Plattegrond/indeling

Transport, hanteren en opslag

  • Transporteren van de machine en/of de onderdelen
  • Hanteren van de machine en/of de onderdelen
  • Opslaan van de machine en/of de onderdelen

Montage, installatie en inbedrijfstelling

  • Montage/integreren van de machine
  • Plaatsen van de machine
  • Mechanische, pneumatische, hydraulische en elektrische installatie
  • Controleren en testen van beveiligingssystemen
  • Installatiecontrole
  • Inbedrijfstelling

Originele fabrieksinstellingen van apparatuur

  • Mechanische instellingen en synchronisatie
  • Veiligheidsgerelateerde (instellings-)parameters
  • Pneumatische, hydraulische, elektrische instellingen en vacuüminstellingen
  • Overige instellingen

Bediening

  • Bedieningsmodi
  • Opstarten en uitschakelen van machine
  • Volgorde of chronologie van bediening
  • Overige bedieningsinstructies, indien van toepassing

Product of capaciteitswijziging

  • Algemene informatie over product- of capaciteitswijziging
  • Productspecifieke informatie over instellen

Inspectie, testen en onderhoud

Reinigen en ontsmetten 

Foutopsporing/probleemoplossing en reparatie

  • Algemene informatie inzake foutopsporing/probleemoplossing en reparatie
  • Probleemoplossingstabel (elektrotechniek)
  • Problemen oplossen van elektrische sensoren, vacuümsystemen, pneumatische en hydraulische systemen

Demonteren, buitenbedrijfstelling en verwijderen

Documenten en tekeningen

  • Documenten
  • Tekeningen 
  • Lijst met onderdelen

Index

Woordenlijst

Bijlagen

Podcast over de ISO 20607

Luister naar deze podcast aflevering als je meer wilt weten over de ISO 20607.

Hoe schrijf ik duidelijke teksten? 

Duidelijke teksten die bijdragen aan allesomvattende werkinstructies kunnen worden bereikt door:

  • alle relevante informatie te verzamelen;
  • de informatie correct te organiseren en te structureren;
  • jargon te vermijden;
  • zinvolle koppen te creëren;
  • ervoor te zorgen dat je gebruikers handelingen correct uitvoeren;
  • de actieve vorm te gebruiken;
  • probleemoplossingsinformatie toe te voegen.

Het belang van het schrijven van duidelijke teksten wordt vaak over het hoofd gezien of onderschat vanwege een gebrek aan kennis, omdat veel werkinstructies zijn geschreven door de ingenieurs die de machine hebben ontwikkeld.

Verzamel alleen informatie die helpt bij het oplossen van de problemen van de gebruiker om werkinstructies te maken die daadwerkelijk worden gelezen

Een ding dat ik nog wat meer wil benadrukken, is het belang van het oplossen van de problemen van de gebruiker

De gebruiker(s) voor wie je de werkinstructie schrijft, kunnen tijdens de levenscyclus van de machine problemen ondervinden. Ze willen deze problemen oplossen. En dat is waar ze jou voor nodig hebben.

Probeer dus bij het praten met de SME’s, het verzamelen van informatie, etc. altijd de problemen te identificeren waarmee ze te maken kunnen krijgen.

Typische problemen zijn vergelijkbaar met de hierboven beschreven vragen en hebben te maken met de installatie, het gebruik, het onderhoud, de reparatie, het reinigen en de verwijdering van de machine. 

Problemen kunnen zeer specifiek zijn, zoals:

  • Hoe kan lawaai of trillingen worden verminderd?
  • Hoe kan ik de mal van mijn machine vervangen?
  • Wat betekent het rode knipperende led-lampje?
  • Mag ik de behuizing van mijn machine reinigen met een schoonmaakmiddel?

Zo hebben we weleens werkinstructies moeten maken voor een machine genaamd de Roof Washer. Een van de belangrijkste stappen die door de gebruiker moest worden uitgevoerd, was het gereedmaken van de Roof Washer.

Het grootste probleem was dus: Hoe maak ik mijn Roof Washer gereed voor gebruik?

Aangezien dit een ENORM onderwerp was, besloten we de informatie op te delen in verschillende stukjes:

  • Het controleren van de inhoud van de levering
  • Het voorbereiden van het mobiele platform
  • Het gereedmaken van de Roof Washer
  • De dakreiniger op het dak van de broeikas tillen
  • Het instellen van het mobiele platform
  • Het instellen van de Roof Washer
    • Het afstellen van de hoofdborstels
    • Het afstellen van de optionele raambeschermingsschakelaar
    • Het afstellen van de optionele gootborstel
    • Het afstellen van de schakelhendels van het voorwiel

Je hebt nu verschillende topics. Topic based authoring is essentieel voor het schrijven van duidelijke werkinstructies.

Organiseer je topics op een duidelijke manier zodat gebruikers eenvoudig door je werkinstructies kunnen navigeren. Inhoudsopgave = de manier waarop je topics in de werkinstructies organiseert.

Organiseer en structureer informatie zodat je gebruiker deze eenvoudig kan vinden

Je bent inmiddels overweldigd met informatie: van het gebruik van de machine en het analyseren van alle beschikbare documentatie tot de informatie die je van de SME’s hebt gekregen. 

Deze informatie bestaat uit een beschrijving van problemen die gebruikers mogelijk willen oplossen, tot oplossingen om ze op te lossen, maar ook allerlei andere informatie zoals elektrische schema's, lijsten met reserveonderdelen etc. 

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

Hoe kan ik al deze informatie verwerken en organiseren? 

Dat is bijna niet mogelijk zonder de informatie eerst in kaart te brengen. Nogmaals, je doel is om alleen informatie te bewaren die nuttig is om topics te schrijven die de vragen van de gebruiker beantwoorden.

Deze topics moeten vervolgens duidelijk worden georganiseerd en identificeerbaar zijn in je inhoudsopgave of menustructuur, volgens de levenscyclus van de machine (zie volgende paragraaf).

Maar voordat je een definitieve, goed doordachte (ja, dit moet een meesterwerk zijn) inhoudsopgave kunt maken, moet je eerst alle informatie structureren en organiseren.

Een paar methoden en hulpmiddelen die je hierbij kunnen helpen:

  1. Creëer de inhoudsopgave gaandeweg.
  2. Gebruik mind mapping-technieken.
  3. Gebruik information mapping-technieken.
  4. Gebruik ouderwetse post-it's.

Alle methoden zijn gebaseerd op de volgende principes:

  • Verdeel alle relevante informatie in kleine en beheersbare stukjes.
  • Beperk elk stukje informatie tot één topic.
  • Label elke stukje informatie zodanig dat het de inhoud identificeert, wat betekent dat de omschrijving die je bedenkt, de inhoud moet beschrijven. Het is bijvoorbeeld beter om ‘Het bijwerken van de software’ te labelen met installatie en niet met gebruik.
  • Organiseer en structureer informatie, terwijl je ervoor zorgt dat je consistent bent in het organiseren, opmaken en rangschikken van informatie (en in het gebruik van terminologie).

Vermijd jargon om de begrijpelijkheid te vergroten

Werkinstructies die zijn geschreven door technische mensen bevatten meestal heel veel jargon.

Wat is jargon?

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

Dit betekent niet dat je geen technische termen mag gebruiken. Vaak heb je ze nodig om een ​​machine goed uit te leggen.

Het uitgangspunt moet zijn dat een werkinstructie zo duidelijk mogelijk is. Het gebruik van terminologie die geen deel uitmaakt van de gebruikelijke woordenschat van je lezer draagt ​​daar niet aan bij. 

Verzin zinvolle kopteksten voor betere navigatie

Een koptekst is een titel aan het hoofd van een pagina of gedeelte van werkinstructies.

Een koptekst markeert de grenzen tussen de topics en subtopics van werkinstructies. Een goede koptekst beschrijft de volledige inhoud van de bijbehorende topic.

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

Probeer te werken met maximaal drie koptekstniveaus: dus kopteksten van het eerste, tweede en derde niveau. Gebruik niet teveel koptekstniveaus.

Bekijk deze voorbeelden:

Merk op dat de formulering van deze koppen consistent is: de koptekst op het eerste niveau dekt waar het hele hoofdstuk over gaat. De kopteksten op het tweede niveau gebruiken de hoe-stijl. De kopteksten op het derde niveau gebruiken zelfstandige naamwoorden.

Zorg ervoor dat je kopteksten zo formuleert dat ze voor zich spreken. De koptekst Het verbinden van een product is veel gebruikersgerichter dan Bandall-standaardmachines gebruiken.

En de kop 'Olie vervangen' is zinvoller dan 'Onderhoud'. 

Help je gebruikers dingen gedaan te krijgen

Je kunt acties uitlokken door minder conceptuele informatie te geven en je te focussen op het beschrijven van procedures: gebruikers willen dingen gedaan krijgen en er niet over lezen.

In veel conventionele werkinstructies wordt niet veel prioriteit gegeven aan ondersteunende acties die een gebruiker moet uitvoeren aan het begin van het handboek.

Veel werkinstructies beginnen met uitleg, technische gegevens, veiligheidsinstructies, procesbeschrijvingen etc. Dit kan op een bepaald moment waardevolle informatie zijn, maar leidt de gebruikers meestal alleen maar af bij het bereiken van hun doel.

Probeer alleen het absolute minimum aan must know-informatie in je werkinstructies op te nemen en beschouw alle nice to know- informatie als overbodig. 

Wanneer je erin slaagt om kort te zijn, zullen de werkinstructies communiceren dat de taak van de gebruiker geen aanzienlijke inspanning vereist, maar relatief eenvoudig is uit te voeren.

Door niet alles uit te leggen in de werkinstructies, wordt een gebruiker gestimuleerd om relevante voorkennis te activeren en meer afhankelijk te zijn van zijn eigen denken.

Wanneer je de vaardigheid beheerst om achtergrondinformatie te minimaliseren en net genoeg informatie verstrekt zodat de gebruiker een taak kan voltooien of een concept kan begrijpen, worden je instructies veel duidelijker.

Een gerichte werkinstructie voor het aansluiten van een machine.

Gebruik actieve zinnen om eenvoudig te begrijpen instructies te maken

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

Actieve zinnen benadrukken de gebruiker en zijn gemakkelijker om te lezen en te begrijpen. 

Het onderwerp en werkwoord zijn altijd duidelijk in actieve zinnen. Bijvoorbeeld: 

"Sluit een toetsenbord aan via een USB-poort op de externe eenheid."

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

Vergelijk deze zin maar eens met een passieve zin:

Een toetsenbord moet worden aangesloten via een USB-poort op de externe eenheid."

In de actieve zin is het veel duidelijker dat de lezer de persoon is die de actie moet voltooien.

Door actieve zinnen te gebruiken, worden je instructies duidelijker, beknopter en directer.

Voeg probleemoplossingsinformatie toe om de tijd te verminderen die wordt besteed aan het corrigeren van fouten

Het maakt niet uit hoe goed een machine of een stukje software is ontworpen, er gaat ongetwijfeld iets mis tijdens het gebruik. Als technisch schrijver moet je hier rekening mee houden.

Gebruikers van machines maken veel eenvoudige fouten. Het corrigeren van deze fouten kan erg tijdrovend zijn. Volgens onderzoek [1] besteden gebruikers gemiddeld 25% tot 50% van hun tijd aan het corrigeren van fouten.

Het is daarom belangrijk om probleemoplossingsinformatie toe te voegen aan instructies die gebruikers mogelijk niet begrijpen.

Het verstrekken van probleemoplossingsinformatie EN op de juiste plek, is een van de meest onderschatte aspecten van werkinstructies. Er zijn verschillende manieren waarop werkinstructies kunnen voorkomen dat gebruikers fouten maken.

Bijvoorbeeld door een veilige reeks stappen te geven, korte en eenvoudige zinnen te gebruiken, jargon te minimaliseren, actieve werkwoorden te gebruiken, etc.

Maar hoe weet je welke probleemoplossingsinformatie je moet opnemen?

Onderzoek [1] heeft aangetoond dat zelfs ervaren technische schrijvers over het algemeen niet echt goed kunnen voorspellen welke problemen zich voordoen wanneer hun documentatie wordt gebruikt. 

De beste manier om erachter te komen met welke problemen gebruikers te maken krijgen, is door het testen van de bruikbaarheid van de werkinstructies. 

Wanneer je de meest voorkomende fouten hebt gevonden, suggereert een model voor het toevoegen van probleemoplossingsinformatie aan jr werkinstructies de volgende fasen: 

  • Identificeer het probleem.
  • Benoem het probleem.
  • Verwerk de probleemoplossende informatie. 

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

Laten we eens kijken naar een oud voorbeeld:

Probleemoplossingsinformatie zoals gepresenteerd in de minimalistische handleiding over WordPerfect.

Probleemoplossingsinformatie is het meest effectief wanneer deze zo dicht mogelijk bij de bron wordt gegeven waar en wanneer de fout optreedt. Dit is vaak direct na een bepaalde instructie.

Wanneer je probleemoplossingsinformatie op de juiste plaats verstrekt, kunnen problemen snel worden gedetecteerd en opgelost, voordat ze tot andere problemen kunnen leiden.

Een apart hoofdstuk voor probleemoplossing, dat vrij vaak wordt gedaan, is niet verkeerd, maar het maakt het moeilijker voor de gebruiker om toegang te krijgen tot de informatie en deze te begrijpen, omdat deze uit de context is gehaald. 

Wanneer je ter plekke probleemoplossingsinformatie verstrekt, bespaar je je gebruiker veel tijd, frustratie EN onrust om te leren over het gebruik van de machine. 

Bovendien maakt goed foutenbeheer het leren gebruiken van een machine productiever.

Hoe kan ik duidelijke beelden maken voor mijn werkinstructies?

Hieronder enkele tips voor begrijpelijke beelden die je teksten ondersteunen:

  • Gebruik lijnillustraties in plaats van foto's om de instructies te verbeteren.
  • Gebruik tabellen om gegevens te organiseren.
  • Gebruik waar nodig standaard symbolen en pictogrammen.
  • Gebruik gestandaardiseerde veiligheidstekens en -aanwijzingen.

Gebruik lijnillustraties om je werkinstructies te verbeteren

Je kunt lijnillustraties gebruiken om tekst te ondersteunen, vervangen of uit te breiden en om een ​​chronologische volgorde van een te volgen procedure of stappen aan te geven. 

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

Illustraties om een reeks stappen te beschrijven (voorbeeld werkinstructies AEG)

Wanneer je illustraties zo dicht mogelijk bij de tekst plaatst waar ze betrekking op hebben, is het duidelijk tot welke tekstuele instructie ze behoren. Zorg ervoor dat de gerelateerde tekst en illustraties tegelijkertijd kunnen worden bekeken en dat deze elkaar ondersteunen om de begrijpelijkheid te vergroten.

In vergelijking met foto’s heb je bij illustraties veel meer vrijheid om je te concentreren op belangrijke details. Je kunt eenvoudig minder relevante informatie weglaten of bepaalde delen vergroten.

Een voordeel van het volledig vervangen van tekst door illustraties, is dat illustraties niet hoeven te worden vertaald. Houd er echter wel rekening mee dat het maken van begrijpelijke illustraties vaardigheden vereist.

Hoewel er veel hulpmiddelen zijn voor het maken van illustraties, is het misschien verstandig om ze te laten maken door een competente grafische kunstenaar of technisch illustrator. 

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

Door genummerde onderschriften aan je illustraties toe te voegen, is het voor de gebruiker  meteen duidelijk waar de illustratie over gaat en kan hij de illustratie gemakkelijk identificeren als er in de tekst naar wordt verwezen. 

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

Illustratie die de belangrijkste productonderdelen identificeert

Soms worden foto's gebruikt in plaats van illustraties. Ik geef echter de voorkeur aan het gebruik van lijnillustraties omdat deze vaak veel duidelijker zijn. 

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

Gebruik van een illustratie in de nieuwe werkinstructie die wij hebben gemaakt

Bij het maken van illustraties kan je irrelevante informatie weglaten of eenvoudig belangrijke informatie benadrukken. Met foto’s zal dit ingewikkelder zijn.

Gebruik tabellen om gegevens te ordenen en een duidelijker overzicht te creëren

Je kunt tabellen gebruiken om cijfers of tekst te ordenen. Technische gegevens zijn vaak beter leesbaar in een tabel. In veel gevallen kan een tabel tekst volledig vervangen.

Zorg ervoor dat je tabellen op een duidelijke, informatieve en consistente manier gebruikt. Plaats tabellen waar mogelijk naast de relevante tekst. Bij wijze van uitzondering kunnen referentietabellen (zoals een lijst met reserveonderdelen) in bijlagen worden geplaatst

Technische gegevens weergegeven in een tabel

Gebruik symbolen of pictogrammen voor een betere informatieoverdracht

Symbolen, pictogrammen en veiligheidstekens worden vaak gebruikt in instructiehandboeken. Deze worden gekenmerkt door een vooraf gedefinieerde en duidelijk identificeerbare betekenis en worden gebruikt om informatie op een taalonafhankelijke manier door te geven.

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

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

  • ISO 7010 - Grafische symbolen - Veiligheidskleuren en -tekens - Geregistreerde veiligheidstekens
  • IEC 60617 - Grafische symbolen voor diagrammen
  • ISO 14617 - Grafische symbolen voor diagrammen
  • ISO 5807 - Informatieverwerking - Documentatiesymbolen en conventies voor gegevens-, programma- en systeemstroomschema's, programmanetwerkgrafieken en systeemresourcesgrafieken

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

Voorbeelden van duidelijke pictogrammen volgens ISO 7010

Waarschuwingsborden en/of veiligheidsberichten gebruiken om veiligheidsinformatie te benadrukken

Het gebruik van gestandaardiseerde waarschuwingstekens draagt ​​bij aan duidelijkere en veiligere werkinstructies. Ze hebben een vooraf gedefinieerde en duidelijk identificeerbare betekenis.

De belangrijkste normen voor veiligheidsberichten zijn:

  • ISO 3864 - Grafische symbolen - Veiligheidskleuren en -borden
  • ANSI Z535.6 - Informatie over productveiligheid in producthandleidingen, instructies en andere ondersteunende materialen

Veiligheidspanelen volgens ISO 3864

Veiligheidspanelen volgens ANSI Z535.6

Werkinstructie voorbeeld

Hoe presenteer ik mijn handleiding/werkinstructies?

Om je werkinstructies op een aantrekkelijke en duidelijke manier te presenteren, moet je ervoor zorgen dat je:

  • een goed grafisch ontwerp toepast;
  • het juiste medium kiest;
  • een paar algemene ontwerpbeginselen toepast.

Houd in de eerste plaats rekening met het feit dat je één enkele handleiding of een reeks afzonderlijke documenten kunt maken. 

Je kunt bijvoorbeeld een afzonderlijk document maken voor de installatie, het onderhoud of het gebruik van een machine. Andere redenen om een werkinstructie te splitsen kunnen zijn omdat een enkel document te groot of te ingewikkeld is, of je wilt een werkinstructie voor verschillende doelgroepen maken.

Als je besluit om alle informatie voor verschillende doelgroepen in één document te bundelen, moet je duidelijk aangeven welk deel voor wie is.

Zorg er ook voor dat lettertypen en lettergroottes voldoende duidelijk en groot genoeg zijn om leesbaarheid te garanderen. Gebruik als richtlijn een lettertype van 8 tot 14 punten voor alineatekst in geprinte documentatie.

De norm ISO 20607 bevat de tabel die wordt gebruikt in de norm 82079 met de minimaal aanbevolen lettergroottes en hoogtes van veiligheidstekens en -symbolen. Veiligheidsinformatie moet duidelijk herkenbaar zijn ten opzichte van andere informatie. Je kunt deze informatie bijvoorbeeld benadrukken met vetgedrukte en cursieve lettertypen, lijnen, kaders of kleuren. 

Pas een goed grafisch ontwerp toe om ​​fraaie handleiding te maken die plezierig zijn om te lezen

Deze werkinstructies

zien er veel uitnodigender uit dan deze werkinstructies.

Kies het juiste medium

De nieuwe norm IEC/IEEE 82079-1: 2019 is iets minder streng geworden wat betreft de het medium en formaat van de te gebruiken informatie. Het medium moet overeenkomen met de behoeften van de doelgroep.

Het is volgens deze norm belangrijk dat het medium eenvoudige en permanente toegang tot gebruiksinformatie mogelijk maakt en dat het gekozen medium duurzaam is.

Het is ook belangrijk om bij het kiezen van het medium en formaat rekening te houden met de gebruiksvoorwaarden.

Als er bijvoorbeeld weinig licht is, moet het medium de tekst laten oplichten en spraak kan beter niet worden gebruikt in een lawaaierige omgeving. Papier mag juist niet worden gebruikt in natte omgevingen of cleanrooms.

Over het algemeen wordt overeengekomen, of in veel gevallen zelfs verplicht, dat werkinstructies (op zijn minst de veiligheidsinstructies) in gedrukte vorm moeten worden aangeboden.

Pas ontwerpbeginselen toe voor een duidelijke presentatie van je werkinstructies

Het volgende is belangrijk om te overwegen voor de opmaak en presentatie van werkinstructies:

  • Ontwerp pagina's met af te drukken informatie op een manier dat ze goed leesbaar zijn.
  • Zorg ervoor dat downloadbare informatie kan worden weergegeven op algemeen gebruikte apparaten.
  • Zorg ervoor dat tekstlettertypen, veiligheidstekens en grafische symbolen duidelijk leesbaar zijn en voldoen aan de aanbevolen minimumgroottes.
  • Maximaliseer het contrast van de helderheid.
  • Zorg ervoor dat grafische symbolen voldoen aan internationale normen.
  • Gebruik duidelijke illustraties om tekst te benadrukken.
  • Zorg ervoor dat tabellen duidelijk, informatief en consistent zijn.
  • Gebruik kleuren alleen om de aandacht te vestigen op bepaalde delen informatie.
  • Gebruik duidelijke, eenduidige pictogrammen.

Gebruik kleuren om de aandacht te trekken.

Zorg voor veel witruimte.

Gebruik een schoon, leesbaar schreefloos lettertype. Zorg ervoor dat de lettergrootte past bij de behoeften van de doelgroep. Vermijd het gebruik van meerdere letterstijlen.

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

Vet lettertype wordt gebruikt om de machineonderdelen aan te duiden.

Cursieve tekst wordt gebruikt om andere paragrafen aan te duiden.

Lettergewicht kan worden gebruikt om belangrijke tekst aan te duiden.

Gebruik consistente kleurcodering en pas, waar mogelijk, normen toe.

Gebruik een consistente opmaak voor elke pagina.

Conclusie

Zoals je ziet valt er veel te zeggen over het schrijven van werkinstructies voor machines. En dan heb ik alleen nog maar de belangrijkste onderwerpen behandeld!

Als je echt goede werkinstructies wilt maken, moet je veel oefenen :)

Of zoals Macolm Gladwell in zijn bestsellerboek 'Outliers' beschrijft, er is minimaal 10.000 uur nodig om een vaardigheid te beheersen.

Ik hoop dat ik je met deze samenvatting een aantal nuttige tips heb kunnen geven op basis van mijn ideeën om goede werkinstructies te schrijven.

Ook hoop ik dat je door het gebruik van deze tips en het bekijken van de voorbeelden beter begrijpt hoe je goede werkinstructies kunt schrijven.

Dus neem de informatie in je op en schrijf geweldige werkinstructies!

Als je dit artikel nuttig vindt, zou ik het op prijs stellen als je hieronder een reactie achterlaat.

WIL JE EEN HANDLEIDING DIE AAN DE ISO 20607 VOLDOET?

Lees hier alles over de norm voor instructiehandboeken voor machines.

NAAR HET ARTIKEL

Contact

Hier zijn wij te vinden

Naar Google Maps

Contact informatie

Nederland
Kraanspoor 7H2, 1033 SC Amsterdam
+31 (0)20 7870708

Duitsland
Lohmühlenstraße 65, 12435 Berlin
T: +49 (0) 30 258142572

Verenigde Staten
2301 Collins Ave
Miami Beach, FL 33139
+1 786 3297111

info@instrktiv.com

 

Volg ons op social media



Blijf verbonden

Laat je e-mailadres achter en blijf op de hoogte van vakrelevante informatie en lopende projecten!