Deutsch

Redaktionssysteme für die Technische Dokumentation – was, wie und warum?

Was Sie über Auswahl und Einführung wissen sollten.

CREATE
Redaktionssysteme für die Technische Dokumentation – was, wie und warum?

"Wir als mittelständischer Maschinenbauer schreiben unsere Technische Dokumentation seit jeher in einem Textverarbeitungsprogramm. So langsam kommen wir mit den Dateigrößen und der Versionierung an die Grenze. Aber lohnt es sich, gleich ein ganzes Redaktionssystem für die Technische Dokumentation einzuführen? Ist das für uns nicht viel zu umständlich und zu aufwändig?"

Zunächst die kurze Antwort: Das kann sich lohnen. Denn: Redaktionssystem ist nicht gleich Redaktionssystem.
Es gibt eine ziemlich große Bandbreite, wenn es um Funktionsumfang, Komplexität, aber auch Preis geht. Der Knackpunkt liegt darin, das passende System für die eigenen Ansprüche zu finden.

Im Folgenden möchten wir nun ein paar grundlegende Fragen beantworten, die Ihnen helfen sollen, zu entscheiden, ob ein Redaktionssystem für Ihre Technische Dokumentation gewinnbringend eingesetzt werden kann und welche Aspekte bei der Entscheidung eine Rolle spielen.

Was ist überhaupt ein Redaktionssystem für die Technische Dokumentation?

Redaktionssysteme (oder auch Component-Content-Management-Systeme (CCMS)) erleichtern die Arbeiten in der Technischen Redaktion, die ansonsten mit hohem Aufwand und hoher Fehleranfälligkeit einhergehen. In Redaktionssystemen wird Technische Dokumentation erfasst, verwaltet, versioniert, qualitätsgesichert und ausgegeben. Auch die Übersetzung in verschiedene Sprachen kann ihren Ursprung im Redaktionssystem haben.

Darüber hinaus folgen Redaktionssysteme drei entscheidenden Prinzipien, die Hand in Hand gehen.

  1. Modulare Inhaltserfassung: Die Inhalte werden nicht wie in einem Textverarbeitungsprogramm in einem fortlaufenden Dokument erfasst, sondern in kleineren Einheiten, sogenannten Modulen. Diese Module werden einzeln gespeichert, übersetzt und versioniert und können je nach Bedarf wiederverwendet werden. So kann ein einmal geprüfter und übersetzter Abschnitt, der für mehrere Maschinen gültig ist, immer wieder verwendet und bei Änderungen leicht angepasst werden. 

  2. Trennung von Layout, Struktur und Inhalt: Die Module werden layoutneutral im XML-Format geschrieben, wobei ein (oft grafischer) Editor hilft. Ist der Inhalt vollständig erfasst, werden die gewünschten Module manuell oder teilautomatisiert zu Dokumenten zusammengestellt und publiziert. Dank der medienneutralen Erfassung der Inhalte kann die Ausgabe in vielen unterschiedlichen Layouts erfolgen. Das Nach- und Umformatieren gehört damit der Vergangenheit an.

  3. Single Source Publishing: Dadurch, dass die Inhalte layoutneutral und zentral in einer Datenquelle verwaltet werden, können diese nicht nur unterschiedlich formatiert, sondern in ganz unterschiedlichen Medien ausgegeben werden. Gängig ist die Ausgabe als PDF für den Druck oder HTML für Websites. Aber auch exotischere Publikationsstrecken lassen sich realisieren. So können Inhalte aus dem Redaktionssystem etwa via App publiziert oder als Basis für digitale Lerneinheiten in einer Online-Akademie verwendet werden.

 

Professionalisieren Sie die Erstellung Ihrer Technischen Dokumentation  Wir zeigen Lösungswege auf, wie Sie durch gezielte Prozessoptimierung die  Erstellung Ihrer Technischen Dokumentation effizienter gestalten.    KOSTENLOSES WHITEPAPER ANFORDERN

 

