2015 ist die aktuelle Version DITA 1.3 herausgekommen. DITA steht für Darwin Information Typing Architecture, eine freie XML-Architektur für Dokumente, die vom Technical Committee (TC) von OASIS entwickelt wird – www.oasis-open.org.
Sechs Jahre ohne Änderung sind eine lange Zeit. Aber für die Verbreitung von DITA waren die stabile Basis und Tool-Landschaft gut. Auch konnten sich in dieser Zeit profunde Kenntnisse entwickeln, wie DITA in unterschiedlichen Anwendungsfeldern bestmöglich eingesetzt werden kann. Natürlich sind damit auch die Erfahrungen gewachsen, was im aktuellen Standard fehlt, was geändert werden sollte und was nicht gebraucht wird.
Das DITA Technical Committee hat diese Erfahrungen gesammelt und in den sechs Jahren eine neue Version konzipiert, die keine Weiterentwicklung im Sinne einer Version 1.4 ist. Vielmehr handelt es sich um eine neue Fassung mit neuer Hauptversionsnummer – DITA 2.0. Die neue Versionsbezeichnung sagt schon aus, dass es sich bei DITA 2.0 um grundlegende Änderungen handelt. Es gibt erfreuliche Neuerungen und Ausrichtungen. Es gibt aber auch Dinge, die dort, wo DITA schon länger eingesetzt wird, zunächst vielleicht nicht so gut ankommen.
Was lässt aufhorchen?
Für alle, die DITA in einer vorhandenen Version (1.0–1.3) einsetzen, folgt eine Auswahl an Neuerungen. Diese lassen aufhorchen, weil sie einen höheren Migrationsaufwand verursachen, wenn auf DITA 2.0 umgestellt werden soll.
Kompatibilität von DITA 2.0: Die erste Version, die nicht abwärtskompatibel ist. Bei allen vorausgehenden DITA 1.x Versionen hat sich das DITA Technical Committee große Mühe gegeben, alle Änderungen abwärtskompatibel zu halten. Aber dieses Mal ist es anders. Und dafür gibt es gute Gründe. Unnötiger Ballast und Altlasten, die sich über die Versionen angesammelt haben, sollen jetzt entfernt werden, um wieder klarere und stabilere Grundstrukturen zu erzielen. Bekannte Designfehler sollen korrigiert werden, und der technische Aufwand der durch die Unterstützung älterer Versionen entstehen würde, soll wegfallen.
DITA 2.0 enthält nicht alles, was es in DITA 1.3 gab: Aus Kapazitätsgründen kommt DITA 2.0 mit einigen Einschränkungen heraus.
Keine XSD-Grammatiken für DITA 2.0: Die DITA 2.0 Grammatiken werden in den Formaten DTD (Dokument-Typ-Definition) und RNG (RELAX NG) bereitgestellt. Das XSD (XML Schema)-Grammatikformat wird zumindest in der ersten Ausgabe von DITA 2.0 nicht unterstützt. Das ist etwas bitter für alle, die bisher die XSD-Grammatiken bevorzugen.
Fehlende Spezialisierungen: Die DITA Spezialisierungen für den Lern-/Lehrbereich und die Machinery Task werden ebenfalls in DITA 2.0 noch nicht enthalten sein. Es wird allerdings einen öffentlichen OASIS Open GitHub-Bereich geben, in dem diese DITA-Spezialisierungen auch von Nicht-TC-Mitgliedern weiterentwickelt werden können.
Das Element <substep> entfällt: Eine weitere Änderung, die Migrationsarbeit nach sich zieht, ist das Wegfallen des Elements <substep>. Es diente bislang dazu, in Schritten einer Handlungsanleitung Unterschritte zu kennzeichnen. Erlaubt war allerdings nur eine Unterebene, damit die Schrittfolgen in einer Anleitung nach den gängigen Qualitätskriterien nicht zu ausladend werden können. In Dita 2.0 gibt es das <substep>-Element nicht mehr. Dafür ist das Element <steps> im Element <step> für Unterschritte erlaubt. Damit öffnet sich leider auch das Tor für eine bisher nicht erlaubte tiefere Schachtelung von Schritten und Unterschritten, was der Qualität entgegensteht. Um die Qualität in diesem Punkt zu sichern, müssen also wieder Regeln aufgestellt und zusätzlich abgeprüft werden.
Der Grund für diese Änderung liegt darin, die Wiederverwendung von Schritten zu erleichtern. So kann ein <step>, der in einer Anleitung ein Unterschritt ist, in einer anderen Anleitung als Handlungsschritt auf erster Ebene wiederverwendet werden. Ein Beispiel für Unterschritte zeigt Abbildung 01: Die Schritte „Kundendaten eingeben“ und „KFZ-Daten eingeben“ sind in der Anleitung „KFZ zur Hauptuntersuchung annehmen“ Unterschritte des Handlungsschritts „Werkstattauftrag erstellen“ und müssen bis DITA 1.3 als <substep> getaggt werden. In der Anleitung „Kundendaten anlegen“ bzw. „KFZ-Daten anlegen“ sind es jeweils Schritte auf erster Ebene und müssen dort mit <step> getaggt werden. Obwohl es sich also jeweils um denselben Schritt handelt, können diese wegen der unterschiedlichen Tags nicht wiederverwendet werden.
Abb. 01 Unterschritte mit <substep> bis DITA 1.3. Quelle Sissi Closs
Da das Element <substeps> mit Version 2.0 entfällt, wird sinnvollerweise ein Sammel-Topic für wiederverwendbare Schritte angelegt. Daraus können sich dann über den conref-Mechanismus alle Anleitungen bedienen, die einen dieser Schritte benötigen. Abbildung 02 verdeutlicht die Funktion des Sammel-Topics.
Abb. 02 Unterschritte mit <step> ab DITA 2.0. Quelle Sissi Closs
Was klingt vielversprechend?
DITA 2.0 bringt viele gute Neuerungen, die neue DITA-Nutzer sicher begrüßen und die bisherigen DITA-Nutzer auch schätzen werden. Auf jeden Fall wird DITA 2.0 vorhandene Quellen, die mit einer früheren Version DITA 1.x erstellt wurden, nicht überflüssig machen.
Mehr Spielraum bei einfachen Tabellen: Einfache Tabellen (<simpletable>) gehören von Anfang an zum DITA-Standard und sind eine geeignete Möglichkeit, Tabellen, die eine einfache Struktur haben sollen, vor Auswüchsen zu schützen. Allerdings konnte bis DITA 1.3 eine einfache Tabelle keine Tabellenüberschrift haben und Tabellenzellen konnten nicht verbunden werden. Ab DITA 2.0 wird beides für einfache Tabellen möglich sein.
Größere Gestaltungsmöglichkeiten bei Begriffserklärungen: Seit DITA 1.3 können in Begriffserklärungen (<glossentry>) im Topic-Rumpf (<glossbody>) umfassende Angaben für die Terminologieverwaltung getaggt erfasst werden. Dazu gehören zum Beispiel die Angabe von Synonymen (<glossSynonym>) oder die Bezeichnung, die bei Einführung des Begriffs verwendet werden soll (<glossSurfaceForm>). Bisher konnten in diesen Unterelementen keine Hervorhebungen gekennzeichnet werden. Ab DITA 2.0 ist in den Unterelementen das Phrase-Element (<ph>) zugelassen. Es ermöglicht dort die Kennzeichnung für Variantensteuerung, Hervorhebung und Wiederverwendung.
Beispiele überall dort, wo sie gewünscht sind: Beispiele konnten bisher nur in sehr eingeschränktem Rahmen als <example> getaggt werden. Das ändert sich mit DITA 2.0. An vielen Stellen, insbesondere in Abschnitten (<section>), Abbildungen (<fig>) und zwischen Absätzen (<p>) sind zukünftig auch Beispiele (<example>) erlaubt.
Mehr Unterstützung für Multimedia: DITA 2.0 bietet die beiden neuen Elemente <audio> und <video> für Audio- und Video-Inhalte. Das macht es deutlich einfacher, Multimedia problemlos in Topics einzubinden.
Normenkonforme Sicherheitshinweise: Ab DITA 2.0 muss ein Sicherheitshinweis (<hazardstatement>) ANSI Z535.6-konform klassifiziert (danger, warning, caution, notice) werden. Außerdem ist es jetzt möglich, im Abschnitt (<howtoavoid>) geordnete oder ungeordnete Listen anzugeben.
Fehlerbehandlung mit Diagnose-Abschnitten: Der Topic-Typ für die Fehlerbehandlung (<troubleshooting>) wurde in DITA 2.0 um einen Diagnose-Abschnitt (<diagnostics>) für die Fehlerdiagnose erweitert. Ein Beispiel dafür steht in Abbildung 03.
Abb. 03 Fehlerbehandlung mit Diagnose-Abschnitt in DITA 2.0. Quelle Sissi Closs
Wie ist der Zeitplan?
Stand heute soll DITA 2.0 als Standard mit allen Spezifikationen Anfang 2023 zur Verfügung stehen. Fraglich ist sicher noch, wie weit dann auch der Tool-Support ist. DITA OT (DITA Open ToolKit) und der Oxygen Editor von SyncroSoft begleiten die DITA-2.0-Entwicklung von Anfang an und bieten heute schon die Option, DITA-2.0-Features versuchsweise auszuprobieren. Wann die volle Unterstützung durch alle DITA-fähigen Tools zur Verfügung steht, ist derzeit noch offen.
Was gilt es zu tun?
Frühzeitig vorbereiten: Dort, wo DITA bereits im Einsatz ist, sollte jetzt schon überprüft werden, ob Attribute oder Elemente enthalten sind, die schon seit längerem – zum Teil bereits seit zehn Jahren – im Standard als veraltet (deprecated) angegeben sind. Diese werden in DITA 2.0 nicht mehr unterstützt. Dazu gehört zum Beispiel die Verwendung des alt-Attributs statt dem <alt>-Element oder des navtitle-Attributs statt dem <navtitle>-Element. Diese Attribute sind in DITA 2.0 nicht mehr vorhanden. Schon jetzt können die als veraltet deklarierten Attribute und Elemente in den Quellen entfernt werden.
Einfach loslegen: Dort, wo mit dem Einsatz von DITA erst angefangen wird, können Anwenderinnen und Anwender der Entwicklung ruhig entgegensehen. Die aktuelle Version DITA 1.3 ist ausgereift und eignet sich daher für ein neues Projekt. DITA 2.0 ist schließlich noch nicht verabschiedet und die volle Tool-Unterstützung fehlt. Dabei sollten aber die zu erwartenden Neuerungen in DITA 2.0 durchaus schon berücksichtigt werden, damit die Quellen möglichst einfach auf den neuen Standard umgestellt werden können. Denn es kommt der Zeitpunkt, zu dem DITA 2.0 von den Werkzeugen komplett unterstützt wird.
Ein Schritt in die Zukunft
Die neue Version klingt vielversprechend, und es ist gut, dass das Warten auf den neuen Standard die aktuelle DITA-Arbeit in keiner Weise ausbremst. Nutzer früherer DITA-Versionen sind nicht verpflichtet, auf die neue Version umzusteigen. Es kann durchaus sein, dass es je nach den Gegebenheiten kein zwingendes Argument gibt, von einer aktuell verwendeten Version DITA 1.x auf DITA 2.0 zu wechseln. Der Einsatz von bzw. Umstieg auf DITA ist jederzeit möglich und auf jeden Fall eine gute Entscheidung, wenn die Informationslandschaft zukunftsorientiert aufgestellt sein soll.
Links zum Beitrag
DITA 2.0 Beta Base: https://github.com/oasis-tcs/dita/releases/tag/v2.0-beta01
DITA 2.0 Beta Technical content: https://github.com/oasis-tcs/dita-techcomm/releases/tag/v2.0-beta01
