Diese Software-Systeme sollten Technische Redakteure kennen

Veröffentlicht: 09.07.2024 Aktualisiert: 10.07.2024

Ein Redaktionssystem nimmt der Technischen Dokumentation eine Menge Arbeit ab. Ergänzt durch Systeme für Terminologie, Übersetzungen und Sprachkorrekturen können Redakteure zusätzlich Zeit sparen und die Qualität ihrer Dokumente erhöhen.

Ein Redaktionssystem erleichtert es Unternehmen, ihre technischen Dokumente zu erstellen, zu verwalten und zu veröffentlichen. Kann es mit Übersetzungsdienstleistern kommunizieren oder auf eine Terminologiedatenbank zugreifen, profitiert die Redaktion von diesen erweiterten Funktionalitäten. Ein Überblick über die wichtigsten Systeme in der Welt der Technischen Dokumentation.

 

CCMS: das Herzstück in der Technischen Dokumentation

Component-Content-Management-Systeme (CCMS) wie SCHEMA ST4 arbeiten mit Inhaltskomponenten oder anders ausgedrückt: in modularen Elementen wie Textbausteinen, Grafiken, Tabellen und Fotos. Ein Redakteur legt also kein Gesamt-Dokument für eine Betriebsanleitung an, sondern jedes Element steht zunächst für sich. Am Ende werden alle Inhalte zu einem Dokument zusammengefügt und ins Layout gebracht. Aufgrund des technischen Datenformats spricht man auch von XML-Redaktionssystemen.

Ein CCMS bietet folgende Vorteile:

  • Einmal erstellt lassen sich die Inhalte in unterschiedliche Formate ausgeben, zum Beispiel als PDF oder in HTML.
  • Die Bausteine können für verschiedenste Dokumente wiederverwendet werden.
  • Aktualisierungen sind sehr einfach möglich.
  • Es lassen sich Workflows festlegen, zum Beispiel für den Freigabeprozess.
  • Ein CCMS erleichtert die Teamarbeit in der Technischen Dokumentation.
  • Aufgaben können automatisiert werden.
  • Das Management von Übersetzungen gelingt leichter.
  • Ein CCMS lässt sich an andere Systeme anbinden, sodass Synergieeffekte entstehen und die Funktionalität steigt.

Insgesamt fördert es das effiziente Arbeiten in der Technischen Dokumentation und bedeutet eine hohe Zeitersparnis.

 

CCMS oder CMS? Das sind die Unterschiede

Sie bezeichnen ein Redaktionssystem in der Technischen Dokumentation als Content-Management-System (CMS)? Dann liegen Sie damit nicht falsch. Grundsätzlich ist ein CMS eine Softwareplattform, die darauf ausgelegt ist, dass Benutzer Inhalte erstellen, bearbeiten und veröffentlichen. In der Regel sind damit aber Web-CMS gemeint, also Plattformen, die die Erstellung und den Betrieb von Websites ermöglichen. Ein Beispiel ist die Open-Source-Software WordPress. Ein Component-Content-Management-System ist eine bestimmte Art von CMS. Es ist darauf ausgelegt, Inhalte modular zu behandeln und im Anschluss zur Veröffentlichung zusammenzustellen. Dadurch kann es sehr komplexe Aufgaben, wie sie in der Technischen Dokumentation anfallen, übernehmen.

 

Weitere wichtige Systeme in der Technischen Dokumentation

Translation-Memory-System: Übersetzungen effizient managen

Ein Translation-Memory-System (TMS) nutzen vorwiegend professionelle Übersetzer. Es zeichnet sich dadurch aus, dass in einer Datenbank Ausgangs- und übersetzte Texte gespeichert werden. Mithilfe dieser Software lässt sich erkennen, ob Textbausteine bereits übersetzt wurden. Das spart Zeit und Kosten. Die Software fördert außerdem die sprachliche Einheitlichkeit.

Das XML-Redaktionssystem SCHEMA ST4 können Sie an Übersetzungssysteme anbinden. Der Austausch von Texten mit Ihrem Übersetzungsdienstleister lässt sich auf diese Weise automatisieren, was Zeit und Aufwand spart. Sie haben stets einen aktuellen Überblick darüber, welche Texte bereits übersetzt wurden und welche Sprachversionen noch fehlen.

 

