Redaktionssysteme für die Technische Dokumentation einführen

Redaktionssystem für die Technische Dokumentation. So arbeiten wir

• Anforderungen bestimmen. Wir analysieren und dokumentieren Ihre Anforderungen an die Erzeugung, Verwaltung und Auslieferung von Nutzungsinformationen.
• Herstellerübergreifend beraten. Wir beraten Sie herstellerübergreifend bei der Auswahl eines für Sie geeigneten Redaktionssystems und begleiten Sie bei der Einführung.
• Inhalte standardisieren. Wir standardisieren und modularisieren Ihre Dokumentationsinhalte, d. h. erarbeiten die passende Informationsarchitektur für das neue Redaktionssystem und setzen das erarbeitete Variantenmanagement und Modularisierungskonzept um.
• Altdaten migrieren. Bei Bedarf unterstützen wir Sie bei der Migration oder Umstrukturierung Ihrer Bestandsdokumentation.
• Schulen. Wir schulen und unterstützen Ihr Redaktionsteam und erarbeiten bzw. überarbeiten Redaktionsleitfäden. Mehr erfahren.

Weitere Informationen rund um das Thema Redaktionssysteme finden Sie auch in unseren FAQs.

FAQs – Häufig gestellte Fragen zum Thema Redaktionssysteme für die Technische Dokumentation

Was ist ein Redaktionssystem für die Technische Dokumentation?

Ein Redaktionssystem (CCMS) verwaltet modulare Inhalte und Medien für die Technische Dokumentation in einer Datenbank, zumeist in einem strukturierten Format wie XML. Inhalte, Layout und Metadaten werden getrennt gesteuert. Ein Redaktionssystem bietet u. a. Funktionen für Workflows, Übersetzungsmanagement, Terminologiekontrolle, Variantenmanagement, Versionierung sowie Rollen- und Rechteverwaltung.

Was sind die wichtigsten Vorteile eines Redaktionssystems ?

Vom Einsatz eines Redaktionssystems  profitieren Ihre Technische Redaktion, Ihr gesamtes Unternehmen und natürlich Ihre Kundschaft. Hier sind die wichtigsten Vorteile:

• Wiederverwendung und Variantenmanagement: Sie erstellen Inhalte nur einmal und verwenden Sie an verschiedenen Stellen wieder. Beispiele sind Warnhinweise oder die Beschreibung von Produktfunktionen. Innerhalb der Inhaltsmodule können Sie zwischen den Inhaltsvarianten für verschiedene Produktvarianten unterscheiden.
• Ausgabe in verschiedenen Kanälen (Single-Source-Publishing oder Omni-Channel-Publishing): Sie erstellen die Dokumentation in einer Quelle und geben Sie in verschiedenen Kanälen und Medien aus: einem Webportal, einer Online-Hilfe, als PDF oder in einer App.
• Kollaboratives Arbeiten und standardisierte Inhalte: Einheitliche Inhaltsstrukturen, integrierte Vorlagen und Textregeln sorgen dafür, dass Ihr Redaktionsteam gemeinsam konsistente Inhalte erstellen kann.
• Übersetzungsmanagement: Ein Redaktionssystem verwaltet die Sprachvarianten Ihrer Dokumentation. Sie sehen auf einen Blick, welche Inhalte bereits übersetzt sind. Viele Redaktionssysteme bieten Schnittstellen zu Translation-Memory- oder Machine-Translation-Systemen, sodass Sie Übersetzungsworkflows und die Zusammenarbeit mit externen Dienstleistern abbilden können.

Welche Redaktionssysteme  empfehlen Sie?

Wir beraten Sie herstellerübergreifend bei der Auswahl eines für Sie geeigneten Redaktionssystems . Entscheidend für die Wahl eines Systems sind immer Ihre Anforderungen. Nachstehend finden Sie eine Auswahl von Systemen (in alphabetischer Reihenfolge), mit denen wir bereits in Kundenprojekten gearbeitet haben:

Beispiele für Redaktionssysteme/CCMS

• Adobe Experience Manager
• COSIMA (docufy)
• Docuglobe und XR/Engineering (gds)
• Empolis Content Lifecycle Manager
• IXIA CCMS
• Schema ST4
• Smart Media Creator
• Tridion Docs von RWS

Was ist der Unterschied zwischen CMS und CCMS?

Ein CMS ist ein Content-Management-System, also ganz allgemein ein System zur Verwaltung von digitalen Inhalten. CMS gibt es u. a. für Zeitschriften, Publikationen oder Websites.

Das CCMS steht für Component-Content-Management-System. Bei einem CCMS sind die Inhalte, die verwaltet werden, modular. Also eher Topics (components) als Dokumente. Die Topics können frei kombiniert und zu Dokumenten zusammengestellt werden. Der Begriff CCMS ist die englische Entsprechung des deutschen "Redaktionssystems" im Bereich Technische Dokumentation.

Wann sollte ich ein Redaktionssystem für meine Technische Dokumentation einführen?

Für das Einführen eines Redaktionssystems sprechen viele Gründe, unter anderem:

• Kollaboration: Wenn es mehrere Redakteur:innen oder mehrere Redaktionsteams gibt, die parallel und gemeinsam an Dokumentation arbeiten, ggf. sogar an verschiedenen Standorten.
• Viele Inhalte: Wenn Sie umfangreiche Inhalte haben, die aus vielen einzelnen Modulen bestehen, kann Ihnen ein Redaktionssystem dabei helfen, diese Inhalte zu organisieren.
• Variantenmanagement und Wiederverwendung: Wenn Sie eine hohe Variantenvielfalt in der Dokumentation und einen hohen Wiederverwendungsbedarf von Inhalten haben.
• Lokalisierung: Wenn Ihre Dokumentation in viele Sprachen übersetzt wird, unterstützt ein Redaktionssystem beim Übersetzungsmanagement.
• Workflow-Steuerung: Wenn Sie die Workflows zur Erstellung, Prüfung, Freigabe und Publikation genau steuern möchten.
• Schnittstellen: Wenn Sie Inhalte über Schnittstellen automatisch in Ihre Technische Dokumentation integrieren möchten, z.B. aus einem Produktinformationsmanagementsystem (PIM) oder Ersatzteilkatalog.
• Layout: Wenn Sie die Formatierung Ihrer Inhalte konsistent halten möchten. Vorlagen in einem Redaktionssystem gewährleisten ein einheitliches Layout.

Einige dieser Anforderungen können auch durch andere Systeme realisiert werden, z. B. durch eine Kombination aus einem XML-Editor wie Oxygen, einem Versionskontrollsystem wie Git und einem Issue-Tracking-System wie JIRA. Erfahren Sie mehr darüber in unserer Leistung Dokumentation automatisieren mit Docs-as-code.