Der nachfolgende Text wurden mit KI erstellt und kann Fehler enthalten. Fehler gefunden? Bei GitHub editieren
Wichtige Keytakeaways
- Architekturdokumentation ist textlastig und eignet sich daher ideal für GenAI-Unterstützung, besonders wenn Diagramme als Code (PlantUML, Mermaid) vorliegen.
- GenAI funktioniert am besten als unterstützendes Werkzeug im Dialog, nicht zur vollautomatisierten Dokumentationsgenerierung, um Qualität und Korrektheit zu gewährleisten.
- Qualitätsziele sollten idealerweise im Team mit Stakeholdern erarbeitet werden – GenAI kann eher bei ADRs (Architecture Decision Records) sinnvoll eingesetzt werden.
- Review und Konsistenzprüfung von bestehender Dokumentation sind die “Sweet Spots” für GenAI-Einsatz und funktionieren zuverlässig bei klaren Kriterien.
- Legacy-Systeme können durch Tools wie DeepWiki automatisiert dokumentiert werden, aber Anforderungen und Designentscheidungen lassen sich nur begrenzt rekonstruieren.
- LLM-Modellwahl, Prompt-Engineering und Eingabequalität haben großen Einfluss auf die Ergebnisse – “Shit in, Shit out” gilt auch hier.
Behandelte Kernfragen
- Welche Synergieeffekte entstehen durch die Kombination von Docs-as-Code und GenAI?
- Wie können Qualitätsziele und Architekturentscheidungen mit GenAI-Unterstützung erarbeitet werden?
- Wie lassen sich bestehende Legacy-Systeme automatisiert dokumentieren?
- Wie können GenAI-basierte Review-Tools Konsistenz und Best Practices in Architekturdokumentation überprüfen?
- Wie sollte die Zusammenarbeit zwischen Teams und GenAI beim Erarbeiten von Dokumentation gestaltet werden?
- Welche Grenzen und Herausforderungen gibt es bei der GenAI-gestützten Dokumentationsgenerierung?
Glossar wichtiger Begriffe
- ADR (Architecture Decision Records): Dokumentationsformat, das Architekturentscheidungen mit Begründung, Alternativen und Entscheidungskriterien strukturiert festhält.
- arc42: Bewährte Template-Struktur zur Dokumentation von Softwarearchitektur mit standardisierten Abschnitten wie Qualitätszielen, Kontextabgrenzung und Lösungsstrategie.
- Docs-as-Code: Ansatz, bei dem Dokumentation wie Quellcode versioniert, gereviewed und automatisiert verarbeitet wird, typischerweise in Markdown oder Diagramm-DSLs.
- DeepWiki: KI-gestützte Lösung, die aus Quellcode-Repositories automatisch durchsuchbare Wiki-Dokumentation mit Chat-Interface generiert.
- Qualitätsszenarien: Konkretisierung abstrakter Qualitätsziele durch spezifische Szenarien, die messbare Anforderungen an die Systemqualität festlegen.
- Prompt Engineering: Gestaltung und Optimierung von Eingabeaufforderungen an LLMs, um bessere und konsistentere Ergebnisse zu erzielen.
Genannte Technologien
- PlantUML / Mermaid: Domain-Specific Languages für textbasierte Diagramm-Definition, ermöglichen Docs-as-Code für Visualisierungen.
- DeepWiki (DeepWiki RS / DeepWiki Open): Automatisierte Dokumentationsgeneratoren aus Quellcode mit Chat-Interface, teilweise Open-Source verfügbar.
- Claude / Mistral: LLM-Modelle, die als Basis für dokumentationsgestützte Anwendungen eingesetzt werden können.
- Doxygen: Klassisches Tool zur automatisierten Generierung von API-Dokumentation aus Quelltext, sprachunabhängig.
- Teamscale: Kommerzielle Lösung für statische Code-Analyse mit hochwertigen Visualisierungen.
- Ollama: Lokal lauffähiges LLM-Framework zur Ausführung von Sprachmodellen ohne Cloud-Abhängigkeit.
- arc42agentic: Werkzeug zum LLM-gestützen Review von Architektur-Dokumentation