Sie sind hier
E-Book

Grundlagen der Technischen Dokumentation

Anleitungen verständlich und normgerecht erstellen

AutorLars Kothes
VerlagSpringer-Verlag
Erscheinungsjahr2010
Seitenanzahl308 Seiten
ISBN9783642146688
FormatPDF
KopierschutzDRM
GerätePC/MAC/eReader/Tablet
Preis53,94 EUR
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.

Kaufen Sie hier:

Horizontale Tabs

Blick ins Buch
Inhaltsverzeichnis
Inhalt5
Kapitel 113
Grundlegendes13
1.1 Stellenwert der Technischen Dokumentation13
1.2 Arten von Technischer Dokumentation14
1.3 Berufsbild des Technischen Redakteurs15
Kapitel 217
Gesetze, Richtlinien und Normen17
2.1 Grundlagen der CE-Kennzeichnung17
2.1.1 Die Europäische Union18
2.1.2 Gesetzgebungsverfahren in der EU19
2.1.3 EG-Richtlinien nach „Neuer Konzeption“ (New Approach)19
2.1.4 Marktaufsicht21
2.1.5 Geltungsbereich der EG-Richtlinien22
2.2 Geräteund Produktsicherheitsgesetz und EG-Richtlinien23
2.2.1 Geräteund Produktsicherheitsgesetz (GPSG)23
2.2.2 Maschinenrichtlinie24
2.2.3 Niederspannungsrichtlinie26
2.2.4 EMV-Richtlinie26
2.2.5 Geräte in explosionsgefährdeten Bereichen (ATEX)27
2.2.6 Medizinprodukterichtlinie28
2.2.7 Weitere Richtlinien29
2.3 Produkthaftung30
2.4 Normen31
2.4.1 Grundlagen der Normung31
2.4.2 DIN EN 6207934
2.4.3 DIN EN ISO 12100-238
2.4.4 ISO Guide 3740
2.4.5 VDI 450042
2.4.6 DIN-Fachbericht 14645
2.4.7 DIN EN 1503847
2.5 Formale Anforderungen an die Anleitung49
2.5.1 Vollständigkeit49
2.5.2 Verständlichkeit49
2.5.3 Lieferform50
2.5.4 Zeitpunkt der Bereitstellung50
2.5.5 Sprache51
2.5.6 Muss der Nutzer die Anleitung eigentlich lesen?51
2.6 Spezielle Anforderungen an Softwaredokumentation52
2.6.1 Internationale Normen52
2.6.2 Software als Bestandteil eines Produkts oder Geräts52
2.6.3 Anwendbarkeit des Geräteund Produktsicherheitsgesetzes (GPSG)53
2.6.4 Mängelgewährleistung53
2.6.5 Sicherheitsanforderungen und abgeleitete Pflichten53
2.6.6 Sprachen55
2.7 Die Risikobeurteilung – Grundlage der Betriebsanleitung55
Kapitel 359
Dokumentationsprozess59
3.1 Projektplanung59
3.1.1 Zuständigkeiten60
3.2 Zielgruppenanalyse60
3.2.1 Zielgruppensegmentierung61
3.2.2 Zielgruppencharakterisierung62
3.3 Recherche63
3.3.1 Recherchecheckliste erstellen63
3.3.2 Vorhandene Informationen auswerten65
3.3.3 Recherche vorbereiten66
3.3.4 Recherche durchführen66
3.3.5 Recherche auswerten67
3.4 Erstellung68
3.4.1 Erstellungsprozess68
3.4.2 Tipps für optimale Arbeitsabläufe beim Erstellungsprozess68
3.5 Qualitätssicherung70
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 Übersetzung75
3.7 Stolpersteine76
3.8 Prozesse optimieren77
Kapitel 479
Inhalte der Anleitung79
4.1 Deckblatt79
4.2 Impressum81
4.3 Inhaltsverzeichnis81
4.4 Allgemeines81
4.4.1 Informationen zu dieser Anleitung82
4.4.2 Symbolerklärung82
4.4.3 Haftungsbeschränkung*83
4.4.4 Urheberschutz84
4.4.5 Garantie und Gewährleistung84
4.5 Sicherheit85
4.5.1 Bestimmungsgemäße Verwendung86
4.5.2 Allgemeine Gefahrenquellen86
4.5.3 Verantwortung des Betreibers*88
4.5.4 Personalqualifikation89
4.5.5 Sicherheitskennzeichnung90
4.5.6 Schutzausrüstung91
4.5.7 Sicherheitseinrichtungen92
4.5.8 Sichern gegen Wiedereinschalten94
4.5.9 Verhalten im Gefahrenfall94
4.5.10 Umweltschutz95
4.6 Technische Daten95
4.6.1 Darstellung der Technischen Daten*96
4.6.2 Technische Daten im Einzelnen96
4.6.3 Alternative Darreichungsformen98
4.7 Aufbau und Funktion99
4.7.1 Kurzbeschreibung*99
4.7.2 Übersicht99
4.7.3 Lieferumfang*102
4.7.4 Prozessoder Funktionsbeschreibung102
4.7.5 Beschreibung der Baugruppen*103
4.7.6 Anschlüsse104
4.7.7 Anzeigen und Bedienelemente105
4.7.8 Bediensoftware106
4.7.9 Arbeitsplätze und Gefahrenbereiche107
4.7.10 Betriebsarten108
4.7.11 Zubehör, Werkzeuge109
4.8 Transport109
4.8.1 Sicherheit109
4.8.2 Transportinspektion*110
4.8.3 Symbole auf der Verpackung*111
4.8.4 Verpackung111
4.8.5 Transport113
4.8.6 Lagerung114
4.9 Installation und Erstinbetriebnahme114
4.9.1 Sicherheit117
4.9.2 Anforderungen an den Aufstellort117
4.9.3 Vorbereitungen118
4.9.4 Installation118
4.9.5 Anschließen119
4.9.6 Erstinbetriebnahme120
4.10 Bedienung, Betrieb120
4.10.1 Sicherheit121
4.10.2 Tätigkeiten vor Gebrauch121
4.10.3 Einund Ausschalten122
4.10.4 Normalbetrieb123
4.10.5 Besondere Handlungen123
4.10.6 Tätigkeiten nach der Benutzung124
4.10.7 Reinigung, Desinfektion, Sterilisation124
4.11 Wartung124
4.11.1 Sicherheit125
4.11.2 Wartungsplan125
4.11.3 Wartungsarbeiten127
4.12 Störungen128
4.12.1 Sicherheit129
4.12.2 Störungsanzeigen129
4.12.3 Verhalten bei Störungen130
4.12.4 Störungstabelle131
4.12.5 Arbeiten zur Störungsbeseitigung133
4.13 Demontage, Entsorgung133
4.13.1 Sicherheit133
4.13.2 Demontage134
4.13.3 Entsorgung134
4.14 Glossar135
4.15 Index135
4.16 Anhang138
4.16.1 Konformitätserklärung139
4.16.2 Qualitätsdokumentation139
4.16.3 Datenblätter140
4.16.4 Checklisten, Prüfbücher140
4.16.5 Anleitungen der Lieferanten140
Kapitel 5142
Anleitungen formulieren142
5.1 Verständlich formulieren142
5.1.1 Kurze und einfache Sätze formulieren143
5.1.2 Substantivierungen vermeiden143
5.1.3 Sätze nicht über Aufzählungen fortsetzen143
5.1.4 Klemmkonstruktionen vermeiden144
5.1.5 Funktionsverbgefüge vermeiden144
5.2 Präzise formulieren145
5.2.1 Eindeutige Terminologie145
5.2.2 Abstrakte Begriffe und Fremdwörter vermeiden145
5.2.3 Einzelheiten direkt benennen146
5.2.4 Abkürzungen vermeiden146
5.2.5 Firmenjargon vermeiden146
5.2.6 Füllwörter vermeiden147
5.2.7 Weichmacher vermeiden147
5.3 Einheitlich formulieren148
5.3.1 Einheitliche Anrede148
5.3.2 Einheiten und Werte149
5.3.3 Komposita übersichtlich schreiben149
5.4 Überschriften korrekt wählen150
5.5 Textwüsten vermeiden, Texte strukturieren150
5.6 Handlungsanweisungen formulieren151
5.6.1 Handlungsanweisung betiteln151
5.6.2 Voraussetzungen definieren151
5.6.3 Handlungsschritte typografisch hervorheben154
5.6.4 Handlungsschritte aktivisch formulieren155
5.6.5 Handlungsschritte vollständig formulieren155
5.6.6 Eine Handlung je Handlungsschritt156
5.6.7 Richtige Reihenfolge einhalten157
5.6.8 Beispiel für eine gute Handlungsanweisung157
5.7 Querverweise setzen157
5.8 Übersetzungsgerecht schreiben161
Kapitel 6162
Anleitungen gestalten162
6.1 Funktionsund zielgruppengerechte Gestaltung162
6.1.1 Zweck der Gestaltung162
6.1.2 Einfluss der Zielgruppe163
6.1.3 Einfluss des Produktes165
6.1.4 Entwicklung einer zweckgerichteten Gestaltung166
6.2 Seitengestaltung169
6.2.1 Seitengröße169
6.2.2 Satzspiegel170
6.2.3 Einseitig oder doppelseitig?174
6.2.4 Ränder174
6.2.5 Navigationselemente und andere Elemente auf der Seite176
6.3 Typografie178
6.4 Digitale Ausgabeformate von Anleitungen181
6.4.1 PDF als Online-Medium181
6.4.2 Klassische Online-Medien182
6.4.3 E-Books183
6.4.4 Hörbücher184
6.4.5 Video-Anleitungen184
Kapitel 7186
Sicherheitshinweise gestalten und formulieren186
7.1 Aufgaben von Sicherheitshinweisen186
7.2 Anforderungen an Sicherheitshinweise187
7.3 Sicherheitshinweise gestalten188
7.3.1 Hervorhebung188
7.3.2 Aufbau189
7.3.3 Symbole189
7.4 Sicherheitshinweise formulieren und strukturieren193
7.4.1 Schwere der Gefahr spezifizieren193
7.4.2 Art und Quelle der Gefahr spezifizieren196
7.4.3 Mögliche Folgen der Gefahr beschreiben196
7.4.4 Instruktionen zur Abwehr der Gefahr geben197
7.5 Eingebettete Sicherheitshinweise197
7.6 Sicherheitshinweise platzieren198
7.6.1 Grundsätzliche (allgemeine) Sicherheitshinweise199
7.6.2 Abschnittsbezogene Sicherheitshinweise199
7.6.3 Eingebettete Sicherheitshinweise199
Kapitel 8200
Visualisierung200
8.1 Bedeutung von Abbildungen200
8.2 Grafiksoftware201
8.3 Abbildungen richtig einsetzen201
8.3.1 Wann brauche ich ein Bild?201
8.3.2 Text-Bild-Anordnung210
8.3.3 Bildgröße217
8.3.4 Ausschnitte221
8.3.5 Bildunterschriften und Legenden221
8.4 Abbildungsarten222
8.4.1 Fotos222
8.4.2 Strichzeichnungen225
8.4.3 Screenshots230
8.4.4 Symbole und Piktogramme231
8.5 Grafische Auszeichnungen233
8.6 Textlose Anleitungen235
Kapitel 9239
Anleitungen modular erstellen239
9.1 Grundlagen der Modularisierung239
9.1.1 Was ist Modularisierung?239
9.1.2 Anwendungsbereiche240
9.1.3 Chancen und Risiken241
9.1.4 Redaktionssysteme242
9.2 Vorgehensweise bei der Modularisierung von Anleitungen243
9.2.1 Modularisierungskonzept festlegen244
9.2.2 Module einteilen248
9.3 Besonderheiten bei der Modularisierung250
9.3.1 Metadaten250
9.3.2 Statusverwaltung251
9.3.3 Versionierung251
9.3.4 Verwendungsnachweis251
9.3.5 Querverweise252
9.3.6 Übersetzungsmanagement252
9.4 Neue Arbeitsabläufe durch Modularisierung255
9.5 Auswahl eines Redaktionssystems257
9.5.1 Basistechnologie XML257
9.5.2 Auswahl der passenden Software262
9.5.3 ROI-Berechnung264
Kapitel 10268
Redaktionsleitfaden268
10.1 Anforderungen an einen Redaktionsleitfaden268
10.2 Inhalte eines Redaktionsleitfadens268
10.3 Einen Redaktionsleitfaden erarbeiten270
Kapitel 11272
Anleitungen für den US-Markt272
11.1 Produkthaftungsrecht in den USA272
11.2 Grundlegende inhaltliche Anforderungen an US-Anleitungen274
11.2.1 Risikobeurteilung275
11.2.2 Normenrecherche276
11.2.3 Kapitelstruktur276
11.3 Sicherheitshinweise nach ANSI Z535.6277
11.3.1 Allgemeines zur ANSI Z535.6278
11.3.2 Struktur und Elemente279
11.3.3 Typen von Sicherheitshinweisen281
11.4 Terminologie und Übersetzung284
Kapitel 12285
Die Anleitung im betriebswirtschaftlichen Kontext285
12.1 Nutzenpotenziale285
12.2 Technische Dokumentation verkaufen?286
12.3 Dokumentationskosten287
12.3.1 Recherche287
12.3.2 Erstellung287
12.3.3 Qualitätssicherung288
12.3.4 Verwaltung289
12.3.5 Übersetzung289
12.4 Optimierungspotenziale290
12.4.1 Abläufe/Informationsfluss290
12.4.2 Automatisierung291
12.4.3 Wissen des Technischen Redakteurs292
Kapitel 13293
Quellen293
13.1 Abbildungen293
13.2 Gesetze293
13.3 EG-Richtlinien 13.4 Normen294
13.5 ANSI-Standards 13.6 VDI-Richtlinien295
Sachverzeichnis296

