Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC)...

28
Bremer Normentag 2011 Einsparung durch Einsparung durch Reduzierung und Reduzierung und Wiederverwenden Wiederverwenden Bedeutung der Normung i d in der technischen Dokumentation -1- - 18.01.2011 19:21:58 - technischen Dokumentation

Transcript of Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC)...

Page 1: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Bremer Normentag 2011

Einsparung durchEinsparung durch Reduzierung undReduzierung und WiederverwendenWiederverwenden

Bedeutung der Normungi din der

technischen Dokumentation- 1 -- 18.01.2011 19:21:58 -

technischen Dokumentation

Page 2: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Ob das ein Erfolgsmodell ist, weiß ich nicht….

… bekannt ist mir aber folgendesErfolgsmodellErfolgsmodell

Normung und Standardisierung in Deutschland dienen 

Wirtschaft und Gesellschaft zur Stärkung, 

Gestaltung und Erschließung 

i l d l b l Mä k

- 2 -- 18.01.2011 19:21:58 -

regionaler und globaler Märkte. 

Page 3: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Volkswirtschaftlicher Schaden durch Gebrauchsanweisungen

Bei über 350 Millionen EURO jährlich liegt derv o l k s w i r t s c h a f t l i c h e G e s a m t s c h a d e n .So jeden fa l l s loka l i s ie r te d ie Wür t temberg ischeFeuerversicherung in einer Studie die Sachschäden, diedurch fehlerhafte Bedienungsanleitungen entstehen. Von12.000 untersuchten Schadensmeldungen an elektronischenProdukten, konnte fast die Hälfte (46%) auf unsachgemäße, ( ) gBedienung zurückgeführt werden. So erschreckend dieZahlen sind, die Dunkelziffer dürfte noch weitaus höher sein.Rechnete man die Verluste innerhalb der Garantiezeiten mitRechnete man die Verluste innerhalb der Garantiezeiten mitund weiterhin die Aufwendungen aus Kulanzhandlungen, soliegt der Gesamtschaden weit über 0,5 Milliarden EURO proJahr Ganz abgesehen von den enormen immateriellenJahr. Ganz abgesehen von den enormen immateriellenImageschäden, die im Prinzip auf die Hersteller zurückfallen.Quelle: Jürgen H. Hahn, "Jetzt zieh den Zipfel durch die Masche - Das Buch derGebrauchsanweisungen" 1994 by Ammann Verlag Zürich ISBN 3 250 10238 5 (Seite 155 und 156)

- 3 -- 18.01.2011 19:21:58 -

Gebrauchsanweisungen , 1994 by Ammann Verlag, Zürich - ISBN 3-250-10238-5 (Seite 155 und 156)

Page 4: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Anleitungen im Alltag

"Anleitung unserer Luftmatratze ES 223…

Wenn das Wetter kalt ist wird die Puff Unterlage sich langsamWenn das Wetter kalt ist, wird die Puff Unterlage sich langsam puffen. Entrollen die Puff Unterlage und liegen auf ihr, dann wird sie von der Wärme sich Inflationen bekommen."Quelle: H. Hahn; "Jetzt zieh den Zipfel durch die Masche"; dtv 1998

Da ist es wohl besser, auf Text zu verzichten:

aber…..

