Redaktionsleitfaden - Was gehört dazu?

(D.O.G.news 04/2007)

Einige haben ihn schon. Einige wollen ihn haben. Viele fragen sich, wo der Nutzen liegt und wie hoch der Aufwand ist. Einen Redaktionsleitfaden zu erstellen ist zuerst einmal viel Arbeit. Nach vielen Besprechungen und Arbeitsstunden entsteht ein Dokument von 10 bis zu über 400 Seiten. Es regelt die Arbeit der technischen Redakteure. Je nach Umfang, Inhalt und Gestaltung liegt der Aufwand bei wenigen Wochen (selten) bis zu mehreren Mann-Monaten. Die Frage nach dem Nutzen ist also berechtigt. Man braucht einen Redaktionsleitfaden, wenn viele Leute am Redaktionsprozess beteiligt sind, wenn eine Umorganisation stattfindet, wenn es eine große Vielfalt von Dokumentenvarianten und -formaten gibt und wenn neue Systeme oder Technologien eingeführt werden. Besonders in Zusammenhang mit dem Wechsel von althergebrachten Redaktionsprozessen zu einer modularen Arbeitsweise ist es notwendig, die wichtigsten Vorgaben für die Arbeit der Redakteure festzuschreiben, damit alle Dokumentationen einheitlich sind. Manche beschränken den Redaktionsleitfaden auf formale Aspekte wie Formatierungen und Corporate Identity. Diese sind sicherlich wichtig, machen aber nur einen Teil der benötigten Inhalte aus. Folgende Punkte gehören zum Inhalt eines Redaktionsleitfadens:

1. Vorspann: Kurze Beschreibung der Aufgabe der Technischen Redaktion im Unternehmen und des Zwecks des Handbuchs.

2. Organisation und Prozesse: Erstellung eines kommentierten Organigramms, aus dem ersichtlich wird, welche Abteilungen Dokumentationen produzieren und zu welchen Zuständigkeitsbereichen sie in der Unternehmensorganisation gehören. Den Bezug der Technischen Redaktion zu Abteilungen wie Entwicklung oder Normen sollte man dabei deutlich darstellen. Es folgt dann für jede Publikationsart eine detaillierte Darstellung der Prozesse mit Informationen wie: Welches sind die einzelnen Schritte bis zur Fertigstellung einer Dokumentation? Wer (Person/Rolle oder Abteilung) ist für welche Aufgabe zuständig? Was wird von einer Stelle an die nächste weitergegeben (z. B. PDF-Dateien für das Korrekturlesen im Ausland)? Mit welchen Werkzeugen arbeitet man? Wie laufen Qualitätssicherung und Archivierung ab?

3. Aufbau der Dokumentation: Hier stehen Vorgaben für ein oder mehrere standardisierte Inhaltsverzeichnisse. Möglicherweise braucht man mehrere Varianten, weil die einzelnen Produkte des Unternehmens zu unterschiedliche Merkmale oder Funktionen haben.

4. Strukturierung der Inhalte: Redakteure arbeiten effizienter und produzieren eine höhere Qualität, wenn sie die Inhalte technischer Dokumentationen in standardisierter Form als vorgegebene Sequenz von Informationen oder Anweisungen darstellen. Diese Sequenzen können beispielsweise eine typische Handlungsanweisung bilden (Zweck - Voraussetzung - Warnhinweis - Handlungsschritte - Ergebnis). Der Redaktionsleitfaden beschreibt die im Unternehmen typischen standardisierten Inhaltselemente.

5. Schreibanweisungen, Terminologie und Layout: Formulierungsstil für Anweisungen, Beschreibungen und Erläuterungen werden hier behandelt. Wie lang dürfen die Sätze sein, wie viele Sätze dürfen im Absatz vorkommen? Aktivstil, Passivstil? „Sie“-Anrede oder Infinitiv bei Anweisungen usw.? Ein wichtiger Punkt ist dabei die Fachterminologie. Gibt es erlaubte / nicht erlaubte Benennungen? Gibt es Vorgaben für die Schreibweise langer Komposita, für Produktnamen, für häufig verwendete Wörter wie „E-Mail/Email/ Email/email“? Hilfreich sind Anweisungen für die Erstellung der Terminologie. Im Anhang kann man Layoutvorlagen mit einer Beschreibung der Typographie und des Satzspiegels hinzufügen.

