Logo - tekom Messe18

DITA macht Diät: Vortrag auf der tekom-Jahrestagung 2018

von

Auf der tekom-Jahrestagung vom 13.-15.11.2018 in Stuttgart halte ich einen Fachvortrag. Genauer: Am 15.11. (Donnerstag), gleich morgens um 8:45 Uhr in Raum C4.2.

Interessiert dich Lightweight DITA und was man damit so anstellen kann? Dann hoffe ich dich begrüßen zu können!

DITA macht Diät – machen Sie mit!

Ich möchte ein Konzept vorstellen, um auf Basis von Lightweight DITA ein Content Management System selbst aufzubauen – mit Hilfe von preiswerten Tools. Dafür gehe ich auf folgende Punkte ein:

  • Was ist Lightweight DITA?
  • Welche Vorteile und Grenzen hat Lightweight DITA?
  • Kann man sich damit selbst eine flexible Redaktionsumgebung aus Standard-Tools zusammenzustellen, anstatt auf ein monolithisches CMS angewiesen zu sein?

Ausgangspunkt 1: Markttrends

Im Bereich der Technischen Dokumentation und der Redaktionsumgebungen gibt es zwei gegenläufige Trends:

Auf der einen Seite werden Standards über die Zeit immer komplexer wie z. B. DITA. Das ist von knapp 200 Elementen bei der Veröffentlichung der Version 1.0 auf mittlerweile über 600 Elemente in der Version 1.3 angewachsen. Auf der anderen Seite entstehen immer wieder Gegenbewegungen. Wie etwa vor 20 Jahren, als man das enorm komplexe SGML zu einem deutlich einfacheren XML weiterentwickelte.

Die gleiche Entwicklung gibt es auch bei DITA, wo aus dem Wunsch nach Vereinfachung der neue Standard Lightweight DITA entstanden ist. Dieser umfasst nurmehr knapp 50 Elemente und erschließt mit HTML und Markdown als zusätzliche Formate ganz neue Benutzergruppen.

Markdown und andere sogenannte „Lightweight Markup“-Sprachen sind ein weiterer Trend v.a. in der Software-Dokumentation, die die Hürden für die Erstellung guter Dokumentation deutlich senken.

Was ist Lightweight DITA?

Im April 2018 wurde die erste finale Version 1.0 von Lightweight DITA verabschiedet. Die wesentlichen Eigenschaften von Lightweight DITA sind:

  • Nur noch 48 Elemente (statt über 600 bei DITA 1.3)
  • 3 Datenformate, neben XML (= XDITA) gibt es jetzt auch HTML (= HDITA) und Markdown (= MDITA)
  • Neue Multimedia-Elemente
  • Spezialisierung weiterhin wie in DITA möglich
  • Immer noch DITA

Die starke Vereinfachung führt natürlich dazu, dass Lightweight DITA in seinen Möglichkeiten begrenzter ist als DITA. So gibt es etwa keine Informationstypen mehr und keine semantische Formatierung. Insgesamt ist Lightweight DITA sicher weniger für komplexere Anforderungen geeignet.

Durch die neuen Formate und die deutliche Vereinfachung ergeben sich aber ganz neue Chancen. Lightweight DITA hat das Potenzial, die Welt der „großen“ und komplexen (und teuren) Redaktionssysteme mit voller DITA-Unterstützung mit der Welt der viel einfacheren Content-Erstellung und -Verteilung im Bereich von Online-Hilfen für Software-Produkte zu verbinden.

Ausgangspunkt 2: Problemstellung im Unternehmen

Stellen Sie sich vor, Sie sind in einem globalen Internetunternehmen für die Dokumentation eines Produktbereichs verantwortlich. Ihr kleines Team ist über die Welt verstreut und hat nur begrenzte finanzielle und zeitliche Ressourcen. Durch mehrere Zukäufe über die letzten Jahre ist ein buntes Portfolio an Prozessen und Tools für die Erstellung und Publikation entstanden. Und aus der Sicht des Kunden gibt es ganz unterschiedliche Dokumentation, zu finden unter unterschiedlichen URLs.

Ihre Aufgabe ist es nun, dies zu konsolidieren. Ihnen schwebt eine Lösung vor, die für alle funktioniert. Die Anforderungen sind folgende:

  • Globale Zusammenarbeit muss möglich sein, am besten als webbasiert.
  • Die Lösung muss flexibel, betriebssystem- und browserunabhängig sein.
  • Die Lösung soll auf die konkrete Situation zugeschnitten sein, aber in Zukunft anpass- und erweiterbar sein.
  • Sie möchten mit preiswerten und weit verbreiteten Tools arbeiten, die mit verhältnismäßig geringem Aufwand individuell angepasst werden können.
  • Sie möchten Standards verwenden, damit Sie in Zukunft nicht auf bestimmte proprietäre Software angewiesen sind. Außerdem können Sie so Daten zwischen verschiedenen Tools leichter austauschen.

Ich hatte da eine Idee.

Idee: Bauen Sie sich Ihre eigene Umgebung auf der Basis von Lightweight DITA auf!

Mit den Anforderungen und dem neuen spannenden Lightweight DITA-Standard lässt sich nun eine „Architektur“ für eine Redaktionsumgebung entwerfen. Mindestens notwendig sind eine Möglichkeit zum Speichern der Dateien, ein Editor und eine Publikationsumgebung:

  • Datenformat: Lightweight DITA. Dies wird schon jetzt von verschiedenen Tools unterstützt, und die Anzahl wird sicher wachsen. LwDITA ist textbasiert (einfaches Handling) und als Standard verabschiedet.
  • File Repository: Vielleicht ist in Ihrem Unternehmen schon eines im Einsatz (wenn Sie Software entwickeln). Beispiele: Git (z.B. in Form von Bitbucket oder Github), Subversion oder sogar Google Drive.
  • Editor: Die Inhalte können in vielen verschiedenen Systemen erstellt werden, je nach Präferenz des Autors. Beispiele: Adobe FrameMaker, Oxygen, Texteditoren wie Notepad++ oder Atom. Gerade für Markdown gibt es wirklich viele Tools.
  • Publikation: Idealerweise verwenden Sie ein Content Delivery Portal
    (z.B. FluidTopics). Das “füttern” Sie mit ganz unterschiedlichen Quelldaten (auch existierende Daten aus bisherigen Systemen). Daraus erzeugt das Portal eine dynamische und facettierte Online-Hilfe. Sie können aber auch auf eine Vielzahl von Werkzeugen für die Generierung von statischen Online-Hilfen oder PDF-Dateien zurückgreifen, z. B. DITA Open Toolkit.
  • Strukturierungsmethode/Inhaltskonzept: Für die Zusammenarbeit unerlässlich – arbeiten Sie nicht ohne. Beispiele sind AraKonzept oder Funktionsdesign.

Und auch für weitere Aufgaben ist man nicht an einen bestimmten Hersteller gebunden. Inhalte in LwDITA sind einfach zu exportieren, einfach zu konvertieren, einfach wiederzuverwenden usw.:

  • Review: Für Korrekturläufe lassen sich Werkzeuge der Content Repositories verwenden. Oder man generiert aus den Quelldateien PDF-Dokumente oder bearbeitbare Formate.
  • Übersetzung: Jedes gängige Translation Memory System kann Dateien in XML, HTML oder einem Textformat wie Markdown verarbeiten.
  • Terminologie
  • Konvertierungen
  • Usw.

Quellen

DITA:

Markdown:

Tools:

Schreiben Sie einen Kommentar