"Wo zusammengearbeitet wird, braucht man Regeln."
Wenn es um das Erstellen von Technischer Dokumentation geht, werden solche Regeln oft in einem verbindlichen Redaktionsleitfaden festgehalten. Wie sollte ein solcher Leitfaden aufgebaut sein? Was sind die wesentlichen Inhalte und worauf muss bei der Einführung geachtet werden?
Die Antworten auf diese Fragen und alle weiteren zentralen Punkte haben wir für Sie zusammengefasst.
Warum überhaupt ein Redaktionsleitfaden?
Technische Redaktion heißt in den meisten Fällen: arbeiten im Team, oft auch über Standortgrenzen hinweg. Dabei ist nicht immer klar, nach welchen Standards und Regeln die Anleitungen eigentlich erstellt werden. Hinzu kommt, dass Redakteur:innen unbewusst ihren ganz eigenen redaktionellen Stil mit in den Prozess einbringen.
Gerade in kniffligen Situationen behilft man sich dann fast schon automatisch mit individuellen Lösungen, die sich in der Vergangenheit oft bewährt haben. Das ist grundsätzlich nicht falsch und kann durchaus dabei helfen, ein gutes Endergebnis abzuliefern.
Auf lange Sicht führt so ein Vorgehen aber zwangsläufig zu Inkonsistenzen in der Dokumentation und gefährlichem methodischen Wildwuchs – ein absolutes No-Go in der Doku-Welt. Abhilfe schafft ein zentrales Regelwerk, in dem alle Vorgaben und Entscheidungen für die effektive Erstellung der Technischen Dokumentation festgehalten sind – der Redaktionsleitfaden.
Komposita – mit oder ohne Bindestrich? Beispiel für die sprachlichen Vorgaben in einem Redaktionsleitfaden.
Welche konkreten Vorteile bietet ein Redaktionsleitfaden?
Eindeutige und verständlich formulierte Regeln erleichtern die Arbeit von Technischen Redakteur:innen erheblich. Klingt logisch! Gibt es noch weitere Vorteile, die sich aus der Einführung eines Redaktionsleitfadens ergeben?
Unserer Erfahrung nach sind die folgenden drei Aspekte von zentraler Bedeutung:
1. Qualität der Dokumentation steigern
Konsistenz ist ein wesentliches Qualitätsmerkmal von guter Technischer Dokumentation. Sie unterstützt die Nutzer:innen dabei, die Informationen leichter aufzunehmen, und erhöht so die Verständlichkeit der Anleitungen. Der Konsistenzbegriff beschränkt sich aber nicht allein auf sprachliche Vorgaben zu Formulierungen und Terminologie.
Auch bei der Strukturierung und Gestaltung der Informationen sowie bei den übergeordneten Abläufen im Redaktionsprozess lautet das Motto: Klare Vorgaben und ein einheitliches Vorgehen sind das A und O. Mit einem Redaktionsleitfaden wird somit eine wichtige Voraussetzung dafür geschaffen, die redaktionelle Arbeit zu professionalisieren und ein gleichbleibend hohes Qualitätsniveau der Dokumentation zu erreichen.
2. Kosten sparen
Die Einführung eines Redaktionsleitfadens ist auch aus betriebswirtschaftlicher Sicht mehr als sinnvoll. Der wesentliche Vorteil: In einer Redaktion, die nach präzise festgelegten Vorgaben arbeitet, können durch Unklarheiten und Rückfragen hervorgerufene Abstimmungsaufwände deutlich reduziert werden. Das steigert die Durchlaufeffizienz und sorgt für eine höhere Produktivität der Redaktionsabteilung insgesamt.
Hinzu kommt: Erst mit einem Redaktionsleitfaden kann das erforderliche Maß an Standardisierung erreicht werden, das notwendig ist, um einmal erstellten Content systematisch wiederzuverwenden. Diese Wiederverwendung zahlt sich aus – sowohl beim Erstellungsprozess als auch beim späteren Übersetzen der Inhalte.
3. Zusammenarbeit verbessern
Unklarheiten im Ablauf, nicht definierte Verantwortlichkeiten oder veraltete Dokumentvorlagen: Solche Negativfaktoren können die Zusammenarbeit in der Redaktion und die Motivation der Mitarbeitenden massiv beeinträchtigen. Ein Redaktionsleitfaden hilft dabei, das Redaktionswissen transparent zu machen und allen Kolleg:innen zur Verfügung zu stellen. So wird eine einheitliche Wissensbasis im Team geschaffen und sprachliche Zweifelsfälle und andere strittige Fragen lassen sich leicht auflösen.
Auch die Einarbeitung neuer Mitarbeiter:innen gelingt mit klaren Regelungen deutlich besser. Das ist gerade in großen Redaktionen hilfreich, die über mehrere Standorte verteilt sind oder beispielsweise von Redakteur:innen eines externen Dienstleisters zusätzlich unterstützt werden.
Was wird in einem Redaktionsleitfaden festgelegt?
Ein guter Redaktionsleitfaden regelt und vereinheitlicht die wesentlichen Aspekte bei der Erstellung von Technischer Dokumentation. Das gilt für sämtliche Ebenen des Prozesses, also von den grundlegenden Abläufen auf einer übergeordneten Prozessebene – sprich wer macht was – bis hin zu konkreten Formulierungsregeln auf der sprachlichen Ebene. Was genau alles in einem Redaktionsleitfaden festgelegt wird, ist logischerweise individuell ausgeprägt und von Redaktion zu Redaktion unterschiedlich.
Grundsätzlich lassen sich die Inhalte eines Leitfadens aber in die folgenden vier Themenbereiche untergliedern:
Prozesse und Abläufe
Eine Anleitung durchläuft von der Planung bis hin zur Publikation verschiedene Schritte. In den einzelnen Projektphasen sind zusätzlich zur Redaktion unterschiedlichste Prozesspartner mit ganz individuellen Aufgaben involviert wie zum Beispiel Konstruktion, Entwicklung, Qualitätsmanagement, Lektorat und Übersetzung. Damit alle Zahnrädchen korrekt ineinandergreifen, müssen die grundsätzlichen Abläufe klar definiert und allen Verantwortlichen bekannt sein.
In einem ersten Schritt gilt es daher, die zentralen Fragen rund um das Projektmanagement zu klären. Das können z. B. sein:
Wer übernimmt im Rahmen der Prozesse welche Aufgaben? Wer sind die jeweiligen Ansprechpersonen? Wie ist der zeitliche Ablauf eines Dokumentationsprojekts definiert? Wer muss zu welchem Zeitpunkt welche Informationen liefern? Welche Tools kommen zum Einsatz und wie werden Informationen zwischen den Abteilungen ausgetauscht? Wie sind die Verantwortlichkeiten im Vertretungsfall geregelt, z. B. bei Krankheit oder Urlaub?
Aufbau und Struktur
Ob Montageanleitung, Softwarehandbuch oder das Topic in einer Online-Hilfe: Für jedes Informationsprodukt sollte der Inhalt nach einheitlichen Regeln strukturiert sein. Wie weit diese Strukturvorgaben gehen, hängt natürlich von den Rahmenbedingungen der jeweiligen Redaktion ab. Ein etabliertes Vorgehen besteht darin, häufig verwendete Content-Bausteine wie z. B. Sicherheitshinweise oder Handlungssequenzen in ihrem grundsätzlichen Aufbau zu definieren.
Wenn in der Redaktion ein klassisches Textverarbeitungstool zum Einsatz kommt, existieren meist schon Mustervorlagen für einzelne Dokumenttypen oder Content-Bausteine. Diese Vorlagen sollten an zentraler Stelle abgelegt sein und der Ablageort sollte mit in den Redaktionsleitfaden aufgenommen werden.
Wird dagegen mit einem XML-basierten Redaktionssystem gearbeitet, können im Leitfaden beispielsweise die Referenzen auf zulässige oder bevorzugte Elementtypen aufgeführt werden. Existiert in der Redaktion zudem ein festes Konzept für die einheitliche Modularisierung des Contents, ist es sinnvoll, dieses ebenfalls in den Leitfaden zu integrieren.
Schreibstil und Formulierungen
Regeln zum einheitlichen Schreiben bilden einen wichtigen Teil jedes Redaktionsleitfadens und sichern die Konsistenz der Dokumentation auf Textebene. Dazu gehört unter anderem der richtige Umgang mit Abkürzungen und Fachbenennungen im Rahmen des Terminologiemanagements. Hier ist wichtig: Die eigentliche Terminologieliste wird nicht mit in den Redaktionsleitfaden aufgenommen, sondern in einem externen, dynamischen Dokument verwaltet. In den Leitfaden gehören aber der Verweis auf diese Liste und alle weiteren Informationen zum Terminologiemanagement.
Ein weiterer zentraler Aspekt sind die Regeln zu Stil und Formulierung. Häufig werden diese Schreibregeln in Form von konkreten Handlungsanweisungen dargestellt, wie folgendes Beispiel zeigt:
Substantivierungen vermeiden
Substantivierungen müssen von den Leser:innen (unterbewusst) in Verben übersetzt werden und wirken dadurch ermüdend.
Layout und Grafik
Welche Vorgaben gibt es rund um die Themen Visualisierung und Gestaltung? Auch hier hängt viel davon ab, mit welchem Tool die Redaktion arbeitet. Im datenbankgestützten Redaktionssystem wird den Redakteur:innen in gestalterischer Hinsicht die meiste Arbeit bereits durch das System abgenommen. Hier kann es sinnvoll sein, die für bestimmte Dokumentarten erforderlichen Stylesheets genauer zu erklären.
Bei der klassischen Textverarbeitung kann man auf Vorlagen und Muster verweisen oder gleich konkrete Angaben zu Typographie, Satzspiegel und weiteren Layouteinstellungen machen. Für die Erstellung von einheitlichen Grafiken ist es zudem essenziell, ein Illustrationskonzept zu definieren. Dies umfasst z. B. Aspekte wie Grafikstil, Farbschema, zulässige Perspektiven sowie definierte Assets von Piktogrammen, Symbolen und Icons. Das schafft eine konsistente Bildsprache und erleichtert den Erstellungsprozess erheblich.
Unter Umständen müssen auch weitere Vorgaben aus dem Marketing – etwa zum Corporate Design – beachtet werden. Diese sind oftmals in einem eigenen Style Guide festgehalten, auf den im Redaktionsleitfaden verwiesen werden sollte.
Wann lohnt sich ein Redaktionsleitfaden?
Kurz gesagt: Ein Redaktionsleitfaden kann zu jeder Zeit und für all diejenigen sinnvoll sein, die mit der Erstellung von Technischer Dokumentation zu tun haben. Das gilt für die große Redaktionsabteilung mit 10 Mitarbeiter:innen und zusätzlichem Dienstleistersupport genauso wie für das kleine Zwei-Personen-Team, das sämtliche Anleitungen in Eigenregie erstellt. Allgemein lässt sich festhalten: Wer die zentralen Regelungen und Vorgaben für den Dokumentationsprozess verständlich und präzise aufbereitet, reduziert Aufwände und schafft Sicherheit – und beugt Situationen vor, in denen z. B. ein zentraler Wissensträger kurzfristig ausfällt und wertvolles Expertenwissen nicht mehr zur Verfügung steht.
Unsere Erfahrung hat zudem zeigt, dass die Einführung eines Redaktionsleitfadens gerade in bestimmten Situationen sinnvoll sein kann:
- Wenn im Unternehmen eine Umorganisation stattfindet, die direkte Auswirkungen auf die Arbeit der Technischen Redaktion hat (z. B. durch die Einführung einer agilen Arbeitsweise in der Entwicklung).
- Wenn von der klassischen Dokumentationserstellung im Textverarbeitungsprogramm auf eine modulare Arbeitsweise gewechselt wird (durch die Einführung eines Redaktionssystems).
Gibt es auch Nachteile?
Wo Licht ist, ist natürlich auch (etwas) Schatten. Wie bei allen Maßnahmen zur Prozessoptimierung muss auch beim Redaktionsleitfaden mit einem initialen Aufwand gerechnet werden, bis sich alles eingespielt hat und die neuen Regelungen greifen.
Bevor mit der eigentlichen Erstellung des Redaktionsleitfadens begonnen werden kann, sollten in einer Konzeptphase unter anderem folgende Schritte durchgeführt werden.
- Prozesse und Qualität der Dokumentation analysieren.
- Regulierungs-, Überarbeitungs- und Optimierungsbedarf ermitteln.
- Redaktionsleitfaden-Beauftragten bestimmen und Redaktionsleitfaden-Team bilden.
- Zeitbedarf ermitteln.
- Gegebenenfalls externe Beratung hinzuziehen.
Mit der richtigen Vorbereitung ist aber auch dieser Initialaufwand überschaubar und sollte kein Argument gegen die Einführung eines Redaktionsleitfadens sein.
Dazu kommt: Im ersten Anlauf müssen nicht sofort alle Aspekte des Prozesses zu 100 % abgedeckt und gleich in ein finales Regelwerk gegossen werden. Auch nach der Einführungsphase ist das Projekt "Redaktionsleitfaden" nicht abgeschlossen, sondern lebt und wächst gemeinsam mit dem Prozess.
Wie sollte der Redaktionsleitfaden publiziert und bereitgestellt werden?
Die klassische PDF
Feste Regeln für die Publikation und Bereitstellung eines Redaktionsleitfadens gibt es nicht.
Viele Redaktionen schreiben ihren Leitfaden als lineares Dokument z. B. in Word und veröffentlichen ihn dann als PDF im Intranet – eine durchaus praktische und erprobte Methode.
Das moderne Wissensportal
Unternehmen, die über eine zentrale Wissensplattform z. B. in Form eines Enterprise-Wikis verfügen, können den Redaktionsleitfaden auch darüber verwalten und bereitstellen. Dieses Vorgehen kann einige Vorteile gegenüber der klassischen PDF-Variante bieten:
- Intelligente Suchfunktion, die Treffer nach Relevanz sortiert und das auch, wenn die User:innen den passenden Fachterminus nicht kennen und nach einem Synonym suchen
- Vielfältige Strukturierungs- und Gestaltungsmöglichkeiten für den Content, die einen besseren Informationszugriff ermöglichen als das statische PDF-Dokument
- Umfangreiche Kommentar- und Feedbackfunktionen, die das gemeinsame Arbeiten am Leitfaden vereinfachen
Gerade mit Blick auf den letzten Punkt ist es wichtig, ein sinnvolles Rollen- und Rechtesystem im Wissensportal zu implementieren. Das schützt vor zu häufigen Änderungen am Redaktionsleitfaden durch fachfremde Personen.
Das Redaktionssystem
Wenn mit einem Redaktionssystem gearbeitet wird, kann der Leitfaden natürlich auch direkt im System erstellt und verwaltet werden. Das hat unter anderem den Vorteil, dass die Multiformat-Ausgabeoptionen des Systems auf Knopfdruck genutzt werden können und der Leitfaden so schnell und einfach in unterschiedlichen Formaten ausgespielt werden kann. Je nach Systemausstattung können einige der Sprachregeln zudem direkt über die Autorenunterstützung abgebildet werden. So lassen sich z. B. Aspekte wie Terminologie oder Satzbau direkt beim Schreiben kontrollieren.
Grundsätzlich lässt sich festhalten: Neben der inhaltlichen Qualität ist es essenziell, dass der Redaktionsleitfaden möglichst aktuell gehalten wird und für alle relevanten Personen leicht zugänglich ist. Ein schwer auffindbarer und dazu noch veralteter Leitfaden wird wenig bis keinerlei Verbesserungen mit sich bringen und auf wenig Gegenliebe bei den Kolleg:innen stoßen.
Unser Fazit: Ein zentrales Regelwerk für die Dokumentation lohnt sich.
Effiziente Prozesse, eine höhere Konsistenz und bessere Arbeitsergebnisse: Die Vorteile eines Redaktionsleitfadens liegen auf der Hand. Damit all das gelingt, braucht es ein systematisches Vorgehen und das richtige Know-how. Im stressigen Redaktionsalltag stehen die dafür notwendigen personellen und fachlichen Ressourcen nicht immer auf Abruf zur Verfügung. In so einer Situation kann sich die gezielte Unterstützung durch einen externen Fachdienstleister lohnen.
