Skip to content

Christian Gödert war unzufrieden mit Swagger

Photo of Björn Wewer
Hosted By
Björn W. and Jana A.
Christian Gödert war unzufrieden mit Swagger

Details

... glücklicherweise ist er jemand, der sich zu helfen weiß. Er hat ein Konzept entwickelt und ein Werkzeug geschaffen, mit dem aus nahezu jedem Quellcode automatisiert Dokumentation erzeugt werden kann. Und das Beste: Er gewährt uns bei diesem Meetup am Beispiel der Swagger-API einen Blick in seine Trickkiste.
Die Aufgabenstellung ist altbekannt: Automatisiere was möglich ist! Die Vorteile liegen auf der Hand. Der Knackpunkt für Christian war die Kombination aus Automatisierung und Standardisierung, um Dokumentation individuell zu strukturierten und die Ausgabe nach Bedarf zu layouten.
Als Standard wählte er, als waschechter Technischer Redakteur, die Darwin Information Typing Architecture (DITA), um die Dokumentation zu erstellen und diese zu Informationsprodukten zu verarbeiten. Doch die verfügbaren Tools waren nicht vorhanden oder nicht geeignet.
Aus diesem Grund hat er eine eigene Lösung entwickelt. Die Vor- und Nachteile seines Ansatzes und wie man aus nahezu jedem Quellcode automatisiert Dokumentation erzeugen kann, wird er uns bei seinem Vortrag näherbringen: Beginnend beim Quellcode bis zum fertigen Informationsprodukt.

Für good ol' Pizza und Softdrinks ist gesorgt.

17.30-18.00 Ankunft & Pizza
18.00-19.30 Vortrag
ab 19.30 Diskussion & Reste-Essen

Noch eins zur Orga für "alte Hasen": Wir haben umfirmiert! Was vorher connyun war ist jetzt Körber Digital. Also nicht vom Namen verwirren lassen. ;-)

Photo of Write the Docs Karlsruhe group
Write the Docs Karlsruhe
See more events
Körber Digital GmbH
Alter Schlachthof 51, 76131 · Karlsruhe