C wie CONTENT-MANAGEMENT-SYSTEM

CONTENT-MANAGEMENT-SYSTEM, DAS

Die auch als Redaktionssystem bezeichneten, datenbankgestützten Systeme sind heutzutage aus der Technischen Dokumentation nicht mehr wegzudenken. Anleitungen modular, konsistent, versioniert, plattformübergreifend, nachhaltig und effizient zu erstellen und pflegen... das ist nur unter dem Einsatz eines Content-Management-Systems möglich. Wir in der MAXKON-Technikredaktion verwenden seit mehreren Jahren ein Content-Management-System (CMS), um genau diese Punkte für unsere Kunden zu realisieren.

Modular – eine Prise Granularität gefällig?

Inhalte werden in Module aufgeteilt, mit Eigenschaften (z. B. die Gültigkeit der Verwendung) gekennzeichnet und separat im CMS abgelegt. Dabei können Module unterschiedliche Inhalte – Content – enthalten: Grafiken, Text, Tabellen, Aufzählungen usw. Die richtige Größe (Granularität) der Inhalte ist zu beachten. Ganz vereinfacht greift hier das Motto "So groß wie möglich, so klein wie nötig.". Um die richtige Größe herauszufinden, ist eine genaue Analyse der Inhalte und deren Zuordnung zu Produkten und Anleitungen nötig - und ganz sinnvoll ist auch Erfahrung. Das Ziel ist hauptsächlich die Wiederverwendbarkeit von Modulen. Und auch hier gibt es ein Motto: "Je besser die Analyse, desto höher die Wiederverwendbarkeit."

Konsistent – gleicher Produkttyp, gleicher Inhalt

Wenn die Module sinnvoll erstellt und geprüft sind, können diese für gleiche Produkttypen oder - je nach Modulinhalt - auch für andere Produkttypen wiederverwendet werden. Der größte Vorteil dieser Wiederverwendbarkeit ist die inhaltliche Konsistenz. Diese zeigt sich insbesondere bei der Änderung von Inhalten. Das Modul wird geändert (z. B. ein technischer Wert oder eine sicherheitsrelevante Information) und nach der Prüfung in allen referenzierten Anleitungen aktualisiert. Es ist also nicht mehr nötig, alle Anleitungen zu durchsuchen, um die zu ändernde Stelle zu finden.

Plattformübergreifend – für jede Plattform das richtige Format

Nur PDF oder nur HTML? Ein Format allein macht heute niemand mehr. Zumeist werden mehrere Ausgabeformate benötigt. Und diese haben dann wieder ihre eigenen Anforderungen. Um Anleitungen für unterschiedliche Plattformen (PC, Tablet, Smartphone) bzw. Ausgabeformate (HTML, PDF, App) zu publizieren, bedarf es einer Trennung von Inhalt und Format. Der Inhalt wird in hierarchisch strukturierten Daten dargestellt. Die Auszeichnungssprache XML ist hierbei der Quasistandard. Die Redakteure erstellen die Anleitungsinhalte nach deren Verwendung und kümmern sich meist nicht um deren Gestaltung bzw. Formatierung. In Abhängigkeit des Ausgabeformats werden diese Inhalte beim Publizieren vom CMS mit Stylesheets in das entsprechende Ausgabeformat gebracht. Und so können Anleitungen fast gleichzeitig für z. B. den Druck und die Online-Hilfe publiziert werden - mit demselben Inhalt.

Versioniert – Check-in mal ganz anders

Welche Version des Sicherheitshinweises war gleich die aktuelle? Das lässt sich vielleicht bei 5 gleichartigen Produkten herausfinden und anpassen. Aber bei 50 oder mehr? Oder was stand gleich in der letzten Anleitungsversion im Haftungskapitel? All das lässt sich durch die konsequente Versionierung der Module im CMS beantworten. Jedes Modul bzw. jedes Element kann und sollte versioniert werden. Dadurch wird der Inhalt eingefroren und kann in dieser Version nicht mehr verändert werden. Um den Inhalt zu ändern, muss das Element wieder in den Bearbeitungsstand versetzt werden, um danach in einer neuen Version abgelegt zu werden. Die unterschiedlichen Versionen existieren nebeneinander und können durchforstet und auch parallel verwendet werden.

Nachhaltig – einmal geschrieben, einmal geprüft, mehrfach wiederverwendet

Ein weiterer großer Vorteil von modulbasiertem Schreiben ist, dass der Korrekturprozess für den Inhalt eines Moduls nur einmal (ggf. bis zur finalen Abänderung) erfolgen muss. Nach dessen Abschluss ist das Modul inhaltlich geprüft und freigegeben. Neben der dadurch erreichten Konsistenz (siehe oben) reduziert sich bei einer konsequenten und sinnvollen Modularisierung der Korrekturaufwand.

CMS – ja oder nein?

Es gibt viele verschieden CMS auf dem Markt, mit verschiedenen Funktionsumfängen und verschiedenen Lizenzmodellen. Entsprechend unterschiedliche Kosten sind zu erwarten. Das beginnt bei einmaligen Investitionen im vierstelligen Bereich bis zu jährlichen Kosten im fünfstelligen Bereich. Zusätzlich sind die Aufwendungen für Schulung und Pflege zu berücksichtigen.

Wann lohnt sich die Anschaffung eines CMS? Das ist nicht pauschal zu beantworten und hängt von vielen Faktoren ab. Letztlich muss bewertet werden, ob die Zeiteinsparung und die bessere Qualität (Konsistenz, Aktualität usw.) die Kosten für Lizenz und Schulung wirtschaftlich berechtigen. Nach unserer Erfahrung sollte sich jeder Hersteller eines erklärungsbedürftigen Produktes mit der Anschaffung und Verwendung eines CMS beschäftigen – in vielen Fällen wird sich das lohnen.

Sie möchten gerne effizient und nachhaltig Anleitungen erstellen?

Dann sprechen Sie uns an! Wir beraten Sie gerne zur Auswahl eines Redaktionssystems und begleiten Sie Schritt für Schritt bei dessen Strukturierung und Content-Erstellung.