Ist die Arbeit mit einem XML-Redaktionssystem wirklich einfacher?

Veröffentlicht: 10.04.2019 Aktualisiert: 16.04.2024

Redaktionssystem einführen, ja oder nein? Dieser oft schon fast philosophischen Frage wollen wir uns heute mal ganz konkret nähern. Stellen Sie sich zwei Redakteure vor, die geme

Ist die Arbeit mit einem XML-Redaktionssystem wirklich einfacher?

Redaktionssystem einführen, ja oder nein? Dieser oft schon fast philosophischen Frage wollen wir uns heute mal ganz konkret nähern. Stellen Sie sich zwei Redakteure vor, die gemeinsam in einem Team in einem mittelständischen Unternehmen arbeiten. Nennen wir sie Thomas und Kathrin. Beide sind jeweils verantwortlich für die Dokumentation einer Baureihe von Waschmaschinen. Der Unterschied: Thomas erstellt seine Bedienungsanleitungen noch per Hand in Word, Kathrin nutzt stattdessen ein XML-Redaktionssystem.

Begleiten wir die beiden einmal bei ihrer täglichen Arbeit. Wo genau liegen die Unterschiede in ihren jeweiligen Arbeitsweisen mit und ohne XML-Redaktionssystem? Gibt es überhaupt so große Unterschiede?

Neuer Input für die Anleitungen

In einer Besprechung erhalten Thomas und Kathrin von ihren Produktmanagern ihr Briefing:

  • Eine Reihe von Waschmaschinen wurde um eine Funktion zur Tierhaarentfernung erweitert. Die Anleitungen müssen entsprechend aktualisiert werden: davon sind einige Texte und Grafiken betroffen.
  • Anschließend müssen die Anleitungen freigegeben und ins Englische übersetzt werden.
  • Ausgabeformate sind zwei Print-Formate: Eine inhaltliche Maximal-Variante im Format A5 und eine inhaltlich reduzierte Variante für eine zweiseitige Kurzanleitung im Format A4. Und das jeweils pro Sprache.

Schauen wir uns erst einmal Thomas Vorgehensweise an, der Word verwendet.

Die tägliche Redakteursarbeit ohne Redaktionssystem - Sisyphos aus Leidenschaft?

Texte erstellen

Thomas setzt sich an seinen Rechner, öffnet den Ordner, in dem der bisherige Stand der Anleitung als Word-Datei abgelegt ist und die entsprechenden Grafiken, die geändert werden müssen. Bevor er mit dem Schreiben beginnt, legt er eine Sicherungskopie an. Dann durchsucht er das gesamte Dokument von oben nach unten nach zu aktualisierenden Abschnitten und beginnt außerdem damit, auch neue Inhalte einzupflegen.

Die Bedienungsanleitungen qualitätssichern, freigeben und übersetzen

Nach der Erstellung gibt Thomas die Inhalte weiter zur Qualitätssicherung und fachlichen Freigabe. Kathrin hat gerade Zeit und prüft die Doku für Thomas auf redaktionelle Richtigkeit, damit Formate und Formulierungen einheitlich verwendet werden. Die Produktmanager prüfen die Inhalte daraufhin auf fachliche Richtigkeit und schreiben Änderungswünsche in die Word-Datei.

Thomas kann dann seine Bedienungsanleitungen freigeben: Dazu lässt er ein Formular von den fachlich Verantwortlichen unterschreiben und speichert eine aktuelle Version der Datei auf dem Laufwerk. Die Datei sendet er anschließend zur Übersetzung ins Englische an die externe Übersetzungsagentur. Aus den übersetzten Inhalten muss er nun händisch die Kurzversion für die A4-Variante zusammenstellen - eine Arbeit, die einen weiteren QS-Aufwand nach sich zieht.

Publikation der Bedienungsanleitung

Thomas fehlt jetzt nur noch das Layout für die verschiedenen Ausgabeformate. Er hat alle Inhalte der A5-Variante für Deutsch und Englisch in je einer Word-Datei ohne Layout-Anpassungen erfasst. Er muss also noch Layouts für die deutsche und englische A5-Variante erstellen. Mit den Kurzanleitungen in A4, ebenfalls jeweils auf Deutsch und Englisch, kommen noch einmal 2 Dateien dazu. Also 4 Layouts, die er manuell unter Berücksichtigung der Unternehmens-Layouts erstellen muss. Das kostet richtig viel Zeit. Zu guter Letzt gibt Thomas die Anleitungen zur letzten Kontrolle an seinen Produktmanager und damit zur offiziellen Freigabe.

 

Sie sind auf der Suche nach einem Redaktionssystem? Unsere Whitepaper zum Thema helfen weiter! Klicken Sie auf diesen Banner, um mehr über unsere Whitepaper zu erfahren.

 

Die tägliche Redakteursarbeit mit einem Redaktionssystem - Mehr Verwaltung als Redaktion?

Texte erstellen