6. Programme und Werkzeuge: Wenn man bestimmte Softwareprodukte (Desktop-Publishing-System, Redaktionssystem, Übersetzungssystem, Grafikprogramm...) einsetzt, finden sich hier die speziellen Anweisungen für die Arbeit mit diesen Programmen. Besonders wenn mehrere Anwender mit gemeinsamen Daten arbeiten, ist es wichtig, dass alle die gleiche Version und die gleichen Einstellungen verwenden.

7. Qualitätsstandards und Qualitätskontrolle: Der Praktiker weiß, dass sich Qualität von Anfang an auszahlt. Hier beschreibt der Leitfaden, was die Qualitätsziele und -standards sind. Bestimmte Qualitäts-Messwerte sind definiert und auch Normen aufgeführt, welche die Redakteure bei ihrer Arbeit einhalten müssen (z. B. DIN EN 62079). Welche Prüfschritte sind vorgesehen, und wer ist dafür zuständig?

8. Anhang: Im Anhang stehen dann alle nützlichen Informationen zum Nachschlagen wie Kontaktadresse, Glossar, Definitionen, Vorlagen, Checklisten. Wenn schon so viel Arbeit in einen Redaktionsleitfaden einfließt, dann muss man sich Gedanken darüber machen, wie man erreichen kann, dass wirklich regelmäßig damit gearbeitet wird. Sonst verstaubt das schöne Werk im Regal und die ganze Anstrengung war umsonst. Die Voraussetzung ist also, dass der Redaktionsleitfaden die Informationen enthält, die Redakteure für ihre Arbeit benötigen. Und dass sie diese Informationen auch leicht finden. Das kann man zum einen über eine Fülle nützlicher Hilfsmittel für die tägliche Arbeit erreichen, wie Checklisten, Kontaktdaten von Ansprechpartnern, Tabellen mit bestimmten Werten, Inhaltsverzeichnisvorlagen, und zum anderen über eine ergonomische Aufbereitung der Informationen: Themen-/zielgruppenbezogene Farben, Symbole, Registersystem, Marginalien.

Ein gelungener Redaktionsleitfaden bringt dem Unternehmen einen großen Nutzen. Er sorgt auch dafür, dass die vielen Individuallösungen, die in der Praxis oft für Qualitätsprobleme und mehr Arbeit sorgen, verschwinden. Alle arbeiten nach einem einheitlichen Muster, die Daten/Dokumente lassen sich besser austauschen und bearbeiten. Die Qualität steigt, was die Zeit für Korrekturen, Überarbeitungen etc. senkt.

Als Nebeneffekt kann man die Arbeit für den Redaktionsleitfaden auch für eine ISO-Zertifizierung verwenden. Die Prozesse und Qualitätsstandards sind dargestellt, und man kann sie übernehmen. Einen Redaktionsleitfaden zu schreiben ist Teamarbeit. Redakteure verwenden den Leitfaden auch nur dann wirklich, wenn sie das Gefühl haben, dass er ihre tägliche Praxis ausreichend berücksichtigt. Die Erstellung erfolgt durch eine Arbeitsgruppe und über die Betreuung einzelner Themen durch einen Verantwortlichen.

Diese Person soll dann hauptverantwortlich die Arbeit des Teams koordinieren und die Einhaltung der Zwischentermine überwachen. Diese Arbeit ist letztendlich nur dann möglich, wenn die Unternehmensführung das Vorhaben unterstützt und die Ressourcen (Zeitbudget und ggf. finanzielle Mittel) bereitstellt. Bei knappen Ressourcen kann es sich lohnen, einen erfahrenen externen Dienstleister als Moderator und Autor des Redaktionsleitfadens heranzuziehen.

Aktuelles

Kurz-Check Ihrer Dokumentation

Schicken Sie uns eine Bedienungsanleitung. Sie erhalten eine Kurzanalyse mit einer Auflistung der festgelegten Mängel und des Optimierungspotenzials für einen Pauschalpreis von 150,- € (zzgl. MwSt.).

Fachinformation

Abkürzen, aber richtig

Ohne sie kommt die technische Dokumentation oder die Software nicht aus. Abkürzungen sind aus dem Alltagsleben eines Redakteurs kaum wegzudenken und sorgen dennoch für viel Gesprächsstoff.

mehr

Terminologie:
Auch eine Sache von oben

Wer "im Feld" als Redakteur, Übersetzer, Marketingspezialist oder Entwickler arbeitet, den braucht man nicht zu überzeugen. Die Notwendigkeit einer gut strukturierten Firmenterminologie ist eine Selbstverständlichkeit ...

mehr