Spoiler: Es war ein AI-Co-Pilot. 😄
Was macht eine gute Architektur-Dokumentation aus?
➡️ Sie ist code-nah.
➡️ Sie lebt im Repository, verlinkt z. B. in der README.
➡️ Sie ist von den Teams geschrieben, nicht „von oben“.
Mein Architektur-Doku-Setup – ein echtes Onboarding-Manifest:
- Produktvision
- Requirements (am besten als BDD-Features, inkl. FR/NFRs & DDD-Glossar)
- High-Level-Architektur (Context- & Komponenten-View nach C4)
- Architecture Decision Records (ADRs)
- Coding Guidelines (Naming, Templates)
- Teststrategie
✨ Bonus-Effekt: Wenn diese Doku aktuell bleibt (Pflege über die DoD + MR-Review), wird sie zum echten Produktivitätsbooster – für neue Kolleg:innen und für eure AI-Co-Pilots.
Seit kurzem arbeite ich mit Cursor IDE (Anthropic), davor mit GitHub Copilot & IntelliJ – was ich gelernt habe:
Wenn die Doku stimmt, liefern Co-Pilots richtig gute Ergebnisse.
Plötzlich werden ADRs eingehalten, Konventionen respektiert – weil die Maschine endlich weiß, wie wir denken.
Software-Engineering verändert sich rasant.
Wir schreiben Doku heute nicht nur für Menschen, sondern auch für Maschinen.
🚀 Wie dokumentiert ihr eure Architektur?
📌 Pflegt ihr sie aktiv im Repo?
🤖 Nutzen eure Co-Pilots schon eure README als Einstieg?
Teilt eure Erfahrungen – ich bin neugierig! 👇
#SoftwareEngineering #Architecture #Documentation #AI #Copilot #DevEx #SoftwareArchitecture #Onboarding #CursorIDE #GitHubCopilot #LLMs #DeveloperExperience