KI-Technik & Entwicklung

Architektur- und Code-Doku mit KI: aktuell halten statt nachpflegen

Kaum ist ein Architekturdiagramm gezeichnet, hat der Code es überholt, und das Wiki beschreibt eine API, die es so nicht mehr gibt. In diesem halben Tag erfahren Softwarearchitekten, Entwickler und technische Redakteure, wie KI Diagramme, API-Beschreibungen und Architecture Decision Records aus dem Repository ableitet und wie Docs-as-Code die Dokumentation an jede Änderung koppelt. Zwei Übungen an einem Repository zeigen, was die generierte Fassung leistet und wo sie ein fachkundiges Review braucht. Am Schluss steht eine Dokumentationsstrecke, die sich in CI und Wiki einfügt.

Für wen

Softwarearchitekten, Entwicklerinnen und Entwickler sowie technische Redakteure, die Dokumentation mit KI zügiger erstellen und dauerhaft auf Stand halten wollen.

KI-Kompaktseminar · 4 Stunden

Diagramme, API-Doku und ADRs aus dem Code ableiten und mit jeder Änderung erneuern

Das nehmen Sie mit

  • Ein KI-gestützt dokumentiertes Übungs-Repository mit abgeleitetem Diagramm und API-Beschreibung.
  • Einen Blick dafür, wo generierte Dokumentation trägt und wo sie ein fachkundiges Review braucht.
  • Ein Vorgehen, um Begriffe und Schreibstil über viele Autorinnen und Autoren hinweg anzugleichen.
  • Den Entwurf einer Dokumentationsstrecke, die bei Änderungen über CI und Wiki selbst nachzieht.

Ablauf

  1. Teil 1

    Modul 1 – Befund: Weshalb Dokumentation dem Code hinterherläuft

    • Ursachen veralteter Doku und welche davon KI tatsächlich beheben kann
    • Docs-as-Code: Dokumentation im Repository versionieren und als lebende Dokumentation führen
    • Was automatisch erzeugte Doku nicht leistet, etwa Begründungen und fachlichen Kontext
    • Gepflegte Doku als Zeitersparnis bei Einarbeitung, Fehlersuche und Übergaben
    • Selbsteinschätzung: wie aktuell Architektur- und API-Doku in Ihrem Team sind
  2. Teil 2

    Modul 2 – Ableiten: Diagramme und API-Doku direkt aus dem Code

    • Architekturdiagramme im C4-Modell und als Mermaid aus dem Quellcode erzeugen
    • API-Beschreibungen und Modul-Dokumentation automatisch generieren lassen
    • Übung: Ein Beispiel-Repository mit KI dokumentieren, vom Überblick bis zur Schnittstelle
    • Wie aus lästiger Pflichtdoku ein Nachschlagewerk wird, das das Team tatsächlich nutzt
  3. Teil 3

    Modul 3 – Angleichen: ADRs, Terminologie und Review

    • Architecture Decision Records mit KI-Unterstützung entwerfen und ergänzen
    • Einheitliche Begriffe und einheitlichen Stil durchsetzen, auch bei vielen Beitragenden
    • Review-Abläufe für generierte Doku: wer prüft was, bevor es veröffentlicht wird
    • Übung: Uneinheitliche Bezeichnungen in mehreren Doku-Seiten mit KI auf ein Glossar bringen
  4. Teil 4

    Modul 4 – Verstetigen: Doku, die mit jeder Änderung mitwächst

    • Dokumentation bei Code-Änderungen automatisch neu erzeugen und aktualisieren
    • Einbindung in CI-Abläufe und bestehende Wikis
    • Fallstudie: Eine Dokumentationsstrecke für ein Entwicklungsteam aufbauen
    • Fahrplan: welche Doku-Arten Sie zuerst automatisieren, damit sie nicht erneut veraltet

VoraussetzungenErfahrung in der Programmierung oder im Softwarearchitektur-Umfeld ist erforderlich.

AbschlussTeilnahmezertifikat und digitales Badge

Thema anfragen