Was leistet ein Redaktionssystem?

Neben den oben genannten Grundfunktionen gibt es noch eine Reihe typischer Funktionen, über die die meisten Redaktionssysteme verfügen:

  • Statusmarkierung und Versionsverwaltung: Jedes Bild, jedes Modul, jedes Dokument hat einen eigenen Status und eine eigene Version, um eine maximal transparente Historie zu gewährleisten.
  • Variantenmanagement: Oft unterscheiden sich einzelne Baureihen nur in Kleinigkeiten, dennoch benötigen sie voneinander abweichende Betriebsanleitungen. Mit Hilfe von z. B. variantenabhängigen Gültigkeiten und Variablen können Inhalte systematisch ausgewählt und zusammengestellt werden. So kann ein Modul vielfach wiederverwendet werden, auch wenn sich einige Details je nach Variante des beschriebenen Produkts ändern.
  • Fremdsprachenmanagement: Der Übersetzungsprozess kann direkt aus dem Redaktionssystem heraus angestoßen werden. Die übersetzten Module können wiederum zurückgespielt und direkt im Redaktionssystem verwaltet werden. So muss für einmal übersetzte Module keine neue Übersetzung beauftragt werden.
  • Vielfältige Automatismen bei der Texterstellung: Einige praktische Hilfestellungen bieten die meisten Redaktionssysteme von Haus aus, z. B. Rechtschreibprüfung oder Hinweise zu ähnlichem, bereits erfassten Inhalt. Einige andere lassen sich über entsprechende Schnittstellen realisieren, z. B. Terminologieprüfung.
  • Automatischer Datenimport und -export: Bilder, Produktdaten, Metadaten etc. – je nach angebundenen Systemen lassen sich verschiedene Datenströme realisieren. Auch fertiggestellte Dokumente können automatisiert publiziert und z. B. an ein ERP-System oder eine Druckerei übermittelt werden.

Ab wann lohnt sich die Anschaffung eines Redaktionssystems?

In Management-Runden werden wir gern nach dem Return on Invest (ROI) für ein Redaktionssystem für die Technische Dokumentation gefragt. Das lässt sich natürlich schwer generalisieren und kommt immer auf die konkrete Situation an.

Bei der Berechnung des ROI stehen sich Gewinn und Kapitaleinsatz gegenüber.
Zum Kapitaleinsatz gehören die Lizenzkosten, die Stylesheeterstellung und die Einarbeitung der Mitarbeiter:innen. Je nach Bedarf kommen noch Migrationsaufwände, Übersetzungsthemen und Schnittstellenentwicklungen hinzu.
Der Gewinn liegt im Einsparpotenzial. Man muss sich also zunächst über die aktuellen Kosten im Bereich der Technischen Dokumentation klar werden, allen voran den Personalkosten. Konservativ geschätzt verbringen Mitarbeiter:innen in der Technischen Dokumentation 70 % der Arbeitszeit mit Dateiverwaltung, Inhaltserstellung, Formatierung und ähnlichen Tätigkeiten. Dabei unterstützt ein Redaktionssystem unmittelbar und gewährleistet eine Zeitersparnis von rund 65 % in den genannten Bereichen.
Ergänzend muss noch der prognostizierte Dokumentations- und Medienzuwachs in die Rechnung einfließen.

Am Ende kann man also sagen, je mehr Mitarbeitende und je mehr Dokumentationsbedarf, desto höher sind die Kosten für die Technische Dokumentation und desto eher lohnt sich ein Redaktionssystem. Grob über den Daumen gepeilt: Bei vier Vollzeitmitarbeiter:innen rentiert sich ein Redaktionssystem oft schon nach einem Jahr. 

Wie finde ich das passende Redaktionssystem für die Erstellung meiner Technischen Dokumentation?