verstehen wir die IKEA-Anleitungen (Ik i t hi ?Anleitungen (Ikea ist hier nur als Synonym für eine spezielle Art von No-Text-Anleitungen genannt)

?- 4 -- 18.01.2011 19:21:58 -

Page 5: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Bedienungsanleitungen im Focus

Kundennutzen zweifelhaft?

Nürnberger Nachrichten

13.08.2005

Seite M13NEIN !Standards durch Verbände als

Hilfestellung zur Ausführung von Benutzerdokumentation

- 5 -- 18.01.2011 19:21:58 -

Benutzerdokumentation

Page 6: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

ZielgruppenTechnische Dokumentation

Z i Zi lZwei Zielgruppen:1. Fachexperten

Anmerkung des

2. nichtgewerbliche Letztverbraucher

Vortragenden:Rechts- und Beamtendeutsch ist eine für Normalbürger wohl

h ä dli hschwer verständliche eigenständige Sprache:stimmen Sie mir da zu?

Der Letztverbraucher, besser gesagt unser Kunde, wünscht sich verständliche Gerätesich verständliche Geräte. Information und damit technische Dokumentation hat einen hohen wirtschaftlichen Stellenwert. Beispiel:

- 6 -- 18.01.2011 19:21:58 -

Page 7: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Marktinformation für Hersteller, Händler, Verbraucher

HerstellerHersteller KUNDENDOKUMENTATIONKUNDENDOKUMENTATION

Bedienungs ‐anleitung, ‐anweisung

Gebrauchs ‐anleitung, ‐anweisung

Betriebs ‐anleitung, ‐anweisungMarkt

Händler VerbraucherA dAnwender

Marktinformationen sind unverzichtbarer Bestandteil einer Firmendokumentation durch die Hersteller an ihredurch die Hersteller an ihre Händler und Verbraucher,an deren Ende in d. R. eine Kundendokumentation steht

- 7 -- 18.01.2011 19:21:58 -

Kundendokumentation steht.

Page 8: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Technische Dokumentation Quelle: tekom nachrichten 3.93 (modifiziert)

Dokumentation

Sonstige Dokumentation

Dokumentation

Technische Dokumentation

Betriebsexternetechnische Dokumentation

Betriebsinternetechnische Dokumentation

PflichtenheftKonstruktionsunterlagenBetriebsanweisungenFertigungsunterlagen usw.

Technische Dokumentationfür die Nutzung des Produkts

Benutzerinformationen:

Technische Dokumentationfür den Vertrieb

ProduktinformationenBenutzerinformationen:BetriebsanleitungenGebrauchsanleitungenHinweise

ProduktinformationenDatenblätterProspekteKatalogetechnische Anteile v Angeboten usw

- 8 -- 18.01.2011 19:21:58 -

Hinweise technische Anteile v. Angeboten usw.

Page 9: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Definition aus DIN EN 307

"Wärmeaustauscher − Anleitung für die Anfertigung von Einbau-und Betriebsanleitungen und Wartungsanweisungen zum Erhalt g g gder Leistung von Wärmeaustauschern jeglicher Bauart"

Definition BetriebsanleitungDefinition Betriebsanleitung

Beschreibung der bestimmungsgemäßen Funktion der Anlage und A fli t d M ß h di fü i i df i B t i bAuflistung der Maßnahmen, die für einen einwandfreien Betrieb erforderlich sind. Betriebsanleitungen beschreiben auch Systemeund Bauelemente sowie deren Lage Funktionsprinzip und sicherund Bauelemente sowie deren Lage, Funktionsprinzip und sicher-heitstechnische Anforderungen an den Wärmeaustauscher. Die Betriebsanleitungen enthalten keine WartungspläneBetriebsanleitungen enthalten keine Wartungspläne.

- 9 -- 18.01.2011 19:21:58 -

Page 10: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

DIN EN 45020: Normung und damit zusammen-ghängende Tätigkeiten - Allgemeine Begriffe

Anleitung für die Praxis (Abschnitt 3.5)

Dokument das Praktiken oder Verfahren für den Entwurf dieDokument, das Praktiken oder Verfahren für den Entwurf, die Herstellung, die Montage, die Wartung oder Verwendung von Geräten, Konstruktionen oder Produkten empfiehlt.

ANMERKUNG: Eine Anleitung für die Praxis kann eine Norm, ein Teil einer Norm oder unabhängig von einer Norm sein.

Anweisung (Abschnitt 7.3)

Festlegung, die ein Handeln erfordert.

- 10 -- 18.01.2011 19:21:58 -

Page 11: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Weitere genormte Begriffe nach DIN EN 45020

Beispiel: Abschnitt in DIN EN 45020

Anbieter‐Erklärung 15.1.1

Anforderung 7.5

b h ib d lbeschreibende Festlegung 7.7Empfehlung 7.4

Festlegung 7 1Festlegung 7.1

Gebrauchstauglichkeit 2.1

Konformität 12.1

Sicherheit 2.5

Zulassung 16.1

- 11 -- 18.01.2011 19:21:58 -

Page 12: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Bedienungs-, Gebrauchs-, Betriebsanleitungen

Normen beschreiben den Rahmen mit Angaben zu:

– Inhalt (z. B. DIN EN 62079)

I h lt t kt ( B DIN F hb i ht 146)– Inhaltstruktur (z. B. DIN Fachbericht 146)

– Terminologie (z. B. DIN-Term)

– Beispiele (diverse Normen)

• Inhaltsverzeichnisse

• Kennzeichnungssystematik

• Literaturhinweise

- 12 -- 18.01.2011 19:21:58 -

Page 13: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Normen und Spezifikationen zur technischen Dokumentation (Beispiele)

DIN EN ISO Sicherheit von Maschinen – Grundbegriffe, allgemeine12100-2 Gestaltungsleitsätze – Teil 2 Technische Leitsätze

(Abschnitt 6)

Hinweis von INMAS:[CE-KOOinfo Nr. 34]

(Abschnitt 6)DIN 875-3 Kälteanlagen – Sicherheitstechnische Anforderungen

für Gestaltung, Ausrüstung, Aufstellung und Betrei-ben – Angaben in Betriebsanleitungen

Die Reihe be gabe e ebsa e u ge

DIN 31052 Instandhaltung, Inhalt und Aufbau von Instandhaltungs-anleitungen

DIN EN 61082 Dokumente der Elektrotechnik (mehrere Teile)

DIN 6789 Dokumentations-systematikAufbau Technischer( )

DIN EN 61187 Elektrische und elektronische Messgeräte – Mitzu-liefernde Unterlagen

DIN EN 60204-1 Sicherheit von Maschinen – Elektrische Ausrüstung

„Aufbau Technischer Produktdokumen-tationen“

gvon Maschinen – Allgemeine Anforderungen

DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt undDarstellung

wird in nächster Zeit so überarbeitet, dass bei einer Neuauflage nur noch ein oderVDI 4500 Bl.1-3 Technische Dokumentation – Benutzerinformation

DIN-Fachb. 146 Technische Produktdokumentation – Betriebsanlei-tungen für Anlagen

nur noch ein oder zwei praktische Teile entstehen.

- 13 -- 18.01.2011 19:21:58 -

Page 14: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Wichtige Dokumente für Betriebsanleitungen

DIN EN 62079 Erstellung von AnleitungenIEC 62079

Die DIN EN 62079wird z.Zt. IEC 62079überarbeitet.

Unter neuerDIN Fachbericht 146 Technische Produktdokumentation -

Betriebsanleitungen für Anlagen

Unter neuer NummerIEC 82079‐1i d di iwird diese zu einer 

weltweiten Norm.

DIN EN 45020 Normung und damit zusammenhängende Tätigkeiten -Allgemeine Begriffe

ErscheinungsterminvoraussichtlichEnde 2011.g g

- 14 -- 18.01.2011 19:21:58 -

Page 15: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

DIN EN 62079 - Erstellung von Anleitungen -Teil 1

Anwendungsbereich:

alle Arten von Produktenalle Arten von Produkten

I di N i dIn dieser Norm sind allgemeine Prinzipien und detaillierte Anforderungen für den Entwurf und die Formulierung aller Arten von Anleitungen gzusammengestellt, die für alle Arten von Produkten notwendig und hilfreichnotwendig und hilfreich sind.

- 15 -- 18.01.2011 19:21:58 -

Page 16: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

DIN EN 62079 - Erstellung von Anleitungen -Teil 2

InhaltInhalt

1. Normative Verweisung2. Begriffe3. Grundsätze4. Allgemeine Anforderungen4. Allgemeine Anforderungen4.1 Anleitung ist Bestandteil des Produkts........

4.7 Erstellung von Anleitungen4.7 Erstellung von Anleitungen

5 Inhalt von Anleitungen5.1 Allgemeinesg........

5.16 Inhaltsverzeichnis, Stichwortverzeichnis

6 Darstellung von Anleitungen6 Darstellung von Anleitungen6.4 Symbole

Anhänge (u. a. Beispiele)

- 16 -- 18.01.2011 19:21:58 -

Anhänge (u. a. Beispiele)

Page 17: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

DIN EN 62079 - Erstellung von Anleitungen -Teil 3

Nicht für jeden Spezialfall

Keine allgemeine Norm kann umfassend Informationen liefern, die jeden Spezialfall abdecken.abdecken.

Diese Norm dient alsDiese Norm dient als Rahmenfestlegung für produktspezifische Normen.

Grundlegende Festlegungen, Stärken und Schwächen = Auszug aus dem Foliensatz „ IEC 62079 - Instrument der Qualitätssicherung - Jochen Fischer, Firma SL innovativ “ Vortrag tekom Regionalgruppe Nürnberg vom 24.03.2003

- 17 -- 18.01.2011 19:21:58 -

Page 18: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Sonstige relevante Normen z.B. für weiße Ware

DIN EN 60335 (VDE 0700)DIN EN 60335 (VDE 0700)

IEC 60335 modifiziert

Sicherheit elektrischerSicherheit elektrischer Geräte für den Hausgebrauch und äh li h Z kähnliche ZweckeTeil 1: Allgemeine

Anforderungeng

Teil 2: Staubsauger

Teil 5: Geschirrspül-maschinenmaschinen

Teil 6: Herde, Koch-mulden, Backöfen

Teil 7: Waschmaschinen

Teil 11: Trommeltrockner

T il 24 Kühl /G f i ät

- 18 -- 18.01.2011 19:21:58 -

Teil 24: Kühl-/Gefriergeräte

Page 19: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Erfolgsmodell Anleitungen weiße Ware

E ropa eite T t b i it Note 1Europaweite Testergebnisse mit Note 1durch unabhängigeTestinstitute belegen:

Einhaltung von Normen macht sich bezahltEinhaltung von Normen macht sich bezahlt

- 19 -- 18.01.2011 19:21:58 -

Page 20: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Wie hat man das erreicht?

Durch Spezialisierung:

• Strukturierte Anleitungen

p g

• Standardisierte Anleitungen

• Kontrollierte Sprachen, wie „Simplified Technical English“

und Strukturiertes Technisches Deutsch“und „Strukturiertes Technisches Deutsch

• Terminologieg

- 20 -- 18.01.2011 19:21:58 -

Page 21: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Standardisierte Sprache ist Realität

Seit Jahrzehnten erprobt …..

i d Fl i d t iin der Flugzeugindustriedurch ASD-Standards

jetzt ganz neujetzt ganz neu

in der Hausgeräteindustriebasierend auf ASD STEbasierend auf ASD STE

Wann in anderen Branchen?

Auch in der Normung, in der sehr vieleDokumente erstellt werden, könnte einSprachstandard zu hoher Qualität sowieEindeutigkeit und Einsparungen führen

- 21 -- 18.01.2011 19:21:58 -

g p g

Page 22: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Drei Fragen zur Qualität von Dokumenten

Vor Beginn jeder Dokumentation sollte man sich folgende Fragen stellen:

•Welche Standards sind zu•Welche Standards sind zu beachten?

•Wie baue ich die Dokumentation auf?

•Wer ist meine Zielgruppe und i h i h i ?wie spreche ich sie an?

- 22 -- 18.01.2011 19:21:58 -

Page 23: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Standardisiert, was bedeutet das?

Berücksichtigung von Normen und Richtlinien

• DIN EN 62079 – VDE 0039 Erstellen von Anleitungen

• VDI 4500 …. BenutzerinformationVDI 4500 …. Benutzerinformation

• DIN 6789 Dokumentationssystematik

• DIN EN 61082 …. Dokumente der Elektrotechnik

• DIN-Fachbericht 146 Betriebsanleitungen für Anlageng g

• DIN EN 45020 Allgemeine Begriffe

• ANSI Z535.6 (USA) Warnhinweise

• Produktspezifische Normen / Hausinterne Standards / Werksnormen

- 23 -- 18.01.2011 19:21:58 -

p

Page 24: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Strukturiert, was bedeutet das?

Entwicklung eines einheitlichen logischen Aufbaus

• Dokumente• Dokumente

• Kapitel

• Unterkapitel/Abschnitte

Ab ä• Absätze

• Warnhinweise

• Sätze

• Abbildungen

- 24 -- 18.01.2011 19:21:58 -

Page 25: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Sprachorientiert, was bedeutet das?

Anwendung von normierter (kontrollierter) Sprache

• Verwenden allgem und leicht verständlicher Wörter• Verwenden allgem. und leicht verständlicher Wörter

• Zuordnen von exakt einer Bedeutung pro Wort

• Ein begrenztes Basisvokabular

Li i i d A hl W i• Limitierung der Anzahl von Wortvarianten

• Auswahl von zugelassenen technischen gFachwörtern (kundenspezifisch)

• Begrenzte Anzahl von Grammatik- und Stilregeln• Begrenzte Anzahl von Grammatik- und Stilregeln

• Beschränkung auf ein Thema pro Absatz

- 25 -- 18.01.2011 19:21:58 -

Page 26: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Drei Antworten zur Qualität von Dokumenten

Die 3S - Methode beinhaltet

•Einhaltung von Normen und Richtlinienund Richtlinien

•Einheitlichen logischenEinheitlichen logischen Dokumenten-Aufbau

•Normierte(kontrollierte) Sprache und Terminologie

Testen Sie uns!

- 26 -- 18.01.2011 19:21:58 -

Page 27: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Ein kleiner Test zum Schluss:

GRATULATION!

Sie haben es geschafft!

Das Prinzip ist ganz einfach. 

Ein ganzes Wort ist für 

G hiunser Gehirn wie ein Bild.Worte oder Schriftzeichen,spielt alles keine Rolle

- 27 -- 18.01.2011 19:21:58 -

keine Rolle.

Page 28: Einsparung durchEinsparung durch Reduzierung ... in der Dokumentation.pdf · DIN EN 62079 (+IEC) Erstellen von Anleitungen – Gliederung, Inhalt und Darstellung wird in nächster

Schön, dass ich besuchen durfteSie

Dipl.-Ing.Holk TraschewskiGeschäftsführerGeschäftsführerTel. direkt (Mobil)+49 (171) 6903920

Fürther Straße 246, 90429 Nürnberg

Tel.: +49 (0)911 23 980 990, Fax: +49 (0)911 23 980 989E M il i f @d k t h dE-Mail: [email protected]

www.dokumentenmacher.de

- 28 -- 18.01.2011 19:21:58 -