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.
Include examples in your style guide
Linguistic rules are often abstract and difficult to understand for a layperson, so every guide should contain meaningful examples. These should make it clear in each specific case where the problem lies with certain wording and why the alternatives are better.
Examples should always come from the everyday work of your writing department, ideally from your company. By the way, if you really don’t want to think of an example for one of the rules, or if you can’t find one in your manuals, the rule probably isn’t very relevant.
Where you can publish your style guide
There are no fixed rules governing the form that the style guide should take. Many companies write their guides as self-contained, linear documents that they release on the intranet as PDF files, which can be a practical and simple solution. If you have a content management system like SCHEMA ST4, another option is to maintain the style guide as part of the system and to make use of the multiformat output options of the CMS.
You can also use the authoring assistant to store individual rules in the CMS. This means that the text is checked as it is being written. The most important thing to remember is that any rule that can be automatically checked as you’re writing (terminology, syntax, etc.) belongs directly within the system and not in the style guide.
Appoint someone responsible for maintaining the style guide
When you create a style guide, it’s usually clear which working group will take on the job. But it often isn’t clear who takes care of the style guide once it’s released. However, this aspect is extremely important, because a guideline isn’t a static document. It has to address new topics, modify existing ones, and take on board its readers’ feedback.
That’s why every guide needs a responsible person with enough time to maintain it. It’s also important that it’s clear in the style guide who maintains it and, when this person changes, this should be noted in the guide.
Practical Guide: How to Create a User-Friendly Operating Manual
How can you create a user-friendly operating manual that meets more than just legal requirements? A document that provides customers and technicians with valuable information about your product in every situation, presented in an understandable and visually appealing way? We answer these questions in this practical guide.