XML-Redaktionssystem für die Technische Dokumentation: Content Management System (CMS)

Ein Redaktionssystem ist ein Content Management System (CMS). Mit dieser datenbankgestützten Software erstellen Sie Inhalte und können diese gemeinschaftlich bearbeiten und verwalten. Die Datenbank enthält einzelne Module, die Sie einmal ablegen und dann beliebig wiederverwenden. Diese Inhalte können in unterschiedlichen Ausgabeformaten publiziert werden, zum Beispiel als PDF oder als Online-Hilfe. Ein CMS funktioniert also nach dem Prinzip der Medienneutralität. Manche CMS beruhen auf XML, andere kommen ohne aus, bieten aber gleichwohl die Vorzüge eines professionellen CMS. Verschaffen Sie sich eine Übersicht und stellen Sie Vergleiche an.

Ein Redaktionssystem einführen: CMS in der Technischen Dokumentation

Die speziellen CMS, die in der Technischen Dokumentation zum Einsatz kommen, werden auch als Redaktionssysteme - oder Component Content Management Systems (CCMS) - bezeichnet. Die Einführung eines Redaktionssystems ist eine Überlegung wert, weil damit große Datenmengen verwaltet werden können.

Im Vergleich zu einem einfachen Textverarbeitungsprogramm zeigt sich eine ganze Reihe von Vorzügen. Ein Redaktionssystem trägt wesentlich dazu bei, die Aufwände bei der Dokumentationserstellung zu reduzieren und die Fehleranfälligkeit zu verringern.

So profitieren Sie von einem XML-basierten Redaktionssystem:

• Unterstützung für Dokumentations-Teams
  Es gibt einen zentralen Ablageort für sämtliche Inhalte der Dokumentation. Alle am Projekt Beteiligten können jederzeit auf die Daten im Redaktionssystem zugreifen und finden immer den aktuellen Stand vor. Auch ist immer nachvollziehbar, wer welche Bearbeitung zu welchem Zeitpunkt vorgenommen hat. Ein Redaktionssystem ermöglicht somit ein kollaboratives Arbeiten an der Dokumentation. Außerdem ist es möglich, verschiedenen Benutzern unterschiedliche Rollen zuzuweisen, um Berechtigungen für das Erstellen und Bearbeiten von Inhalten zu vergeben.
• Leichte Auffindbarkeit von Inhalten
  Die Datenbank ist so strukturiert, dass sich einzelne Inhalte im Redaktionssystem per Suchfunktion schnell finden lassen. Alle Inhalte sind mit Metadaten versehen, also mit beschreibenden Daten, die sich auf die Inhalte beziehen und deren Nutzbarkeit erhöhen. Dazu zählen etwa Informationen über den Autor, Erstellungs- und Aktualisierungsdaten und Versionsinformationen.
• Versionenverwaltung
  Im Redaktionssystem halten Sie verschiedene Versionen eines Moduls. Die älteren Stände bleiben erhalten und können bei Bedarf wieder abgerufen werden. So lässt sich die Historie eines Dokuments in einem Redaktionssystem problemlos rekonstruieren.
• Varianten von Inhalten
  Im Redaktionssystem können mehrere Varianten eines Dokuments generiert werden, zum Beispiel für unterschiedliche Typen eines Produkts, die sich lediglich in einzelnen Funktionalitäten oder Bauteilen unterscheiden. In den Varianten werden dann einzelne Module ausgetauscht, der Rest bleibt unverändert erhalten.
• Wiederverwendbarkeit von Inhalten
  Ein einmal erstellter Inhalt, der als Objekt in der Datenbank des Redaktionssystems liegt, kann beliebig oft und in unterschiedlichen Dokumenten verwendet werden. So lässt sich beispielsweise ein und dieselbe Handlungsanleitung in vielen verschiedenen Dokumenten einsetzen. Die redundante Erstellung von Inhalten entfällt, der Arbeitsaufwand reduziert sich erheblich. Somit leistet ein Redaktionssystem eine wesentliche Voraussetzung für das Single-Source-Publishing, das Publizieren verschiedener Output-Formate aus einer einzigen Quelle ermöglicht.
• Standardisiertes Layout
  DTDs wie PI-Mod oder DITA helfen, die Dokumentation zu strukturieren. Die DTD gibt Elemente vor, die die Dokumentation gliedern: sowohl durch die Art der Elemente als auch ihre Relationen untereinander. Je nach den Anforderungen, die die Dokumentation stellt, lassen sich die DTDs entsprechend anpassen. Wenn also ein Dokument beispielsweise Sicherheitshinweise enthalten soll, dann muss dieses Element in die DTD eingeführt sein.
• Qualitätssicherung von Inhalten
  Die Wiederverwendung von Inhalten innerhalb des Redaktionssystems trägt zur Qualitätssicherung bei. Inhalte, die einmal eine Qualitätsprüfung durchlaufen haben, bleiben in verschiedenen Ausgabeformaten unverändert erhalten, Fehlerquellen werden damit ausgeschaltet.
