Redaktionsleitfaden, Styleguide oder Redaktionshandbuch in der Technischen Redaktion

Veröffentlicht: 06.08.2021 Aktualisiert: 24.03.2023

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. Sehen wir uns einmal an, was Redaktionsleitfäden in der Technischen Redaktion leisten und wie man sie am besten erstellt und pflegt.

Redaktionsleitfaden, Styleguide oder Redaktionshandbuch in der Technischen Redaktion

Inhalt

Wie schon gesagt, bei Redaktionsleitfäden geht es darum, was wir wie schreiben. Das heißt: Ein guter Redaktionsleitfaden enthält nicht nur Informationen darüber, wie Dokumente formuliert und gestaltet sein sollen, also zur Dokumentqualität. Er braucht auch Informationen dazu, auf welchem Weg gute Dokumente entstehen sollen, also zum Redaktionsprozess.

Jenseits dieser Basiskategorien – Dokumentqualität und Redaktionsprozess – ist allerdings vieles individuell zu regeln. Denn entscheidend sind für die Inhalte eines Redaktionsleitfadens die Qualitätsziele ebenso sehr wie die Zielgruppe des Leitfadens. Wenn die Nutzer und Nutzerinnen Ihres Leitfadens nur gelegentlich schreiben, dann ist eine Regel wie z. B. „Funktionsverbgefüge vermeiden“ sinnlos, denn vermutlich wird ihr Adressatenkreis gar nicht wissen, was ein Funktionsverbgefüge ist.

Tatsächlich kann ein Leitfaden sogar gar keine Regeln enthalten, wenn zum Beispiel die Zielgruppe das als Bevormundung empfindet. Dann kann ein Leitfaden auch die Form einer Arbeitshilfe, von Best Practices oder Formulierungsempfehlungen annehmen. Als Faustregel gilt deshalb: Je schreibprofessioneller die Zielgruppe eines Redaktionsleitfadens ist, desto verbindlicher und fachsprachlicher können die Regeln formuliert werden. Wichtig ist aber immer, dies auch wirklich mit der Zielgruppe zu vertesten. Manchmal setzt man zum Beispiel bei seinen Kollegen und Kolleginnen Grammatikkenntnisse voraus, die sie in der Realität überfordern.

Form

Auch für die Form, die der Redaktionsleitfaden annehmen soll, gibt es keine feste Regel. Viele Redaktionen schreiben ihren Leitfaden als fortlaufendes, lineares Dokument und veröffentlichen ihn im Intranet als pdf-Datei. Das kann durchaus eine praktische, aufwandsarme Lösung sein. Arbeitet man mit einem CMS, bietet es sich allerdings an, den Redaktionsleitfaden auch gleich dort vorzuhalten und die Multiformat-Ausgabeoptionen des CMS zu nutzen.

Einzelne Regeln lassen sich im CMS auch besser über die Autorenunterstützung vorhalten und gleich während des Schreibens prüfen, als sie in einem Dokument nur zu formulieren. Ü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.

Nutzen

Kommen wir zu guter Letzt zum Nutzen des Ganzen. Klar: 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 man also die Ressourcen zur Verfügung bekommen möchte, um einen Redaktionsleitfaden zu erstellen, muss man das Argument Qualität ein wenig aufdröseln. Wozu soll die Qualität denn dienen? Soll sie den Text verständlicher machen und dadurch Rückfragen im Support senken? Soll sie die Texte kürzer und präziser machen und 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 für neue Team-Mitglieder. Im Idealfall wird der Redaktionsleitfaden so zum Rundum-Sorglos-Paket.

Die Doku-Lounge von Quanos ist DER Podcast rund um die Technische Redaktion. Kerstin Berke lädt regelmäßig Gäste ein zur gemütlichen Diskussion. Klicken Sie hier, um zum Podcast zu gelangen.

 

Andere Artikel von Quanos

Das könnte Sie auch interessieren

Neufassung der EU-Bauproduktenverordnung - So meisten Sie die zukünftigen Herausforderungen

Die Neufassung der Bauproduktenverordnung (EU-BauPVO) sorgt derzeit für einige Verunsicherung bei Herstellern. Denn i…

White Paper: 12 Fragen, mit denen Sie das passende Redaktionssystem finden

Sie planen die Einführung einer Software für Technische Dokumentation? Mit unserem neuesten White Paper unterstützen …

Docs-as-Code – Redaktionsverfahren aus der Softwarebranche

Seit einigen Jahren fällt in der Softwaredokumentation immer wieder das Stichwort Docs-as-Code. Vor allem in agilen S…