Nach der Besprechung mit dem Produktmanager über die neue Funktion der Waschmaschinen geht Kathrin an ihren Arbeitsplatz und öffnet an ihrem Rechner das XML-Redaktionssystem, in das sie vor einer Weile ihre Dokumentationen migriert hat. Seitdem erstellt sie Inhalte nur noch damit. Da ihre Daten seit der Umstellung auf einem Server liegen und sie alles, was zu einem bestimmten Stand gehört, versioniert, sind alte Versionen immer wieder auffindbar - sie braucht keine Sicherungskopien.

In einem XML-Redaktionssystem werden Dokumente erst bei der Produktion erstellt. Vorher sind einzelne Sinneinheiten des Dokuments als sogenannte Module, Knoten oder Bausteine im System angelegt. Auf diesem Weg kann man dieselben Textbausteine für unterschiedliche Anwendungsfälle beliebig zusammenstellen.

Um die Inhalte zu aktualisieren, öffnet Kathrin also lediglich den entsprechenden Text- oder Grafik-Baustein und ergänzt dort die Informationen zur neuen Funktion. Das macht sie genau einmal, weil sie die Bausteine wiederverwenden wird, und verzichtet so auf leidiges Copy & Paste. Sie vergibt gleich noch ein paar Metadaten an ihre neuen Inhalte, z. B. für welche Arten von Waschmaschinen der Inhalt gültig ist, um später Inhalte, die für einen bestimmten Typ Waschmaschine nicht gelten, herausfiltern zu können.

Die Bedienungsanleitungen qualitätssichern, freigeben und übersetzen

Nachdem sie die neuen Inhalte eingepflegt hat, startet Kathrin im Redaktionssystem eine automatische Prüfung von Satzstrukturen und Absatz-Formaten durch Schematron-Regeln, die sie selbst definiert hat. Währenddessen kontrolliert sie ganz nebenbei die Bedienungsanleitung von Thomas. Für die fachliche Prüfung schickt sie ihrem Produktmanager einen Link auf die aktualisierten und neuen Inhalte im Redaktionssystem. Der liest diese - und nur diese, weil alle anderen bereits in einer vorherigen Version freigegeben wurden - und kommentiert direkt in den Bausteinen. Nach der Korrektur kann Kathrin die Bedienungsanleitung im aktuellen Zustand freigeben.

Als nächstes steht die Übersetzung ins Englische an. Dafür macht Kathrin einen TMS-Export aus dem Redaktionssystem und schickt ihn an die Übersetzungsagentur. Darin befinden sich nur noch nicht übersetzte Inhalte, was Zeit und Kosten spart. Die fertige Übersetzung kann Kathrin über einen TMS-Import wieder ins Redaktionssystem zurückspielen. Dabei werden übersetzte Inhalte automatisch wieder mit den Inhalten der Ausgangssprache verknüpft.

Publikation der Bedienungsanleitung

Nun erstellt Kathrin aus den Text- und Grafikbausteinen eine Struktur für die Maximal-Variante in A5 und aus denselben Bausteinen eine weitere für die abgespeckte Variante in A4, in der nur die wichtigsten Inhalte zu finden sind. So weiß das System, welche Inhalte für welche Variante an welcher Stelle stehen müssen. Die Layouts für die beiden Varianten hat Kathrin fest definiert. Sie werden bei der Produktion automatisch auf die Inhalte und Strukturen angewendet, sodass sich Kathrin darüber gar keine Gedanken machen muss.

Für die englischen Dokumente muss Kathrin nur die Sprache umstellen und klickt daraufhin erneut auf Produzieren.

Mit oder ohne Redaktionssystem - das ist hier die Frage

Auch wenn das Ziel ihrer Arbeit und die Informationsbeschaffung gleichbleiben: Die Arbeitsweisen der beiden Redakteure haben nur noch wenige Gemeinsamkeiten. Bereits ab dem Moment, in dem Thomas und Kathrin die Inhalte neu erstellen, gehen sie unterschiedlich vor. Bei der Arbeit ohne Redaktionssystem haben Redakteure zwar mehr Freiheiten, können aber auch bei all den manuellen Prozessen sehr viel Zeit verlieren - besonders bei der Arbeit im Team.

Im XML-Redaktionssystem sieht die Welt ganz anders aus: Bei Kathrin ist das Layout einmal erstellt und daraufhin bei jeder Produktion wiederverwendbar, sie wird in der Qualitätssicherung und im Übersetzungsmanagement vom System unterstützt.

Wenn Sie mehr über die Vorteile eines XML-Redaktionssystems erfahren möchten, besuchen Sie uns auf unserer Webseite für weitere Informationen oder kostenlose Webinare.

Andere Artikel von Quanos

Das könnte Sie auch interessieren

Agile Dokumentation in der Software-Entwicklung

Agile Entwicklungsprozesse sind im Software-Bereich seit einigen Jahren State of the Art. Aber wie sieht es eigentlic…

Technische Dokumentation: die wichtigsten Normen und Standards

Ein Wort vorab: Von außen lässt sich nie sagen, welche Normen und Standards für eine Technische Redaktion relevant si…

Terminologie am Start

Für viele Unternehmen ist systematische Terminologiearbeit noch ein Buch mit sieben Siegeln. Doch es lohnt sich, dies…