Überspringen zu Hauptinhalt

RS #003 Content-Management-Systeme und Redaktionssysteme in der Dokumentation

Content-Management-Systeme und insbesondere Redaktionssysteme reduzieren Kosten der technischen Dokumentation und vereinfachen sie. Doch was sind sie überhaupt?

Der Ursprung von Content-Management-Systeme und Redaktionssysteme in der technischen Dokumentation

Die Anzahl an technischen Dokumenten wie Betriebsanleitungen, Service-Dokumente, Ersatzteillisten und weiteren Dokumentenarten ist in den letzten 30 Jahren stark angestiegen. Vor der Zeit der
CE-Kennzeichnung, vor der Zeit des modernen PCs und komplexer Software wurden technische Dokumente wie Betriebs- und Gebrauchsanleitungen auf die verschiedensten Weisen erstellt. Sei es auf der Schreibmaschine oder auf anderen Wegen.

Mit der steigenden Anzahl an Dokumenten, der größer werdenden Dokumentationspflicht und dem technischen Fortschritt gab es immer mehr verschiedene Lösungsansätze zur Verwaltung und Optimierung der Prozesse. Das aufkommende Internet Ende der 90er, Anfang der 2000er tat sein Übriges und erhöhte nochmals die Anzahl an Informationen, die erstellt, verwaltet und gepflegt werden mussten.

Unternehmen mussten dadurch immer mehr Texte und Informationen, egal welcher Art verwalten und dokumentieren. Dadurch schaute man sich in anderen Branchen um und fand dort Lösungsansätze. Unternehmen wie Tageszeitungen und Verlage entwickelten bereits in den 80ern die ersten Versionen von Redaktionssystemen. Diese Systeme wurden adaptiert und weiterentwickelt. All diese System werden Redaktionssysteme oder auch Content-Management-Systeme, kurz CMS oder zu Deutsch: Inhaltsverwaltungssysteme genannt.

Begriffsklärung

Beide Begriffe, also Redaktionssystem und Content-Management-System, werden meist als synonym verwendet. Dies liegt daran, dass die beiden Arten von Systemen miteinander verwandt sind. Man verwaltet mit einem Redaktionssystem Inhalte, genau wie bei einem Content-Management-System.

Jedoch unterscheiden sich die beiden Softwarearten in ihren jeweiligen Schwerpunkten. Content-Management-Systeme möchten alle möglichen Verwendungszwecke der Inhalte abdecken. Ein Redaktionssystem legt den Schwerpunkt hingegen auf das Schreiben und Erstellen der Texte und unterstützt den Redakteur durch Erweiterungen wie Autorentools, erweiterte Suchfunktionen und ähnliches. Da diese Differenzierung auch stark von der einzelnen Software abhängt, spreche ich daher einfachheitshalber in diesem Podcast generell von Content-Management-Systemen.

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

Funktionsweise der Systeme

Diese Systeme wurden ursprünglich für die gemeinschaftliche Erstellung, Bearbeitung und Organisation von Inhalten, beispielsweise Websites entwickelt und schnell für andere Dokumentarten und Medienformen angepasst. Die Basis dazu bildet eine Datenbank auf die mehrere Benutzer gleichzeitig zugreifen können.

Informationen und Inhalte werden in kleine Informationseinheiten oder Blöcke aufgeteilt, sinnvoll strukturiert und so gestaltet, dass eine möglichst hohe Wiederverwendung entsteht. Egal ob dies eine Zeile einer Tabelle, ein einzelnes Bild oder mehrere Absätze und Handlungen sind. Diese Informationen werden dann in ein Dokument verknüpft und dies dann ausgespielt. Das Ziel dabei ist es, diese Informationseinheiten so oft wie möglich wieder zu verwenden.

Ich finde die Analogie zu einer Kiste mit Lego-Bausteinen dabei sehr treffend. Die einzelnen Lego-Bausteine stellen dabei Ihre Informationseinheiten dar. Mit diesen einzelnen Einheiten können Sie komplexe Strukturen und Dokumente erstellen. So entstehen aus vielen kleinen Informationseinheiten beispielsweise Betriebsanleitungen, Handbücher oder Kataloge.

