Vorlage für ein Redaktionsleitfaden
Ein Redaktionsleitfaden ist ein Dokument, das die Regeln und Richtlinien für die Erstellung und Überarbeitung von technischen Dokumenten enthält. Es dient als Referenz für Schreib- und Stilrichtlinien, Layout-Anforderungen, Verwendung von Symbolen und Abkürzungen und andere Aspekte der Dokumentenerstellung. Es ist ein wichtiges Werkzeug, um sicherzustellen, dass die Dokumentation einheitlich und konsistent ist und den Anforderungen der Zielgruppe entspricht. Ein Redaktionsleitfaden kann auch Anweisungen für die Verwendung von bestimmten Schreibwerkzeugen oder die Übermittlung von Dokumenten enthalten. Er kann auf einer internationalen Norm wie IEC 82079-1 basieren oder spezifisch für ein Unternehmen oder ein Projekt erstellt werden.
Vorlage für ein Redaktionsleitfaden – Der Redaktionsleitfaden ist die Bibel einer jeden Technischen Redaktion. Er vereint die typischen Inhalte eines Qualitätsmanagementhandbuchs mit den fachlichen Anforderungen aus der Technischen Dokumentation.
Die Mustervorlage beinhaltet max. mögliche Kategorien. Es werden lediglich Kapitelüberschriften vorgegeben, da jede Firma andere Produkte, CI-Richtlinien o.ä. hat.
Die Mustervorlage besteht aus 10 Hauptüberschriften die wiederum unterteilt sind in Unterüberschriften bis zur 3. Ebene. Es gibt insgesamt 245 Kapitel!!!
Hier ein Vorgeschmack auf den Muster-Redaktionsleitfaden:
1 Layout
1.1 Allgemeines
2 Seitenformat
3 Seitenfüllgrad
4 Seitenlayout
4.1 Satzspiegel
4.2 Seitenränder
4.3 Marginalie
5 Zeilenlayout
5.1 Zeilenabstände
5.2 Zeilenlänge
6 Schriften
6.1 Überschriften
6.2 Schriftarten / Schriftfamilie
6.3 Bild- und Tabellenunterschriften
7 Farben
8 Kopfzeilen
9 Fußzeilen
10 Verzeichnisse
10.1 Inhaltsverzeichnis
10.2 Abkürzungsverzeichnis
10.3 Fachwortverzeichnis (Glossar)
10.4 Stichwortverzeichnis (Index)
10.5 Tabellenverzeichnis
10.6 Abbildungsverzeichnis
10.7 Quellenangaben/Literaturverzeichnis
