Documentation-as-Code

2024-10-28 - 2024-10-29

Docs-as-Code (online) - Ralf Müller, Falk Sippach - Deutsch

Description

Architektur-Dokumentation wird sehr oft stiefmütterlich behandelt. Die Gründe dafür sind vielfältig und unter anderem in der Verwendung unpraktikabler Werkzeuge und Formate zu finden. Beim Docs-as-Code-Ansatz wird Dokumentation wie Quellcode behandelt. Dokumente werden in leichtgewichtigen Text- und Grafikformaten erstellt, nahe beim Sourcecode in beispielsweise Git-Repos abgelegt und versioniert sowie in automatisierten Build-Prozessen verarbeitet. Dieses Seminar zeigt aufbauend auf schlanken Tools und Markup-Sprachen die Erstellung einer möglichst redundanzfreien Dokumentation, die für verschiedene Zielgruppen optimiert und in ansprechenden Formaten kontinuierlich ausgeliefert werden kann.

Agenda

  • Einführung in Documentation-as-Code und unser Fallbeispiel
  • Ablage in der Versionsverwaltung
  • Notwendige Werkzeuge und Integration ins Build-Management
  • Einsatz von Markup-Sprachen
  • Modularisierung der Dokumentation
  • Effektive Erstellung von Diagrammen (PlantUML, Kroki.io, Diagrams.net, …)
  • Erzeugung von zielgruppenorientierten Ergebnisformaten
  • Einbinden vorhandener Informationen zur Vermeidung von Redundanzen (Quellcode, Modelle, …)
  • Weiterführende Themen wie Microsites und Im- und Export-Formate

Your Trainers

Falk Sippach

embarc

Architekturbewertungen, Java Experte

Als Trainer, Berater und Architekt ist Falk stets auf der Suche nach dem Funken Leidenschaft, den er bei seinenTeilnehmern, Kunden und Kollegen entfachen kann. Bereits seit über 15 Jahren unterstützt er in meist agilen Softwareentwicklungsprojekten im Java-Umfeld, anfangs als Entwickler, später als Projektleiter, Architekt und Coach. Falk ist überzeugt, dass lebenslanges Lernen die Voraussetzung für die berufliche Selbstentfaltung und dauerhafte Freude am Tun ist. Trotz der Begeisterung für Neues behält er immer auch die Menschen und gewachsene Strukturen im Blick, um ausgewogene Lösungen entwickeln zu können. Als aktiver Bestandteil der Community teilt er sein Wissen gern in Artikeln, Blog-Beiträgen sowie bei Vorträgen auf Konferenzen oder User Group Treffen und unterstützt bei der Organisation diverser Fachveranstaltungen. Video: Was ist eigentlich Documentation as Code? Falk erklärt es euch im Stream mit Lisa Moritz.

Ralf Müller

Docs-as-Code, Softwaredokumentation

Ralf hat in über 25 Jahren in der Softwarebranche seine Fähigkeiten kontinuierlich verbessert und sich vom Softwareentwickler zum erfahrenen Software-Architekten entwickelt. Neben dem Design von Softwarearchitekturen legt er großen Wert auf die klare Kommunikation und Dokumentation seiner Ideen. Mit diesem Ziel vor Augen hat Ralf das Open-Source-Projekt docToolchain ins Leben gerufen, das sich mit der effektiven Dokumentation von Softwarearchitekturen beschäftigt. Er ist auch verantwortlich für die Erstellung der verschiedenen Formate des arc42 Templates. Als CPSA-Advanced-zertifizierter Softwarearchitekt teilt Ralf sein Wissen und seine Erfahrung in Schulungen und Vorträgen, um anderen zu zeigen, wie sie Architekturdokumentation einfach und aktuell halten können. Video: Mehr als Pfeile und Kästchen – Architekturdiagramme im Softwarearchitektur-Stream.

All info about training