DITA – Wie die Technische Dokumentation von einer einfachen Idee profitieren kann

Auch wenn nicht immer DITA draufsteht: Die Technische Dokumentation steht aktuell vor der Herausforderung, Content fit zu machen für die Zukunft. Und dabei kommt fast zwangsläufig ein Konzept ins Spiel, für das der mittlerweile 15 Jahre alte OASIS-Standard „DITA“ (Darwin Information Typing Architecture) berühmt geworden ist.

Auch für unsere Kunden setzen wir aktuell in vielen Projekten die DITA-Idee ein. Und vielleicht betrifft das Thema „Zukunftsfähigkeit“ ja auch Ihre Technische Redaktion? Zum Beispiel weil Sie ihren Kunden schnellere und bessere Unterstützung bieten wollen, etwa durch rollenspezifisch filterbare Online-Hilfen, Wissensdatenbanken als Ablösung  langer Handbücher im Printformat oder Chatbots als intelligenten Suchassistenten. Oder weil Sie neue Informationskanäle erschließen wollen in Form von mobilen Doku-Apps, durch die Wiederverwendung von Doku-Inhalten in E-Learnings oder AR-Szenarien.

Was hat das alles mit DITA zu tun? Und wie kann Ihnen DITA bei Ihren Herausforderungen zur Hilfe werden? Dazu gleich mehr.

DITA aufgedröselt

Lassen Sie uns erst einmal einen Blick darauf werfen, wie DITA eigentlich „funktioniert“. Ganz grob gesagt besteht DITA aus drei Komponenten:

• Komponente 1:  Die Grundidee, nämlich ein Modell zur Organisation von Content in Form von Topics. Topics sind klassifizierte thematische Einheiten, die in sich geschlossen sind und variabel wiederverwendet werden können. Dazu unten noch einmal mehr.
• Komponente 2: Ein XML-Standard (DTD), der für alle Arten von Topics eine Informationsarchitektur bereitstellt, um deren Content zu erfassen. Außerdem gibt es mit den sogenannten Maps einen Mechanismus, über den die Topics zu individuellen Publikationen zusammengestellt werden können.
• Komponente 3: Das DITA Open Toolkit, eine frei verfügbare und konfigurierbare Produktionsumgebung, mit der sich DITA-XML (Komponente 2) in verschiedene Ausgabeformate überführen lässt (z. B. HTML5, PDF etc.).

DITA in der Technischen Dokumentation

Wie lässt sich nun ein Redaktionsprozess mit DITA organisieren? Meine Beobachtung nach sind es vor allem zwei Szenarien, wie DITA aktuell eingesetzt wird:

DITA-Denke + modernes Redaktionssystem

In diesem Szenario übernimmt man von DITA die Grundidee (Komponente 1), nämlich die Organisation von Content in Form von Topics. Da moderne Redaktionssysteme den Content grundsätzlich in klassifizierten Bausteinen halten, unterstützen sie den DITA-Ansatz sehr nachhaltig. Das übrigens auch, wenn sie in der Datenhaltung (Komponente 2) einen eigenen XML-Standard verwenden und nicht das DITA-XML.

Hinsichtlich der Publikation (Ebene 3) schließlich sind moderne Redaktionssysteme dem DITA Open Toolkit klar überlegen. Vor allem, wenn man mit einem Redaktionssystem wie SCHEMA ST4 arbeitet, das die Generierung in fast beliebige Zielformate erlaubt.

DITA im Komplettpaket + XML-Editor

Natürlich ist es möglich, DITA als Komplettpaket anzuwenden. Man nutzt die DITA-DTD (Komponente 2) und setzt als Redaktionswerkzeug einen XML-Editor ein, zum Beispiel XMetal, Arbortext oder Oxygen. Wer auf diese Weise file-basiert mit DITA arbeitet, wird wahrscheinlich auch das DITA Open Toolkit (Komponente 3) verwenden, um die Publikationsschiene abzudecken.