• Reduzierung von Übersetzungskosten
  Auch verschiedene Sprachversionen lassen sich mithilfe eines Redaktionssystems verwalten. Das System erfasst automatisch, ob ein bestimmter Inhalt in eine vorgesehene Zielsprache übersetzt ist und ob diese Übersetzung aktuell oder veraltet ist. Wenn eine neue Version eines Dokuments erstellt wird, kann das Redaktionssystem erkennen, welche Inhalte geändert wurden und nur diese in die Übersetzung schicken. Der Übersetzungsprozess läuft über Sprachpakete, die ausgecheckt und in ein Translation Memory System (TMS) eingecheckt werden. Dort werden sie übersetzt, aus dem Translation Memory System exportiert und wieder in das Redaktionssystem eingecheckt. Unveränderte Inhalte werden nicht erneut übersetzt, wiederverwendete Inhalte brauchen nur einmal übersetzt zu werden.

Ein XML Redaktionssystem einführen. Vorteil - Nachteil.

Einerseits ist die Einführung eines Redaktionssystems zu Beginn mit einigen Investitionen verbunden: durch die Anschaffung der Software, die Systemeinführung, die Schulung der Mitarbeiter und nicht zuletzt durch laufende Kosten für Administration und Wartung. Hinzu kommt die Umstellung der redaktionellen Arbeitsweise auf die neue, modularisierte Methode: Schließlich erfordert die Arbeit mit einem Redaktionssystem eine hochgradig strukturierte Arbeitsweise, die für viele Teams eine enorme Umstellung bedeuten kann. Wer bislang weitgehend unstrukturiert gearbeitet hat, ohne klar definierte Prozesse und verbindliche Standards, sieht sich also mit ganz neuen Herausforderungen konfrontiert.

Argumente gegen die Einführung eines Redaktionssystems:

• In Online-Hilfe oder Handbüchern werden keine Inhalte doppelt verwendet.
• Die Vorteile des Übersetzungsmanagements sind nicht relevant, weil die Dokumentation nur in einer Sprache erstellt wird.
• Versionen und Varianten sind nicht relevant.

Allerdings sind es prinzipiell weniger diese inhaltlichen Argumente, die aus Sicht der Unternehmen gegen die Einführung eines Redaktionssystems sprechen, sondern vielmehr wirtschaftliche: Der Aufwand und die Anschaffungskosten, die die Einführung eines Redaktionssystems mit sich bringen, sind für viele zu abschreckend. Selbst wenn die Anforderungen an die Redakteure im Tagesgeschäft gegeben wären und ein Redaktionssystem ganz deutlich zu effizienterem Arbeiten führen würde, dann entscheiden sich trotzdem viele Unternehmen dagegen.

Durch den Einsatz eines Redaktionssystems wird die Erstellung der Dokumentation mittel- bis langfristig jedoch deutlich kostengünstiger, sodass sich die Einführung auf längere Sicht immer rechnen wird.

Der Umgang mit einem Redaktionssystem setzt ein gewisses Maß an Standardisierung voraus

Sicherlich ist es einleuchtend, dass der Umgang mit einem Redaktionssystem ein gewisses Maß an Standardisierung der Arbeitsabläufe voraussetzt und dass die Einführung umso reibungsloser verläuft, je höher der vorhandene Reifegrad ist. Aber umgekehrt gilt auch: Ein Redaktionssystem kann diejenigen, die mit ihm zu tun haben, bei der Implementierung von Standards unterstützen. So sollten Schulungen zum Beispiel das Bewusstsein dafür schärfen, dass sich modularisierte Inhalte oftmals praktischer wiederverwenden lassen, anstatt sie immer wieder durch Copy&Paste  neu zu erstellen. Auf diese Weise werden die Optionen des Systems zugleich zu Standards des Arbeitens.

Vorgehensmodell bei der Einführung eines Redaktionssystems

Der Einführung eines Redaktionssystem liegt ein Vorgehensmodell zugrunde, das, unabhängig von der Komplexität des Systems und der Größe des Unternehmens, für jede Einführung herangezogen werden kann.

Wenn Sie ein Redaktionssystem einführen wollen, dann sind folgende Punkte für den Projektplan relevant:

• Ist-Zustand analysieren
• Optimierungspotenziale eruieren
• Soll-Zustand definieren
• Redaktionssystem evaluieren und auswählen
• Pflichtenheft erstellen
• Redaktionssystem durch den Anbieter anpassen lassen
• Redaktionssystem implementieren
• Mitarbeiter schulen

Der Projekterfolg der Einführung ist abhängig davon, wie die Prozessreife bewertet wird: wie gut die Einführung des Redaktionssystems geplant wurde, ob Risiko- und Changemanagement gut umgesetzt werden und wie gut das Projektmanagement im Unternehmen funktioniert.

Reifegrad einer Redaktion als Kriterium für die Einführung eines Redaktionssystems
Standardisierung
Metadaten
Cross-Media-Publishing
Single-Source-Publishing