Redaktionsleitfaden

Erfahren Sie hier, was ein Redaktionsleitfaden ist, wie er aufgebaut ist und wie Sie ihn einsetzen können, um Ihre eigene redaktionelle Arbeit zu verbessern.

Was ist ein Redaktionsleitfaden?

Redaktionsleitfäden beschreiben formale Aspekte, die beim Erstellen einer technischen Dokumentation zu beachten sind. Typische Inhalte sind:

  • einheitliche Definition von Gestaltung und Layout
  • Beschreibung der Zielgruppe(n)
  • Ausgabemedien, in die publiziert wird

Ziel des Redaktionsleitfadens

Redaktionsleitfäden geben dem Ersteller einer Dokumentation keine wirkliche Hilfestellung.

Sie zeigen ihm, wie er in einem realen Projekt vorgehen muss,

  • um die Inhalte zu definieren, die in die Dokumentation gehören
  • um die so definierten Inhalte in ein Dokument umzusetzen

Häufig muss ein Redaktionsleitfaden aber genau diese Hilfestellung bieten. Z. B. dann, wenn ein Konstrukteur einer Maschinenoption oder ein externer Dienstleister Kundendokumentation erstellen sollen, die zur bestehenden Dokumentationsstruktur passt und den formalen Anforderungen genügt.

Inhalt eines Redaktionsleitfadens

Für uns gehören in den Redaktionsleitfaden klare Angaben zu den folgenden Themen:

  • Ein Vorgehen, den Inhalt eines konkreten Dokuments zu definieren
  • Der prinzipielle Inhalt der Dokumentmodule
  • Die prinzipielle Inhaltsstruktur

Daneben definieren wir in unseren Redaktionsleitfäden natürlich auch formalen Aspekte. Dazzú zählen die Dokumentstruktur, die Verwendung von Formatvorlagen und die internen und externen Arbeitsprozesse der Dokumentationsabteilung.

Zudem enthält ein Redaktionsleitfadens unter anderem die folgenden Themen:

Definition der Dokumentationsstruktur

  • Dokumentarten
  • Innere Struktur der Dokumentarten
  • Standardstrukturen und Strukturmuster

Vorgehensmodell zur Definition der Inhalte

  • Zielgruppen- und Zweckbeschreibung
  • Aufgaben- & Kenntnis-Analyse
  • Normative Vorgaben
  • Inhaltsvorlagen und Muster

Definitionen für die Gestaltung der Dokumente

  • Gestaltungsregeln
  • Muster für Dokumentarten
  • Definition des Grafikstils
  • Muster für Grafiken

Beschreibung der Organisation der Redaktion

  • Interne Organisation
  • Einbettung in die Unternehmensorganisation

Beschreibungen der Redaktionsprozesse

  • Recherche
  • Erstellung
  • Übersetzung
  • Produktion
  • Qualitätssicherung

Arbeitsmittel für die Redaktion

  • Beschreibung der Anwendung der eingesetzten Systeme und Tools
  • Arbeitsanleitungen für Redakteure für den redaktionsspezifischen Umgang mit der Redaktionssoftware

Wert eines Redaktionsleitfadens

Ein Redaktionsleitfaden gibt Hilfestellung bei allen Schritten eines Dokumentationsprojektes:

  • Er liefert Vorgehensmodelle für die Definition der Inhalte.
  • Dazu enthält er Inhalts- und Strukturmuster, die ausgefüllt werden können.
  • Diese werden ergänzt um Formulierungsmuster und Terminologievorgaben.
  • Und schlißelich enthält er Muster für das Layout und beschreibt die Benutzung der Formatvorlagen.

Mit diesen Inhalten ermöglicht ein Redaktionsleitfaden den schnellen Einstieg in ein Dokumentationsprojekt – für Konstrukteure und Entwickler, die „nebenbei“ schreiben, für neue Redakteure sowie für externe Dienstleister. Und in großen Dokumentationsabteilungen wird die effiziente Zusammenarbeit erst durch einen Redaktionsleitfaden möglich, insbesondere bei verteilten Standorten.