Die großen Vorteile von CMS – die Benutzerverwaltung

Ursprünglich wurden Content-Management-Systeme hauptsächlich von großen Unternehmen verwendet, da diese eine entsprechend große Anzahl an zu verwalteten Informationen hatten und ebenso eine große Anzahl an Mitarbeitern, die diese bearbeiteten.

Durch diese Kombination musste eine Lösung geschaffen werden, die dafür sorgte, dass klar nachvollziehbar war, wer welche Information erstellt oder bearbeitet hatte, wer diese freigab und wie diese verwendet wurde. Die Vorgänge und Workflows des Unternehmens mussten in der Software abgebildet werden können.

Die Komplexität dieser Aufgabe klingt vielleicht banal, aber stellen Sie sich vor, Sie sind der Abteilungsleiter und Hauptverantwortlich für 20 oder 30 Redakteure. Halten Sie hier den Überblick, wer welche Information erstellt hat, wer sie geprüft hat und wie sie verwendet wird. Zudem müssen Sie sicherstellen können, dass die festgelegten Prozesse wie Korrekturläufe eingehalten werden. Das kann eine ganz schöne Mamut Aufgabe sein.

Daher kommen wir zum ersten Vorteil von CMS-Systemen – die Benutzerverwaltung. Sie ist ein großes Merkmal dieser Software. Durch Zugriffsrechte und Berechtigungen kann die Arbeit von mehreren Personen an Inhalten koordiniert und nachvollziehbar gehalten werden. Es ist jederzeit im System ersichtlich, wer welche Information gerade bearbeitet, zuletzt bearbeitet hat, was er bearbeitet oder verändert hat und wer dies auch freigegeben hat. So erfüllen Sie auch Ihre Dokumentationspflicht als Hersteller, den Sie können nachweisen wann sich was beispielsweise in einer Betriebsanleitung verändert hat.

Die großen Vorteile von CMS – medienneutrale Daten

Da wir bereits bei den Vorteilen sind, möchte ich zum nächsten Vorteil übergehen, der meiner Meinung nach auch der wichtigste Vorteil ist. Content-Management-Systeme verwalten nämlich die Inhalte in der Datenbank getrennt vom Layout.

Dies bezeichnet man in der Fachwelt als medienneutrale Datenhaltung. Damit ist gemeint, dass die Inhalte erst bei der Generierung der Dokumente mit dem gewünschten Layout erstellt werden. Erst in diesem Schritt wird beispielsweise festgelegt, welche Schriftart verwendet wird, welches Datenformat ausgespielt wird oder ob die Daten in Druckqualität oder für das Internet generiert werden.

Ein Beispiel: Sie können mit einem Content-Management-System beispielsweise dieselben Inhalte einer Anleitung in Druckqualität mit Schriftart Arial ausspielen oder in verringerter Qualität für das Internet mit Schriftart Helvetia. Sie könnten sogar Dinge wie Schriftfarbe oder Farben von Sicherheitshinweisen dadurch einzeln definieren.

Der Vorteil dabei ist klar. Einmal erstellte Inhalte können, vorausgesetzt sie sind gut erstellt, in beliebigen Zielformaten wiederverwendet werden. Dies ermöglicht eine enorm hohe Wiederverwendung von Texten in Flyern, Prospekten, Websites, Anleitungen oder anderen Dokumenten.

Die großen Vorteile von CMS – Wiederverwendung und einfache Pflege

Diese Wiederverwendung führt uns auch gleich zu einem ebenfalls sehr wichtigen Vorteil. Wie Sie vielleicht wissen, kann die Pflege und Aktualisierung Ihrer Betriebsanleitungen und ähnlichen Dokumenten sehr viel Zeit in Anspruch nehmen. Vor allem wenn man etwa 30 – 40 Anleitungen hat, deren Produkte immer wieder verbessert oder optimiert werden.

