Art

Vortrag (Abstract)

Ort

tekom-Jahrestagung, Herbst 2005, Wiesbaden

Form

Beitrag im Tagungsband

Autor(en)

Robert Erfle, DOSCO GmbH, Heidelberg

Viele Unternehmen stehen der Einführung einer XML-basierten Redaktionsumgebung für ihre Dokumentation positiv gegenüber. Ein wesentlicher Vorteil des XML-Konzepts ist die Regelbasiertheit. Alle XML-Dokumente eines Typs gehorchen seinem Regelwerk, der DTD oder dem XML Schema. Eine wichtige Frage bei der Einführung ist deshalb, wie man zu einem geeigneten Regelwerk gelangt.

Das Regelwerk ist von zentraler Bedeutung für die gesamte Anwendung. Es bestimmt, welche Bestandteile (Elemente, Attribute) in welcher Abfolge in den Dokumenten vorkommen dürfen oder müssen. Es steuert oder beeinflusst damit alle Anwendungskomponenten:

Es führt den Autor bei der Erstellung und Pflege der Dokumente, indem der XML-Editor an jeder Stelle im Dokument nur die Elemente zum Einfügen anbietet, die dort laut Regelwerk erlaubt sind.

Es bestimmt Umfang und Komplexität der Skripte/Programmierung für die automatische Aufbereitung der XML-Dokumente (z.B. zu PDF, HTML). Alle Elemente und Attribute des Regelwerks müssen in allen erlaubten Konstellationen korrekt weiterverarbeitet werden.

Es beeinflusst die Anpassung/Konfiguration eines CMS, etwa hinsichtlich der Granularität der verwalteten XML-Dokumente.

Es ist Grundlage für die Konfiguration eines Translation Memory Systems, bei der u.a. bestimmt wird, welche Markierungen für den Übersetzer gesperrt sind und welche Elemente und Attribute nicht übersetzt werden sollen.

Es ist Grundlage für die Konfiguration von Sprachtechnologie-Software, mit der z.B. korrekte Terminologie, Stil und Konsistenz in der Quellsprache geprüft wird.

XML-Anwendung (ohne Sprachtechnologie): Einfluss des Regelwerks auf die einzelnen Komponenten

Aufgrund der beschriebenen Bedeutung des Regelwerks ist klar, dass jede Änderung wiederum alle Komponenten der Anwendung betrifft. Das Ausmaß der notwendigen Anpassungen an den einzelnen Komponenten hängt stark davon ab, wie das Regelwerk geändert wurde. Das Hinzufügen eines optionalen Elements zur Auszeichnung von Spezialwerkzeugen zum Beispiel hat sicher geringere Auswirkungen als etwa die Erweiterung eines bisher einstufigen Listenmodells um untergeordnete Listen (Liste in Liste).

Änderungen am Regelwerk können auch Auswirkungen auf die bestehenden XML-Dokumente haben. Das Hinzufügen verpflichtender Elemente oder Attribute sowie Umstellungen in der Struktur führen dazu, dass die bestehenden Dokumente nicht mehr konform zum neuen Regelwerk sind und ihrerseits angepasst werden müssen.

Seit der Verabschiedung von XML Schema als W3C-Standard im Jahr 2001 gibt es für die Realisierung des Regelwerks eine Alternative zur DTD. Anders als eine DTD ist ein XML Schema selbst wieder ein XML-Dokument. Der Funktionsumfang ist größer. XML Schema beinhaltet ein durchgängiges Typenkonzept. Damit ist es möglich, auch die Beschaffenheit des Inhalts von Elementen genau festzulegen, z.B. dass eine Postleitzahl immer eine Abfolge von fünf Ziffern enthält.

XML Schemas sind für den Laien schwerer zu lesen bzw. zu erlernen als DTDs. Die Werkzeugunterstützung ist noch nicht so verbreitet wie bei DTDs. Es gibt aber bereits Werkzeuge, die nur noch XML Schemas unterstützen.

Element hervor mit Attribut art jeweils als Ausschnitt aus XML Schema und DTD

Für klassische Text/Bild-basierte Dokumenttypen (z.B. Bedienungs- oder Reparaturanleitungen, Referenzhandbücher) werden die zusätzlichen Möglichkeiten von XML Schemas kaum benötigt. Für Dokumenttypen, die sehr streng strukturiert sind und vermehrt Zahlenwerte mit Maßeinheiten, Preise oder formalisierte Nummern enthalten (z.B. Kataloge), sind sie dagegen sicher hilfreich.

DTDs lassen sich später immer in XML Schemas umwandeln, umgekehrt gilt das nicht. Und außerdem: Viel wichtiger als die Technik des Regelwerks ist sein Inhalt.

Es gibt prinzipiell drei Wege:

Maßgeschneidertes Regelwerk: Das Regelwerk wird von Grund auf neu entwickelt, so dass es genau die speziellen Anforderungen und Bedingungen der abzubildenden Dokumente im Unternehmen erfüllt.

Standard-Regelwerk: Man entscheidet sich für eines der öffentlich zugänglichen Regelwerke.

Anbieter-Regelwerk: Es gibt Anbieter von XML-Lösungen oder XML-Werkzeugen, die bereits ein Regelwerk in ihr Angebot integriert haben.

Als Standard-Regelwerk stehen zur Verfügung:

Diverse ATA- und AECMA-Spezifikationen (z.B. AECMA Spec 1000d): Sehr speziell auf die Anforderungen in der Luftfahrtindustrie zugeschnitten. Außerhalb kaum anwendbar. ·

DocBook: Umfangreiches Regelwerk, vornehmlich – aber nicht ausschließlich – für die Dokumentation von Hard- und Software. Existiert seit vielen Jahren. OASIS-Standard in Version 4.1. ·

