Docs as Code, arc42, AsciiDoc, Gradle und Antora im Einsatz

Docs as Code, arc42, AsciiDoc, Gradle und Antora im Einsatz

JAX Mainz, 08.05.2019, https://jax.de/software-architecture/docs-as-code-arc42-asciidoc-gradle-und-antora-im-einsatz/

Laut mehrerer Umfragen ist fehlende Dokumentation ein großes Hindernis für den Einsatz von Open-Source-Software. In diesem Vortrag wird gezeigt, wie Sie einfach für Ihr Produkt, egal ob Open oder Inner Source, verschiedene Arten von Dokumenationen erzeugen. Dazu werden die gleichen Tools und Ansätze verwendet, wie sie schon zur Entwicklung des Codes Ihres Produkts eingesetzt werden. Damit können Sie die Qualität Ihrer Dokumentation erhöhen und gleichzeitig den Aufwand zur Pflege reduzieren. Anhand des Beispiels einer Architekturdokumentation zeigt Ralf, wie Sie mit dem arc42-Template im AsciiDoc-Format und Gradle als Build-Tool einfach Diagramme in Ihre Dokumentation integrieren, stakeholderspezifische Dokumente erzeugen und verschiedene Ausgabeformate generieren. Zum Schluss werden die Dokumente noch zu einer hübschen Website zusammengeführt.

https://docs-as-co.de

https://www.dbsystel.de/

Cc5f3bf8b3cb91c985ed4fd046aa451d?s=128

Ralf D. Müller

May 08, 2019
Tweet