NEN EN IEC 82079 norm


Categorie

Recent blog items

  • 14 July 2017

    CE-markering medische software

    Wanneer krijgt medische software een CE-markering? Medische hulpmiddelen zoals infuuspomp

    Lees meer>
  • 23 June 2017

    Brexit en dubbele documentatie

    Dubbele documentatie door Brexit? Het Verenigd Koninkrijk (VK) stapt definitief uit de EU

    Lees meer>
  • 30 March 2016

    Publicatie normontwerp gebruikershandleidingen NEN 5509

    Revisie norm gebruikershandleidingen De afgelopen jaren heb ik vanuit Manualise deelgenom

    Lees meer>
  • 30 March 2016

    Machinerichtlijn 2006/42/EC

    Welke eisen stelt de Machinerichtlijn aan de gebruiksaanwijzing? Elke machine die binnen

    Lees meer>
  • 21 March 2015

    Madcap Flare 11

    10 Reasons Why MadCap's Flare 11 Sets the Standard As a technical communication service b

    Lees meer>

NEN EN IEC 82079 norm

DIN

De IEC 82079-1 in een notendop

Hij is er, de IEC 82079-1. Waar gaat deze standaard over? Wat zijn de belangrijkste veranderingen vergeleken met de EN 62079:2001? Wat moeten technisch schrijvers zich aanwennen?

De IEC 82079-1 “Gebruikshandleidingen opstellen” als opvolger van de EN 62079 uit 2001 is een zogenaamde horizontale standaard. Hij is niet alleen op bepaalde producten of sectoren van toepassing, maar bevat regels voor bijna alle takken van de industrie. Dit concept heeft een belangrijke invloed op de inhoud van deze standaard.

Veel gebruikers van de standaard willen weten wat zij precies in hun handleidingen moeten schrijven. “Moeten we dit of dat erin zetten?” is vaak de vraag. Maar de IEC 82079-1 heeft maar halve antwoorden op zulke vragen – de standaard gaat meer om ‘hoe’ dan om ‘wat’.

  • Hoe zouden handleidingen geschreven moeten worden, welke stappen leiden tot een hoogwaardig resultaat?
  • Welke kwalificaties zouden technisch schrijvers en vertalers moeten hebben?
  • Hoe zouden de instructies eruit moeten zien, welke lettertypes zijn geschikt, waar moet rekening mee gehouden worden wat betreft opmaak, opzet en taalgebruik?
  • Hoe zou informatie gerelateerd aan veiligheid gestructureerd, ontworpen en nadruk gegeven moeten worden in instructies?

IEC 82079-1 is een poging om state-of-the-art technology op het gebied van technische communicatie op internationaal niveau te vertegenwoordigen. Dit is vanuit het Duitse perspectief slechts gedeeltelijk gelukt. Het grootste deel van de specificatie is geen verrassing voor professionele schrijvers, maar juist al vele jaren bekend en helaas vaak teleurstellend onbeduidend. Dit geldt met name voor regels over duidelijkheid van teksten en kwaliteit van illustraties, maar ook voor regels met betrekking tot het gebruik van elektronische media. De kracht en het belang van de standaard zijn dan ook voornamelijk gelegen in het bestaan van de standaard op zichzelf. Er is geen ontkomen aan de ‘minimum’ standaard voor instructiehandleidingen. Veel bedrijven zullen amper actie hoeven te ondernemen; andere zullen echter grote gaten moeten vullen om op het gestelde minimum niveau te komen.

Overzicht van de inhoud

De standaard heeft zeven hoofdstukken waarvan de hoofdstukken 4 t/m 6 het substantiële deel vormen. Onderstaande tabel geeft een overzicht. Vergeleken met voorgaande standaarden is de IEC 82079-1 ongeveer de helft langer geworden.

De inhoud van IEC 82079-1
Sectie Korte beschrijving van de inhoud
1 – area of application Definieert de validiteit van de standaard en zijn doelgroep.
2 – references to standards Bevat een lijst met de standaarden waar in IEC 82079-1 naar verwezen wordt.
3 – Terms Bevat definities van belangrijke termen, waaronder veel nieuwe termen.
4 – Principles
  • Bevat voorschriften, bijvoorbeeld over
    • Voorbereiding van instructiehandleidingen
    • Kwalificaties van technisch schrijvers en vertalers
    • Risicominimalisatie
    • Doelgroepanalyse
    • Media en hun beschikbaarheid
    • Instructies voor verschillende productvarianten
    • Terminologie, taal en vertalingen
