Was ist ein Redaktionsleitfaden?
Übersicht
Diese Seite beinhaltet die folgenden Themen:
Was ist ein Redaktionsleitfaden?
Redaktionsleitfäden beschreiben formale Aspekte, die beim Erstellen einer technischen Dokumentation zu beachten sind. Dabei werden beispielsweise Gestaltung und Layout einheitlich definiert, welche Zielgruppe angesprochen wird und welche Ausgabemedien erzeugt werden.
Ziel des Redaktionsleitfadens
Redaktionsleitfäden geben dem Ersteller einer Dokumentation keine wirkliche Hilfestellung, wie er in einem realen Projekt vorgehen muss,
- um die Inhalte zu definieren, die in die Dokumentation hinein gehören,
- um die Umsetzung der so definierten Inhalte in ein Dokument vorzunehmen.
Häufig muss ein Redaktionsleitfaden aber diese Hilfestellung bieten, wenn z. B. ein Konstrukteur einer Maschinenoption oder ein externer Dienstleister in die Lage versetzt werden soll, Kundendokumentation zu erstellen, die sich inhaltlich in die vorgegebene Dokumentationsstruktur eingliedert und den formalen Anforderungen genügt.
Für uns enthält ein Redaktionsleitfaden also klare Angaben
- zum Vorgehen, den Inhalt eines konkreten Dokuments zu definieren,
- zum prinzipiellen Inhalt der Dokumentmodule,
- zur prinzipiellen Inhaltsstruktur.
Daneben definieren wir in unseren Redaktionsleitfäden natürlich auch die formalen Aspekte wie die Dokumentstruktur, die Benutzung von Formatvorlagen und die internen und externen Arbeitsprozesse der Dokumentationsabteilung.
Inhalt eines Redaktionsleitfadens
Ein Redaktionsleitfadens enthält unter anderem die folgenden Themen:
Definition der Dokumentationsstruktur
Vorgehensmodell zur Definition der Inhalte
- Normativen 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
Abläufe des kompletten Redaktionsvorgangs
- 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:
Mit diesen Inhalten ermöglicht er den schnellen Einstieg in ein Dokumentationsprojekt – für Konstrukteure und Entwickler, die "nebenbei" schreiben, für neue Redakteure, für externe Dienstleister. In großen Dokumentationsabteilungen ist er die Grundlage, die eine Zusammenarbeit überhaupt erst ermöglicht, insbesondere, wenn Dokumentationsabteilungen auf mehrere Standorte verteilt sind.