Überspringen zu Hauptinhalt

RA #002 Redaktionsleitfaden erstellen – diese Regeln unbedingt beachten

RA #002 Redaktionsleitfaden Erstellen – Diese Regeln Unbedingt Beachten

Wie schon letzte Woche behandelt, sollten die gesammelten Daten nach Zielgruppen unterteilt werden. Wie bereits erwähnt gehören zu den Zielgruppen unter anderem Redakteure, Entwickler, Konstrukteure, Grafiker, Übersetzer, usw.

Sammlung von Informationen für den Redaktionsleitfaden

Jede Zielgruppe sollte Ihren eigenen Leitfaden oder ein eigenes Kapitel in einem Leitfaden bekommen. Dann kann die betroffene Zielgruppe innerhalb ihres Abschnittes schnell die benötigten Informationen finden. Ebenso erhält die Zielgruppe auch nur die Informationen, die für die jeweilige Zielgruppe bestimmt ist. Zudem hat dies auch den Vorteil, dass der zielgruppenorientierte Leitfaden kürzer ist als die „allumfassende“ Version und nicht gleich eine abschreckende Wirkung hat in Bezug auf den Umfang des zu lesenden Materials.

Es gibt Dinge, die sind auch für alle Zielgruppen interessant. Diese Informationen können Sie in einem allgemeine Kapitel oder als Zielgruppe „Alle“ behandeln.

Es sollte aber nicht alles in einem Redaktionsleitfaden stehen. Da ein großer Benutzerkreis diesen zur Verfügung steht, sollten keine vertraulichen Informationen oder Betriebsgeheimnisse im Redaktionsleitfaden stehen.

Welche Informationen für wen?

Beginnen wir doch mit den Informationen, die jedermann zugänglich sein sollten. Eine kurze Beschreibung des Unternehmens mit den verfügbaren Produkten und Auflistung aller Informationsprodukte wie Anleitungen kann allen zugänglich sein. Genauso eine Übersicht der Dokumentationsabteilung mit Ansprechpartnern, Zuständigkeiten und Telefonnummern.

Weiterhin sollte der Geltungsbereich des Leitfadens im Allgemeinen Bereich beschrieben sein, der aussagt welcher Abschnitt für welche Zielgruppe gedacht ist.

Auch Regelungen, die das gesamte Unternehmen betreffen wie Vorgaben zu der Zusammenarbeit mit Lieferanten, Corporate Identity-Richtlinien, Layout- und Stilvorgaben zu Verträgen, usw. sind in solch einem allgemeinen Teil von Nutzen.

Nach diesem Kapitel 1 welches für alle Benutzer gedacht ist, sind die weiteren Kapitel nach Zielgruppen aufgebaut. In diesen Abschnitten gibt es bestimmte Vorgaben, die an die jeweilige Zielgruppe angepasst sind.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Zielgruppe Redakteure

Der Technische Redakteur benötigt Informationen zur Regelungen, die die gesamte Dokumentationsabteilung betreffen. Dazu zählen unter anderem Konventionen zu Schreibweisen oder Schreibstile, Regelungen zur Dokumentationsfreigabe und dem Übersetzungsablauf.

Auch Feinheiten in Bezug auf einzelne Anleitungsarten bzw. Informationenarten hinsichtlich Format, Struktur und Aufbau sind der Gruppe des Technischen Redakteurs zugeordnet.

Auch wer in anderen Abteilungen als Ansprechpartner für die Dokumentation zuständig ist wie beispielsweise leitende Konstrukteure bzw. Entwickler sind hier hilfreich.

Zielgruppe Konstrukteure

Da wir schon bei den Konstrukteuren sind, diese benötigen auch eigene Informationen. Beispielsweise Projektpläne und Richtlinien für Terminplanung von neuen Produkten und die dazugehörige Dokumentation. Oder wie man den Bedarf für eine neue Dokumentation an welche Stelle meldet. Da helfen Verfahrensanweisungen, welche die Technische Redaktion mit in den Entwicklungsprozess einbezieht. Auch Regeln zur Benennungs- und Terminologiebildung sind für die Konstrukteure angebracht.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Weitere Zielgruppen

Es gibt noch weitere Zielgruppen wie Grafiker, Übersetzer, Druckereien oder Zulieferer. Diese benötigen ganz unterschiedliche Informationen wie Angaben zu Grafikformaten oder die Vorgaben für die Bearbeitung von Druckaufträgen.

Aufbereitung der gesammelten Daten für einen Redaktionsleitfaden

Haben sie ihre Regelungen festgelegt, sollten diese in einen Redaktionsleitfaden einfließen. Zwar können viele Inhalte ohne große Anpassungen in ein Dokument einfließen. Jedoch ist schon etwas Vor- und Nacharbeit gefragt.