Die oben genannten zentralen Funktionen werden mehr oder minder von allen gängigen Redaktionssystemen bereitgestellt oder unterstützt. Darüber hinaus unterscheiden sich die Redaktionssysteme je nach Anbieter in ihrem Funktionsumfang stark. Unterschiede liegen z. B. in folgenden Bereichen:

  • Installation (cloudbasiert oder on-premises)
  • Lizenzart (Einzelplatzlizenzen oder Floating-Modell)
  • Art der verwendeten XML-DTD
  • Grafische Unterstützung des Editors (WYSIWYG oder Syntax-Ansicht)
  • Möglichkeiten für Strukturvorgaben und Dokumentenkonfiguration
  • Granularität und Konzept der Metadatenverwaltung
  • Vordefinierte Schnittstellen

Außerdem bringen manche Hersteller bereits vollintegrierte Publikationsportale (Content-Delivery-Portale), E-Learning-Lösungen oder auch Tools zur Erstellung von Risikobeurteilungen mit. Auch so etwas kann ein Kriterium sein.

Die Antwort auf die Frage nach dem passenden Redaktionssystem kann nun also eher einfach sein, z. B. wenn das System ausschließlich auf Web-Technologien setzen soll, oder recht kompliziert werden, wenn es um nicht so offensichtliche Features z. B. für die Automatisierung von Publikationsstrecken geht. Das reine "Abklappern" einer Funktionsliste ist hier nicht der Weisheit letzter Schluss, denn viele Redaktionssysteme lassen sich individuell anpassen. Vor dem Entscheidungsprozess steht also immer eine genaue Anforderungsanalyse, wobei technische Aspekte genauso wie redaktionelle Prozesse beleuchtet werden müssen.

Welche Nachteile hat ein Redaktionssystem für die Technische Dokumentation?

Natürlich haben Redaktionssysteme nicht nur Vorteile. Bei den Nachteilen stehen an erster Stelle ganz klar die Anschaffungskosten und die aufwändige Einführung. Dazu gehört nicht nur die Einrichtung und Einarbeitung. Ein Modularisierungskonzept wird benötigt und bei den meisten Redaktionssystemen ist es sinnvoll, von Anfang an auch mit einem durchdachten Metadatenkonzept zu arbeiten. Will man Altdaten ins Redaktionssystem integrieren, kann das den Datenbestand gehörig umkrempeln und natürlich in mancherlei Hinsicht ein Umdenken erfordern. Bis dann die angekündigte Zeitersparnis erreicht ist, kann es schon einige Zeit dauern.
Die gute Nachricht: Mit einem erfahrenen Partner an der Seite und der richtigen Strategie lassen sich diese Aufgaben schneller und leichter umsetzen. Als Full-Service-Dokumentationsdienstleister unterstützen wir unsere Kunden bei allen strategischen und operativen Anforderungen rund um das Thema Redaktionssystem – von der Konzeption über die Implementierung bis hin zum Support im aktiven System.

Was kostet ein Redaktionssystem für die Technische Dokumentation?

Zur groben Kosteneinschätzung lässt sich festhalten: Ein vollständiges System mit Installation on-premises kostet ca. zwischen 10.000 und 30.000 € pro Lizenz. Für weitere Lizenzen gibt es oft einen Staffelpreis. Hinzu kommen Stylesheets, Anpassungen, Plug-ins und Schnittstellenanbindungen sowie die jährlichen Wartungskosten, die sich i. d. R. auf etwa 20 % der Gesamtkosten belaufen. Alternativ bieten einige Hersteller auch Subscription-Modelle an. Dabei tauscht man die hohen Anschaffungskosten gegen moderate monatliche Gebühren ein. Schlussendlich fallen noch die Kosten für die Einrichtung und Schulung an sowie die internen Kosten.

Wie nehme ich ein Redaktionssystem in Betrieb?

