Grundlagen der Technischen Dokumentation (eBook)

Dipl.-Ing. Lars Kothes studierte Maschinenbau in Krefeld. Nachdem er fünf Jahre Erfahrung als Technischer Redakteur bei einem Dienstleister für technische Dokumentation gesammelt hatte, gründete er 2003 die Kothes! Technische Kommunikation GmbH & Co. KG. Seit 2001 ist er Regionalgruppenleiter der tekom-Regionalgruppe Nordrhein. 2008 wurde er von der IHK Mittlerer Niederrhein als Sachverständiger für Technische Dokumentation öffentlich bestellt und vereidigt.

Inhalt 5
Kapitel 1 13
Grundlegendes 13
1.1 Stellenwert der Technischen Dokumentation 13
1.2 Arten von Technischer Dokumentation 14
1.3 Berufsbild des Technischen Redakteurs 15
Kapitel 2 17
Gesetze, Richtlinien und Normen 17
2.1 Grundlagen der CE-Kennzeichnung 17
2.1.1 Die Europäische Union 18
2.1.2 Gesetzgebungsverfahren in der EU 19
2.1.3 EG-Richtlinien nach „Neuer Konzeption“ (New Approach) 19
2.1.4 Marktaufsicht 21
2.1.5 Geltungsbereich der EG-Richtlinien 22
2.2 Geräteund Produktsicherheitsgesetz und EG-Richtlinien 23
2.2.1 Geräteund Produktsicherheitsgesetz (GPSG) 23
2.2.2 Maschinenrichtlinie 24
2.2.3 Niederspannungsrichtlinie 26
2.2.4 EMV-Richtlinie 26
2.2.5 Geräte in explosionsgefährdeten Bereichen (ATEX) 27
2.2.6 Medizinprodukterichtlinie 28
2.2.7 Weitere Richtlinien 29
2.3 Produkthaftung 30
2.4 Normen 31
2.4.1 Grundlagen der Normung 31
2.4.2 DIN EN 62079 34
2.4.3 DIN EN ISO 12100-2 38
2.4.4 ISO Guide 37 40
2.4.5 VDI 4500 42
2.4.6 DIN-Fachbericht 146 45
2.4.7 DIN EN 15038 47
2.5 Formale Anforderungen an die Anleitung 49
2.5.1 Vollständigkeit 49
2.5.2 Verständlichkeit 49
2.5.3 Lieferform 50
2.5.4 Zeitpunkt der Bereitstellung 50
2.5.5 Sprache 51
2.5.6 Muss der Nutzer die Anleitung eigentlich lesen? 51
2.6 Spezielle Anforderungen an Softwaredokumentation 52
2.6.1 Internationale Normen 52
2.6.2 Software als Bestandteil eines Produkts oder Geräts 52
2.6.3 Anwendbarkeit des Geräteund Produktsicherheitsgesetzes (GPSG) 53
2.6.4 Mängelgewährleistung 53
2.6.5 Sicherheitsanforderungen und abgeleitete Pflichten 53
2.6.6 Sprachen 55
2.7 Die Risikobeurteilung – Grundlage der Betriebsanleitung 55
Kapitel 3 59
Dokumentationsprozess 59
3.1 Projektplanung 59
3.1.1 Zuständigkeiten 60
3.2 Zielgruppenanalyse 60
3.2.1 Zielgruppensegmentierung 61
3.2.2 Zielgruppencharakterisierung 62
3.3 Recherche 63
3.3.1 Recherchecheckliste erstellen 63
3.3.2 Vorhandene Informationen auswerten 65
3.3.3 Recherche vorbereiten 66
3.3.4 Recherche durchführen 66
3.3.5 Recherche auswerten 67
3.4 Erstellung 68
3.4.1 Erstellungsprozess 68
3.4.2 Tipps für optimale Arbeitsabläufe beim Erstellungsprozess 68
3.5 Qualitätssicherung 70
3.5.1 Welche Faktoren bestimmen die Qualität von Technischen Dokumentationen? 71
3.5.2 Durch welche Prozesse und Systeme kann die Qualität sichergestellt werden? 72
3.6 Übersetzung 75
3.7 Stolpersteine 76
3.8 Prozesse optimieren 77
Kapitel 4 79
Inhalte der Anleitung 79
4.1 Deckblatt 79
4.2 Impressum 81
4.3 Inhaltsverzeichnis 81
4.4 Allgemeines 81
4.4.1 Informationen zu dieser Anleitung 82
4.4.2 Symbolerklärung 82
4.4.3 Haftungsbeschränkung* 83
4.4.4 Urheberschutz 84
4.4.5 Garantie und Gewährleistung 84
4.5 Sicherheit 85
4.5.1 Bestimmungsgemäße Verwendung 86
4.5.2 Allgemeine Gefahrenquellen 86
4.5.3 Verantwortung des Betreibers* 88
4.5.4 Personalqualifikation 89
4.5.5 Sicherheitskennzeichnung 90
4.5.6 Schutzausrüstung 91
4.5.7 Sicherheitseinrichtungen 92
4.5.8 Sichern gegen Wiedereinschalten 94
4.5.9 Verhalten im Gefahrenfall 94
4.5.10 Umweltschutz 95
4.6 Technische Daten 95
4.6.1 Darstellung der Technischen Daten* 96
4.6.2 Technische Daten im Einzelnen 96
4.6.3 Alternative Darreichungsformen 98
4.7 Aufbau und Funktion 99
4.7.1 Kurzbeschreibung* 99
4.7.2 Übersicht 99
4.7.3 Lieferumfang* 102
4.7.4 Prozessoder Funktionsbeschreibung 102
4.7.5 Beschreibung der Baugruppen* 103
4.7.6 Anschlüsse 104
4.7.7 Anzeigen und Bedienelemente 105
4.7.8 Bediensoftware 106
4.7.9 Arbeitsplätze und Gefahrenbereiche 107
4.7.10 Betriebsarten 108
4.7.11 Zubehör, Werkzeuge 109
4.8 Transport 109
4.8.1 Sicherheit 109
4.8.2 Transportinspektion* 110
4.8.3 Symbole auf der Verpackung* 111
4.8.4 Verpackung 111
4.8.5 Transport 113
4.8.6 Lagerung 114
4.9 Installation und Erstinbetriebnahme 114
4.9.1 Sicherheit 117
4.9.2 Anforderungen an den Aufstellort 117
4.9.3 Vorbereitungen 118
4.9.4 Installation 118
4.9.5 Anschließen 119
4.9.6 Erstinbetriebnahme 120
4.10 Bedienung, Betrieb 120
4.10.1 Sicherheit 121
4.10.2 Tätigkeiten vor Gebrauch 121
4.10.3 Einund Ausschalten 122
4.10.4 Normalbetrieb 123
4.10.5 Besondere Handlungen 123
4.10.6 Tätigkeiten nach der Benutzung 124
4.10.7 Reinigung, Desinfektion, Sterilisation 124
4.11 Wartung 124
4.11.1 Sicherheit 125
4.11.2 Wartungsplan 125
4.11.3 Wartungsarbeiten 127
4.12 Störungen 128
4.12.1 Sicherheit 129
4.12.2 Störungsanzeigen 129
4.12.3 Verhalten bei Störungen 130
4.12.4 Störungstabelle 131
4.12.5 Arbeiten zur Störungsbeseitigung 133
4.13 Demontage, Entsorgung 133
4.13.1 Sicherheit 133
4.13.2 Demontage 134
4.13.3 Entsorgung 134
4.14 Glossar 135
4.15 Index 135
4.16 Anhang 138
4.16.1 Konformitätserklärung 139
4.16.2 Qualitätsdokumentation 139
4.16.3 Datenblätter 140
4.16.4 Checklisten, Prüfbücher 140
4.16.5 Anleitungen der Lieferanten 140
Kapitel 5 142
Anleitungen formulieren 142
5.1 Verständlich formulieren 142
5.1.1 Kurze und einfache Sätze formulieren 143
5.1.2 Substantivierungen vermeiden 143
5.1.3 Sätze nicht über Aufzählungen fortsetzen 143
5.1.4 Klemmkonstruktionen vermeiden 144
5.1.5 Funktionsverbgefüge vermeiden 144
5.2 Präzise formulieren 145
5.2.1 Eindeutige Terminologie 145
5.2.2 Abstrakte Begriffe und Fremdwörter vermeiden 145
5.2.3 Einzelheiten direkt benennen 146
5.2.4 Abkürzungen vermeiden 146
5.2.5 Firmenjargon vermeiden 146
5.2.6 Füllwörter vermeiden 147
5.2.7 Weichmacher vermeiden 147
5.3 Einheitlich formulieren 148
5.3.1 Einheitliche Anrede 148
5.3.2 Einheiten und Werte 149
5.3.3 Komposita übersichtlich schreiben 149
5.4 Überschriften korrekt wählen 150
5.5 Textwüsten vermeiden, Texte strukturieren 150
5.6 Handlungsanweisungen formulieren 151
5.6.1 Handlungsanweisung betiteln 151
5.6.2 Voraussetzungen definieren 151
5.6.3 Handlungsschritte typografisch hervorheben 154
5.6.4 Handlungsschritte aktivisch formulieren 155
5.6.5 Handlungsschritte vollständig formulieren 155
5.6.6 Eine Handlung je Handlungsschritt 156
5.6.7 Richtige Reihenfolge einhalten 157
5.6.8 Beispiel für eine gute Handlungsanweisung 157
5.7 Querverweise setzen 157
5.8 Übersetzungsgerecht schreiben 161
Kapitel 6 162
Anleitungen gestalten 162
6.1 Funktionsund zielgruppengerechte Gestaltung 162
6.1.1 Zweck der Gestaltung 162
6.1.2 Einfluss der Zielgruppe 163
6.1.3 Einfluss des Produktes 165
6.1.4 Entwicklung einer zweckgerichteten Gestaltung 166
6.2 Seitengestaltung 169
6.2.1 Seitengröße 169
6.2.2 Satzspiegel 170
6.2.3 Einseitig oder doppelseitig? 174
6.2.4 Ränder 174
6.2.5 Navigationselemente und andere Elemente auf der Seite 176
6.3 Typografie 178
6.4 Digitale Ausgabeformate von Anleitungen 181
6.4.1 PDF als Online-Medium 181
6.4.2 Klassische Online-Medien 182
6.4.3 E-Books 183
6.4.4 Hörbücher 184
6.4.5 Video-Anleitungen 184
Kapitel 7 186
Sicherheitshinweise gestalten und formulieren 186
7.1 Aufgaben von Sicherheitshinweisen 186
7.2 Anforderungen an Sicherheitshinweise 187
7.3 Sicherheitshinweise gestalten 188
7.3.1 Hervorhebung 188
7.3.2 Aufbau 189
7.3.3 Symbole 189
7.4 Sicherheitshinweise formulieren und strukturieren 193
7.4.1 Schwere der Gefahr spezifizieren 193
7.4.2 Art und Quelle der Gefahr spezifizieren 196
7.4.3 Mögliche Folgen der Gefahr beschreiben 196
7.4.4 Instruktionen zur Abwehr der Gefahr geben 197
7.5 Eingebettete Sicherheitshinweise 197
7.6 Sicherheitshinweise platzieren 198
7.6.1 Grundsätzliche (allgemeine) Sicherheitshinweise 199
7.6.2 Abschnittsbezogene Sicherheitshinweise 199
7.6.3 Eingebettete Sicherheitshinweise 199
Kapitel 8 200
Visualisierung 200
8.1 Bedeutung von Abbildungen 200
8.2 Grafiksoftware 201
8.3 Abbildungen richtig einsetzen 201
8.3.1 Wann brauche ich ein Bild? 201
8.3.2 Text-Bild-Anordnung 210
8.3.3 Bildgröße 217
8.3.4 Ausschnitte 221
8.3.5 Bildunterschriften und Legenden 221
8.4 Abbildungsarten 222
8.4.1 Fotos 222
8.4.2 Strichzeichnungen 225
8.4.3 Screenshots 230
8.4.4 Symbole und Piktogramme 231
8.5 Grafische Auszeichnungen 233
8.6 Textlose Anleitungen 235
Kapitel 9 239
Anleitungen modular erstellen 239
9.1 Grundlagen der Modularisierung 239
9.1.1 Was ist Modularisierung? 239
9.1.2 Anwendungsbereiche 240
9.1.3 Chancen und Risiken 241
9.1.4 Redaktionssysteme 242
9.2 Vorgehensweise bei der Modularisierung von Anleitungen 243
9.2.1 Modularisierungskonzept festlegen 244
9.2.2 Module einteilen 248
9.3 Besonderheiten bei der Modularisierung 250
9.3.1 Metadaten 250
9.3.2 Statusverwaltung 251
9.3.3 Versionierung 251
9.3.4 Verwendungsnachweis 251
9.3.5 Querverweise 252
9.3.6 Übersetzungsmanagement 252
9.4 Neue Arbeitsabläufe durch Modularisierung 255
9.5 Auswahl eines Redaktionssystems 257
9.5.1 Basistechnologie XML 257
9.5.2 Auswahl der passenden Software 262
9.5.3 ROI-Berechnung 264
Kapitel 10 268
Redaktionsleitfaden 268
10.1 Anforderungen an einen Redaktionsleitfaden 268
10.2 Inhalte eines Redaktionsleitfadens 268
10.3 Einen Redaktionsleitfaden erarbeiten 270
Kapitel 11 272
Anleitungen für den US-Markt 272
11.1 Produkthaftungsrecht in den USA 272
11.2 Grundlegende inhaltliche Anforderungen an US-Anleitungen 274
11.2.1 Risikobeurteilung 275
11.2.2 Normenrecherche 276
11.2.3 Kapitelstruktur 276
11.3 Sicherheitshinweise nach ANSI Z535.6 277
11.3.1 Allgemeines zur ANSI Z535.6 278
11.3.2 Struktur und Elemente 279
11.3.3 Typen von Sicherheitshinweisen 281
11.4 Terminologie und Übersetzung 284
Kapitel 12 285
Die Anleitung im betriebswirtschaftlichen Kontext 285
12.1 Nutzenpotenziale 285
12.2 Technische Dokumentation verkaufen? 286
12.3 Dokumentationskosten 287
12.3.1 Recherche 287
12.3.2 Erstellung 287
12.3.3 Qualitätssicherung 288
12.3.4 Verwaltung 289
12.3.5 Übersetzung 289
12.4 Optimierungspotenziale 290
12.4.1 Abläufe/Informationsfluss 290
12.4.2 Automatisierung 291
12.4.3 Wissen des Technischen Redakteurs 292
Kapitel 13 293
Quellen 293
13.1 Abbildungen 293
13.2 Gesetze 293
13.3 EG-Richtlinien 13.4 Normen 294
13.5 ANSI-Standards 13.6 VDI-Richtlinien 295
Sachverzeichnis 296