Beachten Sie aber: Wer so „genuin“ mit DITA arbeitet, muss wirklich fit sein in XML – und er muss sich tief einarbeiten in die Konfiguration des Toolkits.

DITA und Technische Dokumentation: Was ist die richtige Wahl?

Die richtige Wahl in diesem Zusammenhang, hängt sehr von den Anforderungen an einen Redaktionsprozess ab. DITA im Komplettpaket funktioniert gut für eher kleinere Redaktionen und Dokumentationsprojekte.

Wer in großen Teams arbeitet und es als Redaktion mit entsprechend ausgefeilten Anforderungen an Variantenmanagement, Übersetzung und Medienvielfalt zu tun hat, ist aus Qualitäts- wie aus Effizienzgründen mit einem modernen Redaktionssystem besser aufgestellt und nutzt nur die DITA-Grundidee.

In den Topics liegt das Potenzial

Doch ganz egal, wie man DITA nun konkret einsetzt: Alles entscheidend ist die „DITA-Denke“ – also das, was wir oben als Komponente 1 herausgearbeitet haben. Und damit möchte ich noch einmal auf die Topics zu sprechen kommen.

Was macht Topics so attraktiv für moderne Redaktionsprozesse?

1. Mit Topics à la DITA konzipieren Sie Ihren Content von Grund auf medienunabhängig. Lapidar gesprochen ist es einem Topic egal, ob es als Abschnitt in einem in Kapiteln gegliederten Handbuch vorkommt oder auf der Seite einer modernen Online-Hilfe als aufklappbarer Textbereich. Ein Topic ist ein in sich geschlossenes Informationsmodul und als solches universell einsetzbar.
2. Topics bieten Ihnen die optimalen Voraussetzungen für eine konsequente Standardisierung von Content. Wenn Sie wie von DITA vorgeschlagen Topics typologisieren (z. B. als Task, Concept oder Reference), können Sie sehr zielgenaue Schreibregeln aufstellen. Und zwar Schreibregeln, die die wirklich qualitätskritischen Eigenschaften von Content adressieren.
3. Mit den Topics kommt eine Größe ins Spiel, über die Sie Content sehr gut klassifizieren und verschlagworten können. Topics sind ganz typische Kandidaten für Metadaten und Taxonomien – die Art Metainformationen, die Content universell einsetzbar, filterbar und auffindbar machen.

Gute Erfahrungen mit der DITA-Denke

Dass die Topics als zentrale Idee von DITA sehr gut zu den Anforderungen moderner Redaktionsprozesse passen, erleben wir immer wieder in Projekten mit unseren Kunden. Viele Redaktionen – auch die, die bereits ein Content-Management-System einsetzen – stehen vor der Herausforderung, sich von der alten Print-Denke in der Dokumentation zu lösen.

Wenn wir mit Kunden in der Beratung herausarbeiten, was passieren muss auf dem Weg zur Nutzung des wertvollen Doku-Contents auf allen Kanälen, wird meist schnell klar: Das Kapitel als Ausgangsbasis für die Organisation von Content funktioniert nicht mehr. Kapitel sind thematisch einfach zu groß und zu behäbig. Das Topic dagegen ist schlank und flexibel einsetzbar. Es eignet optimal als Content-Lieferant in den unterschiedlichsten Kontexten:

• für das zielgenaue Auffinden von Informationen in einer Facettensuche
• als Antwortreservoir für einen Chatbot
• in einem klassischen Handbuch (das ja nach wie vor gebraucht wird)
• als Teil einer Lerneinheit auf einer eLearning-Plattform
• als Problemlösung, die auf kleinstem Raum auf einem Maschinenpanel angezeigt wird

Am liebsten arbeiten wir dabei mit dem oben geschilderten Szenario „DITA-Denke + modernes Redaktionssystem“. Diese Kombination aus redaktioneller Intelligenz und ausgefeilter Technik passt einfach sehr gut zusammen.

Wie sind Ihre Erfahrungen mit DITA? Nutzen Sie auch die Denke oder das Komplettpaket? Wir freuen uns auf Ihren Diskussionsbeitrag in den Kommentaren.