Redaktionelle Grundlagen für die Technische Dokumentation

Wenn Mitarbeiterinnen und Mitarbeiter in der Technischen Redaktion Benutzerinformationen zukünftig mit einem Redaktionssystem erstellen sollen, sind die redaktionellen Grundlagen das notwendige Basiswissen. Dazu gehören grundlegende Kenntnisse der rechtlichen Vorgaben aus Haftungsrecht, EG-Richtlinien, Gesetzen und Normen. Die rechtliche Forderung nach verständlicher Technischer Dokumentation ist nur zu erfüllen, wenn die redaktionellen Grundlagen zu Formulierung, Visualisierung und Strukturierung von Inhalten berücksichtigt und zielgruppengerecht umgesetzt werden. Das Seminarpaket vermittelt diese redaktionellen Grundlagen. Sie erhalten einen Überblick über die wichtigsten Aspekte der Erstellung von Informationsprodukten – von der Recherche über die Konzipierung bis hin zur Planung von Dokumentationsprojekten. Sie lernen die juristischen und normativen Anforderungen kennen und erhalten kompaktes Grundlagenwissen über die Formulierung, Visualisierung und Strukturierung von Technischer Dokumentation. Ihr Nutzen - Überblick über typische Tätigkeiten bei der Erstellung von Anleitungen - Kenntnisse zum Erstellen von Informationsprodukten und Bewertung ihrer Qualität - Verständliches und adressatengerechtes Formulieren - Knapperes, kürzeres und strukturierteres Schreiben - Anwendung bewährter Regeln der Textformulierung - Vermittlung von Informationen durch Fotos, Grafiken, Screenshots und andere Bildarten - Analyse und gezielte Optimierung eigener Bilder - Vermeidung von Fehlern bei der Bildgestaltung - Kenntnis der wesentlichen Kostenfaktoren bei der Erstellung - Aktueller Stand der rechtlichen Rahmenbedingungen und deren Auswirkung auf die Technische Dokumentation - Bekanntmachung von Normen, die sich mit der Technischen Dokumentation befassen - Weitere Quellen für die Erstellung von Technischer Dokumentation - Kenntnis von Gerichtsurteilen, in denen die Technische Dokumentation eine Rolle spielt und deren Nutzung für die eigene Arbeit - Verständnis des gesamten CE-Prozesses und Bedeutung der Technischen Dokumentation darin Zielgruppe Technische Redakteurinnen und Redakteure sowie alle Mitarbeiterinnen und Mitarbeiter in der Technischen Redaktion, die zukünftig Informationsinhalte mit einem Redaktionssystem (CCMS) erstellen und bearbeiten sollen. Inhalt - E-Learning-Kurs Grundlagen der Technischen Redaktion (Aufwand ca. 80 Stunden) - Recherche zu Produkt, Zielgruppen und Tätigkeiten - Analyse von Dokumentationen - Konzeptionierung von Dokumentationen - Projektumfeldanalyse und Projektplanung - Seminar Technische Dokumentation formulieren und visualisieren (Dauer 2 Tage) - Anwendergerechtes Schreiben - Verständliches Schreiben: Wörter, Sätze, Texte - Überprüfung, Messung und Beurteilung der Verständlichkeit - Auswahl der richtigen Bildart für das Informationsziel - Optimierung von Bildinhalten - Berücksichtigung des Erstellungsaufwands - Erstellung von Sicherheits- und Warnhinweisen für EU und USA - Seminar Juristische und normative Anforderungen an die Technische Dokumentation (Dauer 2 Tage) - Senkung von Haftungsrisiken mit Technischer Dokumentation - Das Produktsicherheitsgesetz - Erfüllung der CE-Konformität für den EU-Binnenmarkt - Anwendung von Normen zur Erstellung von Technischer Dokumentation Vorgehensweise Teilnahme am E-Learning-Kurs und anschließender Besuch der Seminare. Methoden und Nachweise Die vermittelten Inhalte werden durch praktische Übungen aus der Technischen Dokumentation trainiert. Teilnehmende erhalten eine ausführliche Seminar-Dokumentation sowie Tutorials zur späteren Nachvollziehbarkeit der Übungen. Teilnehmende erhalten ein Teilnahmezertifikat.