Vorwort 1 Einführung ins Thema... 1 1.1 Warum erstellen wir Technische Dokumentationen?... 1 1.2 Erwartungshaltung von Zielgruppen... 1 1.3 Nachkaufverhalten der Kunden... 2 1.4 Was umfasst die Technische Dokumentation?... 3 1.5 Wer erstellt Technische Dokumentation?... 4 1.6 Anforderungen an Technische Dokumentation... 5 2 Haftungsrechtliche Grundlagen... 7 2.1 Haftung für fehlerhafte Produkte... 7 2.2 Straf- und Zivilrecht... 8 2.3 Produkthaftung wer haftet wann und wofür?... 8 2.4 Gegenüberstellung 823 BGB und ProdHaftG... 10 2.5 Vertragsrechtliche Grundlagen... 10 2.5.1 Sachmängel... 11 2.5.2 Gewährleistung... 12 2.5.3 Garantie... 12 2.5.4 Schadensersatz... 13 2.6 Pflichten des Herstellers... 13 2.6.1 Pflicht zur Betriebsorganisation... 14 2.6.2 Pflicht zur konstruktiven Sicherheit... 14 2.6.3 Instruktionspflicht... 14 2.6.4 Pflicht zur Produktbeobachtung... 15 2.7 Haftung einzelner Mitarbeiter... 15 2.8 Lieferung lokalisierter Dokumentation... 16 2.9 Qualitätsanforderungen an Dokumentationen... 17 3 Internationale Produkthaftung... 18 3.1 Einige grundlegende Tipps... 18 3.2 Harmonisierung in der EU... 18 3.3 Produkthaftung in der EU... 20
3.3.1 Produkthaftung in der Schweiz... 20 3.3.2 Unternehmensstrafrecht... 21 3.4 Produkthaftung in den USA... 21 3.5 Produkthaftung in China... 25 3.6 Produkthaftung in Russland... 25 3.7 Produkthaftung in Japan... 26 3.8 Produkthaftung in der Republik Korea (Südkorea)... 26 3.9 Sprachenschutzgesetze... 26 4 Möglichkeiten zur Risikominimierung... 27 4.1 Generelle Maßnahmen... 27 4.2 Strukturiertes Sicherheitskonzept... 28 4.3 Bestimmungsgemäße Verwendung beschreiben... 29 4.4 Stand der Technik ermitteln... 29 4.5 Normen anwenden... 29 4.6 Gefahrenanalysen und Risikobewertungen erstellen... 30 4.7 Vor Restgefahren warnen... 31 4.8 Risiken durch Prüfungen erkennen und vermeiden... 32 5 Lokalisierung von Dokumenten... 33 5.1 Wege zu zielgruppengerechten Produkten... 33 5.2 Tipps zum übersetzungsgerechten Schreiben... 33 5.3 Terminologie-Management... 35 5.4 Satzstrukturen... 37 5.4.1 Keine Klammer- oder Schachtelsätze... 37 5.4.2 Keine langen Aufzählungen im Satz... 38 5.4.3 Keine Passiv-Konstruktionen... 38 5.4.4 Eindeutige Beziehungen und Bedingungen... 39 5.5 Kontrollierte und vereinfachte Sprachen... 39 5.5.1 Vor und Nachteile von kontrollierten Sprachen... 40 5.5.2 Beispiele für kontrollierte Sprachen... 41 5.5.3 Hilfsmittel... 41 5.5.4 ASD Simplified Technical Englisch (STE)... 42 5.5.5 Strukturiertes Technisches Deutsch (STD)... 43 5.5.6 Entwicklung und Einführung einer kontrollierten Sprache.. 44 5.6 Softwarelokalisierung... 45
5.7 Wirtschaftliche Aspekte... 46 5.7.1 Zusammenarbeit mit externen Übersetzern... 46 5.7.2 Kalkulation von Übersetzungen... 47 5.8 Computerunterstützung bei der Lokalisierung... 48 5.8.1 Terminologie-Datenbanken... 48 5.8.2 Translation Memories... 49 5.8.3 Maschinelle Übersetzung... 50 5.8.4 Controlled Language Checker... 50 5.8.5 Software-Lokalisierungs-Tools... 50 5.8.6 Computersysteme und Fremdsprachen... 51 5.9 Landessprachliche Aspekte... 53 5.9.1 Amtssprachen... 53 5.9.2 USA... 53 5.9.3 Asien allgemein... 54 5.9.4 China, Singapur, Hongkong und Taiwan... 54 5.9.5 Japan... 56 5.10 Inhalt und Gestaltung... 57 5.10.1 Unterschiedliche Maßeinheiten... 57 5.10.2 Unterschiedliche Zeit- und Datumsangaben... 59 5.10.3 Unterschiede in Zahlenangaben... 60 5.10.4 Kulturspezifische Interpretation von Farben... 60 5.10.5 Interpretation von Symbolen und Grafiken... 62 6 Konzeptionelle Arbeiten... 64 6.1 Modularisierung von Inhalten... 64 6.1.1 Handwerkliche oder industrielle Fertigung?... 64 6.1.2 Warum modularisieren?... 65 6.1.3 Wann macht Modularisierung Sinn?... 66 6.2 Der Dokumentationsprozess im Überblick... 67 6.3 Übersicht Übersetzungsprozess... 68 6.4 Übersicht der wichtigsten Teilaufgaben... 69 6.5 Informationsanalyse... 70 6.6 Strukturelle Definitionen... 72 6.6.1 Einführung zum Funktionsdesign... 73 6.6.2 Sequenzen definieren... 75 6.6.3 Funktionale Einheiten definieren... 77 6.6.4 Funktionsdesign: Sequenzmuster definieren... 79 6.6.5 Elemente zur Textauszeichnung... 80 6.6.6 Formulierungsmuster... 80
6.7 Sequenzmuster einer Handlungsanleitung... 81 6.7.1 Generelle Tipps zu Handlungsanleitungen... 81 6.7.2 Beispiel Führungen am Werkstückträger schmieren... 81 6.7.3 Anmerkungen zu dem Beispiel... 83 6.8 Funktionsdesign für Bilder... 83 6.9 Redaktionsleitfaden als Hilfsmittel erstellen... 86 6.9.1 Redaktionelle Vorgaben... 88 6.9.2 Identifikation von Dokumenten... 89 6.9.3 Identifikation von Bausteinen... 89 6.9.4 Definition von Qualitätskriterien und Freigabe... 90 6.9.5 Seitenlayout und Formatierungen festlegen... 91 6.10 Informationssystem definieren... 91 6.11 Redaktionssystem auswählen... 93 6.12 Konzept prüfen... 94 6.13 Redaktionssystem einführen... 95 7 Sicherheits- und Warnhinweise gestalten... 96 7.1 Klassifizierung von Hinweisen... 97 7.2 Inhalte eines Sicherheitshinweises... 98 7.2.1 Piktogramm... 98 7.2.2 Signalwort... 99 7.2.3 Ergänzende Textinformationen... 99 7.3 Weitere Informationen zur Gestaltung... 100 7.4 Übersetzung von Signalworten... 100 7.5 Verwendung von Farben... 102 7.6 ANSI Z535.6: Sicherheitshinweise in Dokumentationen... 103 7.7 Beispiele für Sicherheitshinweise... 104 7.7.1 Supplemental Directives... 104 7.7.2 Section Safety Messages... 105 7.7.3 Embedded Safety Messages... 105 7.8 Realisierung eines speziellen Sicherheitshinweises... 105
8 Anhang... 107 8.1 Internationale Produktzulassungen... 107 8.1.1 MRA-Abkommen (Mutual Recognition Agreement)... 107 8.1.2 CE-Kennzeichnung und Konformitätserklärung... 107 8.1.3 CB-Verfahren... 108 8.1.4 USA: FDA-Zulassung... 108 8.1.5 USA: UL-Zulassung... 109 8.1.6 USA: Federal Communications Commission (FCC)... 109 8.1.7 Russland: GOST-R-Zertifizierung... 109 8.1.8 China: CCC-Zertifizierung... 110 8.1.9 Japan... 110 8.2 Prüf- und Qualitätszeichen... 111 8.2.1 Deutschland: GS-Zeichen... 111 8.2.2 Europa: KEYMARK... 111 8.2.3 Europa: ENEC... 112 8.2.4 Polen: B-Mark-Kennzeichnung... 112 8.2.5 USA: CSA-Kennzeichen... 112 8.3 Checklisten... 113 8.3.1 Checkliste TD-Istanalyse... 113 8.3.2 Checkliste Dokumentationskonzept... 113 8.3.3 Checkliste Übersetzungsgerechte Quelltexte... 115 8.3.4 Checkliste Zusammenarbeit mit externen Übersetzern... 115 8.3.5 Checkliste Pflichtenheft (Spezifikation)... 116 8.3.6 Checkliste Betriebsanleitung... 117 8.3.7 Checkliste Bilder... 118 8.4 Quellen und Hilfen im Internet... 119 8.4.1 Konzeption von Dokumentationssystemen... 119 8.4.2 Gesetze, Richtlinien und Normen... 119 8.4.3 Online-Wörterbücher und sprachliche Regelwerke... 120 8.4.4 Terminologie und Übersetzung... 121 8.4.5 Kontrollierte Sprachen... 121 Sachregister Informationen zu den Autoren