Kundendokumentationen für. Konsum- und Investitionsgüter. Kritische Erfolgsfaktoren für Management und Erstellung

Transkript

1 DIN Martin Böcker Ralf Robers Kundendokumentationen für Konsum- und Investitionsgüter Kritische Erfolgsfaktoren für Management und Erstellung 1. Auflage 2015 Herausgeber: DIN Deutsches Institut für Normung e.v. Beuth Verlag GmbH Berlin Wien Zürich

2 INHALT Inhalt Einleitung l 1 Die Bedeutung der Kundendokumentation in einer sich ändernden Welt Arten der Kundendokumentation Wer liest denn Bedienungsanleitungen? Anleitungen für immer komplexer werdende Produkte Neue User Interfaces wollen erst einmal erlernt werden Produkte sicher betreiben Die Kundendokumentation im Produktlebenszyklus Kulturelle Unterschiede bei der Nutzung der Kundendokumentation 9 2 Juristische und normative Anforderungen an die Technische Dokumentation Ii 2.1 Gesetze Richtlinien Normen 25 Organisation und Management 33 3 Arten von Dokumentationen Die interne Technische Dokumentation Die externe Technische Dokumentation 42 4 Kostenbetrachtungen und -kalkulationen, Kennzahlen Finanzierung der Kosten für Technische Dokumentation Kostenkalkulation von Technischer Dokumentation Kennzahlen 53 5 Interne Schnittstellen und organisatorische Aspekte Erfolgsfaktoren für die Technische Dokumentation Organisationsformen und ihre Einbettung in die Unternehmensstruktur Die Technische Dokumentation als Wertschöpfungsprozess Schnittstellen 60 IX

3 KUNDENDOKUMENTATIONEN FÜR KONSUM- UND INVESTITIONSGÜTER 6 Externe Dienstleister und Unterlieferanten Grundgedanken zur Beauftragung externer Dienstleister Aufgabenspektrum externer Dienstleister Rechtliche Rahmenbedingungen Vertragsformen beim Einsatz externer Dienstleister Einkauf von Übersetzungsdienstleistungen Handhabung der Dokumentation von Unterlieferanten 76 7 Das Personal der Technischen Redaktion Die Schlüsselfaktoren Motivation und Kompetenz Tätigkeits-/Qualifikationsprofile Selbst- und Sozialkompetenz Die drei Rollen der Führungskraft 96 Recherche und Strukturierung io9 8 Informationsentwicklung m 8.1 Begriffe Die Phasen der Informationsentwicklung Inhaltliche Recherche Recherche des Produkts Recherche der anzuwendenden Normen Recherche der relevanten Randbedingungen Recherche der Zielgruppe Recherche der Anwendungssituation Die Dokumentationsstruktur von Gebrauchsgütern Die Herausforderung Voraussetzungen für den Entwurf einer Bedienungsanleitung Die inhaltliche und formale Struktur von Bedienungsanleitungen Bekannte Probleme Die Dokumentationsstruktur von Investitionsgütern Die Herausforderung Voraussetzungen für den Entwurf der Technischen Dokumentation. 157 X

4 INHALT 11.3 Die inhaltliche Struktur von Betriebsanleitungen Die inhaltliche Struktur der Technischen Dokumentation für (Maschinen)Anlagen Integration der Dokumentation von Unterlieferanten Die Dokumentationsstruktur von Software-Produkten Informationsprodukte und Informationsarten Der übliche Aufbau von Benutzerhandbüchern für Software-Produkte Normen zur Dokumentation von Software-Produkten Strukturieren und Standardisieren, Einsatz von Redaktionssystemen Grundlagen der Strukturierung von Informationen Strukturieren mit Funktionsdesign Strukturieren mit Information Mapping Strukturieren mit XML-Standards Standardisieren Organisation von Inhalten - Content Management Einsatz von Redaktionssystemen (Content Management Systeme). 228 Erstellung von Inhalten Richtige und gute Sprache Formale Verständlichkeitskonzepte Wörter und Begriffe Sachliche Sprache und verständliches Deutsch Richtiges Deutsch Editieren und Korrekturlesen Terminologiearbeit in der Technischen Redaktion Die Bedeutung von Terminologiearbeit in Unternehmen Phasen und Prozesse der Terminologiearbeit Terminologiegewinnung (Term-Extraktion) Werkzeuge für die Terminologiearbeit Terminologiearbeit im Unternehmen 265 XI

5 KUNDENDOKUMENTATIONEN FÜR KONSUM- UND INVESTITIONSGÜTER 16 Redaktionsleitfäden > Ziel und Nutzen von Redaktionsleitfäden Aufbau und Inhalt von Redaktionsleitfäden Erstellen von Redaktionsleitfäden Wiki - ein geeignetes Medium für Redaktionsleitfäden Kontrollierte Sprache und übersetzungsgerechtes Schreiben Regelbasiertes Schreiben Ansätze für kontrollierte Sprache Empfehlungen für regelbasiertes Schreiben in der Technischen Dokumentation Technische Dokumentation in Englisch als Ausgangssprache 285 Gestaltung Layout nformate Der Satzspiegel Aspekte der ngestaltung Typographie Definitionen und Grundbegriffe Die Auswahl einer Schriftart für den Fließtext Die Auswahl einer Schriftart für Überschriften Typographische Fehler Bildhafte Darstellungen Bildtypen und ihre Verwendung Visualisierungsarten für Abbilder Standardisieren von Fotos und Grafiken Multimediale Inhalte Verwendung multimedialer Inhalte Video und Animation Audio 332 XII

6 INHALT 21.4 Interaktion E-Learning Hinweise zum Einsatz von multimedialer Dokumentation Barrierefreie Kundendokumentation Zielgruppen mit besonderen Anforderungen Barrierefreiheit in der Kundendokumentation Das Potenzial von Single Source Publishing für barrierefreie Kundendokumentationen 343 Produktion und Qualitätssicherung Druck und andere Ausgabeformate Papierpflicht für die Technische Dokumentation? Grundlagen der Drucktechnik Prinzip des Vierfarbdrucks Druckverfahren Druckkosten Elektronische Ausgabeformate Mobile Dokumentationen Besonderheiten mobiler Endgeräte Konzeptionelle Anforderungen Technische Umsetzungsmöglichkeiten Kompetenzen und Kosten Lokalisierung Lokalisierung ist mehr als nur Übersetzung Dimensionen der Lokalisierung Landesvariationen einzelner Sprachen Übersetzungen Korrekte und fehlerhafte Übersetzungen Übersetzung im Erstellungsprozess der Kundendokumentation Die Nadel im Hafen suchen: maschinelle und teilautomatische Übersetzung Übersetzungen von OEM-Dokumenten 397 XIII

7 KUNDENDOKUMENTATIONEN FÜR KONSUM- UND INVESTITIONSGÜTER 27 Qualitätssicherung Grundsätze einer Qualitätskultur Erkennungsmerkmale einer guten Kundendokumentation Lektorat und Freigabe Einsatz technischer Hilfsmittel Unterstützung durch Expertengutachten Usability-Tests von Dokumentationen Abschließende Bemerkungen und Empfehlungen Hilfreiche Empfehlungen und Richtlinien von Normungsinstituten Normen und Leitlinien Richtlinien aus anderen Quellen Literaturverzeichnis 425 Stichwortverzeichnis 445 XIV