Start : Online Magazin : Archiv : 1999 : Ausgabe Oktober/November : Eine Quelle

Eine Quelle für alle Formate und Sprachen

Von Martin Holzmann

Inhaltsübersicht:

• Unser Projekt: Die TC-Toolbox
• Ziele des Projektes und die Schlüsselelemente zu deren Erreichung
• Schlüsselelement SGML/XML
• Schlüsselelement Dokumentenmanagement-System (DMS)
• Schlüsselelement Translation Memories (TM)
• Schlüsselelement Adobe FrameMaker+SGML
• Der Clou: Die Konvertierung
• Wie arbeiten die Schlüsselelemente zusammen?
• Fazit
   

Cross-Media-Publishing oder auch Single-Source-Publishing sind Schlagworte, die in der technischen Dokumentation in letzter Zeit immer öfter zu hören sind. Dieser Beitrag zeigt ein Beispiel-Projekt, bei dem diese Schlagworte mit Leben gefüllt wurden: die TC-Toolbox von Ovidius für Schneider Automation, eine SGML/XML-basierte Lösung.

Dieses Projekt geht sogar noch einen Schritt weiter: Es integriert die Arbeitsschritte Erstellen – Übersetzen – Publizieren in verschiedenen Medien in einer Anwendung, so dass nahezu alle Aufgaben einer Dokumentationsabteilung in einer Prozesskette zusammengefasst sind.
 

Unser Projekt: die TC-Toolbox

Das Projekt TC-Toolbox (TC = Technical Communications) wurde von Schneider Automation mit dem Ziel gestartet, die Dokumentationserstellung zu rationalisieren und dabei den besonderen Anforderungen dieses Unternehmens gerecht zu werden.

Schneider Automation ist einer der international führenden Hersteller automatisierungstechnischer Produkte, mit Entwicklungs- und Fertigungsstandorten in Frankreich, den USA und Deutschland. Produktentwicklungen finden standortübergreifend statt; die technische Dokumentation muss sich diesen Randbedingungen anpassen und ebenfalls verteilt arbeiten.

Einige Besonderheiten des Unternehmens beeinflussen die Dokumentationserstellung zusätzlich:

• Die technische Dokumentation wird immer am Entwicklungsstandort erstellt. Entwicklungsprojekte sind über die Standorte hinweg verteilt, so dass Autoren aus drei Ländern mit der Erstellung der Dokumentation für ein Produkt beschäftigt sind. Jeder dieser Autoren arbeitet in seiner Muttersprache, so dass sogar zum gegenseitigen Korrekturlesen eine Übersetzung erforderlich ist. Dies bedingt aber auch, dass es zwischen den Autoren sehr genaue Absprachen und Regeln geben muss, wie die Dokumentation zu strukturieren ist, bis hin zum eigentlichen Schreibstil. Der Kunde soll nicht erkennen, dass es sich um das Werk von vielen Autoren handelt.
   
• Automatisierungstechnische Produkte bestehen aus Hard- und Software; erst die Gesamtheit ergibt das Produkt. Neben der herkömmlichen Papier-Dokumentation muss die Dokumentation als Windows-Hilfe zur Verfügung stehen, auch die Hardware-Dokumentation.
   
• Dokumentation im Bereich der Automatisierungstechnik ist ein äußerst langlebiges Gut, genauso wie die Produkte selbst. Schneider Automation gewährt viele Jahre lang Liefergarantien für Produkte und Ersatzteile, weit über den eigentlichen Vermarktungszeitraum hinaus. Hiervon ist natürlich auch die Dokumentation betroffen.

Die Dokumentation muss in verschiedenen Formaten zur Verfügung gestellt werden:

• in der gewohnten Buchform
• im HTML-Format
• als Windows Help und
• als HTML Help, dem Nachfolgeformat von Windows Help

All diese Formate sollen aus einem einzigen Quellformat generiert werden. Eine Mehrfacherstellung ist nicht praktikabel, da hierzu einerseits nicht die notwendigen Kapazitäten an Autoren vorhanden sind und andererseits Inkonsistenzen zwischen den verschiedenen Formaten zwangsläufig die Folge wären. Das Schlüsselelement hierfür ist SGML/XML.

