Semantic Anchors sind im Dokument mit gekennzeichnet. +
Semantic Anchors sind im Dokument mit ⚓ gekennzeichnet. Ein Klick auf einen Anker führt zur vollständigen Definition auf der Semantic Anchors Website.
Alle Dokumentation verwendet kurze Sätze, aktive Sprache und keine überflüssigen Wörter. -Für deutschsprachige Dokumentation gilt analog Gutes Deutsch nach Wolf Schneider.
+Für deutschsprachige Dokumentation gilt analog ⚓ Gutes Deutsch nach Wolf Schneider.Alle Commits folgen einem standardisierten Format für eine saubere, maschinenlesbare Git-History.
Dokumentation lebt im Repository als AsciiDoc, gebaut von docToolchain. Docs-as-Code behandelt Dokumentation wie Quellcode: versioniert, reviewt und automatisch gebaut.
@@ -647,7 +647,7 @@Git-Repository initialisieren
docToolchain installieren und das arc42-Template herunterladen
+docToolchain installieren und das ⚓ arc42-Template herunterladen
KI-Coding-Umgebung mit einer AGENTS.md konfigurieren (oder toolspezifisches Äquivalent wie CLAUDE.md)
Die KI auffordern, die Sokratische Methode zur Klärung der Anforderungen zu nutzen.
+Die KI auffordern, die ⚓ Sokratische Methode zur Klärung der Anforderungen zu nutzen.
MECE (Mutually Exclusive, Collectively Exhaustive) stellt sicher, dass die Fragen alle Bereiche überlappungsfrei abdecken.
+⚓ MECE (Mutually Exclusive, Collectively Exhaustive) stellt sicher, dass die Fragen alle Bereiche überlappungsfrei abdecken.
Den Dialog fortführen, bis man mit der KI zufrieden ist, dass die Anforderungen klar sind.
@@ -817,7 +817,7 @@Gherkin (Given/When/Then) liefert Akzeptanzkriterien, die sowohl für Menschen lesbar als auch maschinell testbar sind. +
⚓ Gherkin (Given/When/Then) liefert Akzeptanzkriterien, die sowohl für Menschen lesbar als auch maschinell testbar sind. Diese Kriterien werden später die Grundlage für TDD.
arc42 bietet 12 Abschnitte, die alles von Kontextabgrenzung bis Deployment abdecken. +
⚓ arc42 bietet 12 Abschnitte, die alles von Kontextabgrenzung bis Deployment abdecken. Die KI kennt die Template-Struktur und füllt sie passend.
C4 Diagrams kombiniert mit PlantUML ermöglichen textbasierte Architektur-Visualisierung auf vier Ebenen: Context, Container, Component, Code. +
⚓ C4 Diagrams kombiniert mit PlantUML ermöglichen textbasierte Architektur-Visualisierung auf vier Ebenen: Context, Container, Component, Code. Die KI kann diese Diagramme ohne grafische Tools erstellen und ändern.
Architekturentscheidungen werden als ADRs nach Nygard dokumentiert. +
Architekturentscheidungen werden als ⚓ ADRs nach Nygard dokumentiert. Jedes ADR folgt der Struktur: Titel, Status, Kontext, Entscheidung, Konsequenzen.
Für jede Entscheidung wird eine Pugh-Matrix mit 3-Punkt-Skala (-1, 0, +1) erstellt, um Alternativen gegen Qualitätskriterien zu bewerten.
+Für jede Entscheidung wird eine ⚓ Pugh-Matrix mit 3-Punkt-Skala (-1, 0, +1) erstellt, um Alternativen gegen Qualitätskriterien zu bewerten.
Ein Architektur-Review mit der Architecture Tradeoff Analysis Method (ATAM) durchführen:
+Ein Architektur-Review mit der ⚓ Architecture Tradeoff Analysis Method (ATAM) durchführen:
INVEST stellt sicher, dass User Stories Independent, Negotiable, Valuable, Estimable, Small und Testable sind.
+⚓ INVEST stellt sicher, dass User Stories Independent, Negotiable, Valuable, Estimable, Small und Testable sind.
MoSCoW (Must have, Should have, Could have, Won’t have) liefert klare Priorisierung.
+⚓ MoSCoW (Must have, Should have, Could have, Won’t have) liefert klare Priorisierung.
Die initiale Backlog-Reihenfolge folgt der EPIC-Sequenz. @@ -969,15 +969,15 @@
TDD (Test-Driven Development) gibt es in zwei Schulen:
+⚓ TDD (Test-Driven Development) gibt es in zwei Schulen:
London School (Mockist): Unit Under Test isolieren, Abhängigkeiten mocken. Gut für interaktionslastigen Code.
+⚓ London School (Mockist): Unit Under Test isolieren, Abhängigkeiten mocken. Gut für interaktionslastigen Code.
Chicago School (Classicist): Verhalten über die öffentliche API testen, echte Kollaborateure nutzen. Gut für zustandsbasierte Logik.
+⚓ Chicago School (Classicist): Verhalten über die öffentliche API testen, echte Kollaborateure nutzen. Gut für zustandsbasierte Logik.
DRY (Don’t Repeat Yourself)
+⚓ DRY (Don’t Repeat Yourself)
SOLID-Prinzipien
+⚓ SOLID-Prinzipien
KISS (Keep It Simple, Stupid)
+⚓ KISS (Keep It Simple, Stupid)
Ubiquitous Language aus Domain-Driven Design: dieselben Begriffe im Code wie in der Spezifikation
+⚓ Ubiquitous Language aus Domain-Driven Design: dieselben Begriffe im Code wie in der Spezifikation
OWASP Top 10 deckt die kritischsten Sicherheitsrisiken für Webanwendungen ab. +
⚓ OWASP Top 10 deckt die kritischsten Sicherheitsrisiken für Webanwendungen ab. Auch für CLI-Tools oder Libraries identifiziert die Methodik gängige Schwachstellenmuster.
Semantic Anchors marked with are highlighted throughout this document. +
Semantic Anchors marked with ⚓ are highlighted throughout this document. Click on any anchor to see its full definition on the Semantic Anchors website.
All documentation uses short sentences, active voice, and no unnecessary words.
All commits follow a standardized format for a clean, parseable git history.
Documentation lives in the repository as AsciiDoc, built by docToolchain. Docs-as-Code treats documentation like source code: version-controlled, peer-reviewed, and built automatically.
@@ -646,7 +646,7 @@Initialize a git repository
Install docToolchain and download the arc42 template
+Install docToolchain and download the ⚓ arc42 template
Configure your AI coding environment with an AGENTS.md (or tool-specific equivalent like CLAUDE.md)
Prompt the AI to use the Socratic Method to clarify requirements.
+Prompt the AI to use the ⚓ Socratic Method to clarify requirements.
MECE (Mutually Exclusive, Collectively Exhaustive) ensures questions cover all areas without overlap.
+⚓ MECE (Mutually Exclusive, Collectively Exhaustive) ensures questions cover all areas without overlap.
Continue the dialogue until both you and the AI are satisfied that the requirements are clear.
@@ -816,7 +816,7 @@Gherkin (Given/When/Then) provides acceptance criteria that are both human-readable and machine-testable. +
⚓ Gherkin (Given/When/Then) provides acceptance criteria that are both human-readable and machine-testable. These criteria become the foundation for TDD later.
arc42 provides 12 sections covering everything from context to deployment. +
⚓ arc42 provides 12 sections covering everything from context to deployment. The AI knows the template structure and fills it appropriately.
C4 Diagrams combined with PlantUML provide text-based architecture visualization at four levels: Context, Container, Component, Code. +
⚓ C4 Diagrams combined with PlantUML provide text-based architecture visualization at four levels: Context, Container, Component, Code. The AI can create and modify these diagrams without graphical tools.
Architecture decisions are documented as ADRs according to Nygard. +
Architecture decisions are documented as ⚓ ADRs according to Nygard. Each ADR follows the structure: Title, Status, Context, Decision, Consequences.
For each decision, create a Pugh Matrix with a 3-point scale (-1, 0, +1) to evaluate alternatives against quality criteria.
+For each decision, create a ⚓ Pugh Matrix with a 3-point scale (-1, 0, +1) to evaluate alternatives against quality criteria.
Conduct an architecture review using the Architecture Tradeoff Analysis Method (ATAM):
+Conduct an architecture review using the ⚓ Architecture Tradeoff Analysis Method (ATAM):
INVEST ensures User Stories are Independent, Negotiable, Valuable, Estimable, Small, and Testable.
+⚓ INVEST ensures User Stories are Independent, Negotiable, Valuable, Estimable, Small, and Testable.
MoSCoW (Must have, Should have, Could have, Won’t have) provides clear prioritization.
+⚓ MoSCoW (Must have, Should have, Could have, Won’t have) provides clear prioritization.
The initial backlog order follows the EPIC sequence. @@ -968,15 +968,15 @@
TDD (Test-Driven Development) comes in two schools:
+⚓ TDD (Test-Driven Development) comes in two schools:
London School (mockist): isolate the unit under test, mock dependencies. Good for interaction-heavy code.
+⚓ London School (mockist): isolate the unit under test, mock dependencies. Good for interaction-heavy code.
Chicago School (classicist): test behavior through the public API, use real collaborators. Good for state-based logic.
+⚓ Chicago School (classicist): test behavior through the public API, use real collaborators. Good for state-based logic.
DRY (Don’t Repeat Yourself)
+⚓ DRY (Don’t Repeat Yourself)
SOLID principles
+⚓ SOLID principles
KISS (Keep It Simple, Stupid)
+⚓ KISS (Keep It Simple, Stupid)
Ubiquitous Language from Domain-Driven Design: use the same terms in code as in the specification
+⚓ Ubiquitous Language from Domain-Driven Design: use the same terms in code as in the specification
OWASP Top 10 covers the most critical web application security risks. +
⚓ OWASP Top 10 covers the most critical web application security risks. Even for CLI tools or libraries, the methodology identifies common vulnerability patterns.