Redaktionsleitfaden

Ein Redaktionsleitfaden regelt die Erstellung und Verwaltung der Technischen Dokumentation in einer Organisation oder Firma, vor allem in den Dokumentations-abteilungen größerer Unternehmen. 

Der Redaktionsleitfaden richtet sich verbindlich an alle Mitarbeiter einer Dokumentationsabteilung.

In einem Redaktionsleitfaden können unter anderem festgelegt sein:

• Zielgruppen und Nutzer der Technischen Dokumentation

• Arbeitsanweisungen für Mitwirkende

• Beschreibung der Vorgänge oder Prozessschritte

• Arten und Medien der Dokumente, beispielsweise unter den Aspekten von Informationskontext (Bedienungsanleitung, Wartungsanleitung, Installationsanleitung)

• Informationsgegenstand (Maschine, Gebrauchsgegenstand, Softwaresystem)

• Informationsart (Text, Grafik, Film)

• Thematische Struktur und Regeln für die Titel

• Layout, Typographie und Corporate Design

• Strukturvorgaben, Formatvorlagen oder Schablonen für verwendete DTP-Programme oder für multimediale Dokumentationsprogramme

• Vorgaben zur Terminologie

• Informationsquellen, Ansprechpartner und Zuständigkeiten

• Externe Dienstleister, die an der Erstellung beteiligt sind (Dokumentationsbüros, Fotografen, Layout- oder Reprobetriebe)

• Prüf- und Freigaberegeln für die Produktion und Publikation