Verwenden Sie in einem solchen Fall ein Content-Management-System, kann diese Pflege sehr stark reduziert werden. Als Beispiel führe ich in Gesprächen gerne den Informationsbaustein der Herstelleradresse auf. Stellen Sie sich vor, Sie sind Hersteller und haben die vorhin erwähnten 30 – 40 Produkte mit Anleitungen. Zusammen mit weiteren Dokumenten wie Flyer, Prospekten und ähnlichem kommen wir nun bestimmt auf über 100 Dokumente. Und nun ziehen Sie um. Eine händische Änderung in allen Dokumenten kostet definitiv einiges an Zeit. In einem Content-Management-System geht das ganz einfach. Sie ändern einmal den Baustein der Hersteller, der in allen Dokumenten verwendet wird. Sobald Sie die Dokumente aktualisieren, ist die korrekte Adresse wieder in allen Dokumenten enthalten.

Sie müssen sich nichts merken oder für zukünftige Anleitungen berücksichtigen. Etwas was gerade wichtig ist, wenn Sie beispielsweise Serienhersteller sind und Anleitungen in großen Mengen bei Druckereien bestellen. Ist dann der Lagerstand nach 3-4 Jahren aufgebraucht, müssen Sie sich nicht mehr überlegen, was sich in dieser Zeit alles in Ihrer Dokumentation geändert hat. Sie aktualisieren das übergeordnete Element im Content-Management-System und das System aktualisiert alle veralteten Informationsbausteine auf den neusten Stand. Vorausgesetzt Ihre Datenbank ist gut und sauber strukturiert.

Weitere Vorteile von CMS - Metadaten

Neben diesen großen Vorteilen bieten Content-Management-Systeme noch weitere Vorteile, auf die ich nicht ganz im Detail eingehen möchte. Auch weil es immer stark von der jeweiligen Software abhängig ist.

Ein häufiger Vorteil ist beispielsweise, dass sich Content-Management-Systeme häufig mit einer sogenannten Metainformation oder mit Metadaten auszeichnen. Damit bezeichnet man die Merkmale und Eigenschaften von Informationen.

Beispielsweise Autor, Datum, Änderungsverlauf und Name einer Information aus dem Content-Management-System. Jede dort verwaltete Information weist diese weiteren Informationen und Merkmale aus. Also wer hat die Information erstellt, wann wurde sie erstellt etc.

Diese Metadaten erlauben es beispielsweise auch, dass man Informationen zusammenverwaltet aber spezifisch ausgibt. Hat beispielsweise ein Produkt mehrere Optionen können diese durch Metadaten im Content-Management-System abgebildet werden. So bekommt das Produkt mit Option A auch die passende Anleitung mit den Informationen zu Option A. Informationen von Option B und C werden hingegen ausgeblendet und nur mit ausgespielt, wenn diese entsprechend angewählt werden.

Weitere, verschiedene Vorteile

Außerdem bieten Content-Management-Systeme weitere Vorteile. Wie bei der Wahl des Editors, also der Oberfläche zur Eingabe der Inhalte ins System. Ein gern genutzter Editor ist beispielsweise Word.

Oder die Verwendung von Variablen beispielsweise für Zahlen. Sie ermöglicht auch eine hohe Wiederverwendung, beispielsweise wenn man eine große Anzahl an Produkten hat, die sich nur in Gewicht oder Durchmesser unterscheidet.

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

Vorteile bei der Übersetzung

Oder die unkomplizierte Anbindung des Content-Management-Systems an weitere Software wie Translation-Memory-Systeme, um Übersetzungskosten zu reduzieren. Dies ist für mich auch ein wichtiger Vorteil, da er sich schnell rechnet. Denn zum einen verwaltet das Content-Management-System nicht nur die einzelnen Inhalte. Meist verwaltet es gleichzeitig auch alle vorhandenen Übersetzungen der jeweiligen Information. So wird beispielsweise ein Sicherheitshinweis in 30 Sprachen einmal übersetzt.

Neue Anleitungen die diesen Sicherheitshinweis ebenfalls verwenden, werden diese im Falle einer Übersetzung übernehmen und der Text geht dabei nicht mehr zum Übersetzer. Dieser muss die einmal erstellte Übersetzung nicht erneut kontrollieren und spart Zeit und Sie wiederum dadurch Geld.

