XML

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

Die komplexe Syntax und die schwerfällige Handhabbarkeit von SGML war sicherlich einer der Hauptgründe, warum XML (eXtensible Markup Language) entwickelt wurde. Schon an dem deutlich geringeren Umfang der XML-Spezifikation im Vergleich zur SGML-Spezifikation lässt sich ablesen, dass sich die Syntax von XML fühlbar vereinfacht haben musste. Obwohl die Spezifikation von XML wesentlich reduziert wurde, hat XML im Vergleich zu SGML praktisch nichts an Flexibilität eingebüßt.

Die Entstehung von XML geht auf das Jahr 1998 zurück, als erstmals eine XML-Spezifikation als W3C-Empfehlung veröffentlicht wurde. Seitdem ist XML so etwas wie die lingua franca des Datenaustauschs geworden. So wird XML beim Datenaustausch für elektronische Kataloge ebenso eingesetzt wie für die Prozessbeschreibung von elektronischen Anlagen. Die Vorteile, die Auszeichnungssprachen wie SGML und XML ausweisen, kommen bei XML zudem deutlicher zum Tragen:

• XML ist für Menschen lesbar, da es sich nicht um ein Binärformat handelt. Mit ein wenig Übung lässt sich die Struktur eines XML-Dokuments leicht erkennen und die Inhalte können sofort gelesen werden.
• XML kann mit den einfachsten Texteditoren erfasst werden. Es sind keine speziellen Programme notwendig, um eine XML-Datei zu erstellen.

Auch für die Technische Dokumentation stellte sich schnell der Nutzen von XML gegenüber SGML heraus. XML-Dokumente können leichter verarbeitet und in andere XML-Dokumente oder Dateiformate transformiert werden. Und auch die Erstellung von DTDs stellte sich nicht mehr ganz so kompliziert dar wie bei SGML.

Dennoch blieb zunächst auch mit XML das Problem bestehen, dass es keine standardisierten DTDs gab, die als Basis für Technische Dokumentation herangezogen werden konnten. Anders als beispielsweise bei Produktkatalogen, wo schon frühzeitig damit begonnen wurde, standardisierte Katalogformate auf XML-Basis auszuarbeiten, begannen die Entwicklungen für standardisierte DTDs in der Technischen Dokumentation erst relativ spät.

Der erste Weg, der dabei beschritten wurde, war das Umschreiben der SGML DTDs in XML DTDs, wie es bei DocBook der Fall war. Hier blieb man dem Konzept einer einzigen monolithischen DTD treu. In einer monolithischen DTD werden alle Elemente für die jeweiligen Dokumenttypen definiert. Monolithische DTDs werden damit sehr schnell sehr groß und damit unübersichtlich. Des Weiteren wird die Wartbarkeit einer solchen DTD mit jedem Hinzukommen eines weiteren Elements immer mehr erschwert. Gerade wenn man nur eine einzige DTD haben will, die viele Bereiche der Technischen Dokumentation abdecken soll, stößt man sehr schnell an die Grenzen der Benutzbarkeit.

So blieb zunächst auch bei XML die Regel gültig, dass eine DTD umso mehr kostet, je spezieller, das heißt, je nützlicher sie für den Nutzer ist. Aber auch hier weisen solche DTDs den Nachteil auf, dass kaum jemand bereit ist, die Kosten dafür zu tragen. In dieser Hinsicht hat sich gegenüber SGML kaum etwas verändert.

Den Entwicklern von DITA war das Problem von nicht standardisierten DTDs für die Technische Dokumentation wohl bekannt. Daher war das primäre Ziel bei der Entwicklung von DITA, DTDs zu entwickeln, die sofort für die Produktion von Technischer Dokumentation eingesetzt werden konnten. Den für DITA entwickelten DTDs liegt das Konzept von Topics zugrunde, das heißt, in sich abgeschlossene Informationseinheiten werden durch die DTDs definiert.

Mit DITA Version 1.1 werden für folgende Topictypen DTDs angeboten:

• Generisches Topic, als Container für topicbasierte Informationen.
• Aufgabe, für Handlungsanweisungen.
• Konzept, um Konzepte und Prinzipien zu erläutern.
• Referenz, für die Erstellung von Referenzinformationen.
• Glossar, für Glossareinträge.

Des Weiteren stellt DITA auch sofort Elemente zur Verfügung, mit denen Inhalte semantisch ausgezeichnet werden können. Die in DITA vorhandenen Elemente werden in Domains organisiert, die thematisch untergliedert sind.

Mit DITA Version 1.1 werden Elemente für folgende Domains angeboten:

• indexing, zur Auszeichnung von Indexeinträgen.
• highlighting, mit Elementen zur typografischen Auszeichnung.
• progamming, zur Auszeichnung von Inhalten einer Programmiersprache.
• software, mit Elementen zur Auszeichnung von Operationen, die ein Softwareprogramm ausführt.
• user interface, mit Elementen zur Auszeichnung aller Bestandteile einer grafischen Oberfläche, die der Nutzer sehen kann.
• utilities, mit Elementen zur Definition einer Image-Map.
• xNAL, mit Elementen zur Erfassung von Adressinformationen.

Das Besondere an DITA ist also weniger, dass XML als Basistechnologie verwendet wird, sondern dass DITA sofort einsatzbereite DTDs liefert, mit denen Dokumente erstellt und Inhalte ausgezeichnet werden können. Dies gilt insbesondere für Dokumente, die als Technische Dokumentation von Softwareprodukten erstellt werden sollen. Die entscheidende Frage, die sich bei DITA stellt, ist, ob die DTDs ausreichen und flexibel genug sind, um genügend Bereiche der Technischen Dokumentation abdecken zu können. Wie das Beispiel DocBook zeigt, wurde dort zwar eine passende DTD für die Produktion von Handbüchern in der Technischen Dokumentation erstellt, aber die DTD ist kaum ausreichend, um beispielsweise Online-Hilfen erstellen zu können.

Wie in „Topicbasierte Informationserstellung“ gezeigt wird, ist der topicbasierte Ansatz in der Technischen Dokumentation nicht neu. So sind Topics in der Online-Dokumentation schon seit Langem bekannt und werden dort heute standardmäßig eingesetzt. Für gedruckte Handbücher jedoch sind Topics, in der ausgeprägten Form wie sie DITA bietet, bisher noch nicht so gebräuchlich.

Darüber hinaus stellt sich bei DITA die Frage – vor allem wenn man sich das erste Mal mit den Konzepten von DITA vertraut macht – ob die vorgegebenen Topictypen für die eigene Dokumentation ausreichen. Oft wird DITA daher mit einer gewissen Skepsis betrachtet, da die Anzahl der vorgegebenen Topictypen nicht als ausreichend und nicht passend für die eigenen Bedürfnisse angesehen werden. Der Hinweis auf eine mögliche Spezialisierung der Topictypen, das heißt, die Möglichkeit der Ableitung neuer Topictypen aus den bestehenden Topictypen, ist dann häufig ein Argument für die Nutzung von DITA. In der Praxis hat sich jedoch gezeigt, dass sich bei der Dokumentation von Software durchaus zunächst ohne eine Spezialisierung gearbeitet werden kann und die von DITA vorgegebenen Topictypen ausreichen, um die gewünschte Technische Dokumentation erstellen zu können.

Betrachtet man die Entwicklung, die DITA in den letzten Jahren genommen hat, so zeigt sich, dass das Vorhandensein einsatzfähiger DTDs wesentlich dazu beigetragen hat, DITA so populär zu machen.

  

<< zurück

vor >>