claude-code-workflow 7.2.23 → 7.2.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.ccw/workflows/cli-tools-usage.md +123 -521
- package/.claude/skills/brainstorm/SKILL.md +408 -408
- package/.claude/skills/review-cycle/SKILL.md +132 -132
- package/.claude/skills/spec-generator/SKILL.md +1 -1
- package/.claude/skills/team-designer/phases/02-scaffold-generation.md +1 -1
- package/.claude/skills/team-lifecycle-v4/SKILL.md +1 -1
- package/.claude/skills/team-review/SKILL.md +1 -1
- package/.claude/skills/team-ultra-analyze/SKILL.md +1 -1
- package/.claude/skills/workflow-multi-cli-plan/SKILL.md +1 -1
- package/.claude/skills/workflow-plan/SKILL.md +1 -1
- package/.claude/skills/workflow-test-fix/SKILL.md +1 -1
- package/.codex/skills/analyze-with-file/SKILL.md +966 -966
- package/.codex/skills/issue-discover/SKILL.md +361 -361
- package/.codex/skills/review-cycle/SKILL.md +1 -1
- package/.codex/skills/roadmap-with-file/SKILL.md +901 -901
- package/.codex/skills/spec-generator/SKILL.md +425 -425
- package/.codex/skills/spec-setup/SKILL.md +669 -669
- package/.codex/skills/team-arch-opt/SKILL.md +242 -175
- package/.codex/skills/team-arch-opt/roles/analyzer/role.md +78 -78
- package/.codex/skills/team-arch-opt/roles/coordinator/commands/analyze.md +57 -57
- package/.codex/skills/team-arch-opt/roles/coordinator/commands/monitor.md +246 -204
- package/.codex/skills/team-arch-opt/roles/coordinator/role.md +196 -184
- package/.codex/skills/team-arch-opt/roles/designer/role.md +115 -115
- package/.codex/skills/team-arch-opt/roles/refactorer/role.md +102 -102
- package/.codex/skills/team-arch-opt/roles/reviewer/role.md +111 -111
- package/.codex/skills/team-arch-opt/roles/validator/role.md +115 -115
- package/.codex/skills/team-arch-opt/specs/pipelines.md +102 -102
- package/.codex/skills/team-brainstorm/SKILL.md +72 -4
- package/.codex/skills/team-brainstorm/roles/challenger/role.md +61 -61
- package/.codex/skills/team-brainstorm/roles/coordinator/commands/analyze.md +58 -58
- package/.codex/skills/team-brainstorm/roles/coordinator/commands/monitor.md +212 -171
- package/.codex/skills/team-brainstorm/roles/coordinator/role.md +172 -160
- package/.codex/skills/team-brainstorm/roles/evaluator/role.md +56 -56
- package/.codex/skills/team-brainstorm/roles/ideator/role.md +69 -69
- package/.codex/skills/team-brainstorm/roles/synthesizer/role.md +57 -57
- package/.codex/skills/team-brainstorm/specs/pipelines.md +72 -72
- package/.codex/skills/team-coordinate/SKILL.md +71 -3
- package/.codex/skills/team-coordinate/roles/coordinator/commands/monitor.md +45 -5
- package/.codex/skills/team-coordinate/roles/coordinator/role.md +402 -389
- package/.codex/skills/team-coordinate/specs/knowledge-transfer.md +111 -111
- package/.codex/skills/team-coordinate/specs/pipelines.md +97 -97
- package/.codex/skills/team-coordinate/specs/quality-gates.md +112 -112
- package/.codex/skills/team-designer/SKILL.md +153 -153
- package/.codex/skills/team-designer/phases/01-requirements-analysis.md +250 -250
- package/.codex/skills/team-designer/phases/02-scaffold-generation.md +228 -228
- package/.codex/skills/team-designer/phases/03-content-generation.md +330 -330
- package/.codex/skills/team-designer/phases/04-validation.md +320 -320
- package/.codex/skills/team-executor/SKILL.md +29 -2
- package/.codex/skills/team-executor/roles/executor/commands/monitor.md +23 -15
- package/.codex/skills/team-frontend/SKILL.md +77 -3
- package/.codex/skills/team-frontend/roles/analyst/role.md +92 -92
- package/.codex/skills/team-frontend/roles/architect/role.md +86 -86
- package/.codex/skills/team-frontend/roles/coordinator/commands/analyze.md +52 -52
- package/.codex/skills/team-frontend/roles/coordinator/commands/monitor.md +222 -188
- package/.codex/skills/team-frontend/roles/coordinator/role.md +189 -177
- package/.codex/skills/team-frontend/roles/developer/role.md +93 -93
- package/.codex/skills/team-frontend/roles/qa/role.md +79 -79
- package/.codex/skills/team-frontend/specs/pipelines.md +76 -76
- package/.codex/skills/team-frontend-debug/SKILL.md +66 -3
- package/.codex/skills/team-frontend-debug/roles/analyzer/role.md +208 -208
- package/.codex/skills/team-frontend-debug/roles/coordinator/commands/analyze.md +174 -174
- package/.codex/skills/team-frontend-debug/roles/coordinator/commands/dispatch.md +198 -198
- package/.codex/skills/team-frontend-debug/roles/coordinator/commands/monitor.md +177 -143
- package/.codex/skills/team-frontend-debug/roles/coordinator/role.md +164 -152
- package/.codex/skills/team-frontend-debug/roles/fixer/role.md +147 -147
- package/.codex/skills/team-frontend-debug/roles/reproducer/role.md +147 -147
- package/.codex/skills/team-frontend-debug/roles/tester/role.md +231 -231
- package/.codex/skills/team-frontend-debug/roles/verifier/role.md +172 -172
- package/.codex/skills/team-frontend-debug/specs/debug-tools.md +215 -215
- package/.codex/skills/team-frontend-debug/specs/pipelines.md +94 -94
- package/.codex/skills/team-issue/SKILL.md +83 -4
- package/.codex/skills/team-issue/roles/coordinator/commands/analyze.md +64 -64
- package/.codex/skills/team-issue/roles/coordinator/commands/dispatch.md +273 -273
- package/.codex/skills/team-issue/roles/coordinator/commands/monitor.md +235 -194
- package/.codex/skills/team-issue/roles/coordinator/role.md +206 -194
- package/.codex/skills/team-issue/roles/explorer/role.md +94 -94
- package/.codex/skills/team-issue/roles/implementer/role.md +87 -87
- package/.codex/skills/team-issue/roles/integrator/role.md +84 -84
- package/.codex/skills/team-issue/roles/planner/role.md +81 -81
- package/.codex/skills/team-issue/roles/reviewer/role.md +86 -86
- package/.codex/skills/team-issue/specs/pipelines.md +124 -124
- package/.codex/skills/team-lifecycle-v4/MIGRATION-PLAN.md +6 -6
- package/.codex/skills/team-lifecycle-v4/SKILL.md +305 -242
- package/.codex/skills/team-lifecycle-v4/roles/coordinator/commands/dispatch.md +1 -1
- package/.codex/skills/team-lifecycle-v4/roles/coordinator/commands/monitor.md +66 -24
- package/.codex/skills/team-lifecycle-v4/roles/coordinator/role.md +13 -1
- package/.codex/skills/team-lifecycle-v4/roles/supervisor/role.md +1 -1
- package/.codex/skills/team-lifecycle-v4/templates/architecture.md +254 -254
- package/.codex/skills/team-lifecycle-v4/templates/epics.md +196 -196
- package/.codex/skills/team-lifecycle-v4/templates/product-brief.md +133 -133
- package/.codex/skills/team-lifecycle-v4/templates/requirements.md +224 -224
- package/.codex/skills/team-perf-opt/SKILL.md +68 -3
- package/.codex/skills/team-perf-opt/roles/benchmarker/role.md +89 -89
- package/.codex/skills/team-perf-opt/roles/coordinator/commands/analyze.md +61 -61
- package/.codex/skills/team-perf-opt/roles/coordinator/commands/monitor.md +35 -1
- package/.codex/skills/team-perf-opt/roles/coordinator/role.md +179 -167
- package/.codex/skills/team-perf-opt/roles/optimizer/role.md +97 -97
- package/.codex/skills/team-perf-opt/roles/profiler/role.md +73 -73
- package/.codex/skills/team-perf-opt/roles/reviewer/role.md +75 -75
- package/.codex/skills/team-perf-opt/roles/strategist/role.md +94 -94
- package/.codex/skills/team-perf-opt/specs/pipelines.md +65 -65
- package/.codex/skills/team-planex/SKILL.md +65 -3
- package/.codex/skills/team-planex/roles/coordinator/commands/analyze.md +52 -52
- package/.codex/skills/team-planex/roles/coordinator/commands/monitor.md +210 -164
- package/.codex/skills/team-planex/roles/coordinator/role.md +171 -159
- package/.codex/skills/team-planex/roles/executor/role.md +91 -91
- package/.codex/skills/team-planex/roles/planner/role.md +112 -112
- package/.codex/skills/team-planex/specs/pipelines.md +93 -93
- package/.codex/skills/team-quality-assurance/SKILL.md +60 -3
- package/.codex/skills/team-quality-assurance/roles/analyst/role.md +80 -80
- package/.codex/skills/team-quality-assurance/roles/coordinator/commands/analyze.md +72 -72
- package/.codex/skills/team-quality-assurance/roles/coordinator/commands/dispatch.md +108 -108
- package/.codex/skills/team-quality-assurance/roles/coordinator/commands/monitor.md +243 -209
- package/.codex/skills/team-quality-assurance/roles/coordinator/role.md +176 -164
- package/.codex/skills/team-quality-assurance/roles/executor/role.md +66 -66
- package/.codex/skills/team-quality-assurance/roles/generator/role.md +68 -68
- package/.codex/skills/team-quality-assurance/roles/scout/role.md +67 -67
- package/.codex/skills/team-quality-assurance/roles/strategist/role.md +71 -71
- package/.codex/skills/team-quality-assurance/specs/pipelines.md +115 -115
- package/.codex/skills/team-review/SKILL.md +58 -3
- package/.codex/skills/team-review/roles/coordinator/commands/analyze.md +71 -71
- package/.codex/skills/team-review/roles/coordinator/commands/dispatch.md +90 -90
- package/.codex/skills/team-review/roles/coordinator/commands/monitor.md +225 -185
- package/.codex/skills/team-review/roles/coordinator/role.md +175 -163
- package/.codex/skills/team-review/roles/fixer/role.md +76 -76
- package/.codex/skills/team-review/roles/reviewer/role.md +68 -68
- package/.codex/skills/team-review/roles/scanner/role.md +71 -71
- package/.codex/skills/team-review/specs/pipelines.md +102 -102
- package/.codex/skills/team-roadmap-dev/SKILL.md +55 -3
- package/.codex/skills/team-roadmap-dev/roles/coordinator/commands/analyze.md +61 -61
- package/.codex/skills/team-roadmap-dev/roles/coordinator/commands/monitor.md +502 -468
- package/.codex/skills/team-roadmap-dev/roles/coordinator/role.md +335 -322
- package/.codex/skills/team-roadmap-dev/roles/executor/role.md +71 -71
- package/.codex/skills/team-roadmap-dev/roles/planner/role.md +76 -76
- package/.codex/skills/team-roadmap-dev/roles/verifier/role.md +74 -74
- package/.codex/skills/team-roadmap-dev/specs/pipelines.md +93 -93
- package/.codex/skills/team-tech-debt/SKILL.md +56 -3
- package/.codex/skills/team-tech-debt/roles/assessor/role.md +69 -69
- package/.codex/skills/team-tech-debt/roles/coordinator/commands/analyze.md +47 -47
- package/.codex/skills/team-tech-debt/roles/coordinator/commands/monitor.md +272 -231
- package/.codex/skills/team-tech-debt/roles/coordinator/role.md +172 -160
- package/.codex/skills/team-tech-debt/roles/executor/role.md +76 -76
- package/.codex/skills/team-tech-debt/roles/planner/role.md +69 -69
- package/.codex/skills/team-tech-debt/roles/scanner/role.md +82 -82
- package/.codex/skills/team-tech-debt/roles/validator/role.md +75 -75
- package/.codex/skills/team-tech-debt/specs/pipelines.md +47 -47
- package/.codex/skills/team-testing/SKILL.md +72 -3
- package/.codex/skills/team-testing/roles/analyst/role.md +95 -95
- package/.codex/skills/team-testing/roles/coordinator/commands/analyze.md +70 -70
- package/.codex/skills/team-testing/roles/coordinator/commands/dispatch.md +106 -106
- package/.codex/skills/team-testing/roles/coordinator/commands/monitor.md +283 -242
- package/.codex/skills/team-testing/roles/coordinator/role.md +184 -172
- package/.codex/skills/team-testing/roles/executor/role.md +96 -96
- package/.codex/skills/team-testing/roles/generator/role.md +95 -95
- package/.codex/skills/team-testing/roles/strategist/role.md +83 -83
- package/.codex/skills/team-testing/specs/pipelines.md +101 -101
- package/.codex/skills/team-uidesign/SKILL.md +65 -3
- package/.codex/skills/team-uidesign/roles/coordinator/commands/analyze.md +59 -59
- package/.codex/skills/team-uidesign/roles/coordinator/commands/dispatch.md +156 -156
- package/.codex/skills/team-uidesign/roles/coordinator/commands/monitor.md +234 -194
- package/.codex/skills/team-uidesign/roles/coordinator/role.md +211 -199
- package/.codex/skills/team-uidesign/roles/designer/role.md +69 -69
- package/.codex/skills/team-uidesign/roles/implementer/role.md +72 -72
- package/.codex/skills/team-uidesign/roles/researcher/role.md +82 -82
- package/.codex/skills/team-uidesign/roles/reviewer/role.md +67 -67
- package/.codex/skills/team-uidesign/specs/pipelines.md +76 -76
- package/.codex/skills/team-ultra-analyze/SKILL.md +73 -3
- package/.codex/skills/team-ultra-analyze/roles/analyst/role.md +90 -90
- package/.codex/skills/team-ultra-analyze/roles/coordinator/commands/analyze.md +73 -73
- package/.codex/skills/team-ultra-analyze/roles/coordinator/commands/monitor.md +50 -9
- package/.codex/skills/team-ultra-analyze/roles/coordinator/role.md +255 -243
- package/.codex/skills/team-ultra-analyze/roles/discussant/role.md +104 -104
- package/.codex/skills/team-ultra-analyze/roles/explorer/role.md +74 -74
- package/.codex/skills/team-ultra-analyze/roles/synthesizer/role.md +78 -78
- package/.codex/skills/team-ultra-analyze/specs/pipelines.md +64 -64
- package/.codex/skills/team-ux-improve/SKILL.md +64 -3
- package/.codex/skills/team-ux-improve/roles/coordinator/commands/analyze.md +62 -62
- package/.codex/skills/team-ux-improve/roles/coordinator/commands/dispatch.md +233 -233
- package/.codex/skills/team-ux-improve/roles/coordinator/commands/monitor.md +195 -160
- package/.codex/skills/team-ux-improve/roles/coordinator/role.md +170 -158
- package/.codex/skills/team-ux-improve/roles/designer/role.md +122 -122
- package/.codex/skills/team-ux-improve/roles/diagnoser/role.md +93 -93
- package/.codex/skills/team-ux-improve/roles/explorer/role.md +77 -77
- package/.codex/skills/team-ux-improve/roles/implementer/role.md +102 -102
- package/.codex/skills/team-ux-improve/roles/scanner/role.md +93 -93
- package/.codex/skills/team-ux-improve/roles/tester/role.md +84 -84
- package/.codex/skills/team-ux-improve/specs/pipelines.md +54 -54
- package/.codex/skills/workflow-test-fix-cycle/SKILL.md +402 -402
- package/README.md +1 -0
- package/package.json +1 -1
- package/.claude/skills/team-iterdev/SKILL.md +0 -127
- package/.claude/skills/team-iterdev/roles/architect/role.md +0 -65
- package/.claude/skills/team-iterdev/roles/coordinator/commands/analyze.md +0 -62
- package/.claude/skills/team-iterdev/roles/coordinator/commands/dispatch.md +0 -234
- package/.claude/skills/team-iterdev/roles/coordinator/commands/monitor.md +0 -182
- package/.claude/skills/team-iterdev/roles/coordinator/role.md +0 -153
- package/.claude/skills/team-iterdev/roles/developer/role.md +0 -74
- package/.claude/skills/team-iterdev/roles/reviewer/role.md +0 -66
- package/.claude/skills/team-iterdev/roles/tester/role.md +0 -88
- package/.claude/skills/team-iterdev/specs/pipelines.md +0 -94
- package/.claude/skills/team-iterdev/specs/team-config.json +0 -172
- package/.codex/skills/team-iterdev/SKILL.md +0 -158
- package/.codex/skills/team-iterdev/roles/architect/role.md +0 -65
- package/.codex/skills/team-iterdev/roles/coordinator/commands/analyze.md +0 -62
- package/.codex/skills/team-iterdev/roles/coordinator/commands/dispatch.md +0 -187
- package/.codex/skills/team-iterdev/roles/coordinator/commands/monitor.md +0 -186
- package/.codex/skills/team-iterdev/roles/coordinator/role.md +0 -181
- package/.codex/skills/team-iterdev/roles/developer/role.md +0 -74
- package/.codex/skills/team-iterdev/roles/reviewer/role.md +0 -66
- package/.codex/skills/team-iterdev/roles/tester/role.md +0 -88
- package/.codex/skills/team-iterdev/specs/pipelines.md +0 -94
- package/.codex/skills/team-iterdev/specs/team-config.json +0 -172
|
@@ -1,254 +1,254 @@
|
|
|
1
|
-
# Architecture Document Template (Directory Structure)
|
|
2
|
-
|
|
3
|
-
Template for generating architecture decision documents as a directory of individual ADR files in Phase 4.
|
|
4
|
-
|
|
5
|
-
## Usage Context
|
|
6
|
-
|
|
7
|
-
| Phase | Usage |
|
|
8
|
-
|-------|-------|
|
|
9
|
-
| Phase 4 (Architecture) | Generate `architecture/` directory from requirements analysis |
|
|
10
|
-
| Output Location | `{workDir}/architecture/` |
|
|
11
|
-
|
|
12
|
-
## Output Structure
|
|
13
|
-
|
|
14
|
-
```
|
|
15
|
-
{workDir}/architecture/
|
|
16
|
-
├── _index.md # Overview, components, tech stack, data model, security
|
|
17
|
-
├── ADR-001-{slug}.md # Individual Architecture Decision Record
|
|
18
|
-
├── ADR-002-{slug}.md
|
|
19
|
-
└── ...
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
---
|
|
23
|
-
|
|
24
|
-
## Template: _index.md
|
|
25
|
-
|
|
26
|
-
```markdown
|
|
27
|
-
---
|
|
28
|
-
session_id: {session_id}
|
|
29
|
-
phase: 4
|
|
30
|
-
document_type: architecture-index
|
|
31
|
-
status: draft
|
|
32
|
-
generated_at: {timestamp}
|
|
33
|
-
version: 1
|
|
34
|
-
dependencies:
|
|
35
|
-
- ../spec-config.json
|
|
36
|
-
- ../product-brief.md
|
|
37
|
-
- ../requirements/_index.md
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
# Architecture: {product_name}
|
|
41
|
-
|
|
42
|
-
{executive_summary - high-level architecture approach and key decisions}
|
|
43
|
-
|
|
44
|
-
## System Overview
|
|
45
|
-
|
|
46
|
-
### Architecture Style
|
|
47
|
-
{description of chosen architecture style: microservices, monolith, serverless, etc.}
|
|
48
|
-
|
|
49
|
-
### System Context Diagram
|
|
50
|
-
|
|
51
|
-
```mermaid
|
|
52
|
-
C4Context
|
|
53
|
-
title System Context Diagram
|
|
54
|
-
Person(user, "User", "Primary user")
|
|
55
|
-
System(system, "{product_name}", "Core system")
|
|
56
|
-
System_Ext(ext1, "{external_system}", "{description}")
|
|
57
|
-
Rel(user, system, "Uses")
|
|
58
|
-
Rel(system, ext1, "Integrates with")
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
## Component Architecture
|
|
62
|
-
|
|
63
|
-
### Component Diagram
|
|
64
|
-
|
|
65
|
-
```mermaid
|
|
66
|
-
graph TD
|
|
67
|
-
subgraph "{product_name}"
|
|
68
|
-
A[Component A] --> B[Component B]
|
|
69
|
-
B --> C[Component C]
|
|
70
|
-
A --> D[Component D]
|
|
71
|
-
end
|
|
72
|
-
B --> E[External Service]
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### Component Descriptions
|
|
76
|
-
|
|
77
|
-
| Component | Responsibility | Technology | Dependencies |
|
|
78
|
-
|-----------|---------------|------------|--------------|
|
|
79
|
-
| {component_name} | {what it does} | {tech stack} | {depends on} |
|
|
80
|
-
|
|
81
|
-
## Technology Stack
|
|
82
|
-
|
|
83
|
-
### Core Technologies
|
|
84
|
-
|
|
85
|
-
| Layer | Technology | Version | Rationale |
|
|
86
|
-
|-------|-----------|---------|-----------|
|
|
87
|
-
| Frontend | {technology} | {version} | {why chosen} |
|
|
88
|
-
| Backend | {technology} | {version} | {why chosen} |
|
|
89
|
-
| Database | {technology} | {version} | {why chosen} |
|
|
90
|
-
| Infrastructure | {technology} | {version} | {why chosen} |
|
|
91
|
-
|
|
92
|
-
### Key Libraries & Frameworks
|
|
93
|
-
|
|
94
|
-
| Library | Purpose | License |
|
|
95
|
-
|---------|---------|---------|
|
|
96
|
-
| {library_name} | {purpose} | {license} |
|
|
97
|
-
|
|
98
|
-
## Architecture Decision Records
|
|
99
|
-
|
|
100
|
-
| ADR | Title | Status | Key Choice |
|
|
101
|
-
|-----|-------|--------|------------|
|
|
102
|
-
| [ADR-001](ADR-001-{slug}.md) | {title} | Accepted | {one-line summary} |
|
|
103
|
-
| [ADR-002](ADR-002-{slug}.md) | {title} | Accepted | {one-line summary} |
|
|
104
|
-
| [ADR-003](ADR-003-{slug}.md) | {title} | Proposed | {one-line summary} |
|
|
105
|
-
|
|
106
|
-
## Data Architecture
|
|
107
|
-
|
|
108
|
-
### Data Model
|
|
109
|
-
|
|
110
|
-
```mermaid
|
|
111
|
-
erDiagram
|
|
112
|
-
ENTITY_A ||--o{ ENTITY_B : "has many"
|
|
113
|
-
ENTITY_A {
|
|
114
|
-
string id PK
|
|
115
|
-
string name
|
|
116
|
-
datetime created_at
|
|
117
|
-
}
|
|
118
|
-
ENTITY_B {
|
|
119
|
-
string id PK
|
|
120
|
-
string entity_a_id FK
|
|
121
|
-
string value
|
|
122
|
-
}
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
### Data Storage Strategy
|
|
126
|
-
|
|
127
|
-
| Data Type | Storage | Retention | Backup |
|
|
128
|
-
|-----------|---------|-----------|--------|
|
|
129
|
-
| {type} | {storage solution} | {retention policy} | {backup strategy} |
|
|
130
|
-
|
|
131
|
-
## API Design
|
|
132
|
-
|
|
133
|
-
### API Overview
|
|
134
|
-
|
|
135
|
-
| Endpoint | Method | Purpose | Auth |
|
|
136
|
-
|----------|--------|---------|------|
|
|
137
|
-
| {/api/resource} | {GET/POST/etc} | {purpose} | {auth type} |
|
|
138
|
-
|
|
139
|
-
## Security Architecture
|
|
140
|
-
|
|
141
|
-
### Security Controls
|
|
142
|
-
|
|
143
|
-
| Control | Implementation | Requirement |
|
|
144
|
-
|---------|---------------|-------------|
|
|
145
|
-
| Authentication | {approach} | [NFR-S-{NNN}](../requirements/NFR-S-{NNN}-{slug}.md) |
|
|
146
|
-
| Authorization | {approach} | [NFR-S-{NNN}](../requirements/NFR-S-{NNN}-{slug}.md) |
|
|
147
|
-
| Data Protection | {approach} | [NFR-S-{NNN}](../requirements/NFR-S-{NNN}-{slug}.md) |
|
|
148
|
-
|
|
149
|
-
## Infrastructure & Deployment
|
|
150
|
-
|
|
151
|
-
### Deployment Architecture
|
|
152
|
-
|
|
153
|
-
{description of deployment model: containers, serverless, VMs, etc.}
|
|
154
|
-
|
|
155
|
-
### Environment Strategy
|
|
156
|
-
|
|
157
|
-
| Environment | Purpose | Configuration |
|
|
158
|
-
|-------------|---------|---------------|
|
|
159
|
-
| Development | Local development | {config} |
|
|
160
|
-
| Staging | Pre-production testing | {config} |
|
|
161
|
-
| Production | Live system | {config} |
|
|
162
|
-
|
|
163
|
-
## Codebase Integration
|
|
164
|
-
|
|
165
|
-
{if has_codebase is true:}
|
|
166
|
-
|
|
167
|
-
### Existing Code Mapping
|
|
168
|
-
|
|
169
|
-
| New Component | Existing Module | Integration Type | Notes |
|
|
170
|
-
|--------------|----------------|------------------|-------|
|
|
171
|
-
| {component} | {existing module path} | Extend/Replace/New | {notes} |
|
|
172
|
-
|
|
173
|
-
### Migration Notes
|
|
174
|
-
{any migration considerations for existing code}
|
|
175
|
-
|
|
176
|
-
## Quality Attributes
|
|
177
|
-
|
|
178
|
-
| Attribute | Target | Measurement | ADR Reference |
|
|
179
|
-
|-----------|--------|-------------|---------------|
|
|
180
|
-
| Performance | {target} | {how measured} | [ADR-{NNN}](ADR-{NNN}-{slug}.md) |
|
|
181
|
-
| Scalability | {target} | {how measured} | [ADR-{NNN}](ADR-{NNN}-{slug}.md) |
|
|
182
|
-
| Reliability | {target} | {how measured} | [ADR-{NNN}](ADR-{NNN}-{slug}.md) |
|
|
183
|
-
|
|
184
|
-
## Risks & Mitigations
|
|
185
|
-
|
|
186
|
-
| Risk | Impact | Probability | Mitigation |
|
|
187
|
-
|------|--------|-------------|------------|
|
|
188
|
-
| {risk} | High/Medium/Low | High/Medium/Low | {mitigation approach} |
|
|
189
|
-
|
|
190
|
-
## Open Questions
|
|
191
|
-
|
|
192
|
-
- [ ] {architectural question 1}
|
|
193
|
-
- [ ] {architectural question 2}
|
|
194
|
-
|
|
195
|
-
## References
|
|
196
|
-
|
|
197
|
-
- Derived from: [Requirements](../requirements/_index.md), [Product Brief](../product-brief.md)
|
|
198
|
-
- Next: [Epics & Stories](../epics/_index.md)
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
---
|
|
202
|
-
|
|
203
|
-
## Template: ADR-NNN-{slug}.md (Individual Architecture Decision Record)
|
|
204
|
-
|
|
205
|
-
```markdown
|
|
206
|
-
---
|
|
207
|
-
id: ADR-{NNN}
|
|
208
|
-
status: Accepted
|
|
209
|
-
traces_to: [{REQ-NNN}, {NFR-X-NNN}]
|
|
210
|
-
date: {timestamp}
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
# ADR-{NNN}: {decision_title}
|
|
214
|
-
|
|
215
|
-
## Context
|
|
216
|
-
|
|
217
|
-
{what is the situation that motivates this decision}
|
|
218
|
-
|
|
219
|
-
## Decision
|
|
220
|
-
|
|
221
|
-
{what is the chosen approach}
|
|
222
|
-
|
|
223
|
-
## Alternatives Considered
|
|
224
|
-
|
|
225
|
-
| Option | Pros | Cons |
|
|
226
|
-
|--------|------|------|
|
|
227
|
-
| {option_1 - chosen} | {pros} | {cons} |
|
|
228
|
-
| {option_2} | {pros} | {cons} |
|
|
229
|
-
| {option_3} | {pros} | {cons} |
|
|
230
|
-
|
|
231
|
-
## Consequences
|
|
232
|
-
|
|
233
|
-
- **Positive**: {positive outcomes}
|
|
234
|
-
- **Negative**: {tradeoffs accepted}
|
|
235
|
-
- **Risks**: {risks to monitor}
|
|
236
|
-
|
|
237
|
-
## Traces
|
|
238
|
-
|
|
239
|
-
- **Requirements**: [REQ-{NNN}](../requirements/REQ-{NNN}-{slug}.md), [NFR-X-{NNN}](../requirements/NFR-X-{NNN}-{slug}.md)
|
|
240
|
-
- **Implemented by**: [EPIC-{NNN}](../epics/EPIC-{NNN}-{slug}.md) (added in Phase 5)
|
|
241
|
-
```
|
|
242
|
-
|
|
243
|
-
---
|
|
244
|
-
|
|
245
|
-
## Variable Descriptions
|
|
246
|
-
|
|
247
|
-
| Variable | Source | Description |
|
|
248
|
-
|----------|--------|-------------|
|
|
249
|
-
| `{session_id}` | spec-config.json | Session identifier |
|
|
250
|
-
| `{timestamp}` | Runtime | ISO8601 generation timestamp |
|
|
251
|
-
| `{product_name}` | product-brief.md | Product/feature name |
|
|
252
|
-
| `{NNN}` | Auto-increment | ADR/requirement number |
|
|
253
|
-
| `{slug}` | Auto-generated | Kebab-case from decision title |
|
|
254
|
-
| `{has_codebase}` | spec-config.json | Whether existing codebase exists |
|
|
1
|
+
# Architecture Document Template (Directory Structure)
|
|
2
|
+
|
|
3
|
+
Template for generating architecture decision documents as a directory of individual ADR files in Phase 4.
|
|
4
|
+
|
|
5
|
+
## Usage Context
|
|
6
|
+
|
|
7
|
+
| Phase | Usage |
|
|
8
|
+
|-------|-------|
|
|
9
|
+
| Phase 4 (Architecture) | Generate `architecture/` directory from requirements analysis |
|
|
10
|
+
| Output Location | `{workDir}/architecture/` |
|
|
11
|
+
|
|
12
|
+
## Output Structure
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
{workDir}/architecture/
|
|
16
|
+
├── _index.md # Overview, components, tech stack, data model, security
|
|
17
|
+
├── ADR-001-{slug}.md # Individual Architecture Decision Record
|
|
18
|
+
├── ADR-002-{slug}.md
|
|
19
|
+
└── ...
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Template: _index.md
|
|
25
|
+
|
|
26
|
+
```markdown
|
|
27
|
+
---
|
|
28
|
+
session_id: {session_id}
|
|
29
|
+
phase: 4
|
|
30
|
+
document_type: architecture-index
|
|
31
|
+
status: draft
|
|
32
|
+
generated_at: {timestamp}
|
|
33
|
+
version: 1
|
|
34
|
+
dependencies:
|
|
35
|
+
- ../spec-config.json
|
|
36
|
+
- ../product-brief.md
|
|
37
|
+
- ../requirements/_index.md
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
# Architecture: {product_name}
|
|
41
|
+
|
|
42
|
+
{executive_summary - high-level architecture approach and key decisions}
|
|
43
|
+
|
|
44
|
+
## System Overview
|
|
45
|
+
|
|
46
|
+
### Architecture Style
|
|
47
|
+
{description of chosen architecture style: microservices, monolith, serverless, etc.}
|
|
48
|
+
|
|
49
|
+
### System Context Diagram
|
|
50
|
+
|
|
51
|
+
```mermaid
|
|
52
|
+
C4Context
|
|
53
|
+
title System Context Diagram
|
|
54
|
+
Person(user, "User", "Primary user")
|
|
55
|
+
System(system, "{product_name}", "Core system")
|
|
56
|
+
System_Ext(ext1, "{external_system}", "{description}")
|
|
57
|
+
Rel(user, system, "Uses")
|
|
58
|
+
Rel(system, ext1, "Integrates with")
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
## Component Architecture
|
|
62
|
+
|
|
63
|
+
### Component Diagram
|
|
64
|
+
|
|
65
|
+
```mermaid
|
|
66
|
+
graph TD
|
|
67
|
+
subgraph "{product_name}"
|
|
68
|
+
A[Component A] --> B[Component B]
|
|
69
|
+
B --> C[Component C]
|
|
70
|
+
A --> D[Component D]
|
|
71
|
+
end
|
|
72
|
+
B --> E[External Service]
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Component Descriptions
|
|
76
|
+
|
|
77
|
+
| Component | Responsibility | Technology | Dependencies |
|
|
78
|
+
|-----------|---------------|------------|--------------|
|
|
79
|
+
| {component_name} | {what it does} | {tech stack} | {depends on} |
|
|
80
|
+
|
|
81
|
+
## Technology Stack
|
|
82
|
+
|
|
83
|
+
### Core Technologies
|
|
84
|
+
|
|
85
|
+
| Layer | Technology | Version | Rationale |
|
|
86
|
+
|-------|-----------|---------|-----------|
|
|
87
|
+
| Frontend | {technology} | {version} | {why chosen} |
|
|
88
|
+
| Backend | {technology} | {version} | {why chosen} |
|
|
89
|
+
| Database | {technology} | {version} | {why chosen} |
|
|
90
|
+
| Infrastructure | {technology} | {version} | {why chosen} |
|
|
91
|
+
|
|
92
|
+
### Key Libraries & Frameworks
|
|
93
|
+
|
|
94
|
+
| Library | Purpose | License |
|
|
95
|
+
|---------|---------|---------|
|
|
96
|
+
| {library_name} | {purpose} | {license} |
|
|
97
|
+
|
|
98
|
+
## Architecture Decision Records
|
|
99
|
+
|
|
100
|
+
| ADR | Title | Status | Key Choice |
|
|
101
|
+
|-----|-------|--------|------------|
|
|
102
|
+
| [ADR-001](ADR-001-{slug}.md) | {title} | Accepted | {one-line summary} |
|
|
103
|
+
| [ADR-002](ADR-002-{slug}.md) | {title} | Accepted | {one-line summary} |
|
|
104
|
+
| [ADR-003](ADR-003-{slug}.md) | {title} | Proposed | {one-line summary} |
|
|
105
|
+
|
|
106
|
+
## Data Architecture
|
|
107
|
+
|
|
108
|
+
### Data Model
|
|
109
|
+
|
|
110
|
+
```mermaid
|
|
111
|
+
erDiagram
|
|
112
|
+
ENTITY_A ||--o{ ENTITY_B : "has many"
|
|
113
|
+
ENTITY_A {
|
|
114
|
+
string id PK
|
|
115
|
+
string name
|
|
116
|
+
datetime created_at
|
|
117
|
+
}
|
|
118
|
+
ENTITY_B {
|
|
119
|
+
string id PK
|
|
120
|
+
string entity_a_id FK
|
|
121
|
+
string value
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Data Storage Strategy
|
|
126
|
+
|
|
127
|
+
| Data Type | Storage | Retention | Backup |
|
|
128
|
+
|-----------|---------|-----------|--------|
|
|
129
|
+
| {type} | {storage solution} | {retention policy} | {backup strategy} |
|
|
130
|
+
|
|
131
|
+
## API Design
|
|
132
|
+
|
|
133
|
+
### API Overview
|
|
134
|
+
|
|
135
|
+
| Endpoint | Method | Purpose | Auth |
|
|
136
|
+
|----------|--------|---------|------|
|
|
137
|
+
| {/api/resource} | {GET/POST/etc} | {purpose} | {auth type} |
|
|
138
|
+
|
|
139
|
+
## Security Architecture
|
|
140
|
+
|
|
141
|
+
### Security Controls
|
|
142
|
+
|
|
143
|
+
| Control | Implementation | Requirement |
|
|
144
|
+
|---------|---------------|-------------|
|
|
145
|
+
| Authentication | {approach} | [NFR-S-{NNN}](../requirements/NFR-S-{NNN}-{slug}.md) |
|
|
146
|
+
| Authorization | {approach} | [NFR-S-{NNN}](../requirements/NFR-S-{NNN}-{slug}.md) |
|
|
147
|
+
| Data Protection | {approach} | [NFR-S-{NNN}](../requirements/NFR-S-{NNN}-{slug}.md) |
|
|
148
|
+
|
|
149
|
+
## Infrastructure & Deployment
|
|
150
|
+
|
|
151
|
+
### Deployment Architecture
|
|
152
|
+
|
|
153
|
+
{description of deployment model: containers, serverless, VMs, etc.}
|
|
154
|
+
|
|
155
|
+
### Environment Strategy
|
|
156
|
+
|
|
157
|
+
| Environment | Purpose | Configuration |
|
|
158
|
+
|-------------|---------|---------------|
|
|
159
|
+
| Development | Local development | {config} |
|
|
160
|
+
| Staging | Pre-production testing | {config} |
|
|
161
|
+
| Production | Live system | {config} |
|
|
162
|
+
|
|
163
|
+
## Codebase Integration
|
|
164
|
+
|
|
165
|
+
{if has_codebase is true:}
|
|
166
|
+
|
|
167
|
+
### Existing Code Mapping
|
|
168
|
+
|
|
169
|
+
| New Component | Existing Module | Integration Type | Notes |
|
|
170
|
+
|--------------|----------------|------------------|-------|
|
|
171
|
+
| {component} | {existing module path} | Extend/Replace/New | {notes} |
|
|
172
|
+
|
|
173
|
+
### Migration Notes
|
|
174
|
+
{any migration considerations for existing code}
|
|
175
|
+
|
|
176
|
+
## Quality Attributes
|
|
177
|
+
|
|
178
|
+
| Attribute | Target | Measurement | ADR Reference |
|
|
179
|
+
|-----------|--------|-------------|---------------|
|
|
180
|
+
| Performance | {target} | {how measured} | [ADR-{NNN}](ADR-{NNN}-{slug}.md) |
|
|
181
|
+
| Scalability | {target} | {how measured} | [ADR-{NNN}](ADR-{NNN}-{slug}.md) |
|
|
182
|
+
| Reliability | {target} | {how measured} | [ADR-{NNN}](ADR-{NNN}-{slug}.md) |
|
|
183
|
+
|
|
184
|
+
## Risks & Mitigations
|
|
185
|
+
|
|
186
|
+
| Risk | Impact | Probability | Mitigation |
|
|
187
|
+
|------|--------|-------------|------------|
|
|
188
|
+
| {risk} | High/Medium/Low | High/Medium/Low | {mitigation approach} |
|
|
189
|
+
|
|
190
|
+
## Open Questions
|
|
191
|
+
|
|
192
|
+
- [ ] {architectural question 1}
|
|
193
|
+
- [ ] {architectural question 2}
|
|
194
|
+
|
|
195
|
+
## References
|
|
196
|
+
|
|
197
|
+
- Derived from: [Requirements](../requirements/_index.md), [Product Brief](../product-brief.md)
|
|
198
|
+
- Next: [Epics & Stories](../epics/_index.md)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
---
|
|
202
|
+
|
|
203
|
+
## Template: ADR-NNN-{slug}.md (Individual Architecture Decision Record)
|
|
204
|
+
|
|
205
|
+
```markdown
|
|
206
|
+
---
|
|
207
|
+
id: ADR-{NNN}
|
|
208
|
+
status: Accepted
|
|
209
|
+
traces_to: [{REQ-NNN}, {NFR-X-NNN}]
|
|
210
|
+
date: {timestamp}
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
# ADR-{NNN}: {decision_title}
|
|
214
|
+
|
|
215
|
+
## Context
|
|
216
|
+
|
|
217
|
+
{what is the situation that motivates this decision}
|
|
218
|
+
|
|
219
|
+
## Decision
|
|
220
|
+
|
|
221
|
+
{what is the chosen approach}
|
|
222
|
+
|
|
223
|
+
## Alternatives Considered
|
|
224
|
+
|
|
225
|
+
| Option | Pros | Cons |
|
|
226
|
+
|--------|------|------|
|
|
227
|
+
| {option_1 - chosen} | {pros} | {cons} |
|
|
228
|
+
| {option_2} | {pros} | {cons} |
|
|
229
|
+
| {option_3} | {pros} | {cons} |
|
|
230
|
+
|
|
231
|
+
## Consequences
|
|
232
|
+
|
|
233
|
+
- **Positive**: {positive outcomes}
|
|
234
|
+
- **Negative**: {tradeoffs accepted}
|
|
235
|
+
- **Risks**: {risks to monitor}
|
|
236
|
+
|
|
237
|
+
## Traces
|
|
238
|
+
|
|
239
|
+
- **Requirements**: [REQ-{NNN}](../requirements/REQ-{NNN}-{slug}.md), [NFR-X-{NNN}](../requirements/NFR-X-{NNN}-{slug}.md)
|
|
240
|
+
- **Implemented by**: [EPIC-{NNN}](../epics/EPIC-{NNN}-{slug}.md) (added in Phase 5)
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
---
|
|
244
|
+
|
|
245
|
+
## Variable Descriptions
|
|
246
|
+
|
|
247
|
+
| Variable | Source | Description |
|
|
248
|
+
|----------|--------|-------------|
|
|
249
|
+
| `{session_id}` | spec-config.json | Session identifier |
|
|
250
|
+
| `{timestamp}` | Runtime | ISO8601 generation timestamp |
|
|
251
|
+
| `{product_name}` | product-brief.md | Product/feature name |
|
|
252
|
+
| `{NNN}` | Auto-increment | ADR/requirement number |
|
|
253
|
+
| `{slug}` | Auto-generated | Kebab-case from decision title |
|
|
254
|
+
| `{has_codebase}` | spec-config.json | Whether existing codebase exists |
|