people text - Technische Dokumentation. Verständlich. Schnell. Professionell. Technische Dokumentation. Verständlich. Schnell. Professionell.

Redaktionsleitfaden erstellen

Ein Redaktionsleitfaden ist ein wertvolles Hilfsmittel in der Technischen Dokumentation. Er erleichtert die Arbeit der Technischen Redakteure und trägt wesentlich zur Qualität der Dokumente bei. Dabei ist es egal, ob der Redaktionsleitfaden gedruckt am Platz liegt, oder die Regeln in ein Redaktionssystem integriert sind: Ein Redaktionsleitfaden unterstützt dabei, Richtlinien einzuhalten und unternehmensweit konsistent zu kommunizieren.

Ziel eines Redaktionsleitfadens

Redaktionsleitfaden

Redaktionsleitfäden enthalten eine Vielzahl an Vorgaben, die für die Erstellung von Dokumenten innerhalb einer Redaktion verbindlich sind. Damit hilft er den Redakteuren, ein konsistentes Erscheinungsbild und ein gleichbleibend hohes Qualitätsniveau der Dokumentation zu gewährleisten. Zugleich vermittelt der Redaktionsleitfaden Sicherheit in Zweifelsfällen des redaktionellen Alltags: Fragen etwa zur Dokumentstruktur oder zum Layout müssen nicht mehr mühsam von Einzelfall zu Einzelfall beantwortet werden, es genügt der Blick in den Redaktionsleitfaden. Für neue Mitarbeiter oder externe Dienstleister verkürzt sich die Einarbeitungszeit erheblich, wenn sie sich schnell und zuverlässig mit sämtlichen redaktionellen Regeln vertraut machen können.

Inkonsistente Dokumente vermeiden

In großen Redaktionen, die zudem noch über mehrere Standorte verteilt sind, ebenso wie in sehr kleine Redaktionen, macht ein Redaktionsleitfaden die Erstellung konsistenter Dokumente überhaupt erst möglich. Andernfalls würde sehr schnell ein Durcheinander von heterogenen Konventionen und inkonsistenten Dokumenten entstehen.

Mit einem Redaktionsleitfaden die Arbeitsergebnisse signifikant verbessern

Je nachdem, wie klar strukturiert die redaktionellen Regeln und Konventionen innerhalb einer Redaktion bereits sind, kann ein Redaktionsleitfaden eine mehr oder weniger große Umstellung bedeuten. Eine Redaktion mit vergleichsweise ungeregelten Abläufen wird im Allgemeinen länger brauchen, um sich auf eine konsistente Dokumentationserstellung umzustellen. Allerdings kann gerade sie in besonderem Maß von den Vorzügen eines Redaktionsleitfadens profitieren: Eine Standardisierung der redaktionellen Regeln und Abläufe wird die Ergebnisse ihrer Arbeit signifikant verbessern.

Ein Redaktionsleitfaden erfordert Zeitaufwand

Auch aus betriebswirtschaftlicher Sicht erscheint ein Redaktionsleitfaden sinnvoll. Zwar erfordert es einigen Zeitaufwand, den Redaktionsleitfaden zu konzipieren, zu erstellen und kontinuierlich zu pflegen. Auf der anderen Seite verbessert er nicht nur die Qualität der Technischen Dokumentation, sondern trägt auch zur Kostenersparnis bei: So können verbindliche Regeln zum Gebrauch von Termini die Kosten für Übersetzungen erheblich senken.

Inhalt eines Redaktionsleitfadens für konsistente Dokumentation

Ein Redaktionsleitfaden regelt alle wichtigen Aspekte der Erstellung von Technischer Dokumentation: von der Organisation der Prozesse bis zu den Details des Layouts. Der Redaktionsleitfaden ist das Ergebnis einer systematischen Analyse der bestehenden Aufgaben und Prozesse.

