Docs-as-Code: Anatomie einer smarten Systemdokumentation

10.12.2019, IT-Tage, Frankfurt
https://www.ittage.informatik-aktuell.de/programm/2019/docs-as-code-anatomie-einer-smarten-systemdokumentation/

In diesem Vortrag zeigen Ralf und Gernot anhand eines (kleinen aber) realen Projekts, wie Sie Schritt für Schritt den Docs-as-Code-Ansatz verwirklichen können. Von Anforderungs- und Architekturdokumentation bis hin zu Developer-Guidelines ist alles einfach, pragmatisch und zum Wiederverwenden geeignet. Sie erleben (live), wie Sie mehrere Dokumentationsartefakte kombinieren können, für verschiedene Zielgruppen unterschiedliche Ausgaben generieren und plattformübergreifend nebenbei noch eine Website für Ihre Doku zaubern können.

Wir vermitteln einerseits die zugrunde liegenden Konzepte, parallel dazu stets die praktische Umsetzung, daher gibt's relativ wenige Slides, und viel praktische Demo. Alles, was wir hier zeigen basiert auf quelloffener Software - Sie können unsere Beispiele in Github-Repositories nachvollziehen.

Transcript

1. Docs-as-Code: Anatomie einer realen Systemdokumentation Dr. Gernot Starke & Ralf D. Müller IT-Tage 2020
2. In diesem Vortrag zeigen Ralf und Gernot anhand eines (kleinen aber) realen Projekts, wie Sie Schritt für Schritt den Docs-as-Code-Ansatz verwirklichen können. Von Anforderungs- und Architekturdokumentation bis hin zu Developer-Guidelines ist alles einfach, pragmatisch und zum Wiederverwenden geeignet. Sie erleben (live), wie Sie mehrere Dokumentationsartefakte kombinieren können, für verschiedene Zielgruppen unterschiedliche Ausgaben generieren und plattformübergreifend nebenbei noch eine Website für Ihre Doku zaubern können. Wir vermitteln einerseits die zugrunde liegenden Konzepte, parallel dazu stets die praktische Umsetzung, daher gibt's relativ wenige Slides, und viel praktische Demo. Alles, was wir hier zeigen basiert auf quelloffener Software - Sie können unsere Beispiele in Github-Repositories nachvollziehen.
3. Durch Verwendung verschiedener Präsentationsmedien existiert zu dieser Session kein Foliensatz. Alle Infos gibt es jedoch auf https://docs-as-co.de bzw. https://arc42.org Das Repository unseres Beispiel ist auf https://github.com/aim42/htmlSanityCheck zu finden. Fragen zum Vortrag können gerne an Ralf.D.Mueller@docs-as-co.de gestellt werden.
4. https://leanpub.com/arc42-primer https://leanpub.com/arc42byexample
5. https://leanpub.com/praxisbuchdocs-as-code/c/nikolaus-2019