Ein Redaktionsleitfaden ist das verbindliche interne Regelwerk für die Erstellung Technischer Dokumentation. Er legt fest, wie geschrieben, strukturiert, gestaltet und freigegeben wird – von der Satzbaustruktur über die Kapitelfolge bis zur Behandlung von Warnhinweisen. Gebräuchlich sind auch die Bezeichnungen Redaktionshandbuch und Styleguide. Der Redaktionsleitfaden sorgt dafür, dass Dokumentation unabhängig von der schreibenden Person einheitlich entsteht, und macht die Anforderungen aus Normen im Arbeitsalltag anwendbar.
Inhalt
Was steht in einem Redaktionsleitfaden?
Der Leitfaden deckt vier Bereiche ab, die in dieser Reihenfolge aufeinander aufbauen.
- Prozess: Wer erstellt, wer prüft fachlich, wer gibt frei, wie werden Änderungen dokumentiert.
- Struktur: verbindliche Kapitelfolge, Schnitt der Module, Pflichtmetadaten.
- Sprache: Satzbau, Anrede, Umgang mit Terminologie, Aufbau von Warnhinweisen, zulässige und unzulässige Formulierungen.
- Gestaltung: Layoutvorgaben, Bildsprache, Auszeichnungen und Symbolik.
Warum sind Warnhinweise ein eigener Regelungspunkt?
Warnhinweise sind der sicherheitskritischste Teil einer Anleitung und gleichzeitig der uneinheitlichste, wenn er nicht geregelt ist. Der Leitfaden legt deshalb fest, welche Signalwörter verwendet werden, wie ein Warnhinweis aufgebaut ist und wo er steht.
Bewährt hat sich eine feste Reihenfolge im Warnhinweis: Art und Quelle der Gefahr, mögliche Folge, Maßnahme zur Vermeidung. Ohne diese Festlegung entstehen Hinweise, die zwar warnen, aber nicht sagen, was zu tun ist – und damit ihre Funktion verfehlen.
Welchen Nutzen hat ein Redaktionsleitfaden?
Der offensichtliche Nutzen ist Einheitlichkeit. Der wirtschaftlich größere liegt an anderer Stelle: Ein Leitfaden verkürzt Einarbeitungszeiten und macht Entscheidungen dauerhaft, die sonst bei jedem Projekt neu getroffen werden.
Hinzu kommt die Wirkung auf Übersetzungen. Einheitliche Formulierungen erhöhen die Wiederverwendungsquote im Translation Memory unmittelbar. Der Leitfaden zahlt sich damit auch dort aus, wo er gar nicht gelesen wird.
Wie erstellt man einen Redaktionsleitfaden?
Der wirksamste Einstieg ist die Auswertung des Bestands, nicht das Schreiben von Regeln. Wer drei bestehende Anleitungen nebeneinanderlegt, findet die Abweichungen, die geregelt werden müssen – und nur die.
- Bestandsanalyse: Wo weichen bestehende Dokumente voneinander ab?
- Normanforderungen einarbeiten, insbesondere zu Sicherheitsinformationen.
- Regeln formulieren, jeweils mit einem Positiv- und einem Negativbeispiel.
- Mit der Redaktion abstimmen und verbindlich in Kraft setzen.
- Pflegeverantwortung und Überprüfungsrhythmus festlegen.
Beispiele sind der entscheidende Teil. Eine Regel wie „kurze Sätze schreiben“ wird unterschiedlich ausgelegt; ein Beispielpaar nicht.
Wie umfangreich sollte er sein?
So knapp wie möglich. Ein Leitfaden von zweihundert Seiten wird nicht gelesen und damit nicht befolgt. Praxistauglich sind Umfänge, die sich in einer Einarbeitungswoche durcharbeiten lassen.
Hilfreich ist eine Zweiteilung: eine kurze verbindliche Regelsammlung für den täglichen Gebrauch und ein ausführlicherer Anhang mit Begründungen und Sonderfällen. Wer nachschlagen will, findet die Regel; wer verstehen will, findet den Hintergrund.
Wie hält man den Leitfaden aktuell?
Ein Redaktionsleitfaden veraltet leise. Neue Produktarten, geänderte Normen und neue Ausgabekanäle erzeugen Regelungsbedarf, der zunächst informell gelöst wird – und dann als ungeschriebene Praxis weiterläuft.
Wirksam ist ein fester Überprüfungstermin und eine benannte verantwortliche Person. Sinnvoll ist außerdem, Abweichungen aus dem Alltag zu sammeln: Jede wiederkehrende Rückfrage im Team ist ein Hinweis auf eine fehlende oder unklare Regel.
Häufige Fragen
Was ist der Unterschied zwischen Redaktionsleitfaden und Styleguide?
Die Begriffe werden weitgehend synonym verwendet. Styleguide betont häufiger die sprachlich-gestalterische Seite, Redaktionsleitfaden schließt Prozesse und Struktur ein.
Braucht eine Ein-Personen-Redaktion einen Leitfaden?
Ja, aus zwei Gründen: Er sichert Entscheidungen über die Zeit ab und macht die Redaktion bei Ausfall oder Wechsel vertretbar.
Gehört die Terminologie in den Redaktionsleitfaden?
Die Regeln zum Umgang mit Terminologie ja, der Begriffsbestand selbst nicht. Dieser wird in einer Terminologiedatenbank gepflegt.
CARSTENS + PARTNER erstellt Redaktionsleitfäden und begleitet ihre Einführung in bestehende Redaktionen. Mehr dazu auf der Seite Beratung und Schulung.
