Mit einem modernen Redaktionssystem erstellen Redakteure die Technische Dokumentation schneller und fehlerfreier als auf manuellem Wege. Der Markt bietet inzwischen eine große Auswahl verschiedener Lösungen. Die meisten davon basieren auf Word oder XML. Doch welche Technologie eignet sich für das eigene Unternehmen am besten?

Bei der Wahl des Redaktionssystems stehen Technische Redakteure vor einer Grundsatzfrage: Bevorzugen sie ein System auf Basis von Word oder XML? Ein Word-Redaktionssystem bietet die obligatorischen Vorzüge einer modernen Softwarelösung für die Technische Dokumentation, indem es Dokumente als Summe einzelner Module betrachtet. Dazu legt der User mit dem Word-Redaktionssystem eine Auswahl an Stammmodulen an. Aus diesen setzt er schließlich Baustein für Baustein ganz bequem seine Technische Dokumentation zusammen. Ändern sich nun als Folge einer Produktweiterentwicklung einzelne Elemente der Dokumentation, kann der Anwender in den Stammdaten die entsprechenden Stellen überarbeiten. Das System übernimmt die Änderungen nun vollständig automatisiert für alle betreffenden Bereiche innerhalb des Gesamtdokuments. Dadurch schließt ein Word-Redaktionssystem die sogenannten Copy-and-Paste-Fehler aus, die selbst routinierten Redakteuren bei händischen Änderungen schnell unterlaufen können. Zudem ist das manuelle Abändern ein wahrer Zeitfresser. Gerade bei umfangreichen Dokumenten können zahlreiche Stellen von einer einzigen Überarbeitung betroffen sein. Kurzum: Das Word-Redaktionssystem spart Zeit und hilft dabei, Fehler zu vermeiden.

DAS XML-REDAKTIONSSYSTEM – DIE VORTEILE DER DIGITALEN WELT

All diese Vorzüge bietet auch ein XML-Redaktionssystem. Es unterteilt die Technische Dokumentation ebenfalls in einzelne Informationsmodule, so dass bereits ein Handgriff in den Stammmodulen ausreicht, um in den zugehörigen Gesamtdokumenten automatisiert alle betreffenden Stellen anzupassen. Darüber hinaus eröffnen sich dank der XML-Basis viele weitere Funktionen.

XML ist eine Sprache zur Auszeichnung von Daten und Informationen. Dadurch können Dokumentationen mit einem XML-Redaktionssystem leicht fit für die digitale Welt gemacht werden. Das Publizieren einer Dokumentation in vielen verschiedenen Ausgangsformaten wie PDF, E-Book oder auch als reine Online-Quelle ist komfortabel möglich. Der große Vorteil: Dokumentationen, die mit einem XML-Redaktionssystem erstellt wurden, können von den Anwendern mit verschiedenen Endgeräten wie dem Desktop-PC oder auch mobil via Tablet abgerufen werden.

Hierdurch entstehen zahlreiche Möglichkeiten, die sich gut am Beispiel von XR/Airline aufzeigen, einem neuen XML-Redaktionssystem speziell für die Anforderungen der Luftfahrt. XR/Airline erlaubt es Usern, Dokumentationen zu öffnen, die auf ihre Benutzerrolle zugeschnitten sind. Piloten erhalten zum Beispiel nur die technischen Informationen, die sie benötigen. Gleiches gilt für die Kabinenbesatzung. Denkbar wären in einem anderen Branchenkontext, beispielsweise im Maschinen- und Anlagenbau, aber auch Benutzerrollen wie Wartungstechniker und Endanwender.

Da die Ausgangsformate digital sind, können die User zudem eine bequeme Volltextsuche oder auch ein Stichwortverzeichnis nutzen. Mühsames Blättern entfällt. Insbesondere bei umfangreichen Betriebsanleitungen oder Usermanuals ist es außerdem schlichtweg komfortabler, ein leichtes Tablet mit sich zu führen und nicht ein schweres Handbuch tragen zu müssen. Außerdem lassen sich die Dokumentationen mit einem XML-Redaktionssystem leicht aktualisieren, wohingegen dies in Papierform natürlich undenkbar ist. Einmal gedruckt, ist das Dokument in seiner Gestalt fixiert. Ändern sich aber – um beim Beispiel der Luftfahrt zu bleiben – Sicherheitsrichtlinien für einen bestimmten Flugzeugtyp, kann der Redakteur die entsprechenden Überarbeitungen vornehmen und die aktualisierten Dokumente für diesen konkreten Maschinentypus an alle betroffenen User ausspielen.

WORD-REDAKTIONSSYSTEM VS. XML-REDAKTIONSSYSTEM – EINE KLARE SACHE?

Auf den ersten Blick mag das XML-Redaktionssystem als klarer Sieger aus dem Vergleich hervorgehen – immerhin bietet es mit weiterführenden Funktionen und zahllosen Möglichkeiten des Publizierens ein großes Spektrum an Vorteilen, die ein Word-Redaktionssystem nicht bietet. Doch hier liegt auch der zentrale Nachteil der XML-Vertreter: Ihr enormer Funktionsumfang muss zunächst einmal gehandhabt werden. Zwar bieten moderne Systeme wie die XR-Familie einen Editor, so dass der Technische Redakteur XML nicht beherrschen muss, dennoch sind die Systeme äußerst komplex. Dem gegenüber stehen die schlankeren Word-Redaktionssysteme wie etwa docuglobe von gds. Sie bieten ebenfalls alle Funktionen, die ein Technischer Redakteur für eine effiziente und fehlerfreie Technische Dokumentation benötigt.

Das entscheidende Kriterium bei der Frage, ob Word oder XML, ist der konkrete Anwendungsfall. Weniger komplexe Technische Dokumentationen lassen sich effizient mit einem Word-Redaktionssystem erstellen. Zudem profitieren Anwender bei der Wahl eines Word-Redaktionssystems davon, dass sie durch die Word-Basis in einer gewohnten Arbeitsumgebung tätig werden können. Für komplexere Dokumentationen empfiehlt sich allerdings ein XML-Redaktionssystem. Es bietet schlichtweg mehr Möglichkeiten, indem es die Technische Dokumentation als digitale Ressource publiziert. Dadurch sind Suchfunktionen und Rollenprofile sowie weitere Differenzierungen umsetzbar. Neben dem Faktor Komplexität bieten sich auf XML-Seite aber auch Vorzüge bezüglich der Aktualität: Mit einem XML-Redaktionssystem erstellte Dokumentationen können, da sie als digitale Quelle vorliegen, jederzeit aktualisiert und den Usern erneut zur Verfügung gestellt werden. Dies ist besonders für Branchen interessant, deren Sicherheitsrichtlinien sich rasch ändern beziehungsweise, bei denen die Aktualität einer Dokumentation eine entscheidende Rolle spielt.