Mumasy: Gemeinsame Initiative verschiedener Unternehmen des deutschen Maschinen- und Anlagenbaus. Umfangreiches Regelwerk. Existiert seit ca. 2001. Kandidat für VDMA Einheitsblatt. ·

DITA: Informationsmodell für Topic-orientierte Inhalte. Enthält Regelwerke und Mechanismen für deren Erweiterung und Spezialisierung. Existiert erst seit kurzem. OASIS-Standard in Version 1.0.

Aufgrund der zentralen Bedeutung des Regelwerks für die gesamte Anwendung verdient es ganz besondere Aufmerksamkeit bei der Einführung von XML. Eine entscheidende Frage wird dabei sein, ob es ein vorgegebenes Regelwerk (Standard oder Anbieter) sein soll oder ein maßgeschneidertes. Zur Beantwortung dieser Frage sollten verschiedene Kriterien berücksichtigt werden.

Passgenauigkeit: Wie gut passen die vorgegebenen Regelwerke zu den Anforderungen und Spezifika meiner Dokumentation?

Ist der Vorrat an Elementen und Attributen zu groß, so geht die Autorführung verloren. Ist er zu klein, so lassen sich bestimmte Inhalte nicht geeignet abbilden. Ein wichtiger Aspekt ist dabei auch die Auszeichnungstiefe. Ermöglichen die gegebenen Regelwerke die Inhalte genau genug auszuzeichnen?

Vielzahl der Elemente der DocBook-DTD (V4.0) auf Absatzebene

Bieten die vorgegebenen Regelwerke das gewünschte Maß an Semantik? Möchte man z.B. Störungsmeldungen mit semantischen Elementen abbilden, etwa meldung, ursache, abhilfe, und diese gibt es nicht, so besteht ein Problem. Auch umgekehrt stören vorhandene semantische Elemente, die nicht gebraucht werden.

Entspricht das vorgegebene Organisationsmodell den eigenen Vorstellungen? Auf der einen Seite gibt es den Ansatz klassischer Dokumente mit hierarchischer Kapitelstruktur (z.B. DocBook), auf der anderen Seite die Aufteilung der Dokumente in viele kleine eigenständige Einheiten, die miteinander vernetzt sind (z.B. DITA).

Werkzeugunterstützung: Ein Vorteil vorgegebener Regelwerke ist, dass es evtl. bereits entsprechende Anpassungen an bestimmte Werkzeuge gibt, etwa einen Editor oder Publikationskomponenten für Druck- oder HTML-Ausgabe. Falls dies zutrifft, kommt es darauf an, ob die Werkzeuge mit ihrer Funktionalität bzw. dem vorgegebenen Aussehen (Layout) den eigenen Vorstellungen entsprechen.

Unabhängigkeit: Der Einsatz vorgegebener Regelwerke bedingt konsequenterweise auch die Übernahme entsprechender Änderungen. Damit verliert man die Unabhängigkeit hinsichtlich der Pflege und Weiterentwicklung der Anwendung. Bei Anbieter-Regelwerken trifft dies nicht unbedingt zu, da diese evtl. nur als Einstiegserleichterung gedacht sind, nach Fertigstellung der Anwendung aber kundenspezifisch sind.

Ein maßgeschneidertes Regelwerk bietet optimale Passgenauigkeit, garantiert Unabhängigkeit und die freie Werkzeugwahl. Ein positiver Nebeneffekt ist auch, dass man sich bei der Erstellung des Regelwerks intensiv mit den Bestandteilen und Strukturen der eigenen Dokumente, sowie den zukünftig geplanten Verwendungsarten und -bereichen auseinandersetzen muss. Dies öffnet den Blick für Verbesserungen.

Die Einführung von XML auf Basis eines maßgeschneiderten Regelwerks und daran angepasster Werkzeuge ist kurzfristig betrachtet wohl immer der teuerste Weg. Er dürfte auch zeitlich der längste sein. XML-Anwendungen sind aber immer langfristig angelegt. Die Verwendung eines vorgegebenen Regelwerks kann im Laufe der Zeit zu höheren Kosten führen, weil z.B. das Regelwerk öfter verändert werden muss, oder weil ein zu großer oder falscher Elementvorrat zu inkonsistenten Dokumenten führt, die manuell nachbereitet werden müssen, bzw. die Nutzung der XML-Anwendung für bestimmte Dokumente einschränkt.

Neben der reinen Kostenbetrachtung spielt auch der Qualitätsaspekt eine Rolle. Ein maßgeschneidertes Regelwerk enthält einen genau auf die Anforderungen des Unternehmens abgestimmten Vorrat an Elementen und Attributen mit geeigneter Semantik. Dies fördert die richtige und eindeutige Auszeichnung bei der Erfassung und ermöglicht Publikationen, die vollständig den Unternehmensvorgaben hinsichtlich Aussehen und Funktionalität entsprechen.

Welcher Weg zu einem Regelwerk der beste ist, lässt sich nur von Fall zu Fall entscheiden. Dazu ist es wichtig, sich zunächst über die eigenen Anforderungen hinsichtlich Element- und Attributvorrat, Auszeichnungstiefe, Maß an Semantik sowie gewünschter Ausgabeformen klar zu werden. Damit lässt sich die Eignung der vorhandenen Regelwerke einschätzen. Kompromisse werden dabei wohl im-mer nötig sein. Für die Entscheidung ist dann abzuwägen, ob hinsichtlich Kosten und Nutzen ein maßgeschneidertes Regelwerk einem vorgegebenen Regelwerk vorzuziehen ist oder nicht.

Für Rückfragen:

Robert Erfle <erfle@dosco.de>