@anhth2/spec-driven-dev-plugin 0.7.0 → 0.9.0
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/ARCHITECTURE.md +6 -2
- package/bin/index.js +105 -0
- package/commands/debug.md +189 -1
- package/commands/debug.tmpl +16 -0
- package/commands/define-product.md +94 -1
- package/commands/fix-bug.md +190 -1
- package/commands/fix-bug.tmpl +17 -0
- package/commands/generate-bdd.md +314 -14
- package/commands/generate-bdd.tmpl +220 -13
- package/commands/generate-code.md +191 -3
- package/commands/generate-code.tmpl +97 -2
- package/commands/generate-design-spec.md +811 -0
- package/commands/generate-design-spec.tmpl +399 -0
- package/commands/generate-prd.md +133 -1
- package/commands/generate-prd.tmpl +39 -0
- package/commands/generate-spec-manifest.md +576 -0
- package/commands/generate-spec-manifest.tmpl +164 -0
- package/commands/generate-tech-docs.md +116 -2
- package/commands/generate-tech-docs.tmpl +22 -1
- package/commands/generate-tests.md +94 -1
- package/commands/learn.md +554 -0
- package/commands/learn.tmpl +63 -0
- package/commands/propose-scenario.md +521 -0
- package/commands/propose-scenario.tmpl +109 -0
- package/commands/refine-prd.md +94 -1
- package/commands/report-bug.md +543 -0
- package/commands/report-bug.tmpl +131 -0
- package/commands/review-code.md +190 -1
- package/commands/review-code.tmpl +17 -0
- package/commands/review-context.md +134 -1
- package/commands/review-context.tmpl +40 -0
- package/commands/review-tech-docs.md +176 -5
- package/commands/review-tech-docs.tmpl +82 -4
- package/commands/run-tests.md +119 -1
- package/commands/run-tests.tmpl +25 -0
- package/commands/setup-ai-first.md +142 -4
- package/commands/setup-ai-first.tmpl +135 -3
- package/commands/smoke-test.md +94 -1
- package/commands/sync.md +405 -0
- package/commands/sync.tmpl +345 -0
- package/commands/update-framework.md +211 -0
- package/commands/update-framework.tmpl +151 -0
- package/commands/validate-traces.md +152 -3
- package/commands/validate-traces.tmpl +58 -2
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +189 -1
- package/core/commands/define-product.md +94 -1
- package/core/commands/fix-bug.md +190 -1
- package/core/commands/generate-bdd.md +314 -14
- package/core/commands/generate-code.md +191 -3
- package/core/commands/generate-design-spec.md +811 -0
- package/core/commands/generate-prd.md +133 -1
- package/core/commands/generate-spec-manifest.md +576 -0
- package/core/commands/generate-tech-docs.md +116 -2
- package/core/commands/generate-tests.md +94 -1
- package/core/commands/learn.md +554 -0
- package/core/commands/propose-scenario.md +521 -0
- package/core/commands/refine-prd.md +94 -1
- package/core/commands/report-bug.md +543 -0
- package/core/commands/review-code.md +190 -1
- package/core/commands/review-context.md +134 -1
- package/core/commands/review-tech-docs.md +176 -5
- package/core/commands/run-tests.md +119 -1
- package/core/commands/setup-ai-first.md +142 -4
- package/core/commands/smoke-test.md +94 -1
- package/core/commands/sync.md +405 -0
- package/core/commands/update-framework.md +211 -0
- package/core/commands/validate-traces.md +152 -3
- package/core/skills/code/SKILL.md +101 -2
- package/core/skills/debug/SKILL.md +108 -3
- package/core/skills/design-spec/SKILL.md +507 -0
- package/core/skills/discovery/SKILL.md +94 -1
- package/core/skills/prd/SKILL.md +14 -2
- package/core/skills/setup-ai-first/SKILL.md +7 -1
- package/core/skills/spec/SKILL.md +14 -2
- package/core/skills/test/SKILL.md +195 -3
- package/core/steps/capture-lesson.md +79 -0
- package/core/steps/context-loader.md +87 -0
- package/core/steps/report-footer.md +7 -1
- package/core/templates/design-spec.template.md +209 -0
- package/core/templates/project-context.yaml +40 -0
- package/package.json +1 -1
- package/skills/code/SKILL.md +101 -2
- package/skills/debug/SKILL.md +108 -3
- package/skills/design-spec/SKILL.md +507 -0
- package/skills/design-spec/SKILL.tmpl +95 -0
- package/skills/discovery/SKILL.md +94 -1
- package/skills/prd/SKILL.md +14 -2
- package/skills/setup-ai-first/SKILL.md +7 -1
- package/skills/spec/SKILL.md +14 -2
- package/skills/test/SKILL.md +195 -3
- package/steps/capture-lesson.md +79 -0
- package/steps/context-loader.md +87 -0
- package/steps/report-footer.md +7 -1
- package/templates/design-spec.template.md +209 -0
- package/templates/project-context.yaml +40 -0
|
@@ -98,6 +98,51 @@ Check if already set up:
|
|
|
98
98
|
- Y → continue (existing files will be preserved — each step will offer merge/skip)
|
|
99
99
|
- If only `specs/` exists or only partial setup detected → continue normally (safe to re-run)
|
|
100
100
|
|
|
101
|
+
## Step 0.5 — Project Type
|
|
102
|
+
|
|
103
|
+
Ask the user:
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
What type of project is this?
|
|
107
|
+
1. Single-service — one codebase, one platform (standard setup)
|
|
108
|
+
2. Umbrella repo — this repo contains multiple service submodules (microservices / multi-app)
|
|
109
|
+
3. PO Spec repo — docs only, no runnable code (PRD + design-spec only)
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Store the answer as `project_type`. Default to `1` if user does not answer.
|
|
113
|
+
|
|
114
|
+
Based on answer:
|
|
115
|
+
|
|
116
|
+
**project_type = 1 (Single-service):** Continue standard setup below.
|
|
117
|
+
|
|
118
|
+
**project_type = 2 (Umbrella):** Ask two follow-up questions:
|
|
119
|
+
- "Path to spec submodule (e.g. `free-trial-specs`)? Press Enter to skip."
|
|
120
|
+
- "List services as `domain:module` pairs, comma-separated
|
|
121
|
+
(e.g. `user:java-spring,order:java-spring`). Press Enter to skip."
|
|
122
|
+
|
|
123
|
+
Then:
|
|
124
|
+
- Skip creating `specs/prd/`, `specs/design-spec/`, `specs/domain-knowledge/` (those live in spec submodule)
|
|
125
|
+
- Create only: `specs/bdd/`, `specs/tech-docs/`, `.trace/`, `.agent/review/` at umbrella level
|
|
126
|
+
*(Unless user explicitly asks to create the full structure)*
|
|
127
|
+
- Generate `.agent/project-context.yaml` in umbrella mode with the services and spec_source provided
|
|
128
|
+
- Skip creating `CLAUDE.md` (umbrella has no single tech stack)
|
|
129
|
+
- After setup, remind: "Open each service submodule separately in Claude Code to install the framework there if needed."
|
|
130
|
+
|
|
131
|
+
**project_type = 3 (PO Spec repo):**
|
|
132
|
+
- Create: `specs/prd/`, `specs/design-spec/`, `specs/product-definition/`, `specs/domain-knowledge/`, `.agent/review/`
|
|
133
|
+
- Skip: `specs/bdd/`, `specs/tech-docs/`, `.trace/`
|
|
134
|
+
- Generate minimal `CLAUDE.md` with only §1 (project overview) and §7 (git conventions)
|
|
135
|
+
- Ask the user: **"List your business domains (e.g. auth, payment, loyalty):"** — store as domain list for `project-context.yaml` and remind PO these names must be used consistently as `@trace.domain` in every PRD
|
|
136
|
+
- Inform:
|
|
137
|
+
- Commands for PO repo: `/define-product`, `/generate-prd`, `/review-context`, `/generate-design-spec`
|
|
138
|
+
- **Critical for dev team handoff:** Every PRD must have `@trace.domain: {domain}` in its frontmatter. Dev team uses this to route generated BDD/code to the correct service submodule. Inconsistent domain names will break routing.
|
|
139
|
+
- Recommended PRD frontmatter:
|
|
140
|
+
```
|
|
141
|
+
@trace.domain: {domain} ← must match a key in dev team's services config
|
|
142
|
+
@trace.id: {TICKET-ID}
|
|
143
|
+
@trace.status: draft | approved
|
|
144
|
+
```
|
|
145
|
+
|
|
101
146
|
## Step 1 — Create Directory Structure
|
|
102
147
|
|
|
103
148
|
Create these directories (skip if they exist):
|
|
@@ -108,6 +153,7 @@ Create these directories (skip if they exist):
|
|
|
108
153
|
│ ├── product-definition/
|
|
109
154
|
│ ├── prd/
|
|
110
155
|
│ ├── bdd/
|
|
156
|
+
│ ├── design-spec/ ← Design Spec documents (FE/App platforms only)
|
|
111
157
|
│ ├── tech-docs/ ← technical design documents
|
|
112
158
|
│ └── domain-knowledge/ ← business dictionary & domain context
|
|
113
159
|
├── .trace/
|
|
@@ -115,8 +161,19 @@ Create these directories (skip if they exist):
|
|
|
115
161
|
└── review/
|
|
116
162
|
```
|
|
117
163
|
|
|
164
|
+
*Directory structure varies by `project_type` set in Step 0.5:*
|
|
165
|
+
|
|
166
|
+
| project_type | Create | Skip |
|
|
167
|
+
|---|---|---|
|
|
168
|
+
| **1 — Single-service** | Full structure above | — |
|
|
169
|
+
| **2 — Umbrella** | `.agent/review/` only (at umbrella root) | Everything else — `specs/` dirs live inside service submodules |
|
|
170
|
+
| **3 — PO Spec repo** | `specs/prd/`, `specs/design-spec/`, `specs/product-definition/`, `specs/domain-knowledge/`, `.agent/review/` | `specs/bdd/`, `specs/tech-docs/`, `.trace/` |
|
|
171
|
+
|
|
118
172
|
## Step 2 — Create CLAUDE.md
|
|
119
173
|
|
|
174
|
+
*Skip this step entirely if `project_type = 2` (Umbrella) — umbrella has no single tech stack.*
|
|
175
|
+
*For `project_type = 3` (PO Spec repo) — create a minimal CLAUDE.md with only §1 (project overview) and §7 (git conventions). Skip §2–§6.*
|
|
176
|
+
|
|
120
177
|
Check if `CLAUDE.md` exists:
|
|
121
178
|
- Yes → ask "Merge template or skip?"
|
|
122
179
|
- No → create from the template below
|
|
@@ -173,12 +230,19 @@ commit_feature: "feat({{TICKET_PREFIX}}-{N}): {description}"
|
|
|
173
230
|
|
|
174
231
|
## Step 3 — Create project-context.yaml
|
|
175
232
|
|
|
233
|
+
*For `project_type = 2` (Umbrella):*
|
|
234
|
+
- *If `.agent/project-context.yaml` was already generated by `--init --umbrella` → open it and verify/edit the `services` section (domain keys, paths, modules). Skip template copy below.*
|
|
235
|
+
- *If not yet generated → ask: "Spec submodule path?" and "Services (domain:module pairs)?" then generate umbrella config (see Step 0.5 for format).*
|
|
236
|
+
|
|
176
237
|
Create `.agent/project-context.yaml` using `.agent/templates/project-context.yaml` as the source template.
|
|
177
238
|
|
|
178
239
|
Copy the template and instruct: "Open `.agent/project-context.yaml` and fill in all `{{PLACEHOLDER}}` values. The `paths` section is pre-configured with sensible defaults — adjust if your project uses different directory names."
|
|
179
240
|
|
|
180
241
|
## Step 4 — Create business-dictionary.md
|
|
181
242
|
|
|
243
|
+
*Skip Steps 4 and 5 if `project_type = 2` (Umbrella) — business dictionary and core entities live in the spec submodule and are managed by the PO team. Dev team reads them from `{spec_source}/specs/domain-knowledge/`.*
|
|
244
|
+
|
|
245
|
+
|
|
182
246
|
Create `specs/domain-knowledge/business-dictionary.md` if it does not exist:
|
|
183
247
|
|
|
184
248
|
```markdown
|
|
@@ -272,8 +336,12 @@ Or: VS Code → `Ctrl+Shift+P` → **"Extensions: Install from Marketplace"**
|
|
|
272
336
|
|
|
273
337
|
## Step 7 — Verify
|
|
274
338
|
|
|
339
|
+
Checklist varies by `project_type`:
|
|
340
|
+
|
|
341
|
+
**project_type = 1 (Single-service):**
|
|
275
342
|
- [ ] `specs/` exists
|
|
276
343
|
- [ ] `specs/bdd/` exists
|
|
344
|
+
- [ ] `specs/design-spec/` exists *(skip if backend-only project)*
|
|
277
345
|
- [ ] `specs/tech-docs/` exists
|
|
278
346
|
- [ ] `specs/domain-knowledge/` exists
|
|
279
347
|
- [ ] `.trace/` exists
|
|
@@ -282,6 +350,24 @@ Or: VS Code → `Ctrl+Shift+P` → **"Extensions: Install from Marketplace"**
|
|
|
282
350
|
- [ ] `specs/domain-knowledge/business-dictionary.md` exists
|
|
283
351
|
- [ ] `specs/domain-knowledge/core-entities.md` exists
|
|
284
352
|
|
|
353
|
+
**project_type = 2 (Umbrella):**
|
|
354
|
+
- [ ] `.agent/project-context.yaml` exists with `setup.mode: umbrella`
|
|
355
|
+
- [ ] `services` section has at least one entry with correct domain keys
|
|
356
|
+
- [ ] `spec_source` path exists (e.g., `my-project-specs/` directory is present)
|
|
357
|
+
- [ ] `.agent/review/` exists
|
|
358
|
+
- [ ] Spec submodule initialized: `git submodule status` shows no `-` prefix
|
|
359
|
+
|
|
360
|
+
**project_type = 3 (PO Spec repo):**
|
|
361
|
+
- [ ] `specs/prd/` exists
|
|
362
|
+
- [ ] `specs/design-spec/` exists
|
|
363
|
+
- [ ] `specs/product-definition/` exists
|
|
364
|
+
- [ ] `specs/domain-knowledge/` exists
|
|
365
|
+
- [ ] `.agent/review/` exists
|
|
366
|
+
- [ ] `.agent/project-context.yaml` exists
|
|
367
|
+
- [ ] `CLAUDE.md` exists (minimal)
|
|
368
|
+
- [ ] `specs/domain-knowledge/business-dictionary.md` exists
|
|
369
|
+
- [ ] `specs/domain-knowledge/core-entities.md` exists
|
|
370
|
+
|
|
285
371
|
## Output
|
|
286
372
|
|
|
287
373
|
# Report Footer — Standard Command Output Format
|
|
@@ -316,7 +402,8 @@ Suggest the logical next command based on workflow phase:
|
|
|
316
402
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
317
403
|
| /generate-prd | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
|
|
318
404
|
| /refine-prd | Open Review Board → update PRD → `/review-context {prd-file}` |
|
|
319
|
-
| /review-context (PRD) | `/generate-
|
|
405
|
+
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (then BDD after sign-off); BE: `/generate-bdd {prd-file}` directly; fix PRD if NEEDS_FIX |
|
|
406
|
+
| /generate-design-spec | Designer review → Figma links confirmed → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
320
407
|
| /generate-bdd | `/review-context {feature-file}` to verify coverage |
|
|
321
408
|
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
|
|
322
409
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
@@ -330,6 +417,11 @@ Suggest the logical next command based on workflow phase:
|
|
|
330
417
|
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/generate-tests {UC-ID}`; all OK → create PR |
|
|
331
418
|
| /fix-bug | Create PR and link to ticket |
|
|
332
419
|
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
420
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
421
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
422
|
+
| /learn | Continue working — lesson applies on next command |
|
|
423
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
424
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
333
425
|
|
|
334
426
|
Format the footer as:
|
|
335
427
|
```
|
|
@@ -342,13 +434,59 @@ Next : {suggested command with example arguments}
|
|
|
342
434
|
|
|
343
435
|
```
|
|
344
436
|
/setup-ai-first Complete ✅
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
Output varies by `project_type`:
|
|
440
|
+
|
|
441
|
+
**Single-service:**
|
|
442
|
+
```
|
|
345
443
|
Next:
|
|
346
444
|
1. Fill CLAUDE.md (replace {{PLACEHOLDER}} values)
|
|
347
445
|
2. Fill .agent/project-context.yaml
|
|
348
|
-
3. Fill specs/domain-knowledge/business-dictionary.md
|
|
349
|
-
4. Fill specs/domain-knowledge/core-entities.md
|
|
446
|
+
3. Fill specs/domain-knowledge/business-dictionary.md
|
|
447
|
+
4. Fill specs/domain-knowledge/core-entities.md
|
|
350
448
|
5. git add and commit those 4 files
|
|
351
|
-
6. Install VS Code extension
|
|
449
|
+
6. Install VS Code extension:
|
|
352
450
|
code --install-extension edupia-team.spec-driven-dev-team
|
|
353
451
|
7. /define-product to start your first feature
|
|
354
452
|
```
|
|
453
|
+
|
|
454
|
+
**Umbrella:**
|
|
455
|
+
```
|
|
456
|
+
Next:
|
|
457
|
+
1. Review .agent/project-context.yaml:
|
|
458
|
+
- Update services[].path to match actual submodule directory names
|
|
459
|
+
- Update services domain keys to match @trace.domain in your PRD files
|
|
460
|
+
- Confirm spec_source path is correct
|
|
461
|
+
|
|
462
|
+
2. Run /sync — one command that handles everything else:
|
|
463
|
+
/sync
|
|
464
|
+
→ git pull + submodule init + spec submodule update
|
|
465
|
+
→ Auto-create .agent/project-context.yaml for each service submodule
|
|
466
|
+
(detects module from pom.xml / go.mod / package.json / pubspec.yaml etc.)
|
|
467
|
+
→ Sync Living Docs panel
|
|
468
|
+
→ Refresh spec-manifest.yaml
|
|
469
|
+
|
|
470
|
+
3. Start generating:
|
|
471
|
+
/generate-bdd {spec_source}/specs/prd/{domain}/TICKET-ID-prd.md
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
**PO Spec repo:**
|
|
475
|
+
```
|
|
476
|
+
Next:
|
|
477
|
+
1. Fill .agent/project-context.yaml:
|
|
478
|
+
- domains: [list all business domains — these become @trace.domain values in PRDs]
|
|
479
|
+
- project.name, project.description
|
|
480
|
+
2. Fill specs/domain-knowledge/business-dictionary.md ← canonical terms
|
|
481
|
+
3. Fill specs/domain-knowledge/core-entities.md ← entity glossary
|
|
482
|
+
4. git add and commit those files
|
|
483
|
+
5. Install VS Code extension:
|
|
484
|
+
code --install-extension edupia-team.spec-driven-dev-team
|
|
485
|
+
6. /define-product to start your first feature
|
|
486
|
+
|
|
487
|
+
⚠️ Dev team handoff reminder:
|
|
488
|
+
- Each PRD must have @trace.domain matching one of your domains list
|
|
489
|
+
- When dev team sets up their umbrella repo, they map these domain names
|
|
490
|
+
to service submodule paths in their project-context.yaml services section
|
|
491
|
+
- Share domain names with dev team before they configure their umbrellas
|
|
492
|
+
```
|
|
@@ -17,6 +17,51 @@ Check if already set up:
|
|
|
17
17
|
- Y → continue (existing files will be preserved — each step will offer merge/skip)
|
|
18
18
|
- If only `specs/` exists or only partial setup detected → continue normally (safe to re-run)
|
|
19
19
|
|
|
20
|
+
## Step 0.5 — Project Type
|
|
21
|
+
|
|
22
|
+
Ask the user:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
What type of project is this?
|
|
26
|
+
1. Single-service — one codebase, one platform (standard setup)
|
|
27
|
+
2. Umbrella repo — this repo contains multiple service submodules (microservices / multi-app)
|
|
28
|
+
3. PO Spec repo — docs only, no runnable code (PRD + design-spec only)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Store the answer as `project_type`. Default to `1` if user does not answer.
|
|
32
|
+
|
|
33
|
+
Based on answer:
|
|
34
|
+
|
|
35
|
+
**project_type = 1 (Single-service):** Continue standard setup below.
|
|
36
|
+
|
|
37
|
+
**project_type = 2 (Umbrella):** Ask two follow-up questions:
|
|
38
|
+
- "Path to spec submodule (e.g. `free-trial-specs`)? Press Enter to skip."
|
|
39
|
+
- "List services as `domain:module` pairs, comma-separated
|
|
40
|
+
(e.g. `user:java-spring,order:java-spring`). Press Enter to skip."
|
|
41
|
+
|
|
42
|
+
Then:
|
|
43
|
+
- Skip creating `specs/prd/`, `specs/design-spec/`, `specs/domain-knowledge/` (those live in spec submodule)
|
|
44
|
+
- Create only: `specs/bdd/`, `specs/tech-docs/`, `.trace/`, `.agent/review/` at umbrella level
|
|
45
|
+
*(Unless user explicitly asks to create the full structure)*
|
|
46
|
+
- Generate `.agent/project-context.yaml` in umbrella mode with the services and spec_source provided
|
|
47
|
+
- Skip creating `CLAUDE.md` (umbrella has no single tech stack)
|
|
48
|
+
- After setup, remind: "Open each service submodule separately in Claude Code to install the framework there if needed."
|
|
49
|
+
|
|
50
|
+
**project_type = 3 (PO Spec repo):**
|
|
51
|
+
- Create: `specs/prd/`, `specs/design-spec/`, `specs/product-definition/`, `specs/domain-knowledge/`, `.agent/review/`
|
|
52
|
+
- Skip: `specs/bdd/`, `specs/tech-docs/`, `.trace/`
|
|
53
|
+
- Generate minimal `CLAUDE.md` with only §1 (project overview) and §7 (git conventions)
|
|
54
|
+
- Ask the user: **"List your business domains (e.g. auth, payment, loyalty):"** — store as domain list for `project-context.yaml` and remind PO these names must be used consistently as `@trace.domain` in every PRD
|
|
55
|
+
- Inform:
|
|
56
|
+
- Commands for PO repo: `/define-product`, `/generate-prd`, `/review-context`, `/generate-design-spec`
|
|
57
|
+
- **Critical for dev team handoff:** Every PRD must have `@trace.domain: {domain}` in its frontmatter. Dev team uses this to route generated BDD/code to the correct service submodule. Inconsistent domain names will break routing.
|
|
58
|
+
- Recommended PRD frontmatter:
|
|
59
|
+
```
|
|
60
|
+
@trace.domain: {domain} ← must match a key in dev team's services config
|
|
61
|
+
@trace.id: {TICKET-ID}
|
|
62
|
+
@trace.status: draft | approved
|
|
63
|
+
```
|
|
64
|
+
|
|
20
65
|
## Step 1 — Create Directory Structure
|
|
21
66
|
|
|
22
67
|
Create these directories (skip if they exist):
|
|
@@ -27,6 +72,7 @@ Create these directories (skip if they exist):
|
|
|
27
72
|
│ ├── product-definition/
|
|
28
73
|
│ ├── prd/
|
|
29
74
|
│ ├── bdd/
|
|
75
|
+
│ ├── design-spec/ ← Design Spec documents (FE/App platforms only)
|
|
30
76
|
│ ├── tech-docs/ ← technical design documents
|
|
31
77
|
│ └── domain-knowledge/ ← business dictionary & domain context
|
|
32
78
|
├── .trace/
|
|
@@ -34,8 +80,19 @@ Create these directories (skip if they exist):
|
|
|
34
80
|
└── review/
|
|
35
81
|
```
|
|
36
82
|
|
|
83
|
+
*Directory structure varies by `project_type` set in Step 0.5:*
|
|
84
|
+
|
|
85
|
+
| project_type | Create | Skip |
|
|
86
|
+
|---|---|---|
|
|
87
|
+
| **1 — Single-service** | Full structure above | — |
|
|
88
|
+
| **2 — Umbrella** | `.agent/review/` only (at umbrella root) | Everything else — `specs/` dirs live inside service submodules |
|
|
89
|
+
| **3 — PO Spec repo** | `specs/prd/`, `specs/design-spec/`, `specs/product-definition/`, `specs/domain-knowledge/`, `.agent/review/` | `specs/bdd/`, `specs/tech-docs/`, `.trace/` |
|
|
90
|
+
|
|
37
91
|
## Step 2 — Create CLAUDE.md
|
|
38
92
|
|
|
93
|
+
*Skip this step entirely if `project_type = 2` (Umbrella) — umbrella has no single tech stack.*
|
|
94
|
+
*For `project_type = 3` (PO Spec repo) — create a minimal CLAUDE.md with only §1 (project overview) and §7 (git conventions). Skip §2–§6.*
|
|
95
|
+
|
|
39
96
|
Check if `CLAUDE.md` exists:
|
|
40
97
|
- Yes → ask "Merge template or skip?"
|
|
41
98
|
- No → create from the template below
|
|
@@ -92,12 +149,19 @@ commit_feature: "feat({{TICKET_PREFIX}}-{N}): {description}"
|
|
|
92
149
|
|
|
93
150
|
## Step 3 — Create project-context.yaml
|
|
94
151
|
|
|
152
|
+
*For `project_type = 2` (Umbrella):*
|
|
153
|
+
- *If `.agent/project-context.yaml` was already generated by `--init --umbrella` → open it and verify/edit the `services` section (domain keys, paths, modules). Skip template copy below.*
|
|
154
|
+
- *If not yet generated → ask: "Spec submodule path?" and "Services (domain:module pairs)?" then generate umbrella config (see Step 0.5 for format).*
|
|
155
|
+
|
|
95
156
|
Create `.agent/project-context.yaml` using `.agent/templates/project-context.yaml` as the source template.
|
|
96
157
|
|
|
97
158
|
Copy the template and instruct: "Open `.agent/project-context.yaml` and fill in all `{{PLACEHOLDER}}` values. The `paths` section is pre-configured with sensible defaults — adjust if your project uses different directory names."
|
|
98
159
|
|
|
99
160
|
## Step 4 — Create business-dictionary.md
|
|
100
161
|
|
|
162
|
+
*Skip Steps 4 and 5 if `project_type = 2` (Umbrella) — business dictionary and core entities live in the spec submodule and are managed by the PO team. Dev team reads them from `{spec_source}/specs/domain-knowledge/`.*
|
|
163
|
+
|
|
164
|
+
|
|
101
165
|
Create `specs/domain-knowledge/business-dictionary.md` if it does not exist:
|
|
102
166
|
|
|
103
167
|
```markdown
|
|
@@ -191,8 +255,12 @@ Or: VS Code → `Ctrl+Shift+P` → **"Extensions: Install from Marketplace"**
|
|
|
191
255
|
|
|
192
256
|
## Step 7 — Verify
|
|
193
257
|
|
|
258
|
+
Checklist varies by `project_type`:
|
|
259
|
+
|
|
260
|
+
**project_type = 1 (Single-service):**
|
|
194
261
|
- [ ] `specs/` exists
|
|
195
262
|
- [ ] `specs/bdd/` exists
|
|
263
|
+
- [ ] `specs/design-spec/` exists *(skip if backend-only project)*
|
|
196
264
|
- [ ] `specs/tech-docs/` exists
|
|
197
265
|
- [ ] `specs/domain-knowledge/` exists
|
|
198
266
|
- [ ] `.trace/` exists
|
|
@@ -201,19 +269,83 @@ Or: VS Code → `Ctrl+Shift+P` → **"Extensions: Install from Marketplace"**
|
|
|
201
269
|
- [ ] `specs/domain-knowledge/business-dictionary.md` exists
|
|
202
270
|
- [ ] `specs/domain-knowledge/core-entities.md` exists
|
|
203
271
|
|
|
272
|
+
**project_type = 2 (Umbrella):**
|
|
273
|
+
- [ ] `.agent/project-context.yaml` exists with `setup.mode: umbrella`
|
|
274
|
+
- [ ] `services` section has at least one entry with correct domain keys
|
|
275
|
+
- [ ] `spec_source` path exists (e.g., `my-project-specs/` directory is present)
|
|
276
|
+
- [ ] `.agent/review/` exists
|
|
277
|
+
- [ ] Spec submodule initialized: `git submodule status` shows no `-` prefix
|
|
278
|
+
|
|
279
|
+
**project_type = 3 (PO Spec repo):**
|
|
280
|
+
- [ ] `specs/prd/` exists
|
|
281
|
+
- [ ] `specs/design-spec/` exists
|
|
282
|
+
- [ ] `specs/product-definition/` exists
|
|
283
|
+
- [ ] `specs/domain-knowledge/` exists
|
|
284
|
+
- [ ] `.agent/review/` exists
|
|
285
|
+
- [ ] `.agent/project-context.yaml` exists
|
|
286
|
+
- [ ] `CLAUDE.md` exists (minimal)
|
|
287
|
+
- [ ] `specs/domain-knowledge/business-dictionary.md` exists
|
|
288
|
+
- [ ] `specs/domain-knowledge/core-entities.md` exists
|
|
289
|
+
|
|
204
290
|
## Output
|
|
205
291
|
|
|
206
292
|
{{include:steps/report-footer.md}}
|
|
207
293
|
|
|
208
294
|
```
|
|
209
295
|
/setup-ai-first Complete ✅
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
Output varies by `project_type`:
|
|
299
|
+
|
|
300
|
+
**Single-service:**
|
|
301
|
+
```
|
|
210
302
|
Next:
|
|
211
303
|
1. Fill CLAUDE.md (replace {{PLACEHOLDER}} values)
|
|
212
304
|
2. Fill .agent/project-context.yaml
|
|
213
|
-
3. Fill specs/domain-knowledge/business-dictionary.md
|
|
214
|
-
4. Fill specs/domain-knowledge/core-entities.md
|
|
305
|
+
3. Fill specs/domain-knowledge/business-dictionary.md
|
|
306
|
+
4. Fill specs/domain-knowledge/core-entities.md
|
|
215
307
|
5. git add and commit those 4 files
|
|
216
|
-
6. Install VS Code extension
|
|
308
|
+
6. Install VS Code extension:
|
|
217
309
|
code --install-extension edupia-team.spec-driven-dev-team
|
|
218
310
|
7. /define-product to start your first feature
|
|
219
311
|
```
|
|
312
|
+
|
|
313
|
+
**Umbrella:**
|
|
314
|
+
```
|
|
315
|
+
Next:
|
|
316
|
+
1. Review .agent/project-context.yaml:
|
|
317
|
+
- Update services[].path to match actual submodule directory names
|
|
318
|
+
- Update services domain keys to match @trace.domain in your PRD files
|
|
319
|
+
- Confirm spec_source path is correct
|
|
320
|
+
|
|
321
|
+
2. Run /sync — one command that handles everything else:
|
|
322
|
+
/sync
|
|
323
|
+
→ git pull + submodule init + spec submodule update
|
|
324
|
+
→ Auto-create .agent/project-context.yaml for each service submodule
|
|
325
|
+
(detects module from pom.xml / go.mod / package.json / pubspec.yaml etc.)
|
|
326
|
+
→ Sync Living Docs panel
|
|
327
|
+
→ Refresh spec-manifest.yaml
|
|
328
|
+
|
|
329
|
+
3. Start generating:
|
|
330
|
+
/generate-bdd {spec_source}/specs/prd/{domain}/TICKET-ID-prd.md
|
|
331
|
+
```
|
|
332
|
+
|
|
333
|
+
**PO Spec repo:**
|
|
334
|
+
```
|
|
335
|
+
Next:
|
|
336
|
+
1. Fill .agent/project-context.yaml:
|
|
337
|
+
- domains: [list all business domains — these become @trace.domain values in PRDs]
|
|
338
|
+
- project.name, project.description
|
|
339
|
+
2. Fill specs/domain-knowledge/business-dictionary.md ← canonical terms
|
|
340
|
+
3. Fill specs/domain-knowledge/core-entities.md ← entity glossary
|
|
341
|
+
4. git add and commit those files
|
|
342
|
+
5. Install VS Code extension:
|
|
343
|
+
code --install-extension edupia-team.spec-driven-dev-team
|
|
344
|
+
6. /define-product to start your first feature
|
|
345
|
+
|
|
346
|
+
⚠️ Dev team handoff reminder:
|
|
347
|
+
- Each PRD must have @trace.domain matching one of your domains list
|
|
348
|
+
- When dev team sets up their umbrella repo, they map these domain names
|
|
349
|
+
to service submodule paths in their project-context.yaml services section
|
|
350
|
+
- Share domain names with dev team before they configure their umbrellas
|
|
351
|
+
```
|
package/commands/smoke-test.md
CHANGED
|
@@ -133,6 +133,7 @@ Read `.agent/project-context.yaml`. Extract and store:
|
|
|
133
133
|
- `paths.core_entities` → path to core-entities.md
|
|
134
134
|
- `paths.tech_docs_dir` → technical documentation root
|
|
135
135
|
- `paths.trace_dir` → trace state directory
|
|
136
|
+
- `paths.design_spec_dir` → Design Spec documents root (FE/App only)
|
|
136
137
|
|
|
137
138
|
If `paths` section is absent, use these defaults:
|
|
138
139
|
- `specs_dir` = `specs/bdd`
|
|
@@ -144,11 +145,75 @@ If `paths` section is absent, use these defaults:
|
|
|
144
145
|
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
145
146
|
- `tech_docs_dir` = `specs/tech-docs`
|
|
146
147
|
- `trace_dir` = `.trace`
|
|
148
|
+
- `design_spec_dir` = `specs/design-spec`
|
|
147
149
|
|
|
148
150
|
If `tech_stack.module` is set, also load `.agent/modules/{module}/stack-profile.yaml` if it exists.
|
|
149
151
|
|
|
150
152
|
---
|
|
151
153
|
|
|
154
|
+
## Step 1.5 — [SERVICE ROUTING] Resolve service paths (umbrella mode)
|
|
155
|
+
|
|
156
|
+
*Skip this step entirely if `setup.mode` is not `"umbrella"` and `services` section is absent from project-context.yaml.*
|
|
157
|
+
|
|
158
|
+
If `services` section is present:
|
|
159
|
+
|
|
160
|
+
**1. Detect active domain** (in priority order):
|
|
161
|
+
- Read `@trace.domain` from target file frontmatter (if Gate loaded a target file)
|
|
162
|
+
- Extract from target file path: segment immediately after `prd_dir` base path
|
|
163
|
+
*(e.g., `specs/prd/user/FEAT-01.md` → domain = `user`)*
|
|
164
|
+
- If `$ARGUMENTS` contains a path, extract the segment after `prd_dir`
|
|
165
|
+
|
|
166
|
+
**2. Route to service** — if active domain matches a key in `services`:
|
|
167
|
+
- Override `paths.specs_dir` → `services.{domain}.specs_dir`
|
|
168
|
+
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir`
|
|
169
|
+
- Store `active_service` = `services.{domain}.path`
|
|
170
|
+
- Store `active_service_module` = `services.{domain}.module`
|
|
171
|
+
- If service has its own `module` → use it as `active_module` (overrides `tech_stack.module`)
|
|
172
|
+
|
|
173
|
+
**3. Fallback** — if domain not detected or no matching service key:
|
|
174
|
+
- Keep default paths from Step 1
|
|
175
|
+
- Set `active_service = unresolved`
|
|
176
|
+
|
|
177
|
+
**4. Spec source auto-override** — if `setup.spec_source` is set AND the corresponding path was not already explicitly set in `paths:`:
|
|
178
|
+
- Override `paths.prd_dir` → `{spec_source}/specs/prd`
|
|
179
|
+
- Override `paths.design_spec_dir` → `{spec_source}/specs/design-spec`
|
|
180
|
+
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
181
|
+
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
182
|
+
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
183
|
+
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
184
|
+
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
185
|
+
|
|
186
|
+
> **Why under `spec_source`:** tester feedback (`/report-bug`, `/propose-scenario`) must land in the **shared spec repo** so PO/Dev see it when they `/sync`. In single-service mode (no `spec_source`), these default to `feedback/bug-reports` and `feedback/bdd-proposals` at repo root — still shared, same repo.
|
|
187
|
+
|
|
188
|
+
---
|
|
189
|
+
|
|
190
|
+
## Step 1.6 — [SERVICE CONVENTIONS] Load service-specific conventions (umbrella mode)
|
|
191
|
+
|
|
192
|
+
*Skip this step entirely if `active_service` is `"unresolved"` or context is single-service mode.*
|
|
193
|
+
|
|
194
|
+
When `active_service` has been resolved to a real path in Step 1.5 (e.g., `user-service/`):
|
|
195
|
+
|
|
196
|
+
**1. Locate service config** — try in priority order:
|
|
197
|
+
- `{active_service}/.agent/project-context.yaml`
|
|
198
|
+
- `{active_service}/project-context.yaml`
|
|
199
|
+
|
|
200
|
+
**2. If found, override with service-specific values:**
|
|
201
|
+
|
|
202
|
+
| Variable | Source |
|
|
203
|
+
|----------|--------|
|
|
204
|
+
| `conventions.test_command` | service's `conventions.test_command` |
|
|
205
|
+
| `conventions.build_command` | service's `conventions.build_command` |
|
|
206
|
+
| `paths.trace_dir` | `{active_service}/{service paths.trace_dir}` — default: `{active_service}/.trace` |
|
|
207
|
+
| `paths.specs_dir` | `{active_service}/{service paths.specs_dir}` (if set in service config, else keep Step 1.5 override) |
|
|
208
|
+
|
|
209
|
+
**3. Store** `service_root = {active_service}` as the working directory anchor for all downstream commands:
|
|
210
|
+
- Shell commands (`/run-tests`, `/generate-tests`) run **from within** `service_root`
|
|
211
|
+
- File write operations (test files, trace TSVs) use paths **relative to** `service_root`
|
|
212
|
+
|
|
213
|
+
**4. If service config not found** — keep umbrella defaults, still set `service_root = {active_service}` (path anchor is always needed even without a config override).
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
152
217
|
## Step 2 — [PROJECT-CONFIG] Load module stack profile (conditional)
|
|
153
218
|
|
|
154
219
|
If `tech_stack.module` is set, read `.agent/modules/{module}/stack-profile.yaml`.
|
|
@@ -239,6 +304,25 @@ These two variables (`active_module`, `platform_type`) are the canonical source
|
|
|
239
304
|
|
|
240
305
|
---
|
|
241
306
|
|
|
307
|
+
## Step 6.7 — [GUARDRAILS] Load Project Lessons (conditional)
|
|
308
|
+
|
|
309
|
+
*Accumulated mistakes the AI must not repeat in this project. These are added over time via `/learn`
|
|
310
|
+
or accepted during `/review-code`, `/fix-bug`, `/debug`.*
|
|
311
|
+
|
|
312
|
+
Resolve the lessons file path:
|
|
313
|
+
- Use `paths.lessons_file` if set (may be service-overridden in umbrella mode, Step 1.6)
|
|
314
|
+
- Else default `specs/domain-knowledge/lessons-learned.md`
|
|
315
|
+
- In umbrella/service mode (when `service_root` is set), if `paths.lessons_file` is unset, default to `{service_root}/.agent/project-lessons.md`
|
|
316
|
+
|
|
317
|
+
If the file exists, read it and store ALL lessons as **ACTIVE GUARDRAILS** for the session:
|
|
318
|
+
- Treat each lesson's **Rule** as a hard constraint — same priority as CLAUDE.md coding standards (Step 3).
|
|
319
|
+
- Before generating or modifying any artifact (PRD, BDD, tech-doc, code, test), check the output against every lesson whose `category` matches the current command AND whose `scope` matches the target (domain / file).
|
|
320
|
+
- If a generated output would violate a lesson → correct it **before** presenting, and note which lesson (`L-NNN`) was applied.
|
|
321
|
+
|
|
322
|
+
If the file does not exist → skip silently (no lessons captured yet).
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
242
326
|
## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
|
|
243
327
|
|
|
244
328
|
After loading all context, synthesize and output a compact summary block.
|
|
@@ -254,6 +338,9 @@ Layers : {layer order from CLAUDE.md §2, e.g., Controller → Facade → Ser
|
|
|
254
338
|
Ticket : {ticket_prefix}-
|
|
255
339
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
256
340
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
341
|
+
Lessons : {loaded — N guardrails | none yet}
|
|
342
|
+
Service : {active_service} ({active_service_module}) | single-service
|
|
343
|
+
Svc Root : {service_root} — conventions + trace_dir loaded from service config | —
|
|
257
344
|
Status : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
258
345
|
```
|
|
259
346
|
|
|
@@ -498,7 +585,8 @@ Suggest the logical next command based on workflow phase:
|
|
|
498
585
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
499
586
|
| /generate-prd | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
|
|
500
587
|
| /refine-prd | Open Review Board → update PRD → `/review-context {prd-file}` |
|
|
501
|
-
| /review-context (PRD) | `/generate-
|
|
588
|
+
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (then BDD after sign-off); BE: `/generate-bdd {prd-file}` directly; fix PRD if NEEDS_FIX |
|
|
589
|
+
| /generate-design-spec | Designer review → Figma links confirmed → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
502
590
|
| /generate-bdd | `/review-context {feature-file}` to verify coverage |
|
|
503
591
|
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
|
|
504
592
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
@@ -512,6 +600,11 @@ Suggest the logical next command based on workflow phase:
|
|
|
512
600
|
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/generate-tests {UC-ID}`; all OK → create PR |
|
|
513
601
|
| /fix-bug | Create PR and link to ticket |
|
|
514
602
|
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
603
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
604
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
605
|
+
| /learn | Continue working — lesson applies on next command |
|
|
606
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
607
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
515
608
|
|
|
516
609
|
Format the footer as:
|
|
517
610
|
```
|