Weitere E-Books zum Thema: Management - Wirtschaft - Coaching

Praxisbuch Microsoft Hyper-V

E-Book Praxisbuch Microsoft Hyper-V

EINSTIEG IN DIE VIRTUALISIERUNG - Jetzt aktuell zu Hyper-V für Windows Server 2008 R2! Grundlegend überarbeitete Neuauflage. - Hier erhalten Sie einen umfassenden Überblick über die Funktionen ...

Strategisches IT-Management

E-Book Strategisches IT-Management

Strategisch und umfassend für Top-Entscheider wird der Themenkomplex der IT im Unternehmen ergebnisorientiert und klar verständlich aufbereitet. Mit vielen nützlichen Checklisten.Dr.-Ing. Dirk ...

IT-Governance in der Praxis

E-Book IT-Governance in der Praxis

Die IT befindet sich heute in vielen Unternehmen in einer 'Sandwichposition': Auf der einen Seite sollen Governance- oder Compliance-Anforderungen erfüllt, auf der anderen Seite Kosten reduziert ...

Linux-Systemadministration

E-Book Linux-Systemadministration

Linux ist eine fest etablierte, für vielfältige Rechnerarchitekturen verfügbare Plattform und zeichnet sich insbesondere durch die hohe Stabilität und Sicherheit des Systems aus. Dieses Buch ...