Zuerst erstellt man einen Entwurf für die Inhalte und fasst darin die wichtigsten Punkte zusammen.

  • Für wen gelten die Regelungen?
  • Warum hat man sich für diese Regelung entschieden?
  • Ab wann gelten die Regelungen
  • Wer hat die Regelungen verfasst
  • Beschreibung der Regelung

Es ist wichtig zu begründen, warum man sich für eine Regelung entschieden hat. Ist diese nicht sinnvoll begründet, kann sich die Regelung auch nicht bei den Benutzern durchsetzen.

Einige Hinweise zum Stilkapitel

Das Stilkapitel hilft beim Verfassen von Dokumentationen. Dazu gehören Vorgaben und Regeln an Satzbau und Formulierungen. Mit den Regeln erleichtert man den späteren Lesern der Dokumentation das Verstehen der Informationen.

Ein paar Regeln die eine bessere Verständlichkeit in die Technische Dokumentation bringen, führe ich jetzt nachfolgend auf.

  • Verwenden Sie ein geschütztes Leerzeichen zwischen Zahlen und Maßeinheiten. So wird die Zahl beim Zeilenumbruch nicht von der Maßeinheit getrennt.
  • Schreiben Sie Ziffern in Kardinalzahlen. Ziffern sind leichter übersetzbar und der Leser erfasst diese einfacher.
  • Schreiben Sie Handlungen aktiv! Das spricht den Benutzer an. Ausdrücke wie „Der Druck muss am Ventil eingestellt werden“ sprechen den Benutzer nicht an und er fühlt sich nicht zuständig die Handlung durchzuführen. Besser Sie schreiben: „Stellen Sie den Druck am Ventil ein.“
  • Achten Sie auf Wörter, deren Bedeutung nicht klar zuzuordnen sind. Ausdrücke wie „regelmäßig“, „ab und zu“ sind beispielsweise keine präzisen Zeitangaben.
  • Vermeiden Sie es, ganze Sätze oder größere Satzteile in Klammern zu setzen. Das verleitet den Leser sonst zum Überlesen.
  • Schreiben Sie Ihre Handlungen nicht wie ein Telegramm.
    Ein Beispiel wie man es nicht machen sollte: Falls Warnschild abgefallen, wiederanbringen!
    Besser: Sollte ein Warnschild an der Maschine abfallen, ist dieses sofort zu wieder anzubringen!
  • Überfrachten Sie ihre Sätze nicht mit Handlungen. Nur eine Handlungsanweisung pro Satz. Das sichert die Verständlichkeit der Anweisungen.

Mit solchen Regeln für die Texterstellung erleichtern Sie dem Anwender das Verstehen. Dieser möchte schnell und eindeutig an die notwendigen Informationen kommen.

Erstellen des Redaktionsleitfaden

Beim Zusammenschreiben der Regelungen in den Redaktionsleitfaden kann man auch ein paar Regeln befolgen. Ich fasse hier einige zusammen, die beim Entwurf eines Redaktionsleitfaden sehr hilfreich sind:

  1. Dem Leser kurz und verständlich das bieten, was er braucht und zwar so kurz wie möglich, verständlich und eindeutig!
  2. Denken Sie an den Nutzer! Schreiben Sie kurze Sätze.
  3. Verfassen Sie Ihre Überschriften zu dem darunter vorkommenden Text. Die Überschrift stimmt den Nutzer auf den Text darunter ein.
  4. Ist Ihr Redaktionsleitfaden fertig, schauen Sie mit einem Tag Abstand nochmal darüber. Womöglich finden Sie noch Verbesserungsmöglichkeiten
  5. Vier Augen sehen mehr wie zwei – Lassen Sie von jemand anderem den Text lesen, bevor Sie en Redaktionsleitfaden herausgeben
  6. Lassen Sie eine Handlungsanweisung von jemand anderen durchführen. Ihr verfasster Redaktionsleitfaden ist brauchbar, wenn der Handelnde zum gewünschten Ziel kommt.

Bringen Sie Ihren Redaktionsleitfaden dann an die Benutzer. Entweder in Papier Form oder digital. Die digitale Variante ist sicher die elegantere Form. Eine Suche erleichtert das Finden von gewünschten Informationen und die digitale Version kann mit zusätzlichen digitalen Verweisen wie Hyperlinks ausgestattet sein.

Auch nach der Einführung benötigt der Redaktionsleitfaden weiterhin Pflege. Aktualisierungen müssen eingepflegt, Fehler behoben werden, usw.

Auch muss geschaut werden, wie der Leitfaden ankommt. Halten sich die meisten daran? Der Mensch ist schließlich ein Gewohnheitstier und trennt sich nur schwer von alten Vorgehensweisen. Es benötigt Zeit bis die Regelungen bei allen angekommen sind. Die erste Fassung des Redaktionsleitfaden wird auch sicher nicht von 100% der Mitarbeiter angenommen. Die Möglichkeit Verbesserungen anzuregen, sollte deswegen auch gewährleistet sein.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen