Grundlagen der Technischen Dokumentation

Transkript

1 Grundlagen der Technischen Dokumentation

2 Lars Kothes Grundlagen der Technischen Dokumentation Anleitungen verständlich und normgerecht erstellen 1 3

3 Dipl.-Ing. Lars Kothes Kothes! Technische Kommunikation GmbH & Co. KG Industriering Ost Kempen Deutschland ISBN e-isbn DOI / Springer Heidelberg Dordrecht London New York Die Deutsche Nationalbibliothek verzeichnet diese Publikation in der Deutschen Nationalbibliografie; detaillierte bibliografische Daten sind im Internet über abrufbar. Springer-Verlag Berlin Heidelberg 2011 Dieses Werk ist urheberrechtlich geschützt. Die dadurch begründeten Rechte, insbesondere die der Übersetzung, des Nachdrucks, des Vortrags, der Entnahme von Abbildungen und Tabellen, der Funksendung, der Mikroverfilmung oder der Vervielfältigung auf anderen Wegen und der Speicherung in Datenverarbeitungsanlagen, bleiben, auch bei nur auszugsweiser Verwertung, vorbehalten. Eine Vervielfältigung dieses Werkes oder von Teilen dieses Werkes ist auch im Einzelfall nur in den Grenzen der gesetzlichen Bestimmungen des Urheberrechtsgesetzes der Bundesrepublik Deutschland vom 9. September 1965 in der jeweils geltenden Fassung zulässig. Sie ist grundsätzlich vergütungspflichtig. Zuwiderhandlungen unterliegen den Strafbestimmungen des Urheberrechtsgesetzes. Die Wiedergabe von Gebrauchsnamen, Handelsnamen, Warenbezeichnungen usw. in diesem Werk berechtigt auch ohne besondere Kennzeichnung nicht zu der Annahme, dass solche Namen im Sinne der Warenzeichen- und Markenschutz-Gesetzgebung als frei zu betrachten wären und daher von jedermann benutzt werden dürften. Einbandentwurf: WMXDesign GmbH, Heidelberg Gedruckt auf säurefreiem Papier Springer ist Teil der Fachverlagsgruppe Springer Science+Business Media (

4 Danksagung Ich bedanke mich bei allen, die mich bei der Erstellung dieses Buches unterstützt haben. Ganz besonders bedanke ich mich bei Alexia Hölscher, die die Texte für die Kapitel Dokumentationsprozess, Sicherheitshinweise gestalten und formulieren und Anleitungen für den US-Markt erstellt hat. Simone Ledermann danke ich für das hervorragende Lektorat. Weiterhin danke ich den Firmen für die Freigabe zahlreicher Abbildungen und Passagen, die im Rahmen von Dokumentationsprojekten bei Kothes! erstellt wurden. v

5 Inhalt 1 Grundlegendes Stellenwert der Technischen Dokumentation Arten von Technischer Dokumentation Berufsbild des Technischen Redakteurs Gesetze, Richtlinien und Normen Grundlagen der CE-Kennzeichnung Die Europäische Union Gesetzgebungsverfahren in der EU EG-Richtlinien nach Neuer Konzeption (New Approach) Marktaufsicht Geltungsbereich der EG-Richtlinien Geräte- und Produktsicherheitsgesetz und EG-Richtlinien Geräte- und Produktsicherheitsgesetz (GPSG) Maschinenrichtlinie Niederspannungsrichtlinie EMV-Richtlinie Geräte in explosionsgefährdeten Bereichen (ATEX) Medizinprodukterichtlinie Weitere Richtlinien Produkthaftung Normen Grundlagen der Normung DIN EN DIN EN ISO ISO Guide VDI DIN-Fachbericht DIN EN Formale Anforderungen an die Anleitung Vollständigkeit vii

6 viii Inhalt Verständlichkeit Lieferform Zeitpunkt der Bereitstellung Sprache Muss der Nutzer die Anleitung eigentlich lesen? Spezielle Anforderungen an Softwaredokumentation Internationale Normen Software als Bestandteil eines Produkts oder Geräts Anwendbarkeit des Geräte- und Produktsicherheitsgesetzes (GPSG) Mängelgewährleistung Sicherheitsanforderungen und abgeleitete Pflichten Sprachen Die Risikobeurteilung Grundlage der Betriebsanleitung Dokumentationsprozess Projektplanung Zuständigkeiten Zielgruppenanalyse Zielgruppensegmentierung Zielgruppencharakterisierung Recherche Recherchecheckliste erstellen Vorhandene Informationen auswerten Recherche vorbereiten Recherche durchführen Recherche auswerten Erstellung Erstellungsprozess Tipps für optimale Arbeitsabläufe beim Erstellungsprozess Qualitätssicherung Welche Faktoren bestimmen die Qualität von Technischen Dokumentationen? Durch welche Prozesse und Systeme kann die Qualität sichergestellt werden? Übersetzung Stolpersteine Prozesse optimieren Inhalte der Anleitung Deckblatt Impressum Inhaltsverzeichnis... 69

7 Inhalt ix 4.4 Allgemeines Informationen zu dieser Anleitung Symbolerklärung Haftungsbeschränkung* Urheberschutz Garantie und Gewährleistung Sicherheit Bestimmungsgemäße Verwendung Allgemeine Gefahrenquellen Verantwortung des Betreibers* Personalqualifikation Sicherheitskennzeichnung Schutzausrüstung Sicherheitseinrichtungen Sichern gegen Wiedereinschalten Verhalten im Gefahrenfall Umweltschutz Technische Daten Darstellung der Technischen Daten* Technische Daten im Einzelnen Alternative Darreichungsformen Aufbau und Funktion Kurzbeschreibung* Übersicht Lieferumfang* Prozess- oder Funktionsbeschreibung Beschreibung der Baugruppen* Anschlüsse Anzeigen und Bedienelemente Bediensoftware Arbeitsplätze und Gefahrenbereiche Betriebsarten Zubehör, Werkzeuge Transport Sicherheit Transportinspektion* Symbole auf der Verpackung* Verpackung Transport Lagerung Installation und Erstinbetriebnahme Sicherheit Anforderungen an den Aufstellort Vorbereitungen

8 x Inhalt Installation Anschließen Erstinbetriebnahme Bedienung, Betrieb Sicherheit Tätigkeiten vor Gebrauch Ein- und Ausschalten Normalbetrieb Besondere Handlungen Tätigkeiten nach der Benutzung Reinigung, Desinfektion, Sterilisation Wartung Sicherheit Wartungsplan Wartungsarbeiten Störungen Sicherheit Störungsanzeigen Verhalten bei Störungen Störungstabelle Arbeiten zur Störungsbeseitigung Demontage, Entsorgung Sicherheit Demontage Entsorgung Glossar Index Anhang Konformitätserklärung Qualitätsdokumentation Datenblätter Checklisten, Prüfbücher Anleitungen der Lieferanten Anleitungen formulieren Verständlich formulieren Kurze und einfache Sätze formulieren Substantivierungen vermeiden Sätze nicht über Aufzählungen fortsetzen Klemmkonstruktionen vermeiden Funktionsverbgefüge vermeiden Präzise formulieren Eindeutige Terminologie Abstrakte Begriffe und Fremdwörter vermeiden Einzelheiten direkt benennen

9 Inhalt xi Abkürzungen vermeiden Firmenjargon vermeiden Füllwörter vermeiden Weichmacher vermeiden Einheitlich formulieren Einheitliche Anrede Einheiten und Werte Komposita übersichtlich schreiben Überschriften korrekt wählen Textwüsten vermeiden, Texte strukturieren Handlungsanweisungen formulieren Handlungsanweisung betiteln Voraussetzungen definieren Handlungsschritte typografisch hervorheben Handlungsschritte aktivisch formulieren Handlungsschritte vollständig formulieren Eine Handlung je Handlungsschritt Richtige Reihenfolge einhalten Beispiel für eine gute Handlungsanweisung Querverweise setzen Übersetzungsgerecht schreiben Anleitungen gestalten Funktions- und zielgruppengerechte Gestaltung Zweck der Gestaltung Einfluss der Zielgruppe Einfluss des Produktes Entwicklung einer zweckgerichteten Gestaltung Seitengestaltung Seitengröße Satzspiegel Einseitig oder doppelseitig? Ränder Navigationselemente und andere Elemente auf der Seite Typografie Digitale Ausgabeformate von Anleitungen PDF als Online-Medium Klassische Online-Medien E-Books Hörbücher Video-Anleitungen Sicherheitshinweise gestalten und formulieren Aufgaben von Sicherheitshinweisen Anforderungen an Sicherheitshinweise

10 xii Inhalt 7.3 Sicherheitshinweise gestalten Hervorhebung Aufbau Symbole Sicherheitshinweise formulieren und strukturieren Schwere der Gefahr spezifizieren Art und Quelle der Gefahr spezifizieren Mögliche Folgen der Gefahr beschreiben Instruktionen zur Abwehr der Gefahr geben Eingebettete Sicherheitshinweise Sicherheitshinweise platzieren Grundsätzliche (allgemeine) Sicherheitshinweise Abschnittsbezogene Sicherheitshinweise Eingebettete Sicherheitshinweise Visualisierung Bedeutung von Abbildungen Grafiksoftware Abbildungen richtig einsetzen Wann brauche ich ein Bild? Text-Bild-Anordnung Bildgröße Ausschnitte Bildunterschriften und Legenden Abbildungsarten Fotos Strichzeichnungen Screenshots Symbole und Piktogramme Grafische Auszeichnungen Textlose Anleitungen Anleitungen modular erstellen Grundlagen der Modularisierung Was ist Modularisierung? Anwendungsbereiche Chancen und Risiken Redaktionssysteme Vorgehensweise bei der Modularisierung von Anleitungen Modularisierungskonzept festlegen Module einteilen Besonderheiten bei der Modularisierung Metadaten Statusverwaltung

11 Inhalt xiii Versionierung Verwendungsnachweis Querverweise Übersetzungsmanagement Neue Arbeitsabläufe durch Modularisierung Auswahl eines Redaktionssystems Basistechnologie XML Auswahl der passenden Software ROI-Berechnung Redaktionsleitfaden Anforderungen an einen Redaktionsleitfaden Inhalte eines Redaktionsleitfadens Einen Redaktionsleitfaden erarbeiten Anleitungen für den US-Markt Produkthaftungsrecht in den USA Grundlegende inhaltliche Anforderungen an US-Anleitungen Risikobeurteilung Normenrecherche Kapitelstruktur Sicherheitshinweise nach ANSI Z Allgemeines zur ANSI Z Struktur und Elemente Typen von Sicherheitshinweisen Terminologie und Übersetzung Die Anleitung im betriebswirtschaftlichen Kontext Nutzenpotenziale Technische Dokumentation verkaufen? Dokumentationskosten Recherche Erstellung Qualitätssicherung Verwaltung Übersetzung Optimierungspotenziale Abläufe/Informationsfluss Automatisierung Wissen des Technischen Redakteurs Quellen Abbildungen Gesetze

12 xiv Inhalt 13.3 EG-Richtlinien Normen ANSI-Standards VDI-Richtlinien Sachverzeichnis