Der Inhalt eines exemplarischen Redaktionsleitfadens könnte so aussehen:

  • Prozesse
    Welche einzelnen Schritte durchläuft ein Dokument von der Planung bis zur Archivierung? Hier muss der Redaktionsleitfaden klare Richtlinien vorgeben, um die Prozesse zu standardisieren und sie damit weniger fehleranfällig zu gestalten. Dazu gehören beispielweise qualitätssichernde Maßnahmen wie interne Reviews, um die sachliche Richtigkeit der Technischen Dokumentation sicherzustellen.
    Reifegrad der Technischen Redaktion
  • Zuständigkeiten
    Wer übernimmt im Rahmen der Prozesse welche Aufgaben? Wer sind die jeweiligen Ansprechpartner?
  • Struktur
    Wie werden die Inhalte der Technischen Dokumentation strukturiert? Wenn ein XML-basiertes Redaktionssystem im Einsatz ist, dann kann auch die Elementreferenz aufgenommen werden.
    Der Aufbau sollte „top-down“ sein, d.h. vom Allgemeinen zum Besonderen und vom Bekannten zum Neuartigen überleiten. Strukturierende Elemente wie kurze Zusammenfassungen und informative Marginalien erleichtern die Navigation und tragen zum besseren Verständnis bei. Diese Informationen sind im Redaktionsleitfaden festgehalten.
    Auch die Links sollten einem Link-Konzept folgen, um Konsistenz und maximale Benutzerfreundlichkeit zu garantieren.
    Link-Konzept
  • Layout
    Welche Vorgaben gibt es für Typographie, Satzspiegel, Farbenauswahl und Grafikgestaltung? Dazu gehören Vorgaben zur Bildbearbeitung, um Grafiken hinsichtlich dpi-Zahl und Farbtiefe einheitlich zu gestalten. Macht das Corporate Design hierzu Vorschriften, die es zu berücksichtigen gilt?
  • Schreibstil
    Wie verfährt man mit Abkürzungen, die nicht ohne weiteres als bekannt vorausgesetzt werden können? Wie sind alternative Schreibweisen geregelt, beispielsweise „des Handbuches“ oder „des Handbuchs“? Die entsprechenden Regelungen sichern die sprachliche Konsistenz der Dokumentation und sind deshalb im Redaktionsleitfaden festgehalten.
    Lektorat
  • Terminologie
    Welche Benennungen sind verbindlich, welche sind nicht erlaubt? Durchdachtes Terminologie-Management trägt wesentlich zu einer verständlichen Technischen Dokumentation bei. Darüber hinaus hilft klare und konsistente Terminologie dabei, übersetzungsgerechte Texte zu schreiben. Wenn es eindeutige Benennungsvorgaben sowohl für die Quellsprache als auch für die Zielsprachen gibt, sinken die Übersetzungskosten.
    Terminologiearbeit

Warum ist ein Redaktionsleitfaden in der Praxis wichtig?

Jeder Redakteur transportiert seinen eigenen Schreibstil in die Dokumentation. Die Qualität von Technischer Dokumentation durch diese individuellen Lösungen bei der Erstellung und Bearbeitung von Dokumenten sinkt dadurch: Die Arbeitsabläufe innerhalb der Redaktion kranken an ständigen Reibungsverlusten, ein konsistentes Erscheinungsbild der Dokumentation ist nicht mehr gewährleistet, verbindliche Qualitätsstandards lassen sich nur noch schwer erfüllen. Ein Redaktionsleitfaden macht diesem Wildwuchs ein Ende. Allgemein gültige Schreibstandards und etablierte Richtlinien aus der Technischen Dokumentation, im Redaktionsleitfaden festgehalten, unterstützen dabei, die wichtigsten Schreib- und Stilregeln zu befolgen. Ein einheitlicher Tonfall und unternehmensweite Konsistenz sind das Ergebnis - die Qualität steigt, Zeitaufwand und Kosten sinken.

Damit der Redaktionsleitfaden seine Aufgabe erfüllen kann, ist es freilich notwendig, dass die dokumentierten Prozesse und Standards im Alltag auch gelebt werden. Deshalb sollte die Erstellung des Redaktionsleitfadens in ständiger enger Abstimmung mit allen Beteiligten erfolgen. Nur so ist sichergestellt, dass die tatsächlichen Anforderungen des redaktionellen Alltags hinreichend berücksichtigt werden – und dass der Redaktionsleitfaden von sämtlichen Redaktionsmitgliedern als wertvolle Bereicherung akzeptiert wird.