iec 82079-1:2012 „erstellen von gebrauchsanleitungen“ angabe von dokument-id, datum und...
TRANSCRIPT
Schmeling + Consultants GmbH Heidelberg
www.schmeling-consultants.de Telefon +49 (0) 62 21 / 58 50 47-0
Entstehung und Inhalte
der Norm
IEC 82079-1:2012
„Erstellen von
Gebrauchsanleitungen“
Winterthur, 2013-11-11
Roland Schmeling [email protected]
Schmeling + Consultants GmbH Heidelberg
www.schmeling-consultants.de Telefon +49 (0) 62 21 / 58 50 47-0
Roland Schmeling [email protected]
SCHMELING + CONSULTANTS HEIDELBERG
Dipl.-
Technikredakteur
Elvis Ališić
Consultant
Dr. Peter
Ebenhoch
CEO
Consultant
Dipl.-
Technikredakteur
Tilo Ried
Consultant
Prof. Robert
Schäflein-
Armbruster,
Partner
Consultant
Dipl.-Phys.
Roland
Schmeling,
CEO, Partner
Consultant
Dipl.-Wirtsch.-Ing.
Mareike von der
Stück
Consultant
Dr. Ulrike
Zuckschwerdt
Consultant
Simone
Heidemann,
Assistant
Analyse
Standardisierung,
Modularisierung,
Redaktionsleitfäden
Schulung
Rechtskonformität
Prozessaudits und
-optimierung
Redaktionssysteme
Zertifizierung
MANAGING.
INFORMATION.
QUALITY.
1. Überblick und Hintergrund
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
4
IEC 82079-1 Erstellen von Gebrauchsanleitungen
Status • Internationale Norm (IEC)
• Europäische Norm (EN)
• Deutsche Übersetzung (DIN) 2013-06
• Wichtigste Norm für Anleitungen generell
Veröffentlichung • August 2012
Vorgänger • IEC 62079:2000 (EN 62079:2001)
Scope • Alle Arten von Anleitungen (instructions for use) für alle Arten von
Produkten, von der Dose Farbe bis zur Industrieanlage
Inhalt • Begriffsdefinitionen
• Prinzipien für die Erstellung von Anleitungen
• Anforderungen an den Inhalt von Anleitungen
• Anforderungen an die Gestaltung von Anleitungen
• Anforderungen an den Erstellungsprozess für Anleitungen
• Anforderungen an die Qualifikationen von Redakteuren, Autoren,
Übersetzern, Lektoren, Illustratoren, Prüfern
• Anforderungen an die Prüfung einer Anleitung auf
Übereinstimmung mit der Norm
• Informativ: Erstellungsprozess
• Informativ: Methoden der Evaluation (Expertisen und empirische
Methoden)
Ausblick • Weitere Teile einer Normenreihe möglich
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
5
Leseempfehlung zur Welt der Normen
http://folio.nzz.ch/2005/februar/was-die-welt-zusammenhalt
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
6
Kritik an der bestehenden 62079
Prozess nicht betrachtet
Titel der 62079: "Preparation of instructions - Structuring, content and presentation" (“Erstellen von Anleitungen - Gliederung, Inhalt und Darstellung“)
In Teilen unverständlich, redaktionelle Mängel
Gliederung: Überlappungen zwischen „Prinzipien“, „Inhalt“, „Darstellung“, Checklisten
Signalworte nicht geregelt
Zahlreiche begriffliche Unklarheiten, fehlende Definitionen
Z. B. „Dokument“, „Sicherheitshinweis“, „Konsument“, „Anlage“, „Komponente“
Entspricht nicht mehr dem Stand der Technik
unter anderem veraltete normative Verweise
Anspruch „von der Dose bis zur Industrieanlage“ nicht erfüllt
Z. B. Schriftgröße mind. 9pt (Dose)
Regelungsbedarf bezüglich neue Medien, Anlagenbau, Verbraucher
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
7
IEC 82079-1 hat IEC 62079 abgelöst
Allgemein Elektrotechnik Telekommunikation
Internationale
Ebene
Europa
Nationale
Ebene:
Deutschland
IEC 62079:2001
EN 62079:2001
DIN EN 62079:2001
DIN EN 82079-1:2013
EN 82079-1:2012
IEC 82079-1:2012
parallel voting
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
8
Ablauf: Vom Normungsantrag zur Norm
CENELEC (CLC)
Europäische Norm (EN)
Final Draft prEN
Draft prEN
Draft
Vorschlag
IEC
IS
FDIS
CDV
CD
NP
DIN
DIN Norm
DIN Norm-Entwurf
Vorschlag
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
9
Projektplan der ISO/IEC 82079-1 – über 2 Jahre Verzögerung
Projektplan Stand 31.10.2008:
Nov 2010 Sommer 2011 Herbst 2011 kurz darauf?
CDV FDIS IS DIN EN
Projektplan Stand Sommer 2010:
Liegt seit 28.01.2011 vor Apr 2012 Aug 2012 Juni 2013
CDV FDIS IS DIN EN
Ergebnis:
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
10
Studien des Verbraucherrats
www.verbraucherrat.din.de/
Dr. Gabriela Fleischer, Berlin
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
11
Gliederung der DIN EN 82079-1
Vorwort
1. Anwendungsbereich
2. Normative Verweisungen
3. Begriffe
4. Prinzipien
5. Inhalt von Gebrauchsanleitungen
6. Gestaltung von
Gebrauchsanleitungen
7. Bewertung der Konformität mit
diesem Teil der Normenreihe
82079
Anhang A (normativ) Bewertung
der Gebrauchsanleitung
Anhang B (informativ) Checkliste
für Konformität und Kommentare
Anhang C (informativ) Checkliste
für die Effektivität der
Kommunikation
Anhang D (informativ) Planung
der Erstellung von
Gebrauchsanleitungen
Anhang E (informativ) Empirische
Methoden zur Unterstützung der
Erstellung von
Gebrauchsanleitungen
Literaturhinweise
Inhalt und Anhänge
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
12
Anforderungen der EN 82079-1 – eine unsortierte Auswahl
Anleitung ist Teil des Produkts
Zielgruppenorientierung
Verfügbarkeit
Landessprache und Berücksichtigung
von Minderheiten
Risikobeurteilung
Berücksichtigung produktspezifischer
Standards
Redaktionsleitfaden
Qualitätssicherung: Lektorat, Prüfung
von Übersetzungen
Qualifikation von Redakteuren,
Übersetzern, Lektoren, …
Regeln für die Konformitätsprüfung
Empirische Prüfung bei
Sammelanleitungen
Teilweise weniger inhaltliche
Anforderungen an bestimmte
Dokumente; Fokus auf Informationen
Angabe von Dokument-ID, Datum und
Revisionsstand
Inhalt von Sicherheitshinweisen und
Warnhinweisen
Gestaltung von Warnhinweisen,
Signalwörter
Funktionale Textstruktur und
Formulierung
Ein Satz, eine Handlungsschritt
Konsistente und adäquate
Terminologie
Empfohlene Mindestschriftgrößen -
differenziert
Farbeinsatz
Elektronische Medien und Navigation
Zulieferdokumentation
Bereitstellung von gedruckten
Anleitungen
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
13
Normungsarbeit: Punkt für Punkt …
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
14
2. Prinzipien der IEC 82079-1
für die Gestaltung von Anleitungen
80
20
!
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
15
Prinzipien 1 (10)
Informationsauswahl und –tiefe (4.1.1 und 5.1)
Terminologie (4.8.2.2, 5.15.5)
Qualifikation der Autoren (4.2)
Berücksichtigung der Zielgruppeneigenschaften (4.4)
Definition der Zielgruppen in der Anleitung
Klare und angemessene Trennung von Informationen für verschiedene Zielgruppen, z. B. Bedienung und Wartung
Zugriff auf die Information (4.7.3)
Informationsbedarf der Zielgruppen (4.8.2)
Basierend auf Zielgruppenanalyse: Alter, Sprache, technische Vorkenntnisse, Umgang mit technischen Produkten
Terminologie (Öffentlichkeit oder Spezialisten)
klare Zuordnung von Informationen zu Zielgruppen
Warnhinweise verständlich für die Zielgruppe (5.5.3)
Empirische Tests, speziell bei Verbraucherprodukten (4.8.1.2, 4.8.2.1, 5.15.5, Anhang D, Anhang E)
Zielgruppenorientierung „target group“
steht in der Norm
fast 40 mal auf
knapp 60 Seiten
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
16
Grundsatz: Relevanz und Informationsbedarf
Zielgruppen als Basis für Detailliertheit
4.1.1 Allgemeines
Das Niveau der Beschreibungen und die Informationstiefe
müssen den Kenntnissen der Zielgruppe(n) angepasst sein.
Die Gebrauchsanleitungen müssen die Vollständigkeit der
relevanten Information auf einem ausreichenden
Beschreibungsniveau, zugeschnitten auf den Bedarf der
Zielgruppe(n), sicherstellen.
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
17
Prinzipien 2 (10)
Gebrauchsanleitung ist Teil
des Produkts (4.1.2)
Konformität mit dem Produkt
(4.8.1)
Identifikation
Wenige Produktvarianten,
klar getrennt
Kennzeichnung von
Optionen
Maßeinheiten
Zubehör
Teil des Produkts
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
18
Sammelanleitung – so nicht!
Aus der Anleitung eines
führenden Herstellers von
Elektrowerkzeugen
Die Inhalte sind jeweils nur
gültig für die angegebenen
Typen D25711, ...
Wie lange dauert es wohl, bis
jemand die Inhalte
verwechselt?
Zusätzliches Problem: Der
Abstand von Text und Bild
(Verweis in der Überschrift) –
im Text wird das Bild jedoch
benötigt (Wartungsanzeige (r))
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
19
Umgang mit Informationen zu Produktvarianten (4.8.1.2)
empirische Evaluation wegen
höherer Gefahr von
Verwechslung
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
20
Prinzipien 3 (10)
Minimierung von Risiken (4.3)
Risikobeurteilung der Verwendung („risk
assessment of use“)
• zu unterscheiden von der
konstruktionsbezogenen Risikoanalyse
• Warnung vor Restgefahren
Vernünftigerweise vorhersehbaren
Fehlgebrauch berücksichtigen
Sicherheitsbezogene Informationen
hervorgehoben und konsistent (5.5, 6.8)
• Unterscheidung: Sicherheitshinweise,
Warnhinweise und Warnschilder
Zusätzliche produktspezifische und
gesetzliche Anforderungen
berücksichtigen (4.7.1, 5.5.1, 7.1)
Sicherheit
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
21
Prinzipien 4 (10)
Sprachen (4.8.3)
Sprache(n) des Anwenderlandes
Minderheiten berücksichtigen
Visualisierung nutzen
Qualifizierte Übersetzer/-innen
Sprachen
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
22
Prinzipien 5 (10)
Verfügbarkeit und Zugriff (4.7.5, 5.7, 5.9.6)
Elektronische Medien und Papier (4.7.3)
Nachbeschaffung (Ersatzkopien)
Speziell Verbraucherprodukte: Anleitung im Internet verfügbar
Barrierefreier Zugriff
Bei Schriftgröße unter 10 pt: Anleitung mit mind. 10 pt verfügbar
Haltbarkeit über den Produktlebenszyklus (4.7.4, 6.2.5)
Anbringungsorte (4.7.2 Location)
In der Packung mit dem Produkt
An oder im Produkt (z. B. elektronisch)
Auf der Verpackung, aber dort nicht ausschließlich
WWW, aber dort nicht ausschließlich
Optionen in separaten Abschnitten / Überschriften (4.8.1.5 Optional modules..)
Verfügbarkeit
IMPORTANT – READ
CAREFULLY BEFORE
USE – KEEP FOR
FUTURE REFERENCE
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
23
Prinzipien 6 (10)
Nutzung der Stärken aktueller
Medien und Technologien
(6.7.1)
ISO 9241 „Ergonomie der
Mensch-System-Interaktion“
Elektronische Dokumentation:
• Navigation durch die
Struktur
• Jeweiliger Ort in der
Struktur erkennbar
• Struktur jederzeit im
Überblick:
mit „Knoten“ und
zugeordneter Information
• Expand and collapse
Aufgaben-angemessenheit
Selbst-beschreibungs-
fähigkeit
Erwartungs-konformität
Lernförderlichkeit Steuerbarkeit
Fehlertoleranz
Individualisier-barkeit
Verfügbarkeit und Medieneinsatz
ISO 9241-110*
* Ergonomie der Mensch-System-Interaktion –
Teil 110: Grundsätze der Dialoggestaltung
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
24
Prinzipien 7 (10)
Rechtskonform
(4.1.3, 4.3, 4.7.1, 4.7.3,
4.8.3.1, 5.6)
Konform mit anzuwendenden
Produktnormen
(4.3, 5.3, 5.15.1, 7.1)
Konformität
§
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
25
Prinzipien 8 (10)
Inhaltliche Konsistenz
Mit dem Produkt (4.1.3) sachliche Richtigkeit und
Widerspruchsfreiheit wird vorausgesetzt
Widerspruchsfrei zu anderen Informationsprodukten (Labels,
Schulungsunterlagen, Werbung, Internet, usw.)
Konsistente Gestaltung
Konsistente Dokumentation (bei mehreren Dokumenten)
Redaktionsleitfaden (6.1.2)
Konsistente Terminologie (4.1.3, 5.15.5, 6.1.4, 6.1.2)
Konsistente Gestaltung von Warnhinweisen (6.8.3)
Farbeinsatz (6.9.1)
Konsistenz
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
26
Widerspruchsfreiheit der Informationskanäle
Betriebs-anleitung
Schulung
Service
Montage
Vertrag Validierung
Katalog
Internet
Flyer
Organisation der
Widerspruchsfreiheit
Inhalt
Technische Daten
Terminologie
Warnhinweise
Ersatzteilwesen
Wartungsfristen
…
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
27
Prinzipien 9 (10)
Vom Allgemeinen (Überblick) zum Speziellen (6.1.1)
Was ist zu tun? Wie ist es zu tun?
Handlungslogische Reihenfolge
Kürze und Einfachheit (6.1.5 ff.)
nur relevante Information (Aufmerksamkeit des Lesers erhalten)
Einfach und kurz
Wenige Querverweise
Spezielle Verständlichkeitsprinzipien zur Gestaltung der Anleitung
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
28
Prinzipien 10 (10)
Professioneller Redaktionsprozess (4.2, Anhang D)
Zielgruppenanalyse
Erstellung durch Fachkräfte (4.2)
Redaktionsleitfaden
Lektorat (Proof reading, 6.1.11)
Professioneller Redaktionsprozess
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
29
3. Inhalt einer Anleitung
IEC 82079-1,
Kapitel 5 „Content of instructions for use“
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
30
Grundlegende Anforderung an den Inhalt
Grundregel: Alle Informationen geben, welche die Zielgruppen benötigen
5.1 Allgemeines
Die Funktionalität der Produkte muss beschrieben werden und
Fragen der Nutzer zum WO? WER? WAS? WANN? WIE?
WARUM? sollten vorweggenommen und passende Antworten
gegeben werden.
Die Informationstiefe hängt von der (den) Zielgruppe(n) ab und
den beabsichtigten oder erlaubten Aufgaben, die im Laufe des
Produktlebens ausgeführt werden.
[…]
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
31
5 Inhalt von Gebrauchsanleitungen
5.1 Allgemeines
5.2 Identifikation von Gebrauchsanleitungen
5.3 Identifikation des Produkts
5.4 Modifikation von Produkten
5.5 Sicherheitsbezogene Informationen
5.6 Übereinstimmung mit dem Produkt
5.7 Wichtigkeit der Aufbewahrung von Gebrauchsanleitungen
5.8 Produkte für den Gebrauch vorbereiten
5.9 Betrieb der Produkte
5.10 Instandhaltung des Produkts
5.11 Mitgelieferte Zubehörteile, Verbrauchsmaterialien, Ersatzteile
5.12 Informationen zu speziellen Werkzeugen, Geräten und Materialien
5.13 Informationen zu Reparatur von Produkten und Austausch von Teilen
5.14 Erforderliche Informationen, wenn das Produkt nicht mehr gebraucht wird
5.15 Struktur der Gebrauchsanleitungen
„if applicable“
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
32
4. Sicherheitsbezogene Informationen
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
33
Sicherheitsbezogene Informationen
4 Prinzipien
4.3 Minimierung von Risiken (Forderung nach einer Risikobeurteilung als Basis)
4.8.3 Sprachen
4.8.3.2 Grafische Symbole einschließlich Sicherheitszeichen und Produktsicherheitslabel
5 Inhalt von Gebrauchsanleitungen
5.5 Sicherheitsbezogene Informationen
5.5.1 Allgemeines (Unterscheidung der Hinweisarten und mögliche Inhalte)
5.5.2 Sicherheitshinweise
5.5.3 Warnhinweise
5.5.4 Sicherheitsbezogene Informationen für Industrieanlagen
5.5.5 Sicherheitsbezogene Informationen in Kurzanleitungen
6 Gestaltung von Gebrauchsanleitungen
6.8 Sicherheitsbezogene Informationen hervorheben und auffällig machen
6.8.1 Text auffällig machen
6.8.2 Visuelle Darstellungen auffällig machen
6.8.3 Gestaltung und Platzierung von Warnhinweisen
6.8.4 Beständigkeit und Sichtbarkeit
6.8.5 Warnhinweise hervorheben
6.8.6 Signalwörter
Wo stehen die Anforderungen in der IEC 82079-1?
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
34
DIN EN 82079-1 und ANSI Z535 passen zusammen
ANSI Z535
ANSI Z535.6
Supplemental directives
Grouped safety
messages
Section safety
messages
Embedded safety
messages
Property damage message
ANSI Z535.4: Product
Safety labels
Product safety labels
Sicherheits-
hinweise*
Warnhinweise
Produkt-
sicherheits-
label/
Sicherheits-
zeichen
ISO 3864-2
Sicherheitsbezogene Informationen
DIN EN 82079-1
Warnhinweise mit Signalwort:
GEFAHR / WARNUNG / VORSICHT Kein Signalwort
festgelegt
* umfassen im Gegensatz zur
ANSI Z535 auch Hinweise zu
möglichen Sachschäden
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
35
DIN EN 82079-1
DIN EN 82079-1
IEC 82079-1
ISO 3864-2 ANSI Z535.6 Bemerkungen
Sicherheitsbezogene
Informationen
Safety-related information
[keine
Regelung]
Safety message Oberbegriff
Sicherheitshinweise
Safety notes
[keine
Regelung]
Grouped safety
message
Grundlegende
Sicherheitshinweise,
Sicherheitskapitel,
Sicherheitsbroschüre
Warnhinweise
Warning messages
[keine
Regelung]
• Section safety
messages
• Embedded safety
messages
Warnhinweise vor und in
Handlungssequenzen
Produktsicherheitslabel
Product safety label
Product safety
labels
Product safety labels
(ANSI Z535.4)
Warnschilder auf Produkten
[keine Regelung] [keine
Regelung]
Supplemental
directives
u. a. für Verweise auf
konkrete Hinweise
Redeweise und Regelungen zu sicherheitsbezogenen Informationen
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
36
DIN EN 82079-1: Signalworte
GEFAHR: Das Signalwort bezeichnet eine Gefährdung mit einem
hohen Risikograd, die, wenn sie nicht vermieden wird, den Tod oder
eine schwere Verletzung zur Folge hat.
WARNUNG: Das Signalwort bezeichnet eine Gefährdung mit einem
mittleren Risikograd, die, wenn sie nicht vermieden wird, den Tod
oder eine schwere Verletzung zur Folge haben kann.
VORSICHT: Das Signalwort bezeichnet eine Gefährdung mit einem
niedrigen Risikograd, die, wenn sie nicht vermieden wird, eine
geringfügige oder mäßige Verletzung zur Folge haben kann.
Inhaltlich
Art, Quelle, Folgen und Maßnahmen gefordert
Sowohl für Warnhinweise als auch für Sicherheitshinweise!
… müssen „in Erwägung gezogen werden“
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
37
Beispiel 1 für Sicherheitshinweise
Nicht konform – Art, Quelle und
Folgen fehlen
Arbeitssicherheit
Eng anliegende Kleidung tragen.
Beim Auswechseln von Arbeitswerkzeugen geeignetes Werkzeug und Handschuhe benutzen.
Brandgefahr vermeiden, Maschine sauberhalten.
Ballastgewichte immer vorschriftsmäßig an den dafür vorgesehenen Befestigungspunkten anbringen.
Arbeiten unter der angehobenen Maschine nur bei sicherer Abstützung durchführen.
...
Konform (aus dem
VDMA-Leitfaden)
Geeignete Kleidung tragen
Locker getragene Kleidung erhöht die Gefahr durch Erfassen oder Aufwickeln an rotierenden Teilen und die Gefahr durch Hängenbleiben an hervorstehenden Teilen. Dadurch können Personen schwer verletzt oder getötet werden.
Eng anliegende Kleidung tragen.
Nie Ringe, Ketten und anderen Schmuck tragen.
Bei langen Haaren Haarnetz tragen.
Feste Schuhe oder Arbeitsschutzschuhe tragen.
VDMA Leitfaden Sicherheits- und Warnhinweise in Betriebsanleitungen für Traktoren und Landmaschinen, 2013
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
38
Wachsender Zeichenvorrat: ISO 7010 und ISO 7000
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
39
Grundlegende Sicherheitshinweise: Inhalte (Beispiel)
Bestimmungsgem. Verwendung***
Grenzen der Verwendung*** Einschränkungen für den sicheren Gebrauch;
Beispiel: Nur in trockener Umgebung
Warnung vor Fehlgebrauch und Missbrauch***
Anforderungen an das Personal*** Besondere Kenntnisse, Fähigkeiten,
Fertigkeiten; wo genau wie möglich; „Fachpersonal“ genügt nicht
Persönliche Schutzausrüstung*** Ggf. auch auf Verpackung/Produkt;
Beispiel Schleifgerät: Atemschutz
Verantwortung des Betreibers
Organisation (Vorschriften, Unfallverhütung, Verantwortung, Zugang, Schlüssel und Passwörter, …)
Sicherheitshinweise zu bestimmten Betriebsphasen
Hinweise zu besonderen Gefahrenarten z. B. Warnung vor Strahlungen***
Hinweise zu besonderen Produkten, z. B. ortsverändlich einsetzbare Maschinen
Arbeitsplätze, Arbeitsumgebung, Platzbedarf (auch für Wartung)
Umgebungsbedingungen (z. B. nur in trockenen Räumen), Einhalten der technischen Daten**
Explosionsschutz**, ATEX 95/137
Elektromagnetische Verträglichkeit, Anforderungen an Montage/Anschluss
Notfallpläne; Verhalten im Notfall, Brand
Ersatzteile**; Warnung vor nicht geprüften Ersatzteilen
technisch einwandfreier Zustand Spezielle Anzeichen, wann das Produkt nicht
mehr sicher ist: Abnutzung, Alter, Beschädigungen***
Änderungen, An- und Umbauten
Sicherer Umgang mit Hilfs- und Betriebsstoffen
Gefahrenbereiche*
Sicherheitskennzeichnung: Anbringungsorte der Schilder*, Erklärung der Schilder*
Erklärung der Symbole in sicherheitsbezogenen Informationen***
Sicherheits- und Schutzeinrichtungen*, Funktionstest; Warnung vor Umgehen
Regelmässige Wartung**
Von Kindern fernhalten***
Restrisiken gemäß Risikobeurteilung Risiken vgl. ISO 12100
Sichere Entsorgung*** Produkt und Betriebsstoffe; Umwelt
*) Ggf. Verweis auf Beschreibung; **) Verweise auf spezifische Informationen; ***) Gemäß IEC 82079-1
Nicht zur „Sicherheit“ gehören: Konformitätserklärungen,
Darstellungskonventionen und mitgeltende Dokumente
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
40
5. Gestaltung von Anleitungen
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
41
Lesbarkeit (6.2.1 Schriftgrößen und Höhen der grafischen Symbole)
Lesbarkeit optimieren mit
mindestens den folgenden
Variablen
Schriftart
Schriftgröße
Zeilenlänge: ca. 70 lateinische
Buchstaben
Zeilenabstand: mindestens
120 % der Schriftgröße der
lateinischen Schrift
Hervorhebungen durch
Fettdruck, Kursiva oder
GROSSBUCHSTABEN nur für
einzelne Worte oder Phrasen,
nicht für komplette Absätze
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
42
IEC 82079-1: Text und Bild beieinander
Text
Bild
... so dass sie zusammen gesehen werden
• Seitenumbrüche?
• Bilder in Online-Hilfen?
• Querverweise auf Bilder in anderen Abschnitten?
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
43
... und jetzt das richtige Bild, und dann die richtige Position ...
So nicht!
44 (c)
2013, S
chm
elin
g +
Consultants
Gm
bH
DIN EN 82079-1
Funktionale Strukturierung und Standardisierung des Texts
6.1.3 Struktur
Die Formulierungen sollten den Textfunktionen entsprechen. Die Struktur der
Texte sollte die verschiedenen Textfunktionen unterstützt. Solche Textfunktionen
sind zum Beispiel:
• Thema (Überschrift);
• Beschreibung;
• Ziel;
• Voraussetzung;
• Zustand;
• Handlung;
• Ergebnis;
• Warnung;
• Aufforderung und Erinnerung;
• Beispiel;
• Bildtext (Beschriftung einer Abbildung oder einer Tabelle).
Die Anwendung einer einheitlichen Strukturierungsmethode wird empfohlen.
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
45
Beispiel
Die Verwaltung der mit
dem Programm
erstellten Tabellen
erfolgt durch Aufrufen
der Hauptmaske mit
zuvor eingestellter
Option „Verwaltung“.
Tabellen verwalten
Wählen Sie die Option
Verwaltung.
Klicken Sie auf Home.
Die Hauptmaske mit
Tabellenverwaltung wird
angezeigt.
Ziel
Handlung
Handlung
Resultat
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
46
6. Prozesse
Planning Development Optimization
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
47
Prozessbezogene Anforderungen der IEC 82079-1
Qualifikation der Informationsentwickler/innen (Abschnitt 4.2)
Qualifikation der Übersetzer/innen (Abschnitt 4.8.3.3)
Qualifikation von Lektor/inn/en (Abschnitt 6.1.11)
Qualifikation der Illustrator/inn/en (Abschnitt 6.3.1)
Zielgruppenanalyse („Analyses of target groups“, Abschnitt 4.8.2.1)
Produktrecherche (Anhang D)
Normenrecherche (u.a. Abschnitt 7.1)
Risikobeurteilung („Minimizing risks“, Abschnitt 4.2)
Qualitätssicherung („Proof reading“, Abschnitt 6.1.11)
Konformitätsprüfung („Evaluation ...“, Abschnitt 7)
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
48
Qualifikation von Redakteuren
Kompetente Verantwortliche
4.2 Qualität der Kommunikation
Die Erstellung der Gebrauchsanleitung, einschließlich
Überprüfung und Korrekturlesen, muss in der
Verantwortlichkeit von erfahrenen Schreibern und
Spezialisten liegen. Sie müssen folgende Fähigkeiten haben:
• fortgeschrittene Kompetenzen in der Kommunikation,
speziell in der technischen Kommunikation;
• solide Kompetenzen in der Originalsprache;
• Vertrautheit mit dem Themenbereich;
• Kenntnisse über die Prozesskette zur Erstellung der
Gebrauchsanleitungen und Kompetenz in der Anwendung
der Anforderungen dieses Teils der Normenreihe 82079 in
der Prozesskette.
Gebrauchsanleitungen sollten kontextuell von qualifizierten
Personen lektoriert werden, die darauf spezialisiert sind,
zielgruppengerecht zu schreiben.
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
49
DIN EN 82079-1: Redaktionsprozess
a) Analyse, festlegen
allgemeiner Bedinungen
b) Planung und Projekt-
management c) Konzeption
d) Gebrauchs-anleitung als Teil
des Produkts
e) Recherche f) Erstellung von
Inhalten g) Qualitäts-
überprüfungen h) Qualitäts-
sicherung
i) Übersetzung j) Medien-produktion
Archivierung (fehlt in der
Norm)
Informativer Anhang D (hier D.3)
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
50
IEC 82079-1: Erstellen von Anleitungen nach Anhang D, 1 (2)
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
51
IEC 82079-1: Erstellen von Anleitungen nach Anhang D, 2 (2)
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
52
7. Konformität
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
53
Kapitel 7: Bewertung der Übereinstimmung mit DIN EN 82079-1
Umgang mit den Checklisten des Anhangs
[…] Für die meisten Produkte kann weder eine 100%ige Wirksamkeit der
Gebrauchsanleitungen erreicht noch qualitativ gemessen werden, und so muss in
der Praxis die Beurteilung auf subjektiven Urteilen basieren. Die Checkliste darf
eher als Leitfaden angewendet werden, um Angaben in der Gebrauchsanleitung
zu kritisieren, die nachweislich nicht wirksam sind, anstatt sie nur als eine Liste von
Kriterien zu verwenden, nach der für das Dokument als Ganzes Noten vergeben
werden. Konstruktive Kritik ist auf den bestimmten Abschnitt zu beziehen, der
zu verbessern ist, und die Gründe sind anzugeben, warum dieser als nicht
wirksam betrachtet wurde (und vorzugsweise wie er überarbeitet werden könnte,
um wirksam zu werden).
Bei keiner Checkliste sollte davon ausgegangen werden, dass sie für jede Art von
Produkt umfassend ist. Sie muss gegebenenfalls ergänzt und/oder geändert
werden im Einklang mit den einschlägigen Produktnormen oder […] im
Einklang mit Normen von vergleichbaren Produkten oder Funktionen […].
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
54
Empirische Methoden (Anhang E)
Befragungen E.2.1
Usability-Tests E.2.2
Selbsteinschätzungen und Checklisten E.2.3
Gutachten, Überprüfungen durch Experten und Zertifikate E.2.4
Beispiel: DocCert
Erkenntnisse aus unabhängigen Preisen oder Leistungsprogrammen
E.2.5
Beispiel: tekom Doku-Preis,
Rückmeldungen aus Beschwerdemanagement, Hotlines und
Kundendienstinformationen E.2.6
Unterstützung der Anleitungsentwicklung durch empirische Methoden
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
55
Anforderungen und Eigenschaften jeder Konformitätsprüfung
Checkliste genügt nicht
Fundiertes Verständnis der gesamten Norm erforderlich
Kein abschließender Anforderungskatalog
Produktspezifische Anforderungen müssen im Einzelfall recherchiert werden
Anforderungen sind oft nicht präzise
Bedürfen der Auslegung
Hilfspersonal ist nicht ausreichend
Qualifiziertes Personal ist erforderlich
Fachlicher Hintergrund des Prüfers/der Prüferin und Prüferfahrung erforderlich
Keine Prüfung der „Anleitung pur“
Prüfung der Anleitung zusammen mit dem Produkt erforderlich
Subjektive Einschätzung des Prüfers/der Prüferin
Keine „technische“ Prüfung mit exakten Messvorschriften
Ziel der Konformitätsprüfung sind das Heben von Verbesserungspotenzialen!
Optimum ist nicht erreichbar
Unabhängiges Prüfpersonal erforderlich
Keine Verflechtungen des Prüfpersonals mit Erstellung, Produktion, Verkauf
Ergänzung der Anforderungen erforderlich
Normenrecherche zwingende Voraussetzung
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
56
Checkliste: Mit Vorsicht zu genießen
IEC 82079-1: Checkliste ist Leitschnur, nicht Anforderungsliste!
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
57
8. Elektronische Medien,
Software-Dokumentation und
Online-Dokumentation
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
58
Anforderungen an elektronische Medien (Quelle: DocCert)
GT4 Anwendung elektronischer Medien (EN 82079-1, 6.7) GT4.1 Die Vorteile des gewählten elektronischen Mediums werden unter Gewährleistung hoher Verständlichkeit
ausgenutzt. GT4.2* Die didaktischen Vorteile elektronischer Medien sind umfassend genutzt. GT4.3 Die Vorteile der dynamischen Navigation und Darstellungsmittel sind genutzt. GT4.4 Bei dynamischer Navigation:
Ein (vorzugsweise baumartiges) Navitationssystem ist bereitgestellt. GT4.5 Bei dynamischer Navigation:
Entsprechende Navigationselemente ermöglichen Orientierung und Interaktion im System. GT4.6** Bei dynamischer Navigation:
Hot Spots dienen als Einstiegspunkte für die Untermenüs. GT4.7** Bei dynamischer Navigation:
Der Zugang zu Online-Hilfe- oder Multimedia-Anwendungen ist dank Suchfunktionen realisiert. GT4.8 Bei dynamischer Navigation:
Anleitungen zum Gebrauch der Software sind - wenn möglich - in die Nutzeroberfläche integriert. GT4.9* Die Barrierefreiheit ist gewährleistet.
GT4.10* Online zur Verfügung gestellte Anleitungen oder zugehörige Informationen kommen in ihrer Darstellung
und den notwendigen Navigationen den Empfehlungen des World Wide Web Consortiums nach (Web
Content Accessibility Guidelines). GT4.11 Wenn erforderlich und aus rechtlichen Gründen zulässig:
Der Hinweis, dass die Anleitung nur in elektronischer Form zur Verfügung steht, ist gegeben. GT4.12 Animationssequenzen sind synchronisiert oder mit einem schriftlichen Begleittext versehen. GT4.13 Werbeinhalt ist klar von der Anleitung getrennt und unabhängig von der Verständlichkeit der Anleitung. GT4.14 Herunterladbare Anwendungen können ohne softwareseitige Änderung oder Anpassung angezeigt
werden. GT4.15 Die Anforderungen der ISO 9241 Serie sind eingehalten. (EN 82079-1, 6.1.9)
* = soll; ** = kann; ohne Kennzeichnung: muss
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
59
„
“
Anforderungen der EN 82079-1
4.7.6 Elektronische Hilfesysteme
Wenn ein elektronisches Hilfesystem angeboten wird, muss es einem
Nutzer ermöglichen, durch die Struktur des Systems zu navigieren, so dass
die Nutzer jederzeit wissen, wo sie sich in der Struktur befinden. Die Nutzer
müssen jederzeit in der Lage sein, auf dem Bildschirm die Struktur zu
sehen, zusammen mit ihren Knoten und dazugehöriger Information. Der
Nutzer muss in der Lage sein, die Systemstruktur, wenn erforderlich,
aufzuklappen oder zuzuklappen.
Warnhinweise zu vorhersehbaren außergewöhnlichen Situationen dürfen
nur den Knoten der Gliederung zugeordnet sein, die sie betreffen.
DIN EN 82079-1:2013
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
60
Anforderungen der EN 82079-1
Handelt es sich bei der App um ein
„elektronisches Hilfesystem“?
Falls die Anforderungen an ein
elektronisches Hilfesystem sinnvoll
anwendbar sind:
• Norm fordert Sichtbarkeit der Struktur (mit
aktuellem Knoten)
• Norm fordert, dass Warnhinweise sich nur
im aktuellen Knoten befinden
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
61
„
“
Anforderungen der EN 82079-1
6.8.3 Gestaltung und Platzierung von Warnhinweisen
Warnhinweise müssen konsistent gestaltet werden, und sie müssen auffällig und hervorgehoben gestaltet werden. Bei der Formulierung und Gestaltung von Warnhinweisen muss Folgendes in Erwägung gezogen werden, um die maximale Wirksamkeit zu erreichen:
• Beginne mit den Signalwörtern (siehe 6.8.6).
• Beschränke den Text und/oder die visuellen Darstellungen auf das Wesentliche.
• Mache die Stelle, den Inhalt und den Stil der Warnhinweise auffallend nach 6.2.
• Stelle sicher, dass Warnhinweise für den Nutzer und für alle anderen gefährdeten Personen aus ihren Positionen während des Gebrauchs (siehe auch 6.2.5) und zum richtigen Zeitpunkt sichtbar sind.
• Erkläre die Quelle der Gefährdung.
• Gib deutliche Anleitung, wie eine besondere Gefährdung zu vermeiden ist.
• Platziere die von der Risikobeurteilung festgelegten Warnhinweise. Zu häufig wiederholte Warnhinweise können ihre Wirksamkeit vermindern.
• Nenne die möglichen Konsequenzen, wenn man die Gefährdung nicht vermeidet, ohne die Konsequenzen herunterzuspielen.
Gestaltung und Platzierung von Warnhinweisen
DIN EN 82079-1:2013
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
62
Anforderungen der EN 82079-1
Abweichungen
• Ist der Inhalt des Warnhinweises wirklich auffallend, wenn
der Warnhinweis standardmäßig zugeklappt ist?
• Ist erkennbar, dass die Warnung aufgeklappt werden muss?
• „Warnung“ ist nicht informativ – wäre folgender Satz nicht
informativer? „WARNUNG – Unfallgefahr durch fehlende
oder falsch verwendete Rückhaltesysteme.“
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
63
tekom Normenkommentar zur EN 82079-1
Aus dem Inhalt:
Einordnung und Umgang mit der Norm
Neuheiten gegenüber EN 62079:2001
Begriffserklärungen
Wichtige Prinzipien
Rollen und Verantwortlichkeiten
Gebrauchsanleitungen im Produktlebenszyklus
Vorgaben für die Gestaltung Sprachfassungen
Struktur
Formulierung
Medien
...
Zulieferdokumentation
Sicherheitsbezogene Informationen
Konformitätsprüfung
Ausblick
Index
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
64
Kommentar vom DIN
Angekündigt, aktuell für
Dezember 2013
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
65
Konformitätsprüfung
Konformitätsprüfung nach
IEC 82079-1: DocCert
Incl. Prüfung des
Zusammenspiels
Anleitung/Produkt
Prüfzeichen
Zertifizierung möglich
Prozessaudit und Zertifizierung
der Redaktionsprozesse:
DocCertSystem
Bei Fragen:
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
66
Mögliche Themen der nächsten Revision der IEC 82079-1
Sicherheitsaspekte klarer und
konsistenter, z. B. Zusammenhang von
Risikobeurteilung und IEC 60204 ist
unklar
Kompetenzen der Prozessbeteiligten
differenzierter
Elektronische Medien noch
unzureichend, z. B. mobile
Dokumentation nicht berücksichtigt
Kontakt zu ISO / IEEE ist
aufgenommen: Bezug zur ISO IEC
IEEE 26514 über Software-
Dokumentation; (auch 26511,
26512, 26513, 26515)
International konforme Anleitungen
Empirische Methoden (bisher kein Wie)
Ausprägung von Qualitätssicherung
Klarere Formulierung von
Qualitätskriterien
Erstellungsprozess (bisher nur
informativ und exemplarisch
im Anhang D)
Mehr begriffliche Konsistenz
Auch parallele Anwendung der
ISO IEC IEEE 26514 ermöglichen
User Feedback
Integration von Komponenten
speziell: Anlagenbau
Struktur von Informationsarten
Gliederung verbessern
Verständlichkeit verbessern
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
67
Schmeling + Consultants GmbH Heidelberg
www.schmeling-consultants.de Telefon +49 (0) 62 21 / 58 50 47-0
Entstehung und Inhalte
der Norm
IEC 82079-1:2012
„Erstellen von
Gebrauchsanleitungen“
Winterthur, 2013-11-11
Roland Schmeling [email protected]
Schmeling + Consultants GmbH Heidelberg
www.schmeling-consultants.de Telefon +49 (0) 62 21 / 58 50 47-0
Ausblick
IEC 82079-1:2012
„Erstellen von
Gebrauchsanleitungen“
Winterthur, 2013-11-11
Roland Schmeling [email protected]
Ausblick
DKE Arbeitskreis 113.0.2 gestartet
Sitzung fand am 28. Oktober 2013 in Frankfurt statt
Ziel: Überarbeitung liegt 2016 vor
Angestrebt: Joint Working Group DKE / DIN in Deutschland
Relativ sicher: Joint Working Group IEC / ISO auf internationaler
Ebene
U.a. Japan stark involviert
(c)
2013, S
chm
elin
g +
Consultants
Gm
bH
70
Schmeling + Consultants GmbH Heidelberg
www.schmeling-consultants.de Telefon +49 (0) 62 21 / 58 50 47-0
Danke für die Aufmerksamkeit!
IEC 82079-1:2012
„Erstellen von
Gebrauchsanleitungen“
Winterthur, 2013-11-11
Roland Schmeling [email protected]