Docs-as-Code, Arc42, ASCIIDOC, Gradle & Co. im Einsatz
Sprecher: Ralf D. Müller
Aufgenommen: 2021-04-13
00:00:00 Begrüssung
00:03:33 Der Vortrag
00:05:22 Problemstellung
00:06:30 Wer bin ich?
00:07:43 Setting the Scene
00:09:29 arc42
00:20:52 Docs-as-Code
00:28:50 Zwischenfragen
00:34:37 Diagramme
00:41:39 Nicht malen, modellieren!
00:44:16 Stakeholder
00:49:37 Zusammenarbeit
01:04:36 Testing
01:07:24 Static Site Generators
01:13:50 docToolchain
01:15:10 Abschluss
01:15:54 Fragen/Diskussion
Der Vortrag zeigt, wie Du die Qualität Deiner Dokumentation erhöhst und gleichzeitig den Aufwand zur Pflege reduzierst, indem Du Deine Dokumentation genauso wie Deinen Code verwaltest und in den Build integrierst. Anhand des Beispiels einer Architekturdokumentation, zeigt Ralf, wie Du mit dem arc42-Template im AsciiDoc-Format und Gradle als Build-Tool einfach Diagramme in Ihre Dokumentation integrierst, Stakeholder-spezifische Dokumente erzeugst und verschiedene Ausgabeformate generierst. Reviewfähige PDF-Dokumente? Publishing nach Confluence? Integration einer Präsentation? Alles kein Problem! Einige Teile der Doku kannst Du sogar automatisiert testen!
Ralf ist tagsüber Software Engineering Advocat bei DB Systel und liebt nach Sonnenuntergang alles, was mit Bits und Bytes zu tun hat. In den letzten Jahren seiner Karriere konzentrierte er sich auf die Dokumentation von Softwaresystemen mit arc42 und den Docs-as-Code-Ansatz.
Twitter: @RalfDMueller
Organisiert von: Java User Group Switzerland
https://www.jug.ch/