Inhalt eines Redaktionsleitfadens
In einem Redaktionsleitfaden (auch als Redaktionshandbuch bezeichnet) sind Regeln für die Erstellung der Technischen Dokumentation in einem Unternehmen oder für ein bestimmtes Kundenunternehmen festgehalten.
Die genaue Zusammenstellung der Inhalte hängt dabei vom Einzelfall ab. Grundsätzlich können in einem Redaktionsleitfaden z. B. Informationen zu folgenden Themen festgelegt werden:
- Zielgruppen
- Zielformate
- Layout und Typographie
- Vorgaben zur Terminologie
- Schriftarten und -formatierungen
- Gliederung und Struktur
- Arbeitsprozesse
- Bearbeitung von Abbildungen
- Ansprechpartner*innen und andere Informationsquellen
- Vorgehen bei der Recherche
- Zusammenarbeit mit externen Stellen (z. B. Übersetzer*innen)
- Prüf- und Freigabeverfahren
Wenn Informationen zu Layout, Typographie etc. enthalten sind, kann sich durch den Redaktionsleitfaden ein separater Styleguide erübrigen. Denn dann ist der Styleguide bereits im Redaktionsleitfaden enthalten.
Zweck des Redaktionsleitfaden
Ein Redaktionsleitfaden ist insbesondere dann sinnvoll, wenn mehrere Technische Redakteur*innen an der Erstellung der Dokumentationen arbeiten. Sie nimmt ihnen zwar nicht die eigentliche Redaktionsarbeit ab, informiert aber über projektbezogene Prozesse und Aspekte, sodass die erstellten Dokumente auch ohne ständige Absprachen möglichst einheitlich sind und den formalen Anforderungen entsprechen.
Nicht vorgeschrieben, aber sinnvoll
Bei der Erstellung einer Technische Dokumentation greifen verschiedene Normen und gesetzliche Regelungen, bis hin zur Schadensersatzregelung nach dem BGB. Bei einem Redaktionsleitfaden hingegen sind in puncto Gestaltung und Inhalt keine Grenzen gesetzt, da es diesbezüglich keine rechtlichen Vorschriften ö. Ä. gibt. Nicht einmal seine Existenz ist vorgeschrieben.
Für einheitliche Dokumentationsergebnisse ist es jedoch sinnvoll, sich vorab Gedanken zu machen und die Ergebnisse so festzuhalten, dass alle Projektbeteiligten sich daran orientieren können. Im Idealfall wird von Anfang an auch der Kunde/die Kundin in die Diskussion einbezogen, um aufwendige Korrekturzyklen zu vermeiden.