Überspringen zu Hauptinhalt

RA #001 Redaktionsleitfaden in der technischen Dokumentation

RA #001 Redaktionsleitfaden In Der Technischen Dokumentation

Der Redaktionsleitfaden dient als eine Art „Bedienungsanleitung“, um technische Inhalte redaktionell und einheitlich aufzubereiten. Er enthält Arbeitsanweisungen für Mitwirkende und Beschreibungen zu wichtigen Vorgängen sowie Prozessschritte.

Was ist ein Redaktionsleitfaden

Der Sinn eines Redaktionsleitfaden liegt darin, Vorgehensmodelle für die Definition von Inhalten zu schaffen. In einer verständlichen Form erhält der Benutzer des Redaktionsleitfaden Arbeitsanweisungen für Vorgaben an Struktur, Layout, terminologische und sprachliche Regelungen von jeglichen Dokumentenarten.

Allgemein soll mit einem Redaktionsleitfaden ein guter Einstieg geschaffen werden, um Dokumente zu verfassen. Ebenfalls sollen der Redaktionsleitfaden ein konsistentes Erscheinungsbild und ein gleiches Qualitätslevel unter den Technischen Dokumenten gewährleisten. Dann muss nicht für jedes Dokument die Struktur oder das Layout mühsam von Einzelfall zu Einzelfall gewählt werden.

Auch Abläufe und Arbeitsprozesse (wie beispielsweise Terminplanung oder Qualitätsprüfung) innerhalb der Redaktion eines großen Unternehmens können in einem Redaktionsleitfaden abgebildet sein. Andernfalls hätte man schnell inkonsistente Daten und ein Durcheinander unter den verschiedenen Dokumenten.

Eine strukturierte Regelung zur Erstellung von Dokumenten kann eine große Umstellung bedeuten. Jedoch verbessert die Standardisierung der redaktionellen Regeln und Abläufe die Ergebnisse der Arbeit deutlich.

Allgemein gültige Schreibstandards und etablierte Richtlinien sind zudem auch vor allem für neue Mitarbeit sinnvoll.

Für wen ist ein Redaktionsleitfaden gedacht?

Alle Beteiligten, die Beiträge für die Technische Dokumentation liefern sollen, profitieren von einem Redaktionsleitfaden. Das können beispielsweise Konstrukteure, Entwickler, Redakteure oder auch externe Dienstleister sein. Die erwähnten neuen Mitarbeiter haben ebenfalls eine Grundlage um sich einfacher und schneller einzuarbeiten.

Wenn neue Mitarbeiter in das Unternehmen eintreten, nimmt die Einarbeitung dieser viel Zeit in Anspruch. Die neuen Personen benötigen Informationen:

  • über Ansprechpartner in den Unternehmensbereichen
  • welche Redaktionssysteme zum Einsatz kommen und wie diese zu bedienen sind
  • Organisation von Dateisystemen und Ablagen
  • Verfahrensweise für Erstellung und Freigabe von Dokumentationen
  • Zuständigkeiten, Terminvorgaben

Ein Redaktionsleitfaden kann für neue Redakteure eine erste Quelle darstellen, um den anstehen Informationsbedarf schon ein wenig zu decken.

Die alten Hasen unter den Redakteuren können von den Informationen ebenfalls profitieren, darunter zählen Informationen zu:

  • Struktur, Aufbau und Layoutvorgaben einzelner Dokumentarten
  • Regelungen zum Schreibstil
  • Festlegungen wegen Vertretung von Kollegen bei Krankheit oder Urlaub
  • Terminplanung von Projekten
  • Formatvorlagen und Vordrücke

Falls neben den Redakteuren auch Grafiker und Illustratoren separat arbeiten, können diese ebenfalls zu der Zielgruppe für einen Redaktionsleitfaden zählen. Diese benötigen Informationen zu:

  • Beschreibungen zum gewünschten Stil der Zeichnungen sowie mögliche Muster
  • Angaben zur benötigten Software
  • Ansprechpartner in der Reaktion für Rückfragen

Da auch Konstrukteure und Entwickler bei der Erstellung einer Dokumentation mitwirken, benötigen diese auch Informationen zu:

  • Wer in der Redaktion für welche Aufgabe zuständig ist
  • Wieviel Zeit für eine Dokumentation eingeplant ist
  • Wen man in der Dokumentation oder anderen Abteilungen über Neuentwicklungen informieren muss
  • Regeln zu Benennung von Produkten und Funktionen

Andere Abteilungen wie Marketing, technischer Kundendienst oder die Unternehmensleitung können ebenfalls von dem Redaktionsleitfaden profitieren.

Verteilen sich die Abteilungen auf mehrere Standorte ist ein Redaktionsleitfaden ebenfalls eine gute Methode für eine Zusammenarbeit.

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

