Hugendubel.info - Die B2B Online-Buchhandlung 

Merkliste
Die Merkliste ist leer.
Bitte warten - die Druckansicht der Seite wird vorbereitet.
Der Druckdialog öffnet sich, sobald die Seite vollständig geladen wurde.
Sollte die Druckvorschau unvollständig sein, bitte schliessen und "Erneut drucken" wählen.

Grundlagen der Technischen Dokumentation

E-BookPDF1 - PDF WatermarkE-Book
308 Seiten
Deutsch
Springer Berlin Heidelbergerschienen am20.10.20102011
Technische Dokumentation ist die Aufbereitung und Publikation technischer Sachverhalte und Abläufe. Dabei spielen die Strukturierung der Information, die prägnante Formulierung von Texten, die visuelle Aufbereitung und die Wahl des Mediums eine wesentliche Rolle. Die Berücksichtigung von Gesetzen, Normen und Richtlinien kann dazu beitragen, Hersteller vor Schadensersatzforderungen zu schützen. Das Buch vermittelt grundlegendes Wissen für die externe Technische Dokumentation von Maschinen, Anlagen und anderen technischen Produkten.

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.mehr
Verfügbare Formate
BuchGebunden
EUR119,99
E-BookPDF1 - PDF WatermarkE-Book
EUR86,99

Produkt

KlappentextTechnische Dokumentation ist die Aufbereitung und Publikation technischer Sachverhalte und Abläufe. Dabei spielen die Strukturierung der Information, die prägnante Formulierung von Texten, die visuelle Aufbereitung und die Wahl des Mediums eine wesentliche Rolle. Die Berücksichtigung von Gesetzen, Normen und Richtlinien kann dazu beitragen, Hersteller vor Schadensersatzforderungen zu schützen. Das Buch vermittelt grundlegendes Wissen für die externe Technische Dokumentation von Maschinen, Anlagen und anderen technischen Produkten.

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.
Details
Weitere ISBN/GTIN9783642146688
ProduktartE-Book
EinbandartE-Book
FormatPDF
Format Hinweis1 - PDF Watermark
Erscheinungsjahr2010
Erscheinungsdatum20.10.2010
Auflage2011
ReiheVDI-Karriere
Seiten308 Seiten
SpracheDeutsch
IllustrationenXII, 308 S. 118 Abbildungen
Artikel-Nr.1550663
Rubriken
Genre9200

Inhalt/Kritik