5 – Content of user manuals
  • Bevat lijstjes met typische inhoud voor verschillende gebruiksaspecten (fasen in de levenscyclus):
    • Voorbereiding (transport, opslag, installatie, oplevering)
    • Gebruik (normaal gebruik, noodsituaties, fouten zoeken en corrigeren)
    • Onderhoud, reparaties
    • Demontage, recycling, afvoer

Dit lijstje geeft slechts een ruwe basis en aanvulling met product specifieke standaarden moet altijd overwogen worden. Sommige eisen die gesteld worden zijn rechtstreeks aan deze aspecten te koppelen:

  • Informatie voor productidentificatie en veranderingen
  • Veiligheidsgerelateerde informatie (tijdens normaal gebruik, maar ook voor bijv. onderhoud)
  • Informatie over accessoires die met het product worden geleverd, navullingen en reserve-onderdelen
  • Informatie over speciale gereedschappen die nodig zijn voor (de)montage en onderhoud
6 – Presentation of user manuals Bevat basisregels op de volgende gebieden:

  • Duidelijkheid
  • Leesbaarheid (lettergrootte)
  • Kwaliteit van illustraties
  • Grafische symbolen en waarschuwingsmarkeringen
  • Opmaak van tabellen
  • Documenttypes en elektronische media
  • Nadruk op veiligheidsgerelateerde informatie
  • Gebruik van kleur
7 – Analysis of conformance Bevat aanbevelingen over hoe gecontroleerd kan worden of handleidingen aan de eisen van IEC 82079-1 voldoet.

 

In sectie 3 zijn veel nieuwe definities te vinden van belangrijke termen. In sectie 4 wordt het duidelijk dat de regels die een beetje gefragmenteerd waren in EN 62079 nu in meer detail worden gepresenteerd. Hetzelfde kan gezegd worden over sectie 6, waar technisch schrijvers nu drie pagina’s kunnen vinden over leesbaarheid (6.2), in tegenstelling tot een enkele zin over lettergrootte.

Procesgerelateerde regelgeving

Het is vaak genoeg gezegd dat de titel “handleidingen opstellen” misleidend is. IEC 82079-1 suggereert daarmee dat in de standaard het creëren van instructiehandleidingen uitgelegd en gereguleerd wordt. Dit is niet het geval, maar er zijn wel elke belangrijke procesgerelateerde regels aan de standaard toegevoegd.

Sectie 4.3 stelt dat een risicoanalyse vooraf zou moeten gaan aan de creatie van een instructiehandleiding. De gevonden risico’s moeten vervolgens in de instructies genoemd worden. Dit verwijst duidelijk naar het creatieproces. Het nieuwe voorschrift helpt technisch schrijvers om te vragen naar risicoanalyses, aangezien zij deze vaak laat of niet ontvangen en zelf veiligheidsgerelateerde informatie moesten zoeken.

In samenhang met sectie 4.8.2 vraagt sectie 4.4 om het uitvoeren van een doelgroepanalyse, ook in de voorfase van het creatieproces van de handleiding. De resultaten van de doelgroepanalyse zouden dan de basis moeten vormen voor beslissingen over taalgebruik (4.8.3), benodigde inhoud (4.8.2.2), terminologie (4.8.2.3) en de verdeling van informatie over mogelijk meerdere handleidingen. Daarbovenop ondersteunt het de keuze voor de vorm van de instructies, ofwel de selectie van het medium (4.7.3).

Kwaliteitsgerelateerde regelgeving

Een van de doelen van de standaard is het vaststellen van een minimum aan kwaliteit. Hiervoor bevat de standaard allerlei regels met betrekking tot onder andere leesbaarheid, kwaliteit van de illustraties, organisatie en opmaak. Dit was overigens ook al het geval in EN 62079.

Twee nieuwe secties focussen op de kwalificaties van de personen die betrokken zijn bij het creëren van de instructies. In sectie 4.2 vinden we de eisen die gesteld worden aan technisch schrijvers. Zij moeten:

  • over goede communicatievaardigheden beschikken, in het bijzonder met betrekking tot technische communicatie.
  • de taal van de bron goed beheersen.
  • goed bekend zijn met de functionaliteit van het object waarover geschreven wordt.
  • kennis hebben over de processen die ten grondslag liggen aan het creëren van een handleiding en in staat zijn de eisen van de standaard te implementeren.

