You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+196-1Lines changed: 196 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,4 +48,199 @@ Diese Richtlinie gilt für alle AI-Agenten, die Code oder Systemkonfigurationen
48
48
-[ ] Gesamte Testsuite (`pytest`) ohne Fehler durchgelaufen
49
49
-[ ] Änderungen mit den Projekt‑Konventionen konsistent
50
50
51
-
Diese Richtlinie gewährleistet, dass Code‑Änderungen nicht isoliert, sondern im Kontext des gesamten Projekts betrachtet werden und die langfristige Wartbarkeit sowie die Zuverlässigkeit der Software erhalten bleibt.
51
+
Diese Richtlinie gewährleistet, dass Code‑Änderungen nicht isoliert, sondern im Kontext des gesamten Projekts betrachtet werden und die langfristige Wartbarkeit sowie die Zuverlässigkeit der Software erhalten bleibt.
52
+
53
+
## Architecture-First Development Process
54
+
55
+
Dieser Abschnitt definiert den verbindlichen Arbeitsablauf für die Entwicklung neuer Funktionen im PySignalduino-Projekt. Der zentrale Grundsatz lautet: **Jede neue Funktion beginnt mit einer vorausschauenden Erweiterung der Architekturdokumentation.** Diese dokumentierte Architektur dient als die einzige verbindliche Spezifikation und der primäre Leitfaden für alle nachfolgenden Implementierungsschritte.
56
+
57
+
### Grundprinzipien
58
+
59
+
1.**Architektur vor Code:** Design-Entscheidungen müssen zuerst in der Dokumentation reflektiert und abgestimmt werden, bevor jeglicher Code geschrieben wird.
60
+
2.**Dokumentation als Single Source of Truth:** Die Architekturdokumentation ist die autoritative Referenz für alle Implementierungsentscheidungen.
61
+
3.**Traceability:** Jede Code-Änderung muss auf eine spezifische Architekturentscheidung zurückführbar sein.
62
+
4.**Compliance-Checks:** Implementierungen müssen regelmäßig auf Konformität mit der dokumentierten Architektur überprüft werden.
63
+
64
+
### Vier-Phasen-Prozess
65
+
66
+
#### Phase 1: Architekturdefinition mit verbindlichem Architekturproposal
67
+
-**Ziel:** Erstellung eines vollständigen Architekturproposals, das alle Design-Entscheidungen dokumentiert
68
+
-**Aktivitäten:**
69
+
- Anforderungsanalyse und Scope-Definition
70
+
- Erstellung von Architekturdiagrammen (Mermaid, PlantUML)
71
+
- Definition von Schnittstellen und Datenmodellen
72
+
- Risikoanalyse und Alternativenbewertung
73
+
- Erstellung eines Architecture Decision Record (ADR)
74
+
-**Deliverables:**
75
+
- Architekturproposal im AsciiDoc-Format
76
+
- Mermaid-Diagramme für Komponenten- und Sequenzabläufe
77
+
- ADR im `docs/architecture/decisions/` Verzeichnis
78
+
- Review-Protokoll mit Genehmigung durch Architecture Owner
79
+
80
+
#### Phase 2: Implementierungsplanung basierend auf genehmigter Architektur
81
+
-**Ziel:** Detaillierte Planung der Implementierungsschritte unter strikter Einhaltung der Architektur
82
+
-**Aktivitäten:**
83
+
- Aufteilung in konkrete Arbeitspakete (Tasks)
84
+
- Definition von Akzeptanzkriterien für jede Komponente
85
+
- Planung von Teststrategien (Unit, Integration, System)
86
+
- Ressourcen- und Zeitplanung
87
+
- Erstellung von Mockups/Prototypen für kritische Pfade
88
+
-**Deliverables:**
89
+
- Implementierungsplan mit Task-Breakdown
90
+
- Testplan mit Coverage-Zielen
91
+
- Prototypen für Risikokomponenten
92
+
- Genehmigung durch Feature Developer und Reviewer
93
+
94
+
#### Phase 3: Implementierung mit strikter Konformität zur Architektur
95
+
-**Ziel:** Code-Entwicklung unter ständiger Referenzierung der Architekturdokumentation
96
+
-**Aktivitäten:**
97
+
- Iterative Entwicklung gemäß Implementierungsplan
98
+
- Regelmäßige Architektur-Compliance-Checks
99
+
- Dokumentation von Abweichungen und deren Begründung
100
+
- Kontinuierliche Integration und Code-Reviews
101
+
- Anpassung der Dokumentation bei notwendigen Änderungen
G -->|Ja| H[ADR für Änderung<br/>oder Rückführung]
223
+
H --> E
224
+
G -->|Nein| I[Phase 4: Validation & Integration]
225
+
I --> J{Alle Tests bestanden<br/>und Compliance ok?}
226
+
J -->|Ja| K[Merge & Deployment]
227
+
J -->|Nein| I
228
+
229
+
subgraph "Architektur-Governance"
230
+
L[Architecture Owner Review]
231
+
M[ADR Management]
232
+
N[Compliance Monitoring]
233
+
end
234
+
235
+
B --> L
236
+
D --> L
237
+
I --> L
238
+
H --> M
239
+
F --> N
240
+
```
241
+
242
+
### Verbindlichkeit
243
+
244
+
Dieser Architecture-First Development Process ist für **alle** neuen Funktionen und wesentlichen Änderungen verbindlich. Ausnahmen sind nur bei kritischen Bugfixes erlaubt und müssen durch einen Emergency-ADR dokumentiert werden. Jede Abweichung vom Prozess muss vom Architecture Owner genehmigt werden.
245
+
246
+
Die Einhaltung dieses Prozesses gewährleistet, dass Design-Entscheidungen bewusst getroffen, dokumentiert und nachvollziehbar sind, was die langfristige Wartbarkeit, Skalierbarkeit und Qualität des PySignalduino-Projekts sicherstellt.
0 commit comments