Security@Work

E-Book Security@Work

Die Autoren erläutern die konzeptionellen und technischen Grundlagen des Themas IT-Sicherheit anhand anschaulicher Beispiele. Im Fokus stehen dabei die praktische Verwendbarkeit realitätsnaher ...

Weitere Zeitschriften

Computerwoche

Computerwoche

Die COMPUTERWOCHE berichtet schnell und detailliert über alle Belange der Informations- und Kommunikationstechnik in Unternehmen – über Trends, neue Technologien, Produkte und Märkte. IT-Manager ...

Courier

Courier

The Bayer CropScience Magazine for Modern AgriculturePflanzenschutzmagazin für den Landwirt, landwirtschaftlichen Berater, Händler und generell am Thema Interessierten, mit umfassender ...

küche + raum

küche + raum

Internationale Fachzeitschrift für Küchenforschung und Küchenplanung. Mit Fachinformationen für Küchenfachhändler, -spezialisten und -planer in Küchenstudios, Möbelfachgeschäften und den ...

SPORT in BW (Württemberg)

SPORT in BW (Württemberg)

SPORT in BW (Württemberg) ist das offizielle Verbandsorgan des Württembergischen Landessportbund e.V. (WLSB) und Informationsmagazin für alle im Sport organisierten Mitglieder in Württemberg. ...

DGIP-intern

DGIP-intern

Mitteilungen der Deutschen Gesellschaft für Individualpsychologie e.V. (DGIP) für ihre Mitglieder Die Mitglieder der DGIP erhalten viermal jährlich das Mitteilungsblatt „DGIP-intern“ ...

EineWelt

EineWelt

Eine Anregung der Gossner Mission zum verbesserten Schutz indigener Völker hat Bundespräsident Horst Köhler aufgegriffen: Er hat auf Anregung des Missionswerkes eine Anfrage an die Bundesregierung ...

ERNEUERBARE ENERGIEN

ERNEUERBARE ENERGIEN

ERNEUERBARE ENERGIEN informiert durch unabhängigen Journalismus umfassend über die wichtigsten Geschehnisse im Markt der regenerativen Energien. Mit Leidenschaft sind wir stets auf der Suche nach ...