Inhaltsverzeichnis
1;Inhalt;5
2;Kapitel 1;13
2.1;Grundlegendes;13
2.1.1;1.1 Stellenwert der Technischen Dokumentation;13
2.1.2;1.2 Arten von Technischer Dokumentation;14
2.1.3;1.3 Berufsbild des Technischen Redakteurs;15
3;Kapitel 2;17
3.1;Gesetze, Richtlinien und Normen;17
3.1.1;2.1 Grundlagen der CE-Kennzeichnung;17
3.1.1.1;2.1.1 Die Europäische Union;18
3.1.1.2;2.1.2 Gesetzgebungsverfahren in der EU;19
3.1.1.3;2.1.3 EG-Richtlinien nach Neuer Konzeption (New Approach);19
3.1.1.4;2.1.4 Marktaufsicht;21
3.1.1.5;2.1.5 Geltungsbereich der EG-Richtlinien;22
3.1.2;2.2 Geräteund Produktsicherheitsgesetz und EG-Richtlinien;23
3.1.2.1;2.2.1 Geräteund Produktsicherheitsgesetz (GPSG);23
3.1.2.2;2.2.2 Maschinenrichtlinie;24
3.1.2.3;2.2.3 Niederspannungsrichtlinie;26
3.1.2.4;2.2.4 EMV-Richtlinie;26
3.1.2.5;2.2.5 Geräte in explosionsgefährdeten Bereichen (ATEX);27
3.1.2.6;2.2.6 Medizinprodukterichtlinie;28
3.1.2.7;2.2.7 Weitere Richtlinien;29
3.1.3;2.3 Produkthaftung;30
3.1.4;2.4 Normen;31
3.1.4.1;2.4.1 Grundlagen der Normung;31
3.1.4.2;2.4.2 DIN EN 62079;34
3.1.4.3;2.4.3 DIN EN ISO 12100-2;38
3.1.5;2.4.4 ISO Guide 37;40
3.1.5.1;2.4.5 VDI 4500;42
3.1.5.2;2.4.6 DIN-Fachbericht 146;45
3.1.5.3;2.4.7 DIN EN 15038;47
3.1.6;2.5 Formale Anforderungen an die Anleitung;49
3.1.6.1;2.5.1 Vollständigkeit;49
3.1.6.2;2.5.2 Verständlichkeit;49
3.1.6.3;2.5.3 Lieferform;50
3.1.6.4;2.5.4 Zeitpunkt der Bereitstellung;50
3.1.6.5;2.5.5 Sprache;51
3.1.6.6;2.5.6 Muss der Nutzer die Anleitung eigentlich lesen?;51
3.1.7;2.6 Spezielle Anforderungen an Softwaredokumentation;52
3.1.7.1;2.6.1 Internationale Normen;52
3.1.7.2;2.6.2 Software als Bestandteil eines Produkts oder Geräts;52
3.1.7.3;2.6.3 Anwendbarkeit des Geräteund Produktsicherheitsgesetzes (GPSG);53
3.1.7.4;2.6.4 Mängelgewährleistung;53
3.1.7.5;2.6.5 Sicherheitsanforderungen und abgeleitete Pflichten;53
3.1.7.6;2.6.6 Sprachen;55
3.1.8;2.7 Die Risikobeurteilung - Grundlage der Betriebsanleitung;55
4;Kapitel 3;59
4.1;Dokumentationsprozess;59
4.1.1;3.1 Projektplanung;59
4.1.1.1;3.1.1 Zuständigkeiten;60
4.1.2;3.2 Zielgruppenanalyse;60
4.1.2.1;3.2.1 Zielgruppensegmentierung;61
4.1.2.2;3.2.2 Zielgruppencharakterisierung;62
4.1.3;3.3 Recherche;63
4.1.3.1;3.3.1 Recherchecheckliste erstellen;63
4.1.3.2;3.3.2 Vorhandene Informationen auswerten;65
4.1.3.3;3.3.3 Recherche vorbereiten;66
4.1.3.4;3.3.4 Recherche durchführen;66
4.1.3.5;3.3.5 Recherche auswerten;67
4.1.4;3.4 Erstellung;68
4.1.4.1;3.4.1 Erstellungsprozess;68
4.1.4.2;3.4.2 Tipps für optimale Arbeitsabläufe beim Erstellungsprozess;68
4.1.5;3.5 Qualitätssicherung;70
4.1.5.1;3.5.1 Welche Faktoren bestimmen die Qualität von Technischen Dokumentationen?;71
4.1.5.2;3.5.2 Durch welche Prozesse und Systeme kann die Qualität sichergestellt werden?;72
4.1.6;3.6 Übersetzung;75
4.1.7;3.7 Stolpersteine;76
4.1.8;3.8 Prozesse optimieren;77
5;Kapitel 4;79
5.1;Inhalte der Anleitung;79
5.1.1;4.1 Deckblatt;79
5.1.2;4.2 Impressum;81
5.1.3;4.3 Inhaltsverzeichnis;81
5.1.4;4.4 Allgemeines;81
5.1.4.1;4.4.1 Informationen zu dieser Anleitung;82
5.1.4.2;4.4.2 Symbolerklärung;82
5.1.4.3;4.4.3 Haftungsbeschränkung*;83
5.1.4.4;4.4.4 Urheberschutz;84
5.1.4.5;4.4.5 Garantie und Gewährleistung;84
5.1.5;4.5 Sicherheit;85
5.1.5.1;4.5.1 Bestimmungsgemäße Verwendung;86
5.1.5.2;4.5.2 Allgemeine Gefahrenquellen;86
5.1.5.3;4.5.3 Verantwortung des Betreibers*;88
5.1.5.4;4.5.4 Personalqualifikation;89
5.1.5.5;4.5.5 Sicherheitskennzeichnung;90
5.1.5.6;4.5.6 Schutzausrüstung;91
5.1.5.7;4.5.7 Sicherheitseinrichtungen;92
5.1.5.8;4.5.8 Sichern gegen Wiedereinschalten;94
5.1.5.9;4.5.9 Verhalten im Gefahrenfall;94
5.1.5.10;4.5.10 Umweltschutz;95
5.1.6;4.6 Technische Daten;95
5.1.6.1;4.6.1 Darstellung der Technischen Daten*;96
5.1.6.2;4.6.2 Technische Daten im Einzelnen;96
5.1.6.3;4.6.3 Alternative Darreichungsformen;98
5.1.7;4.7 Aufbau und Funktion;99
5.1.7.1;4.7.1 Kurzbeschreibung*;99
5.1.7.2;4.7.2 Übersicht;99
5.1.7.3;4.7.3 Lieferumfang*;102
5.1.7.4;4.7.4 Prozessoder Funktionsbeschreibung;102
5.1.7.5;4.7.5 Beschreibung der Baugruppen*;103
5.1.7.6;4.7.6 Anschlüsse;104
5.1.7.7;4.7.7 Anzeigen und Bedienelemente;105
5.1.7.8;4.7.8 Bediensoftware;106
5.1.7.9;4.7.9 Arbeitsplätze und Gefahrenbereiche;107
5.1.7.10;4.7.10 Betriebsarten;108
5.1.7.11;4.7.11 Zubehör, Werkzeuge;109
5.1.8;4.8 Transport;109
5.1.8.1;4.8.1 Sicherheit;109
5.1.8.2;4.8.2 Transportinspektion*;110
5.1.8.3;4.8.3 Symbole auf der Verpackung*;111
5.1.8.4;4.8.4 Verpackung;111
5.1.8.5;4.8.5 Transport;113
5.1.8.6;4.8.6 Lagerung;114
5.1.9;4.9 Installation und Erstinbetriebnahme;114
5.1.9.1;4.9.1 Sicherheit;117
5.1.9.2;4.9.2 Anforderungen an den Aufstellort;117
5.1.9.3;4.9.3 Vorbereitungen;118
5.1.9.4;4.9.4 Installation;118
5.1.9.5;4.9.5 Anschließen;119
5.1.9.6;4.9.6 Erstinbetriebnahme;120
5.1.10;4.10 Bedienung, Betrieb;120
5.1.10.1;4.10.1 Sicherheit;121
5.1.10.2;4.10.2 Tätigkeiten vor Gebrauch;121
5.1.10.3;4.10.3 Einund Ausschalten;122
5.1.10.4;4.10.4 Normalbetrieb;123
5.1.10.5;4.10.5 Besondere Handlungen;123
5.1.10.6;4.10.6 Tätigkeiten nach der Benutzung;124
5.1.10.7;4.10.7 Reinigung, Desinfektion, Sterilisation;124
5.1.11;4.11 Wartung;124
5.1.11.1;4.11.1 Sicherheit;125
5.1.11.2;4.11.2 Wartungsplan;125
5.1.11.3;4.11.3 Wartungsarbeiten;127
5.1.12;4.12 Störungen;128
5.1.12.1;4.12.1 Sicherheit;129
5.1.12.2;4.12.2 Störungsanzeigen;129
5.1.12.3;4.12.3 Verhalten bei Störungen;130
5.1.12.4;4.12.4 Störungstabelle;131
5.1.12.5;4.12.5 Arbeiten zur Störungsbeseitigung;133
5.1.13;4.13 Demontage, Entsorgung;133
5.1.13.1;4.13.1 Sicherheit;133
5.1.13.2;4.13.2 Demontage;134
5.1.13.3;4.13.3 Entsorgung;134
5.1.14;4.14 Glossar;135
5.1.15;4.15 Index;135
5.1.16;4.16 Anhang;138
5.1.16.1;4.16.1 Konformitätserklärung;139
5.1.16.2;4.16.2 Qualitätsdokumentation;139
5.1.16.3;4.16.3 Datenblätter;140
5.1.16.4;4.16.4 Checklisten, Prüfbücher;140
5.1.16.5;4.16.5 Anleitungen der Lieferanten;140
6;Kapitel 5;142
6.1;Anleitungen formulieren;142
6.1.1;5.1 Verständlich formulieren;142
6.1.1.1;5.1.1 Kurze und einfache Sätze formulieren;143
6.1.1.2;5.1.2 Substantivierungen vermeiden;143
6.1.1.3;5.1.3 Sätze nicht über Aufzählungen fortsetzen;143
6.1.1.4;5.1.4 Klemmkonstruktionen vermeiden;144
6.1.1.5;5.1.5 Funktionsverbgefüge vermeiden;144
6.1.2;5.2 Präzise formulieren;145
6.1.2.1;5.2.1 Eindeutige Terminologie;145
6.1.2.2;5.2.2 Abstrakte Begriffe und Fremdwörter vermeiden;145
6.1.2.3;5.2.3 Einzelheiten direkt benennen;146
6.1.2.4;5.2.4 Abkürzungen vermeiden;146
6.1.2.5;5.2.5 Firmenjargon vermeiden;146
6.1.2.6;5.2.6 Füllwörter vermeiden;147
6.1.2.7;5.2.7 Weichmacher vermeiden;147
6.1.3;5.3 Einheitlich formulieren;148
6.1.3.1;5.3.1 Einheitliche Anrede;148
6.1.3.2;5.3.2 Einheiten und Werte;149
6.1.3.3;5.3.3 Komposita übersichtlich schreiben;149
6.1.4;5.4 Überschriften korrekt wählen;150
6.1.5;5.5 Textwüsten vermeiden, Texte strukturieren;150
6.1.6;5.6 Handlungsanweisungen formulieren;151
6.1.6.1;5.6.1 Handlungsanweisung betiteln;151
6.1.6.2;5.6.2 Voraussetzungen definieren;151
6.1.6.3;5.6.3 Handlungsschritte typografisch hervorheben;154
6.1.6.4;5.6.4 Handlungsschritte aktivisch formulieren;155
6.1.6.5;5.6.5 Handlungsschritte vollständig formulieren;155
6.1.6.6;5.6.6 Eine Handlung je Handlungsschritt;156
6.1.6.7;5.6.7 Richtige Reihenfolge einhalten;157
6.1.6.8;5.6.8 Beispiel für eine gute Handlungsanweisung;157
6.1.7;5.7 Querverweise setzen;157
6.1.8;5.8 Übersetzungsgerecht schreiben;161
7;Kapitel 6;162
7.1;Anleitungen gestalten;162
7.1.1;6.1 Funktionsund zielgruppengerechte Gestaltung;162
7.1.1.1;6.1.1 Zweck der Gestaltung;162
7.1.1.2;6.1.2 Einfluss der Zielgruppe;163
7.1.1.3;6.1.3 Einfluss des Produktes;165
7.1.1.4;6.1.4 Entwicklung einer zweckgerichteten Gestaltung;166
7.1.2;6.2 Seitengestaltung;169
7.1.2.1;6.2.1 Seitengröße;169
7.1.2.2;6.2.2 Satzspiegel;170
7.1.2.3;6.2.3 Einseitig oder doppelseitig?;174
7.1.2.4;6.2.4 Ränder;174
7.1.2.5;6.2.5 Navigationselemente und andere Elemente auf der Seite;176
7.1.3;6.3 Typografie;178
7.1.4;6.4 Digitale Ausgabeformate von Anleitungen;181
7.1.4.1;6.4.1 PDF als Online-Medium;181
7.1.4.2;6.4.2 Klassische Online-Medien;182
7.1.4.3;6.4.3 E-Books;183
7.1.4.4;6.4.4 Hörbücher;184
7.1.4.5;6.4.5 Video-Anleitungen;184
8;Kapitel 7;186
8.1;Sicherheitshinweise gestalten und formulieren;186
8.1.1;7.1 Aufgaben von Sicherheitshinweisen;186
8.1.2;7.2 Anforderungen an Sicherheitshinweise;187
8.1.3;7.3 Sicherheitshinweise gestalten;188
8.1.3.1;7.3.1 Hervorhebung;188
8.1.3.2;7.3.2 Aufbau;189
8.1.3.3;7.3.3 Symbole;189
8.1.4;7.4 Sicherheitshinweise formulieren und strukturieren;193
8.1.4.1;7.4.1 Schwere der Gefahr spezifizieren;193
8.1.4.2;7.4.2 Art und Quelle der Gefahr spezifizieren;196
8.1.4.3;7.4.3 Mögliche Folgen der Gefahr beschreiben;196
8.1.4.4;7.4.4 Instruktionen zur Abwehr der Gefahr geben;197
8.1.5;7.5 Eingebettete Sicherheitshinweise;197
8.1.6;7.6 Sicherheitshinweise platzieren;198
8.1.6.1;7.6.1 Grundsätzliche (allgemeine) Sicherheitshinweise;199
8.1.6.2;7.6.2 Abschnittsbezogene Sicherheitshinweise;199
8.1.6.3;7.6.3 Eingebettete Sicherheitshinweise;199
9;Kapitel 8;200
9.1;Visualisierung;200
9.1.1;8.1 Bedeutung von Abbildungen;200
9.1.2;8.2 Grafiksoftware;201
9.1.3;8.3 Abbildungen richtig einsetzen;201
9.1.3.1;8.3.1 Wann brauche ich ein Bild?;201
9.1.3.2;8.3.2 Text-Bild-Anordnung;210
9.1.3.3;8.3.3 Bildgröße;217
9.1.3.4;8.3.4 Ausschnitte;221
9.1.3.5;8.3.5 Bildunterschriften und Legenden;221
9.1.4;8.4 Abbildungsarten;222
9.1.4.1;8.4.1 Fotos;222
9.1.4.2;8.4.2 Strichzeichnungen;225
9.1.4.3;8.4.3 Screenshots;230
9.1.4.4;8.4.4 Symbole und Piktogramme;231
9.1.5;8.5 Grafische Auszeichnungen;233
9.1.6;8.6 Textlose Anleitungen;235
10;Kapitel 9;239
10.1;Anleitungen modular erstellen;239
10.1.1;9.1 Grundlagen der Modularisierung;239
10.1.1.1;9.1.1 Was ist Modularisierung?;239
10.1.1.2;9.1.2 Anwendungsbereiche;240
10.1.1.3;9.1.3 Chancen und Risiken;241
10.1.1.4;9.1.4 Redaktionssysteme;242
10.1.2;9.2 Vorgehensweise bei der Modularisierung von Anleitungen;243
10.1.2.1;9.2.1 Modularisierungskonzept festlegen;244
10.1.2.2;9.2.2 Module einteilen;248
10.1.3;9.3 Besonderheiten bei der Modularisierung;250
10.1.3.1;9.3.1 Metadaten;250
10.1.3.2;9.3.2 Statusverwaltung;251
10.1.3.3;9.3.3 Versionierung;251
10.1.3.4;9.3.4 Verwendungsnachweis;251
10.1.3.5;9.3.5 Querverweise;252
10.1.3.6;9.3.6 Übersetzungsmanagement;252
10.1.4;9.4 Neue Arbeitsabläufe durch Modularisierung;255
10.1.5;9.5 Auswahl eines Redaktionssystems;257
10.1.5.1;9.5.1 Basistechnologie XML;257
10.1.5.2;9.5.2 Auswahl der passenden Software;262
10.1.5.3;9.5.3 ROI-Berechnung;264
11;Kapitel 10;268
11.1;Redaktionsleitfaden;268
11.1.1;10.1 Anforderungen an einen Redaktionsleitfaden;268
11.1.2;10.2 Inhalte eines Redaktionsleitfadens;268
11.1.3;10.3 Einen Redaktionsleitfaden erarbeiten;270
12;Kapitel 11;272
12.1;Anleitungen für den US-Markt;272
12.1.1;11.1 Produkthaftungsrecht in den USA;272
12.1.2;11.2 Grundlegende inhaltliche Anforderungen an US-Anleitungen;274
12.1.2.1;11.2.1 Risikobeurteilung;275
12.1.2.2;11.2.2 Normenrecherche;276
12.1.2.3;11.2.3 Kapitelstruktur;276
12.1.3;11.3 Sicherheitshinweise nach ANSI Z535.6;277
12.1.3.1;11.3.1 Allgemeines zur ANSI Z535.6;278
12.1.3.2;11.3.2 Struktur und Elemente;279
12.1.3.3;11.3.3 Typen von Sicherheitshinweisen;281
12.1.4;11.4 Terminologie und Übersetzung;284
13;Kapitel 12;285
13.1;Die Anleitung im betriebswirtschaftlichen Kontext;285
13.1.1;12.1 Nutzenpotenziale;285
13.1.2;12.2 Technische Dokumentation verkaufen?;286
13.1.3;12.3 Dokumentationskosten;287
13.1.3.1;12.3.1 Recherche;287
13.1.3.2;12.3.2 Erstellung;287
13.1.3.3;12.3.3 Qualitätssicherung;288
13.1.3.4;12.3.4 Verwaltung;289
13.1.3.5;12.3.5 Übersetzung;289
13.1.4;12.4 Optimierungspotenziale;290
13.1.4.1;12.4.1 Abläufe/Informationsfluss;290
13.1.4.2;12.4.2 Automatisierung;291
13.1.4.3;12.4.3 Wissen des Technischen Redakteurs;292
14;Kapitel 13;293
14.1;Quellen;293
14.1.1;13.1 Abbildungen;293
14.1.2;13.2 Gesetze;293
14.1.3;13.3 EG-Richtlinien 13.4 Normen;294
14.1.4;13.5 ANSI-Standards 13.6 VDI-Richtlinien;295
15;Sachverzeichnis;296mehr

Autor

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.