Zum anderen spielen Content-Management-Systeme die Inhalte für den Übersetzer meist in sogenannten Auszeichnungssprachen wie XML oder HTML aus, wodurch der Übersetzer keine Informationen zum Layout erhält, sondern nur den Text.

Dadurch entfallen Kosten für die Nachformatierung, Einrückungen und Nachbearbeitung des Layouts bei der Übersetzung. Denn diese Aufgabe wird erst bei Publikation der Informationen aus dem Content-Management-System in das gewünschte Zielformat durchgeführt. Sprich ganz am Schluss und aufgrund der Funktion und Einstellung des Content-Management-Systems automatisch.

Der große Nachteil von Content-Management-Systemen

Neben all diesen Vorteilen haben Content-Management-Systeme jedoch auch einige Nachteile, auf die ich eingehen möchte. Der größte und wichtigste Nachteil dabei ist die Anschaffung und Einführung der Systeme.

Content-Management-Systeme sind zum einen im Anschaffungspreis meist nicht ganz billig. Abhängig von der Anzahl an Benutzern die das System bedienen sollen über Zusatzfunktionen, Einstellungen und Wartungsverträge sammelt sich einiges an Kosten an. Diese sind jedoch auch von Hersteller zu Hersteller der Systeme unterschiedlich. Daher kann ich hier nur eine allgemeine Aussage treffen.

Der aus meiner Sicht wichtigere Nachteil ist hingegen die Einführung selbst. Sie ist ein nicht zu unterschätzender Faktor. Zum einen müssen erstmal alle vorhandenen Dokumente in das neue System eingefügt werden. Je nach Anzahl der Dokumente kann dies eine sehr große Position und Aufgabe werden.

Zum anderen können diese Dokumente nicht einfach so übernommen oder importiert werden. Sie müssen zuvor gesichtet, analysiert und strukturiert werden. Der Sinn des Content-Management-Systems ist schließlich, dass Inhalte einmalig erstellt und dann wiederverwendet werden. Also müssen die Dokumente auf die einzelnen Elemente gesichtet und die wiederverwendbaren Elemente entsprechend gekennzeichnet und übernommen werden.

Dies ist eine Aufgabe, die bei wenigen Dokumenten oder Produkten noch überschaubar ist aber mit jedem dazukommenden Produkt entsprechend wächst.

Schulung des Personals oder Einsatz eines Dienstleisters

Der nächste Nachteil hängt eng mit dem vorherigen Punkt zusammen. Denn diese Analyse und Strukturierung der alten Daten erfordert Wissen und Know-How. Entweder man schickt die eigenen Leute zu Schulungen und Weiterbildungen und entwickelt dieses im Haus oder man muss einen Dienstleister damit beauftragen. Beides kann Geld kosten.

Jedoch ist es mit einer Schulung für das eigene Personal oder der Beauftragung eines Dienstleisters leider nicht erledigt. Aus eigener Erfahrung kann ich sagen, dass hier noch etwas mehr dazugehört. Der Dienstleister muss Ihre Produkte kennen, ansonsten kann er keine gute Strukturierung erstellen. Also müssen Sie den Dienstleister schulen. Ansonsten kann es sein, dass Sie zwar eine an sich gute Struktur haben, diese aber für Ihre Produkte und Abläufe ungeeignet ist.

Die eigenen Leute hingegen kennen zwar die Produkte, haben jedoch keine Erfahrung im Bereich der Strukturierung. Die Strukturierung wird dadurch langsamer umgesetzt und eventuell entstehen Fehler, die Sie erst in einigen Jahren bemerken werden und dann nur noch schwer und aufwändig behoben werden können.

Ich habe selbst beide Fälle erlebt. Erstellt man unerfahren eine Struktur, scheint dies aus damaliger Sicht eine gute Struktur zu sein. Nach einigen Jahren muss man dann feststellen, dass sie oberflächlich gut ist, jedoch in der Tiefe nicht. Texte die man damals zusammenfasste, da diese bis dahin immer zusammen vorgekommen sind, werden plötzlich einzeln benötigt und man steht vor dem Thema entweder doppelte Inhalte zu erstellen oder eben die alten Daten aufwändig zu ändern.

