Informationsstrukturen erweitern

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Das Erstellen einer DTD ist mit viel Aufwand verbunden. Wie in „Verwendung bekannter Technologien“ erläutert wurde, ist der damit verbundene Aufwand oftmals so groß, dass er sich für Technische Redaktionen in den wenigsten Fällen lohnt. Die Entwicklung einer speziellen und damit häufig komplexen DTD kann dadurch umgangen werden, dass eine möglichst generische DTD erstellt wird. Wie gezeigt wurde, können bei dieser Vorgehensweise nur bedingt die Vorteile einer Auszeichnungssprache wie XML genutzt werden.

Wurde auf die Erstellung einer generischen DTD verzichtet und tatsächlich eine DTD erstellt (und es ist wirklich nur eine DTD gemeint), die speziell auf die zu erzeugenden Dokumente zugeschnitten ist, so ist es oft nur eine Frage der Zeit, bis die DTD mit einer neuen Herausforderung konfrontiert wird: die DTD ist zu „eng“ und muss erweitert werden.

Die Gründe dafür können vielfältig sein:

  • Bestehende Dokumententypen werden modifiziert. Dieser Fall tritt in der Praxis sehr häufig auf, beispielsweise dann, wenn man merkt, dass bestimmte Informationen oder Informationsstrukturen mit der bestehenden DTD nicht mehr im ausreichenden Maße erfasst werden können.
  • Neue Dokumententypen kommen hinzu. Dies kann beispielsweise der Fall sein, wenn neben den Schulungsunterlagen zusätzlich noch ein Tutorial erstellt werden soll. Auch dieser Fall ist in der Praxis häufig zu beobachten.
  • Die semantischen Auszeichnungen müssen erweitert werden. Müssen neue Produkte aus neuen Geschäftsfeldern dokumentiert werden, reicht oft die bestehende Semantik nicht mehr aus.
  • Externe Dokumente müssen verarbeitet werden. Wenn Informationen aus externen Dokumenten in die Dokumentation aufgenommen werden müssen, kann eine bestehende DTD oftmals nicht die passenden Elemente zur Erfassung der Inhalte bieten.
  • Dokumente müssen mit anderen Unternehmen ausgetauscht werden. Was gestern noch der Mitbewerber war, kann heute der Joint-Venture Partner sein. Die Zusammenführung des Dokumentenbestands wird dann sicherlich zu einer großen Herausforderung.

Eine DTD steht also vor der Aufgabe, mit den Entwicklungen im Unternehmen, oder besser gesagt, mit der Entwicklung der zu produzierenden Inhalte Schritt halten zu können.

Wird eine DTD nicht erweitert, so muss der bestehende Satz an Elementen auf eine größere Anzahl von Dokumententypen angewendet werden. Die Folge davon ist, dass die bestehenden Auszeichnungen zu „verwässern“ beginnen. Da mit den bestehenden Elementen sowohl die alten wie auch die neuen Dokumenttypen ausgezeichnet werden müssen, ist eine eindeutige Zuordnung der Elemente zu den Dokumentenstrukturen immer weniger möglich. Auch wenn semantische Auszeichnungen nicht durch aktuelle Elemente ergänzt werden, besteht auch hier zunehmend die Gefahr, Inhalte mit unpassenden Elementen auszuzeichnen. Damit bewegt man sich schließlich wieder in Richtung generischer Auszeichnungen.

Wie die Praxis zeigt, ist die Weiterentwicklung einer bestehenden DTD häufig noch zeitaufwändiger, als es die erstmalige Erstellung bereits war. Zum einen stellt gerade bei monolithischen DTDs die Wartbarkeit ein immenses Problem dar. Zum anderen darf nicht vergessen werden, dass mit der Erweiterung einer DTD auch die Stylesheets erweitert werden müssen, damit die Inhalte der neuen Elemente bei der Produktion der Ausgabemedien berücksichtigt werden.

Ist eine Weiterentwicklung erst einmal erreicht, stößt man auf ein weiteres Problem. Mit der Erweiterung der DTD wächst die Anzahl der zur Verfügung stehenden Elemente kontinuierlich, bis sich irgendwann die Unübersichtlichkeit deutlich bemerkbar macht. Insbesondere problematisch erweist sich die Tatsache, wenn mehrere Technische Redakteure an unterschiedlichen Dokumenttypen arbeiten. Dann benötigt jeder Technischer Redakteur nur eine Teilmenge, die immer geringer wird, je mehr Elemente in der DTD definiert werden.

Wie die DTD von DocBook gezeigt hat, ist eine monolithische DTD, in der alle Elemente definiert sind, ungeeignet, um flexibel Änderungen aufnehmen zu können. Die feste Menge von Elementen bietet jedoch auf der anderen Seite die Möglichkeit, die Verarbeitung der XML-Dateien gut steuern zu können, wie die Stylesheets von DocBook zeigen. Um Informationsstrukturen erweitern zu können, bedarf es daher folgender Voraussetzungen:

  • Ein Inhaltsmodell muss flexibel genug sein, um Erweiterungen und Reduzierungen zu ermöglichen.
  • Eine DTD muss so modular aufgebaut sein, dass aus ihr nur die Bestandteile entnommen werden können, die benötigt werden. Selbstredend muss eine neue DTD nach wie vor zum Inhaltsmodell passen.
  • Ein Verarbeitungsmechanismus muss in der Lage sein, auch die Elemente von erweiterten oder reduzierten DTDs verarbeiten zu können.

Wie der nächste Abschnitt "Flexible Erweiterbarkeit mit DITA" zeigt, sind diese Voraussetzungen allesamt bei DITA dafür gegeben.

  

<< zurück vor >>

 

 

 

Tipp der data2type-Redaktion:
Zum Thema DITA bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2008 XLcontent Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DITA - Der neue Standard für Technische Dokumentation" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

XLcontent Verlag, Pflegerstraße 40, 81247 München