XML – DITA, DocBook, S1000D oder Shipdex – Verwirrt?

  • Technologien
  • Nach Typ sortieren
  • SLM
  • Blogbeitrag
Published on
2017-08-25
Written by
Jonas Härdner

Immer mehr technische Redakteure erkennen den Wert von XML als Format für die Erstellung ihrer Dokumente, aber es gibt viele verschiedene Standards wie DITA, DocBook, S1000D oder Shipdex. Eine der ersten Fragen, die sich dem neuen Benutzer von XML stellt, ist die Frage, welchen Standard der Informationsstruktur er verwenden soll. Unserer Ansicht nach muss der Standard zu den Geschäftsanforderungen des Unternehmens passen, und unsere Erfahrung ist, dass sich ein sehr komplexes Datenmodell selten auszahlt. In diesem kurzen Artikel wollen wir versuchen, die Unterschiede herauszuarbeiten und unser eigenes „Standard“-Technologiedokument von Simonsoft vorstellen.

Hintergrund

Wir haben einmal eine Frage erhalten: Welche XML-Standards gibt es für unsere Branche? Eine einfache Google-Suche später hatten wir etwa 60 verschiedene XML-Standards gefunden, die alle behaupteten, genau das zu sein – ein Standard. Beginnen wir mit den Grundlagen, um die Situation besser zu verstehen.
Ein XML-Dokument trennt zwischen Inhalt, Stil und Struktur.

Um sicherzustellen, dass Autoren den gleichen Prinzipien eines Dokuments folgen, wird die Struktur von einer „DTD“ (Document Type Definition) oder einem „Schema“ gesteuert. In dieser XML-Datei wird die Struktur gesteuert, um zu bestimmen, welcher Inhalt zu welchem Zeitpunkt erlaubt ist, wie der Inhalt wiederverwendet werden kann und welche Dateielemente zulässig sind. Kurz gesagt können zwei Autoren, die dieselbe DTD verwenden, ihre Dokumente problemlos zusammenführen, ohne dass es zu Formatierungsproblemen wie Seitenumbrüchen kommt.

Soweit so gut, aber wenn man sich die Dokumentation für verschiedene Branchen ansieht, wird der Inhalt recht unterschiedlich sein. Deshalb begannen die verschiedenen Branchen, standardisierte DTDs zu entwickeln, die ihren Bedürfnissen entsprechen. Die drei häufigsten sind DITA, DocBook und S1000D (Shipdex).

Buchbasierte DTDs – DocBook

Das häufigste Format ist ein klassisches Buch. Es hat ein Titelblatt, ein Inhaltsverzeichnis, Kapitel und einen Anhang. Einige technische Veröffentlichungen können auch Unterkapitel oder Abschnitte enthalten.
Dieses Format ist für jeden vertraut. Die abstrakte Struktur von Titelblatt, Titel, Inhaltsverzeichnis und Kapitel kann als Platzhalter für Inhalte dienen, unabhängig davon, worum es geht. Das Buch als DTD funktioniert gut!

Es gibt einige standardisierte DTDs rund um das Buch, und das häufigste ist Docbook. Es handelt sich um eine strukturelle Datei, die seit rund 20 Jahren entwickelt wird und in jedem gängigen XML-Editor erhältlich ist. Die meisten bestehenden DTDs basieren auf dem Buchformat und bieten folgende Vorteile:

  • Leichtes Übertragen von MS Word, InDesign oder anderen Dokumenten
  • Umfassend und leicht zu erlernen
  • Einfach zu erstellende Stilvorlagen für das Layout

Topic-basierte DTD’s – DITA

In der XML-Welt gibt es einen klaren Unterschied zwischen den DTD’s, die auf Büchern basieren, und denjenigen, die sich auf „Topics“ (Themen) konzentrieren. Der mit Abstand bekannteste Standard ist DITA (Darwin Information Type Architecture). DITA wurde von IBM erfunden, hauptsächlich für Software-Dokumentationen.

Um die „Topic-based“-Struktur zu erklären, ziehe ich den Vergleich zu einer Firmen-Webseite. Jede Seite repräsentiert ein Thema, und alle Seiten zusammen bilden das Dokument. Das klingt für Webseiten großartig, aber was ist, wenn ich tatsächlich ein Buch produzieren möchte? Nun, DITA löst dieses Problem mit einem strukturellen Platzhalter namens „Book Map“ (Buchkarte). In dieser Karte können alle Themen in der gewünschten Reihenfolge für die Veröffentlichung verlinkt werden.

Wie Sie sich vorstellen können, ist es mit DITA recht schwierig, alte Inhalte von Buchformen in die neue Struktur zu übertragen, aber es passt hervorragend für Software-Dokumentationen oder Inhalte, die für das Web veröffentlicht werden sollen. Außerdem erfordert die Struktur mit „Topics“ (Themen) eine strengere Durchsetzung von Schreibregeln, da jedes Thema in sich geschlossen sein muss. Vielleicht erinnern Sie sich an das Spiel aus alten Zeiten, bei dem Sie eine Geschichte auf Papier verfassten. Dabei schrieb jeder Schüler einen Absatz und faltete das Papier, sodass der nächste Schreiber nur den letzten Satz sehen konnte. Wenn keine Regeln im Voraus festgelegt werden, kann die Geschichte am Ende ziemlich lustig sein.

