Art

Beitrag (Abstract)

Ort

Produkt Global 2/2006, S. 36–37

Form

Zeitschriftenartikel

Autor(en)

Robert Erfle, DOSCO GmbH, Heidelberg

Technische Dokumentationen, die langfristig gepflegt und in viele Sprachen übersetzt werden, sind ein erheblicher Kostenfaktor. Einsparungen lassen sich vor allem durch Standardisierung und Automatisierung erzielen. In Verbindung mit der Einführung von XML eröffnen sich ganz neue Möglichkeiten

Durch die Trennung von Inhalt/Struktur und Darstellungsinformation lässt sich dasselbe XML-Dokument unterschiedlich formatieren.

Technische Geräte, ob Konsum- oder Investitionsgüter, werden immer komplexer und bieten immer mehr Funktionen. Ihre Kenntnis und Nutzung setzt präzise und leicht verständliche Begleitunterlagen voraus. Das gilt auch für die globale Verbreitung der Produkte und z.B. für Servicemitarbeiter vor Ort. Anforderungen wie immer kürzere Aktualisierungszyklen oder neue rechtliche Vorgaben setzen Dokumentationsabteilungen zusätzlich unter Druck.

Die produktbegleitende interne und externe Dokumentation ist folglich von großer Bedeutung und oft mit erheblichen Kosten verbunden. Dennoch wird sie in vielen Fällen noch weitgehend manuell hergestellt – bezogen auf eine ganz bestimmte Ausgabeform (meist PDF- bzw. Papierdokument) und unter Verwendung proprietärer Formate und Werkzeuge. Etwas überspitzt könnte man sagen: nach vorindustriellen Methoden und Prinzipien.

Wie die Anforderungen erfüllt werden können, zeigt ein Blick auf die industrielle Fertigung. Dort heißen die Stichworte Normierung, Modularisierung und Automatisierung: Materialien, Bauteile und Verfahren werden genormt, die Modularisierung erlaubt die Wiederverwendung, die Automatisierung sorgt für gleich bleibende Qualität, Schnelligkeit und Kostensenkungen.

Typischer Aufbau einer XML-Anwendung

Auf die produktbegleitende Dokumentation, die selbst wiederum ein Produkt ist, sind die genannten Methoden ebenfalls anwendbar. Voraussetzungen dafür sind eine Änderung der Prozesse und XML (Extensible Markup Language) als Dokumentformat

Normierung: XML ist ein anerkannter, internationaler Standard. Über ein Regelwerk – DTD (Document Type Definition) oder XML Schema – werden die für einen bestimmten Typ von Dokumentation erforderlichen strukturellen Bestandteile (Kapitel, Abschnitte, Gefahrenhinweise, Listen, Tabellen usw.) genormt. Die Einhaltung dieser Norm lässt sich mit den Werkzeugen für die Erstellung und Weiterverarbeitung der XML-Dokumente überprüfen und sicherstellen.

Modularisierung: Bildlich gesprochen bestehen XML-Dokumente aus Containern mit Inhalt (Text, Bilder), die durch Schachtelung zu Containern mit immer mehr inneren Containern aufgebaut werden. Die Möglichkeiten der Schachtelung sind wiederum in dem Regelwerk genormt. In Verbindung mit redaktionellen Regeln lassen sich die Inhalte einer Dokumentation vollständig in Container einer bestimmten Granularität zerlegen. Analog zur Transportbranche erlaubt dies eine äußerst flexible und effiziente Zusammenstellung und Lieferung von Inhalten. Die Container eines XML-Dokuments besitzen keine Darstellungsinformation (Schriftart, Schriftgröße oder Abstände). Diese kommt erst bei der Weiterverarbeitung (Formatierung) zum eigentlichen Dokumentationsprodukt (PDF-, HTML-Dokument usw.) hinzu. Dieselben Container lassen sich also wiederverwenden, auch wenn die Endprodukte unterschiedlich aussehen sollen.

Automatisierung: Die Weiterverarbeitung der XML-Dokumente zum fertigen Dokumentationsprodukt kann vollständig automatisiert werden, da ihre Bestandteile und ihr Aufbau genormt sind. Dabei bleibt der strukturelle Aufbau erhalten, so dass auch alle fremdsprachigen Dokumente automatisch weiterverarbeitet werden können.

Durch die Einführung industrieller Methoden auf Basis von XML ergeben sich vielfältige Vorteile bei der Erstellung, Pflege und Publikation produktbegleiten-der Dokumentation.

