Docs-as-Code: Anatomie einer realen Systemdokumentation

Docs-as-Code: Anatomie einer realen Systemdokumentation

W-Jax, 6.11.2018, München
https://jax.de/software-architecture/docs-as-code-anatomie-einer-realen-systemdokumentation/

Diese Session wurde als Live-Coding durchgeführt, deshalb (fast) keine Slides.

Alle Infos gibt es jedoch auf https://docs-as-co.de

Das Repository unseres Beispiel ist auf https://github.com/aim42/htmlSanityCheck zu finden

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 direkten Konsum („wiederverwenden“) geeignet. Sie erleben (live), wie Sie mehrere Dokumentationsartefakte kombinieren können, für verschiedene, zielgruppenunterschiedliche Ausgaben generieren und plattformübergreifend nebenbei noch eine Website für Ihre Doku zaubern können. Neben diversen Good Practices zeigen Ralf und Gernot auch die Probleme und Grenzen einiger Ansätze auf. Format: Viel Demo, wenige Slides, Github-Repository zum selbst ausprobieren.

Cc5f3bf8b3cb91c985ed4fd046aa451d?s=128

Ralf D. Müller

November 06, 2018
Tweet