Wann es sinnvoll ist einen Redaktionsleitfaden einzusetzen

Die Einführung neuer Werkzeuge zur Dokumentation ist beispielsweise ein guter Zeitpunkt, um einen Redaktionsleitfaden einzuführen. Zu diesem Zeitpunkt ist es meist sinnvoll, die Strukturen und Abläufe in der Dokumentation zu überdenken und zu verbessern.

Auch wenn mehrere Redakteure unterschiedliche Informationsprodukte herstellen, ist ein Regelungsbedarf gefragt. Die Zusammenarbeit ist dort anders als im Falle von der „Ein-Mann-Redaktion“. Gerade um unterschiedliche Arbeitsweisen und Methoden über Bord zu werfen und einheitliche Regeln zu schaffen, ist der Einsatz eines Redaktionsleitfaden sinnvoll.

Vor- und Nachteile eines Redaktionsleitfaden

Der Einsatz eines Redaktionsleitfaden innerhalb der Technischen Dokumentation kann Vor- und Nachteile mit sich bringen.

Zu den Vorteilen zählen unter anderem die Steigerung der Effizienz bei der Erstellung von Dokumenten. Durch die einheitlichen Regelungen arbeiten mehrere Redakteure und Redaktionsbereiche effizienter zusammen, da sich alle an die jeweiligen Prozesse anpassen müssen.

Der zeitliche Aufwand zur Konzeption von neuen Dokumentationen ist zudem durch den Einsatz eines Redaktionsleitfaden verkürzt. Auch die mehrfache Verwendung erstellter Inhalte ist durch den Einsatz eines Redaktionsleitfaden vereinfacht, weil alle Inhalte einheitlich erstellt werden.

Auch ist das Wissen über die Abläufe in der Dokumentationserstellung schriftlich gesichert und hinterlegt. Das verhindert, dass Wissen verloren geht, falls das Wissen bei einer einzelnen Person liegt und diese das Unternehmen verlässt. Ein Redaktionsleitfaden sichert solch ein Wissen und macht dies für alle verfügbar.

Das eigene Unternehmen und die Dokumentations-Benutzer haben ebenfalls einen Nutzen von den einheitlich erstellten Dokumenten. Zumal die Möglichkeiten zur Schulung neuer Mitarbeiter durch einheitliche Regelungen vereinfacht werden.

Es gibt aber nicht nur Vorteile; ein Redaktionsleitfaden kann auch Nachteile beinhalten.

Die Erstellung eines Redaktionsleitfaden ist mit einiger Arbeit verbunden, die man neben den üblichen Aufgaben unterbringen muss. Daher ist der zeitliche Aspekt schon mal ein großer Punkt unter den Nachteilen.

Auch ist nicht mit einem „schlagartigen“ Erfolg zu rechnen. Es benötigt Zeit bis die Abläufe und Vorgänge unter den Mitarbeitern integriert ist.

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

Worauf beim Erstellen eines Redaktionsleitfaden zu achten ist

Zuerst sollte Material für den Redaktionsleitfaden gesammelt werden. Meist gibt es innerhalb des Unternehmens schon schriftlich niedergelegte Vorgaben und Regelungen, die als Basismaterial verwendbar sind. Im Redaktionsgeschäft muss sowieso mit vielen Stellen im Unternehmen kommuniziert werden. Dann kann dort bereits nach vorhandenen Verfahrensanweisungen, Checkliste, Organigramme oder ähnliches geschaut werden.

Werbe- bzw. Marketingabteilungen können beispielsweise Antworten darauf liefern, welche Stilvorgaben es an Dokumente gibt, die im ganzen Betrieb eingehalten werden müssen. Auch welche Schriften, Farben und Logos überhaupt verwendet werden dürfen.

Die Konstruktions- bzw. Entwicklungsabteilung hat Angaben dazu welche Normen und Richtlinien bei der Entwicklung neuer Produkte zum Einsatz kommen. Oder in welchen Formaten Zeichnungen zur Verfügung stehen und wie man diese dann in der Technischen Dokumentation nutzen kann. Auch wie und nach welchen Regeln neue Funktionen und Produkte benannt werden.

Die Abteilung des Kundenservice liefert Meldungen aus der Produktbeobachtung aus der man Rückschlüsse für zukünftige Dokumentationen ziehen kann, die dann in den Redaktionsleitfaden einfließen können.

Das eingesammelte Material kann dann auf dem Rechner gespeichert werden. Nutzen Sie eine Datenstruktur mit unterschiedlichen Verzeichnissen, um ihre Materialsammlung systematisch zu ordnen.

Dann können die gesammelten Informationen aufbereitet werden und für jedermann in Form eines Redaktionsleitfaden zugänglich gemacht werden.

Wie das geht, werde ich in der kommenden Folge genauer erläutern.

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

An den Anfang scrollen