Deze eisen zijn uiterst belangrijk, met name in een internationale horizontale standaard. Tot slot wordt duidelijk vermeld dat alleen experts op het gebied van technische communicatie instructiehandleidingen zouden moeten schrijven.  Of de expertise (kennis en vaardigheden) door training of educatie is verkregen doet er niet toe. Ongekwalificeerde schrijvers worden door de IEC 82079-1 duidelijk afgekeurd.

Soortgelijke eisen gelden voor de kwalificatie van vertalers van handleidingen. Deze kunnen gevonden worden in sectie 4.8.3.3, onder de misleidende kop ‘Quality of translations‘ (‘Kwaliteit van vertalingen’). Eigenlijk is dit ook niet echt een onderwerp voor deze standaard, want standaarden voor de kwaliteit van vertalingen en kwalificaties van vertalers bestaan al, of komen net opduiken op andere plaatsen. Hoe dan ook, de schrijvers van IEC 82079-1 vonden het nodig om minimumeisen op te nemen. Vertalers moeten:

  • over goede communicatievaardigheden beschikken, in het bijzonder met betrekking tot technische communicatie.
  • goed bekend zijn met de functionaliteit van het object waarover geschreven wordt.
  • de brontaal en de doeltaal uitstekend beheersen; in het ideale geval is de doeltaal tevens de moedertaal van de vertaler.

Het laatste criterium herhaalt de veel besproken ‘ijzeren’ regel van de kunst van het vertalen en kan daarom in deze bespreking een beetje op de achtergrond blijven. Het lijkt belangrijker te zijn dat betrokken vertalers bekend zijn met de aard van technische communicatie. Op sommige universiteiten, zoals de Technische Universiteit van Cologne, worden vertalers al bekend gemaakt met de eigenaardigheden van taal in instructiehandleidingen. Er wordt vaak weinig acht geslagen op de technische kennis van de vertaler, maar deze is heel belangrijk. Het is immers onmogelijk om iets te vertalen dat je niet begrijpt.

De tabel laat zien welke secties voor een technisch schrijver relevant zijn als hij bezig is met waarschuwingen en veiligheidsinstructies.

Aanbevolen leesmateriaal
Sectie Inhoud
1 Validiteitsgebied; beschrijft ook het doel van de standaard
3.19, 3.34, 3.37, 3.43 Belangrijke nieuwe definities met betrekking tot gebruikershandleidingen, veiligheidstips, experts, waarschuwingen
4.2, 4.8.3.3 Eisen gerelateerd aan kwalificatie van technisch schrijvers (4.2) en vertalers (4.8.3.3)
4.3 Voer een risicoanalyse uit voor het maken van de handleiding
4.4 en 4.8.2 Analyseer de doelgroep voor het maken van de handleiding; beslissingen die afhankelijk zijn van de resultaten uit de doelgroepanalyse
4.8.1.2 Beschrijving van verschillende productvarianten
5.5 en 6.8 Updates van veiligheidsinformatie

Regels voor waarschuwingen en veiligheidsinstructies