Oder man muss den Dienstleister, wie vorhin kurz erwähnt, aufwändig in den eigenen Produkten schulen, der aber trotzdem im Detail die Produkte nie so gut kennen kann wie ein interner Mitarbeiter. Langjährige Erfahrung kann in beiden Fällen leider nicht ersetzt werden. Daher erfordert die Einführung und Umsetzung entsprechend Zeit und Geld. Denn ein Datenstand ist nun mal nicht in wenigen Stunden strukturiert und in einem neuen System eingepflegt und einsatzbereit.

Hohe Anforderungen an die Redakteure

Zu guter Letzt stellen Content-Management-Systeme hohe Anforderungen an die Redakteure selbst. Die Redakteure müssen strukturiert arbeiten, eine für das Produkt und die Informationen passende Systematik entwickeln und über gutes, logisches Denken verfügen.

Nur wenn man sich an die selbst auferlegten Strukturen und Workflows im System hält, bleibt der Datensatz auf lange Zeit nutzbar und in guter Qualität. Halten sich die Redakteure nicht daran, beinhaltet die Datenbank schnell doppelte Inhalte, falsche Verweise und unnütze Bausteine.

Das Fazit zu Content-Management-Systemen

Schaut man sich diese ganzen Vor- und Nachteile nochmals an, kann man sagen, dass die Arbeit mit Content-Management-Systemen und Redaktionssystem nicht einfach ist. Ist es jedoch einmal eingeführt, umgesetzt und die Redakteure halten sich an die vorgegebenen Strukturen, so hebt man die Verwaltung und Erstellung der Informationen auf ein neues Level.

Systeme wie Content-Management-Systeme und Redaktionssystem können die Erstellung und Verwaltung von technischer Dokumentation oder anderen Informationen stark vereinfachen und Kosten reduzieren. Aber nur, wenn es sinnvoll eingeführt und umgesetzt wird.

Persönliche Meinung

Zum Schluss noch meine persönliche Meinung. Ich finde den Einsatz dieser Systeme richtig und wichtig. Vor allem wenn es gilt eine Vielzahl an Informationen und Dokumenten zu erstellen und zu verwalten. Ich arbeite seit 13 Jahren mit diesen Systemen und habe hierbei einiges gesehen und meine Erfahrungen damit gemacht. Egal ob gut strukturierte Datenbanken oder Datenbanken mit Dubletten und Wildwuchs.

Für kleinere Unternehmen sehe ich den Einsatz nicht als zwingend erforderlich an. Sollte man jedoch über eine große Anzahl an Dokumenten verfügen, empfinde ich eine Verwaltung, beispielsweise in Word, als ungeeignet. Hier ist die Wahl eines Redaktionssystems daher besser. Im Gegenzug ist ein solches System für die Erstellung und Verwaltung von wenigen Dokumenten nicht notwendig. Hier ist die Verwendung von Word oder anderer Programme wesentlich sinnvoller.

Wir setzen übrigens für die Erstellung von technischer Dokumentation für alle unsere Kunden Redaktionssysteme ein, falls dies den Anforderungen des Kunden entspricht. Dadurch können wir auf vorgefertigte, allgemeine Bausteine und Texte zurückgreifen und diese verwenden. Denn auch wir erstellen nicht alles immer neu.

Der ein oder andere Zuhörer kennt vielleicht auch das GFT Redaktionssystem und fragt sich, warum ich darüber in diesem Podcast nichts erzählt habe. Nun es ist einfach. Wir haben ab 2005 oder 2006 bis etwa 2012 unser eigenes System entwickelt. Danach hat sich bei uns die Erstellung, die Beratung und Prüfung der technischen Dokumentation in den Vordergrund gestellt und wir haben beschlossen, dass wir uns darauf konzentrieren. Das System gibt es jedoch immer noch, es gehört unserem damaligen Entwicklungspartner PGX und ist unter dem Namen Bloxedia erhältlich.

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

An den Anfang scrollen