Redaktionsleitfaden, Styleguide oder Redaktionshandbuch in der Technischen Redaktion
Redaktionshandbuch, Styleguide, Schreibleitfaden: In fast jeder Technischen Redaktion gibt es ein oder mehrere Dokumente, die regeln, wie was geschrieben wird. Die Bezeichnungen sind vielfältig, aber die Anforderungen an das Dokument ähneln sich. Wir erklären, was Redaktionsleitfäden in der Technischen Redaktion leisten und wie Sie sie am besten erstellen und pflegen.
Für mehr Konsistenz in der Technischen Dokumentation und ein Lektorat, bei dem sich die Reviewer auf die wesentlichen Punkte konzentrieren können, empfiehlt sich ein Redaktionsleitfaden. Zwar benötigt die Erstellung und anschließende Pflege etwas Zeit, aber der Aufwand lohnt sich. In diesem Blogbeitrag erfahren Sie, auf was Sie bei der Ausarbeitung eines Redaktionshandbuchs achten sollten.
Definieren Sie, welches Problem Ihr Redaktionsleitfaden lösen sollte
Vielleicht überrascht Sie das, aber sehr viele Redaktionsleitfäden entstehen, ohne dass vorher klar ist, wozu der Styleguide dienen soll: „Lass uns mal alle unsere Sprachregeln aufschreiben.“ Oder: „Wir suchen uns aus dem tekom-Leitfaden alle Regeln heraus, die wir brauchen.“ Wer so vorgeht, erstellt eine Regelsammlung. Diese hat ungefähr die gleiche Attraktivität wie die Hausordnung eines Mehrfamilienhauses. Keine gute Basis für eine erfolgreiche Einführung.
Fragen Sie sich stattdessen, welches Problem Ihr Redaktionsleitfaden lösen soll.
- Soll die Zusammenarbeit mit den fachlichen Inputgebern verbessert werden?
- Wollen Sie die verschiedenen Herangehensweisen in Ihrer Redaktion vereinheitlichen?
- Gibt es Stilfehler in Ihren Anleitungen?
- Oder soll das Redaktionshandbuch eine Checkliste für die Qualitätssicherung werden?
Je nach Ziel wirkt sich dies auf die Inhalte, die Gestaltung und die mediale Umsetzung Ihres Redaktionsleitfadens aus.
Wie Sie Vorgesetzte von der Notwendigkeit eines Redaktionsleitfadens überzeugen
Redaktionsleitfäden sorgen für eine einheitliche Qualität, soweit sind sich vermutlich alle einig. Allerdings überzeugt die Managementebene das Argument Qualität oft nicht. Wenn Sie die Ressourcen erhalten möchte, einen Redaktionsleitfaden zu erstellen, sollten Sie das Argument Qualität ein wenig aufdröseln: Wozu soll die Qualität dienen?
- Sollen die Texte verständlicher werden und dadurch Rückfragen im Support sinken?
- Sollen die Texte kürzer und präziser werden und sich dadurch die Fehlerbehebung bei den Kolleginnen und Kollegen im Service beschleunigen?
Zeigen Sie auf, was eine verbesserte Qualität bewirkt, damit der Nutzen auch den Entscheiderinnen und Entscheidern klar wird.
Und nicht vergessen: Neben der Qualität für die Dokumente hat ein guter Redaktionsleitfaden auch Vorteile auf der Prozessebene. Er strafft die Dokumenterstellung, sorgt dafür, dass Arbeiten Hand in Hand gehen und dass alle Prozessbeteiligten wissen, welche Rolle bzw. welche Mitarbeitenden was wann wie erledigen. Er dient damit auch der Wissensorganisation und erleichtert die Einarbeitung neuer Teammitglieder. Im Idealfall wird der Redaktionsleitfaden so zum Rundum-sorglos-Paket.
Welche Inhalte ein Redaktionsleitfaden aufweisen sollte
In Redaktionsleitfäden wird definiert, was wir wie schreiben. Er enthält nicht nur Informationen darüber, wie Texte formuliert und gestaltet sein sollen, also zur Dokumentqualität. Er beschreibt auch, auf welchem Weg gute Dokumente entstehen, also den Redaktionsprozess. Dazu gehören etwa die Fragen:
- Wie viel Zeit ist für die fachliche QS gegeben?
- Welche Konventionen gibt es bei der Benennung von Dateien?
- Wie soll eine Korrektur vorgenommen werden?
- In welchen Formaten sollen die Rohtexte angeliefert werden?
Jenseits dieser Basiskategorien – Dokumentqualität und Redaktionsprozess – sind die Inhalte individuell. Entscheidend sind die Qualitätsziele und die Zielgruppe. Wenn die Nutzer und Nutzerinnen Ihres Leitfadens nur gelegentlich schreiben, ist eine Regel wie „Funktionsverbgefüge vermeiden“ sinnlos, denn vermutlich wird Ihr Adressatenkreis nicht wissen, was dies ist.
Ein Leitfaden kann sogar ohne Regeln auskommen, wenn die Zielgruppe dies als Bevormundung empfinden würde. In diesem Fall kann ein Leitfaden die Form einer Arbeitshilfe, von Best Practices oder Formulierungsempfehlungen annehmen.
Inhalte an der Zielgruppe ausrichten
Je nach Zielgruppe müssen Sie Ihre Sprachregeln anders gestalten, wenn Sie einen Redaktionsleitfaden erstellen. Was in Ihrer Technischen Redaktion leicht verständlich ist, kann eventuell die Kollegen in der Entwicklung überfordern. Vielleicht müssen Sie dann mit Daumenregeln arbeiten oder aber ein wenig redaktionelle Qualifizierung in Ihrem Redaktionsleitfaden leisten, damit die Inhalte auch ankommen. Auch die emotionalen Aspekte eines Redaktionshandbuchs sollten Sie nicht unterschätzen. Wer kein Textprofi ist, betrachtet es manchmal als persönlichen Angriff, wenn er oder sie Vorschriften zum Schreibstil bekommt. Hier gilt es ebenfalls mit Feingefühl auf die Zielgruppe einzugehen.
Als Faustregel gilt: Je professioneller die Zielgruppe des Redaktionsleitfadens im Schreiben ist, desto verbindlicher und fachsprachlicher lassen sich Regeln formulieren. Wichtig ist, dies mit der Zielgruppe zu testen. Manchmal setzt man bei seinen Kollegen und Kolleginnen zum Beispiel Grammatikkenntnisse voraus, die sie in der Realität überfordern.
Fügen Sie Beispiele in Ihr Redaktionshandbuch ein
Sprachliche Regeln sind für Laien oft abstrakt und schwer nachvollziehbar. Deshalb sollte jeder Leitfaden aussagekräftige Beispiele enthalten. Dadurch wird am konkreten Einzelfall klar, weshalb bestimmte Formulierungen problematisch und Alternativen besser sind.
Beispiele sollten immer aus dem Alltag Ihrer Redaktion stammen, bestenfalls aus Ihrem Unternehmen. Übrigens: Wenn Ihnen partout kein Beispiel für eine der Regeln einfallen will bzw. wenn Sie keines in Ihren Anleitungen finden, ist die Regel vermutlich nicht sehr relevant.
Wo Sie Ihren Redaktionsleitfaden veröffentlichen können
Für die Form, die der Leitfaden annehmen soll, gibt es keine feste Regel. Viele Unternehmen erstellen ihren Redaktionsleitfaden als fortlaufendes, lineares Dokument und veröffentlichen ihn im Intranet als PDF-Datei. Das kann eine praktische und einfache Lösung sein. Arbeiten Sie mit einem Redaktionssystem wie SCHEMA ST4, bietet es sich an, den Redaktionsleitfaden dort vorzuhalten und die Multiformat-Ausgabeoptionen des CMS zu nutzen.
Einzelne Regeln lassen sich im Redaktionssystem auch über die Autorenunterstützung vorhalten. Das heißt, dass der Text schon beim Formulieren geprüft wird. Überhaupt gilt: Was als Regel während des Schreibprozesses automatisiert geprüft werden kann (Terminologie, Syntax etc.), gehört direkt ins System und nicht in den Redaktionsleitfaden.
Bestimmen Sie eine zuständige Person für die Pflege des Redaktionsleitfadens
Wenn Sie einen Redaktionsleitfaden erstellen, ist meist klar, welche Arbeitsgruppe diese Aufgabe übernimmt. Oft ist aber nicht geklärt, wer sich um das Redaktionshandbuch kümmert, wenn es einmal freigegeben ist. Das ist aber extrem wichtig, denn ein Leitfaden lebt: Er muss neue Themen aufnehmen, Bestehendes muss sich anpassen und das Feedback seiner Leser und Leserinnen will berücksichtigt werden.
Deshalb braucht jeder Leitfaden eine Zuständige oder einen Zuständigen mit entsprechenden Zeitbudgets für die Pflege. Ebenfalls wichtig ist, dass im Redaktionsleitfaden klar erkennbar wird, wer sich darum kümmert und dass dort nachgetragen wird, wenn sich die Zuständigkeiten ändern.
Praxis-Guide So erstellen Sie eine nutzerfreundliche Betriebsanleitung
Wie lässt sich eine nutzerfreundliche Betriebsanleitung erstellen, die nicht nur rechtlichen Anforderungen genügt? Ein Dokument, das Kunden und Technikern in jeder Situation wertvolle Inhalte zu Ihrem Produkt liefert, verständlich aufbereitet und visuell ansprechend? Dies beantworten wir in diesem Praxis-Guide.
