Das moderne Redaktionshandbuch als Rückgrat technischer Dokumentation

Transkript

1 als Rückgrat technischer Dokumentation Gertraud Fischer cognitas. Gesellschaft für Technik-Dokumentation mbh Ottobrunn, Alte Landstr Paderborn, Heinz-Nixdorf-Ring 1 gertraud.fischer@cognitas.de

2 Überblick über die Inhalte des Vortrags Einführung Medienübergreifendes Konzept Bedeutung des Mediums Papier Bedeutung des Mediums Intranet Aktualität und Vollständigkeit gewährleisten Folie 2 Gertraud Fischer 26. April 2001

3 Einführung: Hilfsmittel für Qualitätssicherung in der Technischen Dokumentation Qualitätsmanagement-Handbuch an interne und externe Leser gerichtet Überblick über Aufbau und Abläufe im Unternehmen: Was passiert im Unternehmen? Verweise auf detaillierte Prozessbeschreibungen und Verantwortungszuweisungen in Subdokumentationen Redaktionshandbuch an interne Leser gerichtet Beschreibung von Prozessen, Verfahren und Hilfsmitteln im Unternehmen Folie 3 Gertraud Fischer 26. April 2001

4 Medienübergreifendes Konzept (1) Medium Papier: Redaktionshandbuch als Ordner mit Registern Medium Intranet: Redaktionshandbuch auf mehreren Ebenen für jeden thematischen Schwerpunkt ein eigenes Register für jedes Register ein eigenes Inhaltsverzeichnis Ebene der Register Ebene des Inhaltsverzeichnisses Ebene der Inhalte Schwerpunkt: konstante Inhalte Schwerpunkt: dynamische Inhalte Folie 4 Gertraud Fischer 26. April 2001

5 Medienübergreifendes Konzept (2) Konstante Inhalte auf Papier zusätzlich auch im Intranet individuell bevorzugte Zugangsmöglichkeit wählbar. Dynamische Inhalte vollständig nur im Intranet auf Papier nur eine Übersicht über die Inhalte zur Orientierung Folie 5 Gertraud Fischer 26. April 2001

6 Bedeutung des Mediums Papier konstante Bestandteile lange Gültigkeitsdauer beispielhafte Inhalte Redaktionelle Grundlagen Prozesse Verfahren Regeln zur Aufbewahrung von qualitätsrelevanten Dokumenten Folie 6 Gertraud Fischer 26. April 2001

7 Redaktionelle Grundlagen Konzept für eine Dokumentation erarbeiten Richtlinien für Aufbau und Gliederung von verschiedenen Dokumentationstypen Verständliches Schreiben Grafiken erstellen Folie 7 Gertraud Fischer 26. April 2001

8 Prozesse und Verfahren Was? Allgemeingültige Prozessbeschreibung: Erstellen technischer Dokumentation Prozessbeschreibung für die Redaktion XY: Erstellen technischer Dokumentation angepasst an die speziellen Aufgabengebiete der unterschiedlichen Redaktionen Wie? Verfahrensbeschreibungen zu den einzelnen Prozess-Schritten Folie 8 Gertraud Fischer 26. April 2001

9 Beispiel: Ausschnitt aus dem Prozess Technische Dokumentation erstellen Redaktionshandbuch Konzept / Gliederung erstellen Muster Einladung & Protokoll Dokumentationsstruktur besprechen Auftraggeber Projektplanung im Projektordner Dokustrukturbesprechung Ressourcen planen Projektplanung im Projektordner Redaktionshandbuch & Input Dokumentation erstellen Auftraggeber Qualitätsaufzeichnung im Projektordner Musteranschreiben & Projektplan Korrekturlauf durchführen Auftraggeber Folie 9 Gertraud Fischer 26. April 2001

10 Bedeutung des Mediums Intranet dynamische Bestandteile häufige Anpassung an sich wandelnde Anforderungen schneller Informationsaustausch möglich Beispielhafte Inhalte Styleguide Toolbeschreibungen Hilfsmittel zu einzelnen Prozess-Schritten oder Verfahren Folie 10 Gertraud Fischer 26. April 2001

11 Styleguide und Toolbeschreibungen Dynamik bei Dokument-Schablonen neues/verändertes Corporate Design zusätzlicher Bedarf an speziellen Formaten Dynamik bei redaktionellen Tools Weiterentwicklung aufgrund zusätzlicher Anforderungen Anpassung an neue Versionen von Redaktionssystemen und DTP-Programmen Folie 11 Gertraud Fischer 26. April 2001

12 Hilfsmittel Muster für externe Korrespondenz Anschreiben zum Korrekturlauf Protokoll zur Besprechung der Dokumentationsstruktur Muster für interne Qualitätsdokumentation Projektplanung Statusdokumentation eines Projekts Checklisten Satz- und Layoutkontrolle Inhalte eines Dokumentationsvertrags Folie 12 Gertraud Fischer 26. April 2001

13 Aktualität und Vollständigkeit gewährleisten Zielsetzung alle Abläufe erfassen vollständige Dokumentation Aktualität Pflegeaufwand minimieren klar ablesbare Zuständigkeit Folie 13 Gertraud Fischer 26. April 2001

14 Wie gewährleistet man Aktualität? für verschiedene Inhalte unabhängige Dokumente pflegen Einzeldokumente versionieren und datieren Zuständigkeit klar definieren bei Änderungen nur das betroffene Einzeldokument und dessen Version und Datum ändern sicherstellen, dass immer alle Betroffenen sofort über die Änderungen informiert werden, und dementsprechend ihre Papierexemplare aktualisieren Folie 14 Gertraud Fischer 26. April 2001

15 Wie gewährleistet man Vollständigkeit? Vollständigkeit eines Redaktionshandbuchs ist visionär. ABER: Redakteure dafür sensibilisieren, dass das Redaktionshandbuch lebt. Klare Zuständigkeiten für alle Bestandteile des Redaktionshandbuchs festlegen. Die redaktionelle Bedienungsanleitung profitiert genauso von den Korrekturvorschlägen und Anregungen der Anwender, wie die Dokumentation eines technischen Produkts von Leserzuschriften und Usability Tests. Folie 15 Gertraud Fischer 26. April 2001