Waar waarschijnlijk het meest naar werd uitgekeken zijn de veranderingen gerelateerd aan waarschuwingen en veiligheidsinstructies. Sectie 5.2 “safety-related information” (“veiligheidsgerelateerde informatie” is systematisch aan deze zaken toegewijd. Dit is ook de nieuwe overkoepelende term waar we aan moeten wennen.

Onder veiligheidsgerelateerde informatie worden verstaan:

  • Veiligheidsmarkeringen, bijvoorbeeld labels op producten
  • Veiligheidsinstructies
  • Waarschuwingen in de context van de instructies

Op elk van deze vormen zijn specifieke eisen van toepassing. Helaas wordt niet vermeld dat veiligheidsgerelateerde informatie zichtbaar, hoorbaar of voelbaar zou moeten zijn. De volgende versie van de standaard zou op dit gebied verbeterd moeten worden.
Veiligheidsinstructies zouden op logische wijze georganiseerd moeten worden. Dat wil zeggen, in een sectie of hoofdstuk aan het begin van de handleiding, met een titel die duidelijk aangeeft dat de tekst relevant is voor veiligheid (5.5.2). Dit is de eerste keer dat in een internationale standaard een soort hoofdstuk over veiligheid ‘geëist’ wordt. Als inhoud zou ten minste informatie over veilig gebruik, over het voorkomen en vermijden van gevaren en over de gevolgen ervan opgenomen moeten worden (5.5.1). De selectie van veiligheidsgerelateerde informatie moet gebaseerd worden op een risicoanalyse (4.3).

Fabrieks- of systeemveiligheidsinformatie met betrekking tot individuele componenten zou alleen beschreven moeten worden in de instructies van de betreffende componenten. Maar, als er nieuwe risico’s ontstaan door de samenvoeging van componenten op een bepaald gebruiksniveau, dan zou extra informatie verschaft moeten worden op dat gebruiksniveau.

Bij het samenvoegen van individuele instructies moeten de veiligheidsinstructies altijd pas verschijnen op het niveau waar de risico’s relevant zijn (5.5.4). Deze specificatie is een poging om het complexe geheel van veiligheidsinstructies op fabrieks- of systeemniveau te reguleren. Helaas roept deze specificatie juist meer vragen op: Hoe zou de informatie specifiek in de handleiding verdeeld moeten worden? Kunnen er meer hoofdstukken over veiligheid zijn? Zijn verwijzingen naar andere delen van de handleiding soms voldoende? Omdat verschillende delen van een systeem of fabriek functioneel samen werken, kunnen risico’s tijdens het bedienen of onderhouden van individuele componenten ook op systeem- of fabrieksniveau relevant zijn. Wat doen we in dergelijke gevallen met waarschuwingen?

Alle veiligheidsinformatie die relevant is voor de activiteiten beschreven in een korte instructiehandleiding moet in diezelfde handleiding beschreven worden (5.5.5).  Waarschuwingen moeten in de instructies voorkomen wanneer het gevaar waar ze voor waarschuwen ook voorkomt (5.5.2). Ze moeten de volgende zaken bevatten:

  • een signaalwoord – ‘danger’, ‘warning’ of ‘attention’, met dezelfde betekenis als in ANSI en ISO 3864 (staat niet in 5.5.2 maar in 6.8.3)
  • het gevaar
  • de mogelijke gevolgen
  • de remedie (staat niet in 5.5.2 maar in 6.8.3)

De vorm van waarschuwingen komt aan bod in 6.8.3, 6.8.5 en 6.8.6. De opvallendste punten zijn:

  • Het is niet verplicht om veiligheidskleuren te gebruiken.
  • De waarschuwingsdriehoek moet altijd voor het signaalwoord staan.

Helaas zijn de eisen met betrekking tot waarschuwingen niet in één sectie bij elkaar gebracht. Veel technisch schrijvers zullen zich ook verbazen over de vrijheid die zij nog steeds hebben. Sommigen hadden striktere regels verwacht, of er misschien zelfs op gehoopt. Deze vrijheid is goed nieuws voor schrijvers die het ontwerp van waarschuwingen en veiligheidsinstructies graag aanpassen aan de opmaak en het typografisch ontwerp van hun handleidingen.

En nu?

Als eerste stap zou iedereen de standaard zorgvuldig moeten analyseren. De consequenties van IEC 82079-1 kunnen in drie stappen bepaald worden:

  • Vergelijk planning en werkelijkheid
  • Maak een lijstje met maatregelen en bijbehorende prioriteiten
  • Werk een implementatieplan uit

Tekom heeft gewerkt aan een duidelijk commentaar dat technisch schrijvers helpt om de standaard te begrijpen en hun inhoud goed te organiseren. Ook zullen er meer colleges gegeven worden op conferenties.

Iedereen die even op het internet zoekt vindt al snel talloze trainingsaanbiedingen en leesmateriaal. In 2013 wordt een echte “82079 hype” verwacht. Om het overzicht niet te verliezen zou iedereen voor zichzelf de grootte van het ‘gat’ in zijn kennis moeten bepalen. De beste manier om dit te doen is door de nieuwe standaard door te lezen, met een markeerstift bij de hand. Zelfs de “ervaren rotten” zouden weleens tot verrassende inzichten kunnen komen: De nieuwe standaard is niet compleet nieuw, maar gaat op vele fronten wel dieper op de materie in.