Architektur-Dokumentation
Erstellt strukturierte Architektur-Dokumentation nach ADR und C4-Model.
Der Prompt
Du bist ein Software-Architekt mit Fokus auf klare Dokumentation komplexer Systeme. Erstelle Architektur-Dokumentation für: **System:** [SYSTEMNAME] **Zweck:** [WAS TUT DAS SYSTEM] **Haupt-Komponenten:** [KOMPONENTEN] **Externe Abhängigkeiten:** [APIs, DATENBANKEN, SERVICES] **Deployment-Umgebung:** [CLOUD / ON-PREM / HYBRID] **Team-Grösse:** [WIE VIELE ENTWICKLER] **Wichtigste Architektur-Entscheidungen:** [LISTE] Liefere: 1. **System-Übersicht** (C4-Level 1: Context Diagram) - Was ist das System? - Wer nutzt es? - Mit welchen externen Systemen interagiert es? 2. **Container-Diagramm** (C4-Level 2) - Hauptkomponenten (Web, API, DB, Message Queue) - Technologie-Stack pro Container - Kommunikationswege 3. **Component-Diagramm** (C4-Level 3, für Hauptkomponenten) - Interne Struktur - Abhängigkeiten 4. **Architecture Decision Records (ADRs)**, für die wichtigsten 3-5 Entscheidungen: - Kontext (warum mussten wir entscheiden?) - Optionen (welche Alternativen gab es?) - Entscheidung (was wurde gewählt) - Konsequenzen (positive und negative) 5. **Cross-Cutting Concerns:** - Authentication & Authorization - Logging & Monitoring - Error Handling - Data Management - Deployment & CI/CD 6. **Quality Attributes:** - Performance-Ziele (Response Times, Throughput) - Verfügbarkeit (SLA) - Sicherheit (Threat Model) - Skalierbarkeit 7. **Bekannte Trade-Offs und technische Schulden** Stil: präzise, ohne Buzzwords, ehrlich über Limitationen. Technische Details, aber zugänglich.
Anzupassende Variablen
[SYSTEMNAME][ZWECK][KOMPONENTEN][EXTERNE ABHÄNGIGKEITEN][DEPLOYMENT][TEAM-GRÖSSE][ENTSCHEIDUNGEN]Warum dieser Prompt funktioniert
Architektur-Dokumentation ist meist entweder zu abstrakt (nutzlos für Entwickler) oder zu detailliert (veraltet nach 2 Wochen). C4-Model und ADRs sind der Industriestandard, weil sie gerade das richtige Abstraktionsniveau bieten.
Beispielausgabe
Häufige Fragen
Wie detailliert sollte Architektur-Dokumentation sein?
Gerade so detailliert, dass ein neuer Entwickler in 2 Stunden das System versteht. Mehr wird nicht gelesen, weniger ist nutzlos.
Wie aktuell muss Architektur-Dokumentation sein?
Die High-Level-Diagramme sollten aktuell bleiben (monatliches Review). Detaillierte Komponenten-Dokumentation veraltet schnell, dort lieber auf den Code als Source of Truth verweisen.
Verwandte Prompts
Code-Review mit KI
Strukturiertes Code-Review mit Fokus auf Bugs, Performance, Best Practices und Security.
Bug-Analyse & Debug-Hilfe
Analysiert Bugs systematisch und schlägt konkrete Lösungsansätze vor.
API-Dokumentation Generator
Erstellt strukturierte API-Dokumentation mit Beispielen, Fehlercodes und Best Practices.