Nach Auswahl und Kauf steht als nächstes die Installation an. Ist das geschafft, folgt die administrative Einrichtung mit Nutzerverwaltung und Rollen- und Rechtesystem sowie die inhaltlich-strukturelle Konzeption und Einrichtung. Dazu gehört das Anlegen von Dokumentstrukturen, Ablagesystemen und Metadaten. Und schließlich die Schulung der Mitarbeiter:innen im System, aber auch in der neuen Arbeitsweise. In größeren Redaktionen empfiehlt es sich, hier gestaffelt vorzugehen: zunächst eine Schulung in rein technischen Aspekten, dann eine Workshopreihe, in der gemeinsam neue Konzepte und Prozesse festgelegt werden, z. B. ein Modularisierungskonzept, Prozesse rund um die Metadatenvergabe, Regeln zum Statuswechsel etc. Und schließlich noch eine Vertiefungsschulung, in der es um Feinheiten im System auch in Hinblick auf die neuen Prozesse geht.

Sollen Schnittstellen und Anpassungen eingerichtet werden, sind auch dazu noch Arbeitsschritte nötig.

Oft folgt als vorerst letzter Schritt die Migration von Bestandsdaten. Mitunter ist dieser Schritt teilautomatisiert möglich. Will man aber Bestandsdaten auch für neue Dokumente wiederverwenden, müssen diese ebenfalls an die neue Erstellstruktur angepasst werden. Modularisierung und Bedatung sind dann oft zumindest in Teilen Handarbeit, in Teilen gibt es aber auch hier bereits Tools, die unterstützen können.

Wie unterstützt kothes bei der Einführung eines Redaktionssystems?

Egal wie Ihre konkrete Fragestellung rund um Redaktionssysteme aussieht: Wir können weiterhelfen – umfassend und kompetent. Dabei kommt es nicht darauf an, ob Sie eine große Redaktion mit 20 oder mehr Redakteur:innen oder ein Zweierteam sind. Wir kennen alle gängigen Redaktionssysteme, sind Experten in der redaktionellen Praxis und zudem führend in der Anpassung von Redaktionssystemen.

Konkret können wir Sie z. B. in den folgenden Bereichen unterstützen:

  • Anforderungsmanagement: Wir helfen Ihnen ergebnisorientiert bei der Bedarfsanalyse.
  • Systemvergleich und Auswahl: Wir begleiten Sie unabhängig durch den gesamten Auswahlprozess und setzen uns direkt mit den Anbietern in Verbindung.
  • Systemverkauf: Ausgewählte und bewährte Systeme können Sie direkt über uns kaufen. Dazu gehören z. B. COSIMA go! von DOCUFY, SCHEMA ST4 von Quanos oder auch der Smart Media Creator von Expert Communication Systems.
  • Einführung und Schulung: Wir unterstützen Sie in der gesamten Einführungsphase und können in einigen System auch selbst die Schulungen vornehmen, sodass Sie alles aus einer Hand erhalten. 
  • Redaktionelle Unterstützung in der Migrationsphase: Wir unterstützen Sie nicht nur bei der konzeptionellen Arbeit, sondern können z. B. auch in der Migrationsphase anfallende Arbeitslast direkt abfangen.
  • Support: Bei einigen Systemen können wir direkt den Support auf Level 1 und 2 übernehmen sowie Stylesheets und Schnittstellen entwickeln.

Natürlich unterstützen wir Sie gern im gesamten Prozess, aber auch bei einzelnen Schritten. Dabei achten wir stets darauf, individuelle und praktikable Lösungen zu finden, die punktgenau zu Ihren Anforderungen passen.

Sprechen Sie uns gerne direkt an.

 

Stefanie Langmann
Author:
Blog post Stefanie Langmann
Newsletter Abonnieren

Newsletter abonnieren

Abonnieren Sie unseren kothes Newsletter und Sie erhalten regelmäßig E-Mails zu aktuellen Themen, Veranstaltungen und Seminaren.

NEWSLETTER ABONNIEREN