Die meisten Standard-Publishing-Tools sind auf den einzelnen Autor zugeschnitten und unterstützen die Zusammenarbeit in einer Gruppe nur bedingt. Zusammenarbeit über Ländergrenzen hinweg ist bei diesen Tools nur durch den Austausch von Dateien möglich. Dass diese Dateien auch noch übersetzt werden müssen, bevor ein Autor an einem anderen Standort überhaupt in der Lage ist, sie zu verstehen, kommt noch erschwerend hinzu. Die Schlüsselelemente hierfür sind der Einsatz eines Dokumentenmanagement-Systems (DMS) und die Integration des Übersetzungsprozesses mit Hilfe von Translation Memories (TM).

Die unterschiedlichen Formate kennen unterschiedliche Methoden für Querverweise oder Hyperlinks. In einem Buch findet man z.B. einen Verweis wie “siehe Kapitel 5.3, Seite 128”, während man in einem der Online-Formate nur ein unterstrichenes Wort findet, das bei Anwahl direkt zu der gewünschten Textstelle führt.

Aber auch innerhalb der Online-Formate gibt es unterschiedliche Arten von Hyperlinks: HTML kennt z.B. nur den 1-auf-1-Link, ein unterstrichener Text führt also immer genau zu einem anderen Topic. Dagegen unterscheidet Windows Help zwischen Sprung und Popup (der Originaltopic bleibt angezeigt) und kennt zusätzlich noch den 1-auf-n-Link (ein Absprungpunkt liefert eine Auswahlliste von mehreren Zielen).

Ziel ist es, dass im Quelldokument ein Hyperlink nur ein einziges Mal gesetzt werden muss und dann jeweils passend umgewandelt wird. Auch muss die Integrität der Hyperlinks zwischen einzelnen Dokumenten gewährleistet sein. Wird z.B. ein Dokument gelöscht, auf das ein Hyperlink aus einem anderen Dokument besteht, muss eine passende Reaktion erfolgen. Das Schlüsselelement hierfür ist ein Dokumentenmanagement-System, das nicht nur Informationen über Dokumente verwaltet, sondern bis zu einem gewissen Grad auch deren Inhalt.

Jeder, der schon länger mit Dokumentationserstellung zu tun hat, kennt das Problem: Ein Handbuch, das vor einigen Jahren geschrieben wurde, soll überarbeitet werden. Nicht selten existieren die Programme, mit denen das Dokument ursprünglich erstellt wurde, nicht mehr. Mit etwas Glück lassen sich solche Dokumente dann in einem anderen Programm öffnen; in den meisten Fällen werden sie allerdings erheblich nachformatiert werden müssen. Doch auch der völlige Verlust der Daten ist möglich. Ein Ziel der TC-Toolbox ist, eben solche Risiken zu minimieren. Das Schlüsselelement hierfür ist SGML/XML.

Insbesondere die Online-Formate unterliegen einer ständigen Veränderung oder werden zum Teil ganz und gar ersetzt. Beispiele sind Windows Help und HTML Help oder der aufkommende Standard XML, der HTML ergänzen wird. Es sollte möglich sein, einmal erstellte Dokumente in neuen Formaten zu präsentieren, ohne diese zu überarbeiten. Das Schlüsselelement hierfür ist SGML/XML.

Langjährige Autoren verfügen über ein großes Maß an Erfahrung im Umgang mit Textverarbeitungs- und DTP-Systemen. Sie haben gelernt, mit diesen Systemen effizient zu arbeiten. Es ist nicht zumutbar und verringert die Produktivität erheblich, wenn sich die Benutzung eines Tools eher an Programmierern orientiert als an der gewohnten Arbeitsumgebung; es sollte leicht handhabbar sein. Das Schlüsselelement hierfür ist Adobe FrameMaker+SGML.

Abschließend ist noch ein Punkt zu berücksichtigen, der in manchem SGML/XML-Projekt der technischen Dokumentation vernachlässigt wird: Unterschiedliche Medien benötigen unterschiedliche logische Dokumentstrukturen, um ergonomische Kriterien zu erfüllen. Um dies zu erreichen, werden die Dokumente nicht von einem Format in ein anderes gefiltert, sondern sie werden konvertiert – und damit nicht nur formatmäßig verändert, sondern auch strukturell angepasst.
 

Seitenanfang

Schlüsselelement SGML/XML