Terminologie-Management-System: für sprachliche Konsistenz

Mithilfe eines Terminologie-Management-Systems definieren Sie Bezeichnungen, die in Ihrem Unternehmen oder speziell in der Technischen Redaktion bevorzugt verwendet werden sollen. Auch verbotene Begriffe legen Sie in dieser Datenbank ab. Die Terminologie-Software dient aber nicht nur als Nachschlagewerk für eine einheitliche Unternehmenssprache. Mit ihrer Hilfe können Sie erstellte Dokumente auch überprüfen. In SCHEMA ST4 sind einige Werkzeuge zum Terminologiemanagement integriert. Für komplexere Aufgaben lassen sich spezialisierte Systeme anbinden.

 

Authoring-Memory-System: schneller schreiben mit der Autorenunterstützung

Ein Authoring-Memory-System zeigt einem Technischen Redakteur während des Schreibens an, ob ähnliche Sätze oder Formulierungen bereits in der Vergangenheit im CCMS angelegt wurden. In SCHEMA ST4 kann der Benutzer die erstellten Inhalte dann per Klick in sein neues Textelement übernehmen. Diese Funktion spart nicht nur Zeit beim Schreiben, sondern unterstützt auch die sprachliche Einheitlichkeit und reduziert Übersetzungskosten.

 

Controlled Language Checker: Fehlern auf der Spur

Idealerweise verlässt ein Text die Technische Redaktion fehlerfrei. Um Redakteure bei der Qualitätsprüfung zu unterstützen, bieten sich Controlled Language Checker (CLC) an. Sie prüfen folgende Aspekte:

  • Stilistik
  • Formale Vorgaben, zum Beispiel zu Satz- und Absatzlängen
  • Rechtschreibung und Grammatik
  • Terminologie

Verwenden Sie bei SCHEMA ST4 Microsoft Word als Editor, ist die Rechtschreib- und Grammatikprüfung von Office bereits mit an Bord. Weitere Tools lassen sich per Plug-in hinzufügen. Darüber hinaus können Sie einzelne Textbausteine oder Ihre gesamte Betriebsanleitung mit SCHEMA ST4 auf die Einhaltung bestimmter Regeln überprüfen lassen. Für umfangreichere Funktionalitäten können Systeme, die auf das Controlled Language Checking spezialisiert sind, eingebunden werden.

 

Fazit: Ein XML-Redaktionssystem lässt sich fast grenzenlos erweitern

Der Einsatz eines Component-Content-Management-Systems wie SCHEMA ST4 bietet schon für sich allein eine Reihe von Vorteilen, weil es mit vielen Funktionalitäten aufwartet und die Effizienz in der Technischen Dokumentation erhöht. Wer darüber hinaus spezialisierte Systeme, zum Beispiel für das Management von Übersetzungen benötigt, kann diese anbinden. So lässt sich ein Redaktionssystem entsprechend den eigenen Anforderungen erweitern. Darüber hinaus kann es sinnvoll sein, es mit anderen Systemen, die im Unternehmen genutzt werden, zu vernetzen, zum Beispiel dem Product Information Management. Auf diesen Aspekt gehen wir in einem weiteren Blogbeitrag ausführlich ein.

Andere Artikel von Quanos

Das könnte Sie auch interessieren

Die perfekte Technische Dokumentation

Die perfekte Technische Dokumentation

Perfekt ist natürlich niemand, auch keine Dokumentation. Aber man wird ja noch träumen dürfen. Wie sähe sie denn aus,…

1 – 2 – Callout! Grafikbeschriftung leicht gemacht

1 – 2 – Callout! Grafikbeschriftung leicht gemacht

Technische Dokumentation, das heißt meistens: Viele Bilder. Denn immer wieder muss man zeigen, welches Produktbestand…

Redaktionsleitfaden, Styleguide oder Redaktionshandbuch in der Technischen Redaktion

Redaktionsleitfaden, Styleguide oder Redaktionshandbuch in der Technischen Redaktion

Redaktionshandbuch, Styleguide, Schreibleitfaden – in fast jeder Technischen Redaktion gibt es ein oder mehrere Dokum…