Webinar-Präsentation: "Was bedeutet die internationale Norm IEC 82079-1 zum Erstellen von...
Transcript of Webinar-Präsentation: "Was bedeutet die internationale Norm IEC 82079-1 zum Erstellen von...
Schmeling + Consultants GmbH Heidelberg
www.schmeling-consultants.de Telefon +49 (0) 62 21 / 58 50 47-0
Webinar in Kooperation mit Acrolinx
Im Fokus: Sprache und Terminologie
Fachbeitrag: Was bedeutet
die internationale Norm
IEC 82079-1 zum Erstellen
von Gebrauchsanleitungen
für Ihr Unternehmen?
07.05.2014
Roland Schmeling [email protected]
Acrolinx
IEC 82079-1 Erstellen von Gebrauchsanleitungen
Status • Internationale Norm (IEC)
• Europäische Norm (EN)
• Deutsche Übersetzung (DIN EN) seit 2013-06
• Wichtigste Norm für Anleitungen
Veröffentlichung • August 2012
Vorgänger • IEC 62079:2001 (ungültig; aber: EN 62079:2001 noch bis
12.09.2015)
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
2
Acrolinx
Kleine Umfrage …
3 (c)
2014, S
chm
elin
g +
Consultants
Gm
bH
Acrolinx
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
4
Acrolinx
EN 62079: Rechtliche Bedeutung in Europa und Deutschland
EN 82079-1 tritt Nachfolge an
IEC 62079
EN ISO 12100
DIN EN ISO 12100
Gesetz - verbindlich
Norm – freiwillig
„Stand der Technik“
ProdSG
EG-Vertrag AEUV Artikel 114
• Legt „hohes Schutzniveau“ fest
• Ermöglicht Richtlinien mit Anforderungen an Produkte
bzw. Arbeitsmittel
EG Produktsicherheits-
richtlinie 2001/95/EG
EG Maschinen-RL
2006/42/EG
9. ProdSGV
EN 62079
DIN EN 62079
EG Medizinprodukte-
RL 93/42/EG
MPG
EN IEC 60601-1
DIN EN IEC
60601-1
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
5
Acrolinx (c)
2014, S
chm
elin
g +
Consultants
Gm
bH
IEC 82079-1: Bedeutung
Normen generell
Erstellung durch privatrechtliche Organisationen
„Interessierte Kreise“
Normen sollen den Stand der Technik wiederspiegeln
Anwendung freiwillig, aber:
Rechtsprechung: Regeln der Technik
Produkthaftungsrecht: Mindeststandards
Produktsicherheitsrecht: Teilweise zur Umsetzung von Gesetzen
6
IEC 82079-1
EU: Ohne Auftrag der Kommission, daher
keine harmonisierte Norm, keine generelle Zuordnung zu einer Richtlinie des „Neuen Konzepts“
• siehe www.newapproach.org
Deutschland: Vorgänger DIN EN 62079 hatte Vermutungswirkung hinsichtlich des GPSG für allgemeine Produkte (bisher durch AtAV, jetzt AfPS; künftige Regelung noch unklar)
International wachsende Aufmerksamkeit und Mitwirkung
Normungsorganisationen und –gremien, Verbraucherverbände, COPOLCO (http://www.iso.org/iso/copolco)
IEC: horizontale Norm zum Aspekt: „Anleitung“ (ISO: ähnliche Regelung)
Deutliche Empfehlung für vertikale (produktbezogene) Normen
Gilt immer dann, wenn vertikale Norm keine abweichende Regelung hat
ISO: horizontale Bedeutung (ähnlich wie IEC)
Gemeinsame Arbeitsgruppe mit IEC; Beginn einer Normenreihe: offen für weitere Teile
Acrolinx
Wichtige Neuigkeiten
Sicherheits- und Warnhinweise
Differenzierte Regelung für die Lesbarkeit
Neuer Anhang Prozess
Neuer Anhang Empirische Methoden
Qualifikation von Redakteuren
Regelung für die Konformitätsprüfung
Zielgruppenanalyse
Kein Standard-Inhaltsverzeichnis mehr
…
Weniger spannend:
Elektronische Medien
Anlagen
…
7 (c)
2014, S
chm
elin
g +
Consultants
Gm
bH
Acrolinx
Mögliche Themen der nächsten Revision der IEC 82079-1
Sicherheitsaspekte klarer und
konsistenter, z. B. Zusammenhang von
Risikobeurteilung
Kompetenzen der Prozessbeteiligten
differenzierter (Rollendefinitionen)
Nutzung elektronischer Medien
Empirische Methoden zur
Informationsqualität und zur
Zielgruppenanalyse
Qualitätssicherung
International konforme Anleitungen
Klarere Formulierung von
Qualitätskriterien und einer
Qualitätsmetrik
Erstellungsprozess (bisher nur
informativ und exemplarisch
im Anhang D)
Erstellungsprozess
Scope und Titel der Norm
Gliederung, Verständlichkeit und
begriffliche Klarheit und Konsistenz der
Norm verbessern
Ggf. Ermöglichen weiterer Teile
User Feedback
Integration von Komponenten
speziell: Anlagenbau
Abstimmung mit ISO IEC IEEE 26514
über Software-Dokumentation, u.a.
begrifflich
Struktur von Informationstypen
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
8
Acrolinx
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
9
Acrolinx
IEC oder DIN EN?
IEC 82079-1 Preparation of
instructions for use …
Quelldokument
relativ teuer
Vorlage für Übersetzung
Style guide
„The intention of no failure should be
aimed for.“ (zielt auf die Fehlerfreiheit
einer Anleitung, vgl. TQM-Prinzipien)
DIN EN 82079-1 Erstellen von
Gebrauchsanleitungen …
Deutsche Übersetzung
vergleichsweise günstig
Enthält Übersetzungsfehler
Übersetzung: „Gestaltungsleitsatz“
besser: „Redaktionsleitfaden“
Übersetzung: „Es sollte die Absicht
angestrebt werden, nicht zu
versagen.“
Sinngemäß besser: „Fehlerfreie
Anleitungen sollten stets das Ziel
sein.“
Wer es genau wissen will, muss im
englischsprachigen Original nachlesen.
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
10
Acrolinx
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
11
Acrolinx
DIN EN 82079-1: Formulierung
6.1.7 Eine Handlungsanweisung pro Satz
Ein Satz darf nur eine Handlungsanweisung enthalten oder höchstens eine
kleine Anzahl von eng zusammenhängenden Handlungsanweisungen.
6.1.8 Regeln der einfachen Formulierung
Der Text der Gebrauchsanleitung muss in einfachen, eindeutigen, direkten
Formulierungen in kurzen Sätzen geschrieben werden, also nach dem
Prinzip „Ein Ausdruck, eine einfache Bedeutung". Die logische Struktur
des Texts muss deutlich sein.
[…]
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
12
Acrolinx
DIN EN 82079-1, 6.1.7 Regeln der einfachen Formulierung
Prinzipien Empfohlen Abzulehnen
Aktivform von Verben statt
Passivform verwenden
Stellen Sie den Strom ab. Seien Sie sicher, dass der
Strom ausgeschaltet ist.
Sei bestimmt: vorzugsweise
Befehle als schwächere Form
Entfernen Sie keine
Etiketten.
Sie sollten keine Etiketten
entfernen.
Anleitungen eher mit
Tätigkeitsverben als mit
abstrakten Hauptwörtern
Anwenden, instand
halten, vermeiden
Verwendung,
Instandhaltung,
Vermeidung
Nutzer eher direkt
ansprechen als sagen, was
sie tun könnten
Ziehen Sie den schwarzen
Hebel zu sich.
Nutzer werden den
schwarzen Hebel von der
Maschine wegziehen.
Doppelte Verneinungen
vermeiden
Nur 3-A-Sicherungen
passen
Keine Sicherungen passen
außer 3 A
Leicht verwechselbare
Wörter vermeiden
(besonders mit Präfixen, die
gleich aussehen und klingen)
Brennbarer Inhalt;
Hohe/(niedrige)
Empfindlichkeit
Entflammbarer Inhalt;
Hyper/(hpyo)-
Empfindlichkeit
Tabelle 1: Beispiele für Schreibstil
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
13
Acrolinx
DIN EN 82079-1: Fachbegriffe, Abkürzungen, Akronyme
6.1.8 Regeln der einfachen Formulierung
[…]
Abkürzungen und Akronyme müssen vermieden werden, es sei denn, es kann
angenommen werden, dass sie den beabsichtigten Nutzern bekannt sind, oder die
Begriffe sind beim ersten Auftreten in der Gebrauchsanleitung oder/und in einem Glossar
erklärt.
[…]
5.15.5 Fachbegriffe, Akronyme und Abkürzungen
Unvermeidbare Fachbegriffe, Akronyme und Abkürzungen, die für die beabsichtige
Zielgruppe nicht sofort verständlich sind, müssen aufgelistet und erklärt werden.
Bei Verbraucherprodukten ist es hilfreich, empirische Tests durchzuführen, wenn
zweifelhaft ist, ob die Fachbegriffe im Allgemeinen von der Zielgruppe verstanden
werden. Es wird ein Glossar empfohlen, wenn Fachbegriffe in der Gebrauchsanleitung
oft angewendet sind.
[…]
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
14
Acrolinx
DIN EN 82079-1: Redaktionsleitfaden
6.1.2 Gestaltungsleitsatz
Ein Gestaltungsleitsatz sollte festgelegt und in der gesamten
Gebrauchsanleitung befolgt werden, der zum Beispiel abdeckt:
• Schreibstil (siehe Tabelle 1);
• Formulierung;
• konsistente Anwendung von Begriffen;
• Art und Weise der Anrede der Leser;
• Gestaltung von Text- und Seitenlayout einschließlich Auswahl von
Schriftart und –größe (siehe Tabelle 2).
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
15
Acrolinx
DIN EN 82079-1: Konsistente Terminologie
5.15.5 Fachbegriffe, Akronyme und Abkürzungen
[…]
Eine gleichbleibende Terminologie muss in der Gebrauchsanleitung, am
Produkt, auf der Verpackung und, falls notwendig, in Begleitmaterialien wie
Handbüchern angewandt werden.
6.1.4 Konsistente Terminologie
Die Terminologie muss konsistent nach dem redaktionellen
Gestaltungsleitsatz angewendet werden, auf diese Weise verbessert sich
die Verständlichkeit.
Eine konsistente Terminologie muss in den Materialien angewendet
werden, sei es in der Gebrauchsanleitung selbst, auf der Verpackung, in
anderen zusätzlichen Materialien und auf dem Produkt selbst.
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
16
Acrolinx
DIN EN 82079-1: Stichwortverzeichnis
5.15.4 Stichwortverzeichnis
Wenn die Gebrauchsanleitungen lang und komplex sind, sollte ein Index
mit Schlagwörtern in alphabetischer
Reihenfolge angegeben werden. Der Index muss im Inhaltsverzeichnis
referenziert werden.
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
17
Acrolinx
DIN EN 82079-1: Qualitätssicherung
6.1.11 Korrekturlesen
Gebrauchsanleitungen müssen von anderen Personen Korrektur gelesen
werden als vom Autor oder Übersetzer, vorzugsweise einem
Muttersprachler der Zielsprache, der Kenntnisse über das betreffende
Produkt hat.
Die Bewertungskriterien sind:
• Formulierung entsprechend dem Gestaltungsleitsatz;
• korrekte Rechtschreibung und Zeichensetzung;
• korrekte Grammatik;
• Konsistenz der Begriffe.
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
18
Acrolinx
DIN EN 82079-1: Funktionale Formulierung
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
19
Acrolinx
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
20
Acrolinx
Inhalt (Proposition) und Funktion (Illokution) unterscheiden
Feststellen, dass die Tür offen ist.
NN vorwerfen, dass NN die Tür offen gelassen hat.
NN auffordern zu prüfen, ob die Tür offen ist.
NN auffordern, die Tür zu schließen.
NN auffordern, zu gehen.
NN einladen, hereinzukommen.
Im Funktionsdesign:
Festlegen der benötigten Sprechakte
Zielangabe, Handlungsaufforderung, Bedingung, Voraussetzung, Tipp, Beispiel, Risiko,
Thema, Orientierung, Resultat, Aufbau, Funktionsweise, Bedienelement-Funktion, …
Nicht: Bitte, Entschuldigung, Vorwurf, Gefühlsäußerung, Befehl, Schuldspruch, Eid, …
Definition der entsprechenden schreibtechnischen Regeln in einem
Redaktionsleitfaden nach einheitlichem Beschreibungsmuster
Maßgabe: Hohe Informationsqualität und Konsistenz
Darauf aufbauend: Schulung, Qualitätssicherung, Tool-Konfiguration, …
„Die Tür ist offen.“
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
21
Acrolinx
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)
2014, S
chm
elin
g +
Consultants
Gm
bH
22
Acrolinx
Wäre es nicht wunderbar …
… wenn eine Software einen Teil dieser umfangreichen
schreibtechnischen Prüfungen abnehmen könnte?
… wenn eine Software einen Teil der nach EN 82079-1
geforderten Qualitätssicherung automatisieren könnte?
… wenn der Autor diese zahlreichen schreibtechnischen
Regeln und terminologischen Festlegungen nicht merken oder
jeweils nachschlagen muss?
(c)
2014, S
chm
elin
g +
Consultants
Gm
bH
23