SGML (= Standard Generalized Markup Language) ist ein in ISO 8879 festgelegter Standard, der eine Sprache beschreibt, mit der man Dokumentstrukturen definieren kann. Ein SGML-Dokument ist ein reiner ASCII-Text, in dem die einzelnen Textteile durch spezielle Auszeichnungen (Tags) markiert sind und der nach festen Regeln strukturiert ist. Diese Strukturregeln werden in einer eigenen Definitionsdatei festgelegt, der Document Type Definition (DTD). Das SGML-Dokument enthält keinerlei Hinweise auf seine optische Aufbereitung, ist also frei von Formatinformationen.

XML ist eine Untermenge von SGML, definiert durch das W3C Consortium, die für die Anwendung im Internet optimiert ist und Balast aus SGML beseitigt. Es ist sowohl als Quellformat als auch als zukünftiges Zielformat (im Web) nutzbar.

SGML/XML überführt geschriebene Informationen in Daten. Ein normaler Text in einem DTP-System ist eben nichts anderes als Text, der hier und da durch Formatinformationen optisch strukturiert wird. Will der Autor diese Formatierung ändern, so muss er dies von Hand durchführen.

Oftmals finden sich in solchen Texten allerdings auch noch Daten, die entweder aus einem anderen System übernommen oder aber in einem anderen Dokument wiederverwendet werden könnten. Die technischen Daten eines Produktes etwa könnten sowohl in einem Handbuch als auch in einem Katalog identisch sein. Da es in einer normalen Textverarbeitung allerdings nicht möglich ist zu erkennen, welcher Textausschnitt denn nun die technischen Daten sind, müssen diese für jede Anwendung wieder erfasst werden.

Mit SGML/XML wird dieses Problem gelöst: Jeder Text wird durch einen Tag identifiziert. Der Tag könnte in unserem Beispiel <Technische Daten> .... </Technische Daten> lauten. Jetzt ist auch innerhalb eines umfangreichen Dokuments zu erkennen, welcher Bereich die technischen Daten beschreibt.

Wie weit man bei der Aufspaltung in identifizierbare Textobjekte geht, hängt von der Anwendung ab, die man damit realisieren will. Diese Aufspaltung wird in der Document Type Definition festgehalten. Hier werden nicht nur alle Elemente definiert, die es in einem Dokument geben darf, das nach dieser DTD geschrieben worden ist, sondern es wird darüber hinaus die Reihenfolge definiert, in der diese Elemente auftauchen dürfen.

Aufgrund dieser Eigenschaften lassen sich SGML/XML-Dokumente mit Hilfe von darauf zugeschnittenen Programmen

• wie eine Datenbank abfragen
• beliebig umstrukturieren und
• problemlos und verlustfrei in andere Formate konvertieren

Als Standard sind SGML und XML zudem herstellerunabhängig. Im Markt gibt es die verschiedensten Tools, mit denen SGML Dokumente erstellt, manipuliert und publiziert werden können. Diese Tools können beliebig miteinander kombiniert werden, da alles, was diese Tools über ein Dokument wissen müssen, in der DTD enthalten ist. Die Dokumentbasis ist also optimal geschützt.

SGML/XML-Dokumente können vom Autor nur nach der in der DTD vorgegebenen Strukturregel erstellt werden. Abweichungen von dieser Struktur lassen SGML/XML-Editoren nicht zu (oder nur temporär in der Erstellungsphase). Autoren, die an einem Projekt an verschiedenen Standorten arbeiten, erstellen somit Dokumente, die zumindest strukturell zueinander passen. Dies bedeutet nicht, dass die Dokumente auch inhaltlich zueinander passen, hilft jedoch schon ein gutes Stück weiter. Es ersetzt allerdings nicht die intensive Zusammenarbeit von Autoren auch über Ländergrenzen hinweg.
 

Seitenanfang

Schlüsselelement Dokumentenmanagement-System (DMS)

Ein Ziel des Projektes war es, Dokumente in vielen unterschiedlichen Publikationen wiederverwenden zu können. Deshalb wurden die Dokumentationen in viele kleine SGML/XML-Dokumente zerlegt, die dann modular wieder zu einer Publikation zusammengefügt werden können. Dies erhöht allerdings die Anzahl der Dokumente erheblich. Ohne entsprechende Unterstützung geht der Überblick schnell verloren.

Die verteilte Arbeitsweise von Schneider Automation macht es zusätzlich erforderlich, dass Dokumente den Autoren aller Standorte zur Verfügung stehen. Auch hierfür ist ein DMS zwingend notwendig.

