Erstellen eines Redaktionsleitfadens mit TIM als Grundlage

Das Erstellen eines Redaktionsleitfadens (RLF) ist in vielen Technischen Redaktionen auf Grund von Ressourcenmangel sehr oft problematisch. Jedoch ergibt sich mit dem Implementieren von TIM die Möglichkeit, das Thema Redaktionsleitfaden parallel zu starten und zumindest einen ersten Entwurf zu erstellen.

Folgende Situation treffe ich oft bei Interessenten an:

  1. Ja, es gibt einen Redaktionsleitfaden und wir arbeiten bereits auch danach.
  2. Ja, es gibt einen Redaktionsleitfaden, aber der ist veraltet und nicht aktuell.
  3. Nein, es gibt noch keinen Redaktionsleitfaden.

Situation 1 ist natürlich die optimale Antwort. Die häufigste Situation, die ich allerdings antreffe, ist jedoch Situation 3. Von dieser Situation gehen wir auch in diesem Beitrag aus.

Vorteile und Nutzen eines Redaktionsleitfaden

In einem Redaktionsleitfaden steckt jede Menge Arbeit und Wissen von verschiedenen Personen aus Ihrem Unternehmen. Diese Arbeit ist wertvoll und steigert nachweislich die Qualität Ihrer Informationsprodukte.

Nachfolgend ein paar Punkte, die für das Implementieren und Arbeiten mit einem Redaktionsleitfaden sprechen.

  • Modularisieren und Wiederverwenden von Objekten.
  • Definieren von Standards wie Layouts, Kapitelstrukturen, Tabellen, Grafiken, usw.
  • Anwenden einer konsistenten Terminologie und Sprache.
  • Vereinheitlichen der Arbeitsprozesse.
  • Vermeiden von Informationsredundanzen.
  • Erhöhen und Sicherstellen des Qualitätsstandards.
  • Bilden einer Basis für das Einarbeiten neuer Mitarbeiter.

Starten Sie mit TIM und entwickeln Sie Ihren Redaktionsleitfaden

In dem Moment, in dem Sie sich entschieden haben, TIM als Redaktionssystem einzuführen, bietet sich für Sie die perfekte Möglichkeit, parallel einen Redaktionsleitfaden zu erstellen. Hierzu können Sie auf der im TIM Standard Umfang enthaltenen XML-Elementstruktur aufbauen.

In dieser Phase entsteht ein erster Entwurf, der später weiter ausgearbeitet und entwickelt werden kann. Ein Redaktionsleitfaden lebt und wird nie gesamt abgeschlossen. Das wird auch in Ihrem Fall nicht möglich sein. Sie können allerdings wichtige Punkte definieren, festhalten und später in Ihren Redaktionsleitfaden übertragen. In diesem Beitrag möchte ich Ihnen einen Überblick liefern, wie Sie zu Ihrem ersten Entwurf kommen.

Standardisieren Sie Ihre Informationsprodukte

Das Implementieren von TIM und das Erstellen eines Redaktionsleitfadens bietet ebenfalls die Basis zum Standardisieren und Modularisieren Ihrer Informationsprodukte. In einer Zielgruppenanalyse definieren Sie, welches Informationsprodukt für welche Zielgruppe erstellt wird.

Darüber hinaus standardisieren Sie Ihre Layouts und legen genau fest, welches Dokument für welche Zielgruppe in welchem Ausgabeformat publiziert werden soll.

Über unser ausgefeiltes Metadatenkonzept in TIM lassen sich alle Objekte klassifizieren und werden so nachhaltig nutzbar. Hier legen Sie den Grundstein, um Ihre Produktkommunikation auf digitale Beine zu stellen.

Mit dem Ziel Produktinformationen digital, zielgruppengerecht, weltweit und in Echtzeit anzubieten.

Die TIM Standard XML-Elementstruktur als Basis

TIM bietet mit seiner XML-Elementstruktur, die auf Basis des Funktionsdesigns entwickelt wurde, eine optimale Grundlage. Sie können so zu Beginn die Standard XML-Elementstruktur z.B. für Handlungsanweisungen, Tabellenaufbau, Wartungsanweisungen usw. verwenden. Die große Flexibilität ermöglicht es sehr einfach, später diese XML-Elementstruktur auf Ihre Bedürfnisse und Ansprüche anzupassen.