Vorteile von DITA:

  • Extrem modulare Struktur, die eine hohe Wiederverwendung ermöglicht
  • Gut für Software-Dokumentationen und Web-Veröffentlichungen
  • Möglichkeit, Themen individuell zu übersetzen, da keine Kontextabhängigkeit besteht Nachteile:
  • Schwer zu erlernen
  • Kostspielige Migration
  • Komplexere Erstellung von Stilvorlagen

Modulbasierte DTDs – S1000D, ATA und Shipdex

Es gibt noch eine weitere wichtige Alternative zu den auf Büchern und themenbasierenden DTDs, nämlich die Aufteilung des XML-Inhalts in Module. In unserem Verständnis ist dies nicht weit von den auf Themen basierenden DTDs entfernt, aber es geht vielmehr darum, sie mit der Produktstruktur zu verknüpfen.

Die drei Standards sind sehr ähnlich, wurden jedoch von spezifischen Branchen initiiert. S1000D – Militär, ATA – kommerzielle Fluggesellschaften, Shipdex – Schifffahrt.

Der Zweck dieser Standards ist recht einfach zu verstehen. Wenn ein Flugzeughersteller alle Dokumentationen über ein Flugzeug zusammenstellen möchte, sind wahrscheinlich mehr als hundert Lieferanten beteiligt. Wenn jeder Lieferant sein eigenes Format und seine eigene Schreibweise verwendet, wäre es fast unmöglich, die Informationen zu einer einzigen Dokumentation zusammenzuführen. Tatsächlich müssen Lieferanten, die sich an diese Standards halten, die Informationen als XML liefern, ohne Stile anzuwenden. Das erleichtert die Erstellung eines vollständigen Dokumentationssatzes.

Diese Standards sind für Hersteller äußerst anspruchsvoll und werden daher außerhalb der genannten Branchen nur selten verwendet. Für Lieferanten, die nur teilweise für diese Branchen tätig sind, empfehlen wir, einen anderen Standard zu verwenden und eine Exportfunktion zum benötigten Standard zu erstellen.

Fazit

Ein Standard ist immer ein Standard und er versucht, allen Anwendungsfällen zu dienen. Standards sind manchmal zu komplex und können nicht einfach „out of the box“verwendet werden. Zum Beispiel gibt es in DITA fünf verschiedene Möglichkeiten, ein Bild zu markieren. Das erschwert die Wiederverwendung von Inhalten. Für die meisten Projekte ist es notwendig, den Standard an die Bedürfnisse des Unternehmens anzupassen. Das ist teuer und zeitaufwendig.

Simonsoft hat „Techdoc“ entwickelt, unsere eigene Version einer auf Büchern basierenden DTD, aber mit einigen Verbesserungen in Modularisierung, besseren Prozessbeschreibungen und einem vorgegebenen Stil. Wir haben auch Techniken entwickelt, um Informationen für andere modularisierte Standards wie Shipdex oder S1000D zu exportieren.

All das ermöglicht eine schnelle XML-Bereitstellung für mittelgroße Unternehmen.

Viel Glück!
Jonas

Social media

Follow us on our social media platforms


ÄHNLICHE BLOGBEITRÄGE

View all posts

PDSVISION wird Mitglied der GfSE

PDSVISION wird Mitglied der Gesellschaft für Systems Engineering (GfSE) zur...
Mehr erfahren

Unternehmen Weihnachtsspende – 10 Jahre kontinuierliche Unterstützung

Seit einem Jahrzehnt unterstützen wir Ärzte ohne Grenzen und unterstützen...
Mehr erfahren

Technische Berechnungen leicht gemacht

Technische Berechnungen leicht gemacht Mathcad Prime macht technische Berechnungen...
Mehr erfahren

Entfesseln Sie Ihren inneren Naturliebhaber: Freiwilligenarbeit in unseren nationalen Wäldern – Teil 2

Dies ist das zweite Update von Matt Sweitzer von PDSVISION. Matt verbrachte den...
Mehr erfahren

Optimiertes Änderungsmanagement

Die Welt hat einen Wirbelsturm von Veränderungen erlebt, doch das Wesen des...
Mehr erfahren

KeyShot 2023: Die neuesten Verbesserungen

Mit der neuen Version 2023 hat das KeyShot-Team eine Reihe von Verbesserungen...
Mehr erfahren

PDSVISION unterstützt die digitale Transformation mit Codebeamer 2.0: Entfesselte Produktivität und Kontrolle

Codebeamer 2.0 bringt erhebliche Leistungsverbesserungen mit sich.
Mehr erfahren

FLASH-LIDAR und die Auswirkungen auf die Unterhaltungselektronik

FLASH-LIDAR und die Auswirkungen auf die Unterhaltungselektronik Werfen wir einen...
Mehr erfahren