Ein Redaktionsleitfaden ist eine Art „Anleitung zum Verfassen von Anleitungen“, also eine umfassende Sammlung all der Vorgaben, Festlegungen und
Prozesse, die notwendig sind, um qualitativ gute Technische Dokumentation zu erstellen. Der Redaktionsleitfaden ist dadurch ein wichtiges internes Dokument für die Arbeitsorganisation innerhalb einer Technischen Redaktion und der Akteure, die mit der Technischen Redaktion zusammenarbeiten. Der Redaktionsleitfaden beschreibt den unternehmensinternen Standard für Technische Dokumentation und bildet einen Maßstab für die Qualität der Technischen Dokumentation.
Bezeichnungen für „Redaktionsleitfaden“
Für Redaktionsleitfäden gibt es zahlreiche synonyme Bezeichnungen: „Redaktionshandbuch“, „Styleguide“, „Dokumentationsrichtlinie“, „Corporate
Design-Handbuch“, „Qualitätsmanagement-Handbuch Technische Redaktion“ usw. Fast jedes Unternehmen hat eine eigene Bezeichnung
– und betont im Redaktionsleitfaden unterschiedliche Aspekte: die Qualität des Endproduktes Technische Dokumentation, die Prozesse bei der Erstellung oder die Gestaltung Technischer Dokumentation.
Zweck eines Redaktionsleitfadens
An der Erstellung von Technischer Dokumentation können sehr viele Akteure beteiligt sein wie zum Beispiel:
- die Mitarbeiterinnen und Mitarbeiter in der Technischen Redaktion, die Technischen Redakteure;
- Konstrukteure und Entwickler, die als Fachexperten (Subject Matter Experts, SME) den notwendigen fachlichen, sachlichen Informationsinput für die Technische Dokumentation liefern;
- Übersetzer der Technischen Dokumentation in andere Sprachen;
- Mitarbeiterinnen und Mitarbeiter weiterer unternehmensinterner Abteilungen wie Produktion, IT-Abteilung (IT = Informationstechnik), Marketing, Qualitätsmanagement, Rechtsabteilung;
- Mitarbeiterinnen und Mitarbeiter von anderen Unternehmen, die an dem Erstellungsprozess Technischer Dokumentation beteiligt sind, wie Dokumentations-Dienstleistungsfirmen, Beratungsfirmen, Druckereien, Logistik-Firmen usw.
Die Grundlage für eine effektive und effiziente Zusammenarbeit all dieser Akteure, die in unterschiedlichem Maße an der Erstellung Technischer Dokumentationbeteiligt sind, kann am besten in einem Redaktionsleitfaden beschrieben werden. Der Zweck eines Redaktionsleitfadens ist somit vor allem:
- Transparenz: Offenlegung der Abläufe und Verantwortlichkeiten im Erstellprozess Technischer Dokumentation
- Kooperationsgrundlage: Regeln und Festlegungen für das koordinierte Zusammenwirken aller Akteure
- Qualitätsmaßstab: Beschrieben von Standards für Technische Dokumentation
Prozess der Erstellung eines Redaktionsleitfadens
Die Frage, wie der Redaktionsleitfaden erstellt wird, ist zentral dafür, ob der Redaktionsleitfaden von allen Akteuren als Grundlage des Handelns akzeptiert und beachtet wird. Deswegen sollte man damit beginnen, wie man Prozess der Erstellung des Redaktionsleitfadens organisiert, und sich nicht auf das Resultat eines vollständigen Redaktionsleitfadens fixieren. Was ist mit dieser Empfehlung gemeint? Redaktionsleitfäden sollten prinzipiell nicht von einer einzelnen Person im Alleingang erstellt werden und danach der gesamten Redaktionsmannschaft als „Bibel“ verkündet werden. Dieses Vorgehen hat sich in der Praxis als völlig verfehlt erwiesen, weil es nur dazu führt, dass der Redaktionsleitfaden ein „totes“ Dokument bleibt, das im Schrank oder in der Dateiablage verstaubt. Wenn man jedoch will, dass die Festlegungen und Standards, die man für einen Redaktionsleitfaden erarbeitet, von allen Beteiligten „gelebt“ und bei der täglichen Arbeit in der Technischen Redaktion berücksichtigt werden, dann muss man den Redaktionsleitfaden von Anfang an zusammen mit den beteiligten Mitarbeitern erstellen, nicht für sie. Nur Regelwerk, an dem man selbst mitgewirkt hat, wird man akzeptieren und bei der täglichen Arbeit berücksichtigen.
Wenn ein Redaktionsleitfaden unter Beteiligung möglichst aller relevanten Akteure erstellt wird, dann ist es hilfreich, wenn eine Person die Rolle eines „Sekretärs“ oder „Schriftführers“ für den Redaktionsleitfaden übernimmt und gemeinsam die in Diskussionen und Besprechungen erarbeiteten Ergebnisse als Vorschläge für Kapitel des Redaktionsleitfadens schriftlich ausformuliert. Diese Vorschläge des „Sekretärs“ werden dann von einer „Redaktionsleitfaden-Konferenz“ ergänzt, geändert und letztlich verabschiedet.
Aufbau und Inhalte eines Redaktionsleitfadens
Ein Redaktionsleitfaden kann beispielsweise Festlegungen zu folgenden Fragen der Dokumentationserstellung enthalten:
- zur Sprache (standardisierter Textaufbau je nach Textsorte, Wortwahl / Terminologie);
- zu Abbildungen und Visualisierungen in Technischer Dokumentation (Arten von Abbildungen und Visualisierungen, Zweck von Abbildungen und Visualisierungen);
- zu den Inhalten Technischer Dokumentation (z. B. standardisierte Inhalte);
- zum Aufbau / zur Gliederung Technischer Dokumentation, also zur Struktur (z. B. modulartiger Aufbau von Teilen der Technischen Dokumentation);
- zur Gestaltung (Typographie, Layout, äußere Gestaltung);
- zu technischen Arbeitsmitteln der Dokumentations-Erstellung (Software, Redaktionssysteme);
- zu allen Prozessen bei der Erstellung von Technischer Dokumentation (Planung, Informationsbeschaffung, Erstellung, Korrektur, Freigabe, Qualitätssicherung / Usability Testing, Produktion, Distribution, Wartung / Revision, Archivierung);
- zu Verantwortlichkeiten in den jeweiligen Prozessen;
- zu Fragen der Kostenplanung, Finanzierung;
- zu Normen und Richtlinien, die bei der Erstellung Technischer Dokumentation beachtet werden müssen.
Ein Redaktionsleitfaden kann also zu allen diesen Fragen Aussagen enthalten – oder aber nur zu einigen der genannten, z. B. nur zu Gestaltungsfragen – dann ist er am ehesten ein „Style Guide“ im Wortsinne).
Beispiele
Vorschlag von Enders, Wolff, 2008, S. 23: drei Hauptteile: Vorab, Strategische Themen, Operative Themen
Literatur zu Redaktionsleitfaden
| Baumert, Andreas (1998): Gestaltungsrichtlinien. Style Guides planen,
erstellen und pflegen. Reutlingen: doculine Verlags GmbH, ISBN:
3980577058 |
| Enders, Michael; Wolff, Thomas (4/2008): „Sie haben Ihr Ziel erreicht“. Inhalte und Struktur eines Redaktionsleitfadens. In: technische kommunikation. Stuttgart, S. 18 - 24
|
| Schäflein-Armbruster, Robert (4/2008): Ohne Leit kein Freud. Herausforderungen auf dem Weg zum erfolgreichen Redaktionsleitfaden. In: technische kommunikation. Stuttgart, S. 25 - 30
|
| Schwermer, Rolf (4/1998): Redaktionsleitfäden – Ein unersetzliches Hilfsmittel in der Technikredaktion. In: doculine. Reutlingen
|
| Oehmig, Peter; Reimold, Michael (2004): Redaktionsleitfaden. Grundstein zur Dokumentation. Schenkenzell: GFT Verlag, ISBN: 3938334312
|
| Hoffmann, Walter; Hölscher, Brigitte G.; Thiele, Ulrich (2002): Handbuch für Technische Autoren und Redakteure Produktinformation und Dokumentation im Multimediazeitalter. Berlin: VDE, ISBN: 3800726742
Insbesondere S. 40 ff: Ein „Redaktionshandbuch“ wird als Bestandteil eines Qualitätsmanagementsystems nach DIN EN ISO 9001 dargestellt. Inhalte eines Redaktionshandbuches; drei Phasen der Erstellung u.a.m.
|
Uploading ....