Ihr Redaktionsleitfaden

Anlegen und Nutzen von Snippets

Ein weiterer Vorteil ist das Anlegen und Nutzen von Snippets. Bei Snippets handelt es sich um XML-Abschnitte, die innerhalb von Modulen eingesetzt werden können. Die in Snippets hinterlegten XML-Strukturen können per Mausklick in ein Modul eingefügt und müssen somit nicht immer wieder neu aufgebaut werden.

Snippets können verschiedenen Texttypen sein:

  • Handlungsanweisungen
  • Legenden
  • Listen
  • Warnhinweise
  • Tabellen

Exemplarischer Aufbau eines Redaktionsleitfadens

Im nachfolgenden Kapitel möchte ich Ihnen Ideen und Anregungen für den Aufbau eines Redaktionsleitfaden liefern.

Einleitung
  1. Was ist der Zweck des RLF?
  2. Welche Kapitel im RLF sind für welche interne Zielgruppe relevant?
  3. Wie wird mit Änderungen und Verbesserungsvorschlägen umgegangen?
  4. Gibt es mitgeltende Dokumente (CI-Leitfaden, Richtlinien, usw.)?
  5. Wie ist der aktuelle Redaktionsprozess aufgebaut?
  6. Welche Rollen sind im Redaktionsprozess definiert?
  7. Welche Informationsprodukte werden in welchen Sprachen erstellt?
Arbeitsmittel und Datenablage
  1. Welche Software und Systeme kommen bei der Dokumentationserstellung zum Einsatz?
  2. Gibt es Richtlinien für den Aufbau von Dateinamen o.ä.?
  3. Welche Normen und Richtlinien müssen berücksichtigt werden?
Leitlinien für Informationsprodukt A
  1. Gibt es Layout- und Grafikvorgaben (evtl. Verweis auf CI-Leitfaden)?
  2. Gibt es bereits eine definierte Kapitelstruktur? (Abweichungen definieren und dokumentieren)
Definieren der Inhalte pro Kapitel

Die nachfolgenden Punkte sollten Sie für jedes Kapitel einzeln betrachten und entsprechend den Definitionen mit Inhalten füllen.

  1. Wo sollen die entsprechenden Kapitel platziert sein? (Titelblatt, Rückseite)
  2. Ist das Kapitel feststehend oder fortlaufend?
  3. Um was geht es inhaltlich in diesem Kapitel? (z.B. Technische Daten, Funktionsbeschreibung, Besonderheiten, usw.)
  4. Was ist nicht erlaubt? (z.B. werbliche Texte, Inhalte ohne Aussagekraft)
  5. Sind Grafiken erlaubt?
    • Wo werden diese im Kapitel platziert?
    • Spezifische Grafikvorgaben z.B. über die Auflösung, Grafikgröße, usw.
  6. Werden Tabellen verwendet? Wenn ja, wie sind sie aufgebaut? (Anzahl Spalten, Farbgestaltung)
  7. Für ein besseres Verständnis für die Redakteure, sollten am Ende jedes Kapitels umgesetzte Beispiele aufgeführt werden.
Zusatzinformationen zur Arbeitsunterstützung
  1. Gibt es im Unternehmen bereits Schreibregeln?
  2. Gibt es einen Prozess für Terminologie?
  3. Wie wird die Qualität sichergestellt? Die Qualitätssicherung ist ein Thema mit hoher Priorität und kann im späteren Verlauf ein eigenes Kapitel bilden.

Hier finden Sie den Download eines exemplarischen Redaktionsleitfadens.

Um die Qualität Ihrer Inhalte weiter zu optimieren bietet TIM weitere Features. Hier kann ich Ihnen unsere TIM Autorenunterstützung ans Herz legen. Diese ist kostenfrei in TIM (Version 4.3) integriert und bietet Ihnen eine Rechtschreibprüfung, Grammatikprüfung, Terminologie Prüfung und eine Satzwiedererkennung.

Gerne präsentieren wir Ihnen unser TIM Redaktionssystem einmal Live. Kommen Sie einfach auf uns zu.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

Ich akzeptiere

Das könnte Dir auch gefallen