Das Dokumentenmanagement-System muss die folgenden Funktionen abdecken:

• Zugriff der Autoren zu den Dokumenten verwalten: Es muss sichergestellt sein, dass nicht mehrere Autoren gleichzeitig an einem Dokument arbeiten. Die Autoren müssen außerdem erkennen können, wer ein Dokument erstellt hat, Informationen über die Gültigkeit eines Dokuments erhalten etc.
   
• Versionen der Dokumente verwalten: Dokumente werden oftmals mehrfach überarbeitet, weil sich das Produkt ändert, das sie beschreiben. Die alten Versionen sind deswegen nicht ungültig, sie beschreiben nur eine andere Version des Produktes und müssen gegebenenfalls auch wieder publiziert werden können.
   
• Translation Memories dokumentbezogen verwalten: Verwaltung und Pflege der Translation Memories (TM) sind ohne die Einbindung in ein DMS mit erheblichem Aufwand verbunden. Werden Dokumente übersetzt, muss die automatische Vorübersetzung anhand der dazu passenden TM erfolgen. Nicht jede Übersetzung kann als Grundlage der Übersetzung eines beliebigen anderen Dokuments dienen; sie muss vielmehr entsprechend dem Themengebiet zugewiesen werden. Dies kann mit Hilfe des DMS automatisch erfolgen.
   
• Konsistenz der Querverweise zwischen Dokumenten sicherstellen: Querverweise setzen die Autoren zu einem Zeitpunkt, zu dem eine Publikation noch nicht fertiggestellt ist. Im Laufe der Erstellung können Dokumente, auf die Querverweise existieren, verändert oder gar gelöscht werden. Hier muss das DMS entsprechende Unterstützung bieten, die den Autor z.B. beim Löschen davor warnt, dass er nun ein Querverweisziel entfernt hat und nun auch noch ein anderes Dokument überarbeiten muss – nämlich das, von dem der Verweis ausging. Diese Funktion bedingt, dass das DMS nicht nur Informationen über ein Dokument hat, sondern auch den Inhalt eines Dokuments teilweise interpretieren kann.
   
• Zusammenstellung der Endprodukte unterstützen: Die einzelnen Module, aus denen sich eine Publikation zusammensetzt, müssen in einer Art Stückliste hierarchisch zusammengestellt werden. Diesen Vorgang muss das DMS unterstützen. In der Stückliste muss enthalten sein:
  -die Dokument-ID
  -die Dokumentversion
  -die Dokumentsprache
  Anhand dieser Stückliste kann die Publikation zu jedem Zeitpunkt wiederhergestellt werden.
   

Seitenanfang

Schlüsselelement Translation Memories (TM)

Im Bereich der technischen Dokumentation stellt nicht die komplette Neuübersetzung eines Dokuments den Normalfall dar, sondern das Nachübersetzen von Ergänzungen und Korrekturen an einem bestehenden Dokument. Hier wird beim herkömmlichen Übersetzungsprozess viel Arbeit darauf verwendet, dass der Autor alle Änderungen in einem Dokument markiert und dem Übersetzer somit mitteilt, was er zu bearbeiten hat. Der Übersetzer muss dann mit dem gleichen Programm wie der Autor die fremdsprachigen Dokumente bearbeiten und neu formatieren. Die meisten dieser Schritte werden durch Translation Memories überflüssig.

Handelt es sich nun um eine Nachübersetzung, wird der neue Text mit allen bereits übersetzten Texten verglichen und jene Teile, die schon übersetzt vorliegen, werden automatisch wieder in die Datei eingebunden. Der Übersetzer erhält so ein gemischtsprachliches Dokument und muss nur noch den tatsächlich neuen Anteil übersetzen. Der Rest geht wie zuvor: Die Formatinformation wird hinzugefügt, und das Dokument ist fertig.

Zusätzlich stellt ein TM-System in der Regel eine ausgereifte Terminologiedatenbank zur Verfügung und hilft somit, die Qualität der Übersetzung zu verbessern.

Der Einsatz eines TM-Systems bietet die folgenden Vorteile:

