Rückblick zur DITAWORLD 2022
c-rex.net bei der DITAWORLD 2022
Drei Tage vollgepackt mit Vorträgen rund um das Thema Intelligent Content for an intelligent world
. So lautete der
diesjährige Slogan, den Adobe für die DITAWORLD 2022 gewählt hatte.
Nach Angaben von Adobe nahmen mehr als 6000 Teilnehmer aus der ganzen Welt vom 10.-12. Mai 2022 an der Onlinekonferenz teil.
Das Programm bot Vorträge, Keynotes und Praxisberichte zu einer großen Bandbreite an Themen. Es ging unter anderem um DITA, strukturiertes Editieren, RoboHelp, Captivate, Lokalisierung, Microcontent, API-Dokumentation und vieles mehr.
Wir von c-rex waren erstmalig als Platinum-Sponsor dabei und haben uns in diesem Jahr mit zwei Sessions beteiligt.
-
Building Content Bridges. Why Content Needs to Flow Like Water.
In seiner Keynote erklärt Markus Wiedenmaier, warum Inhalte wie Wasser fließen müssen, warum es zwei Herangehensweisen braucht, wenn es um Inhaltserstellung geht und dass wir in Schnittstellen denken müssen.
Im Abschnitt Content-Brücken bauen. Warum Inhalt fließen muss wie Wasser. gibt’s eine kurze Inhaltsangabe.
Eine Aufzeichnung der Keynote ist auf YouTube verfügbar.
-
Decouple development and documentation processes. API-Documentation - with OpenApi/Swagger, DITA, and AEM
Im seinem zweiten Vortrag beschäftigt sich Markus mit Entwicklungs- und Dokumentationsprozessen. Software-Entwicklung und technisches Schreiben sind keine Silos mehr. Im Gegenteil, sie wachsen mehr und mehr zusammen. Personen, die Software entwickeln, schreiben auch die Benutzerdokumentation. Oder das Team der Technischen Redaktion ist Teil des Scrum-Teams und begleitet die Entwicklung. Aber ist es gut, wenn die Dokumentation vom Entwicklungsteam geschrieben wird?
Markus' Antwort und sein Vorschlag, wie man mit dieser Problematik sinnvoll umgehen sollte, gibt es im Abschnitt Entkoppeln Sie Entwicklungs- und Dokumentationsprozesse. API-Dokumentation - mit OpenApi/Swagger, DITA und AEM und in der Vortragsaufzeichnung auf YouTube.
Brücken bauen und damit Inhalts-Silos verbinden. Warum Inhalt fließen muss wie Wasser.
Kurzusammenfassung des Vortragsinhalts. Vortragsaufzeichnung auf YouTube
Wenn Unternehmen die digitale Transformation verschlafen, verschlafen sie auch die Disruption. Doch wie erreicht eine Organisation eine Transformation, wenn Sie sich in siloartigen Unternehmensstrukturen befindet? Insbesondere im Bereich der technischen Dokumentation – aber auch darüber hinaus? Das rein technische Aufbrechen der Silos reicht nicht aus. Vielleicht ist das Aufbrechen dieser Silos an manchen Stellen sogar kontraproduktiv.
Vielmehr brauchen wir im Rahmen unserer Content-Strategie zwei "Content-Betriebssysteme":
-
Wir brauchen eines für unsere internen Daten und redaktionellen Prozesse.
Es sollte strukturiert, stabil und fehlertolerant sein und Informationen automatisch transportieren.
-
Und wir brauchen eines für die Integration unserer zunehmend dynamischen Außenwelt.
Dieses System muss sich agil entwickeln und flexibel an die Anforderungen unserer Kunden, Nutzer und des Marktes anpassen.
Wir müssen in Schnittstellen denken: Aus technischer und organisatorischer Sicht.
Unternehmens- und Produktinformationen müssen - wie Wasser - innerhalb und außerhalb des Unternehmens zu jedem fließen, der sie braucht, zu Menschen und vor allem zu Maschinen.
Entkoppeln Sie Entwicklungs- und Dokumentationsprozesse. API-Dokumentation mit OpenApi/Swagger, DITA und AEM
Kurzzusammenfassung des Vortragsinhalts. Vortragsaufzeichnung auf YouTube
Software-Entwicklung und technisches Schreiben sind keine Silos mehr. Sie sind zusammengewachsen und oft wird die Benutzerdokumentation von der Softwareentwicklung übernommen.
Aber ist es gut, wenn die Personen, die Software entwickeln, auch die Dokumentation schreiben? Die Antwort von uns ist ein klares Nein. Schließlich braucht es Spezialwissen in beiden Disziplinen. Und raten Sie mal, wer gewinnt, wenn der Abgabetermin näher rückt und Softwarecode und Softwaredokumentation von der gleichen Person geschrieben werden. Gewinnt die Softwareversion oder die Dokumentation?
Die beste Option ist, beides zu haben: Personen, die Software entwickeln, und Personen, die Software beschreiben und die technische Redaktion übernehmen. Unsere Aufgabe ist, beide Bereiche intelligent miteinander zu verknüpfen, so dass beide Bereiche entkoppelt voneinander arbeiten können und der Informationsaustausch möglichst automatisch abläuft. Wenn wir dabei auch die Zielgruppe im Auge behalten, haben wir einen zukunftssicheren Ansatz für die Erstellung von Softwaredokumentation.
Im Vortrag wird am Beispiel der REST-API-Dokumentation dargestellt, wie man die OpenAPI-Spezifikation (ehemals Swagger-Spezifikation) und DITA nutzen und in den Adobe Experience Manager integrieren kann.
Ziel ist es, den Dokumentationsprozess zu entkoppeln, den Kommunikationsbedarf zwischen den beiden Domänen deutlich zu reduzieren und ein Konzept für eine benutzerfreundliche API-Dokumentation zu erstellen.
Gern verweisen wir hier auf unseren Blogbeitrag Flexibel dokumentieren mit DITA, indem wir die Leistungsfähigkeit der DITA-Reuse-Mechanismen beschreiben.