Da die Darstellungsinformation erst bei der (automatischen) Aufbereitung zum Dokumentationsprodukt hinzugefügt wird, ist die Darstellung einheitlich. Autoren und Übersetzer verbringen keine Zeit mehr mit Layoutarbeiten. Die Bestandteile der XML-Dokumente lassen sich wiederverwenden, neu zusammenstellen und zu den unterschiedlichsten „Endprodukten“ (PDF, CD, Online) aufbereiten. Änderungen an der gewünschten Darstellung berühren nur die zentrale Darstellungsdefinition, nicht jedes einzelne Dokument.

Zur Senkung und Kontrolle von Übersetzungskosten sind Translation-Memory-Systeme heute unverzichtbar. XML-Dokumente eignen sich besonders für die Übersetzung mit solchen Systemen. Da die Darstellungsinformation fehlt, kann sie beim Übersetzen nicht verloren gehen oder verändert werden. Die XML-Markierungen (Containergrenzen) werden geschützt, so dass das übersetzte Dokument strukturgleich zum Ausgangsdokument ist.

Da XML ein internationaler Standard ist, sind die Dokumente unabhängig von Herstellern und Produkten einsetzbar. Sie sind Unicode-basiert und können deshalb ohne spezielle Vorkehrungen auch Inhalte von Sprachen wie Chinesisch, Japanisch oder Arabisch repräsentieren. Der normierte, komponentenweise Aufbau erleichtert die Verwaltung in Content-Management-Systemen. In Verbindung mit solchen Systemen kann die Pflege, Übersetzung und Freigabe auch auf Komponentenebene erfolgen. Dies beschränkt die Überarbeitung auf die wirklich betroffenen Teile. Notwendige Arbeiten lassen sich parallel durchführen, die Datenhaltung ist weitgehend redundanzfrei.

Die Komponenten bzw. Container (Kapitel, Abschnitte, Absätze usw.) lassen sich mit Metadaten versehen, die etwas über die Verwendung oder Bestimmung der jeweiligen Komponente aussagen. Sie geben etwa Auskunft darüber, für welche Baugruppe einer Maschine, für welche Funktion eines Geräts oder für welche Lesergruppe die Komponente gedacht ist. Diese Metadaten lassen sich produktspezifisch auswerten, so dass sehr zielgerichtete Dokumentationen entstehen. Auf diese Weise produziert etwa Volkswagen für das Phaeton-Modell Bedienungsanleitungen, die ausschließlich die Ausstattungen beschreiben, die der jeweilige Kunde in seinem Fahrzeug tatsächlich hat.

Ein Umstieg auf XML ist dann sinnvoll, wenn die Informationsmenge eine gewisse Größe übersteigt, regelmäßig aktualisiert wird und die genannten Vorteile für die Anwendung von Bedeutung sind. Kriterien sind z.B. die Anzahl der zu bedienenden Sprachen, das Bedürfnis nach einer einheitlichen Darstellung oder die Frage, ob neben der PDF- bzw. Druckausgabe auch etwa eine HTML-Ausgabe erstellt werden soll. Ist die Dokumentation so langlebig wie etwa in der Luftfahrtindustrie, dann spricht viel für XML aufgrund seiner Hersteller- und Werkzeugunabhängigkeit.

Dokument in einem XML-Editor

Die Einführung ist mit einigen Kosten verbunden. Sie nimmt eine gewisse Zeit in Anspruch und bedarf entsprechender Expertise. Basierend auf einer Dokumentanalyse wird das Regelwerk entwickelt. Geeignete Produkte (z.B. XML-Editor, Formatierer) werden ausgewählt und an das Regelwerk angepasst. In einer Schulung lernen die Autoren die neue Technik und die neuen Werkzeuge kennen. Abhängig davon, wie konsistent Formatvorlagen in der bisherigen Dokumentation eingesetzt wurden, kann ihre Übernahme nach XML mehr oder weniger automatisiert erfolgen. Das Ergebnis ist eine maßgeschneiderte Lösung.

Alternativ dazu gibt es mehr oder weniger konfektionierte Lösungen, die modifiziert und ergänzt werden können. Sie sind öffentlich zugänglich (Open Source) oder werden von Herstellern- bzw. Dienstleistern angeboten. Eine solche Lösung „von der Stange“ verlangt jedoch immer eine gewisse Kompromissbereitschaft.

Die Formalisierung der Methoden bei der Erstellung, Verwaltung und Publikation produktbegleitender Dokumentationen auf Basis des regelbasierten Formats XML birgt erhebliches Rationalisierungspotenzial mit dauerhaften Einsparungen. Dadurch sind die Einführungskosten bald amortisiert.