• Es spart Kosten, da Doppelübersetzungen entfallen.
• Es verringert den Vorbereitungsaufwand für den Autor: Die Differenzen zwischen zwei Versionen sucht das TM-System selbst heraus.
• Es erhöht die Konsistenz der Übersetzung, da gleiche Texte immer gleich übersetzt werden.
• Die Terminologieunterstützung erhöht die Konsistenz der benutzten Termini und verringert ebenfalls die Kosten der Übersetzung, da die Terminologie automatisch in den Text übernommen werden kann.

Seitenanfang

Schlüsselelement Adobe FrameMaker+SGML

FrameMaker+SGML ist die Kombination einer Desktop-Publishing-Software mit einem SGML/XML-Editor. FrameMaker bietet ausgezeichnete Layout- und Gestaltungsmöglichkeiten; die Unterstützung von SGML/XML ermöglicht es, Dokumente strukturiert zu erstellen, d.h. dem Autor eine klare Führung beim Editieren zu geben. Mit Hilfe der Struktur – die in Form eines Baumes dargestellt wird, wie er vom Windows Explorer her bekannt ist – ist es dem Autor möglich, sehr schnell und effektiv Strukturänderungen am Dokument vorzunehmen.

Die Umstellung auf eine vollständig strukturierte Editierumgebung ist eine starke Veränderung in der Arbeitsweise von Autoren. Reine SGML/XML-Editoren unterscheiden sich von dem, was ein Autor als Editierumgebung gewohnt ist, erheblich. Die Kombination von DTP und SGML/XML-Editor beseitigt diese Anfangshürde nahezu vollständig.
 

Seitenanfang

Der Clou: die Konvertierung

Viele unterschiedliche Tools (von Microsoft Word bis hin zu Doc-To-Help) haben sich auf die Fahnen geschrieben, aus einer Quelle auf Knopfdruck die unterschiedlichsten Formate zu erzeugen. Diese Fähigkeit ist auch ohne Zweifel vorhanden. Ob diese Formate allerdings tatsächlich medienspezifisch aufbereitet werden, steht auf einem anderen Blatt. All diese Formatkonvertierungen sind mehr oder weniger lineare Konvertierungen: Die Struktur des Ausgangstextes wird – ohne diese Struktur zu verändern – in ein anderes Dateiformat konvertiert. Wenn diese unterschiedlichen Formate dann aber auch unterschiedliche Medien bedeuten, wird diese Vorgehensweise problematisch.

Probleme mit herkömmlichen Tools entstehen an zwei Stellen:

1. bei der Anpassung an verschiedene Medien: Ein Fall, der wohl in jeder Dokumentation vorkommt, ist eine Abbildung mit einem dazugehörigen Titel. Dieser Titel sollte nun aus ergonomischen Gründen in einer Papier-Dokumentation als Bildunterschrift auftauchen. In einer Online-Dokumentation sollte der Titel hingegen als Bildüberschrift erscheinen, da hier nicht gewährleistet ist, dass der Leser auf seinem Bildschirm Text und Bild gleichzeitig sieht. Dies ist eine Veränderung der Struktur des Dokuments und durch einen linearen Konverter nicht mehr zu erreichen. Das Ergebnis eines herkömmlichen Tools ist also strukturell entweder ein Buch am Bildschirm oder ein Online Dokument auf dem Papier.
    
2. bei der Übersetzung: Das Umsetzen in ein anderes Format geschieht zwar auf “Knopfdruck”, für ein gutes Hilfe-System beispielsweise ist jedoch noch eine ganze Menge Nacharbeit notwendig: Soll das Dokument übersetzt werden, muss man sich entscheiden, was die Quelle ist und übersetzt wird und was das Ziel ist und damit nach der Übersetzung wieder aufbereitet werden muss.

In einem SGML/XML-Dokument lässt sich jedes Element eindeutig identifizieren. Um bei dem Beispiel mit dem Bild und dem dazugehörigen Titel zu bleiben, könnte dies in SGML/XML z.B. folgendermaßen aussehen:

• Es gibt ein Element Abbildung.
• Das Element Abbildung besteht aus:
  -Bild
  -Titel

Die Reihenfolge von Bild und Titel kann nun für das Editieren fest definiert sein, z.B. zuerst das Bild und dann der Titel. Dies spielt jedoch für die Ausgabe auf Papier oder als Online-Dokument keine Rolle. Da die Elemente identifizierbar sind, können diese vor der Konvertierung in das eigentliche Zielformat in jede gewünschte Reihenfolge gebracht werden.