@edupia-tutor/spec-driven-docs 0.14.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/bin/build.js +230 -0
- package/bin/index.js +598 -0
- package/commands/debug.md +830 -0
- package/commands/debug.tmpl +257 -0
- package/commands/define-product.md +652 -0
- package/commands/define-product.tmpl +158 -0
- package/commands/dev-gen-test.md +1010 -0
- package/commands/dev-gen-test.tmpl +490 -0
- package/commands/dev-run-test.md +744 -0
- package/commands/dev-run-test.tmpl +224 -0
- package/commands/dev-smoke-test.md +711 -0
- package/commands/dev-smoke-test.tmpl +217 -0
- package/commands/fix-bug.md +744 -0
- package/commands/fix-bug.tmpl +171 -0
- package/commands/generate-bdd.md +1054 -0
- package/commands/generate-bdd.tmpl +534 -0
- package/commands/generate-code.md +869 -0
- package/commands/generate-code.tmpl +349 -0
- package/commands/generate-design-spec.md +958 -0
- package/commands/generate-design-spec.tmpl +464 -0
- package/commands/generate-prd.md +748 -0
- package/commands/generate-prd.tmpl +254 -0
- package/commands/generate-spec-manifest.md +658 -0
- package/commands/generate-spec-manifest.tmpl +164 -0
- package/commands/generate-tech-docs.md +849 -0
- package/commands/generate-tech-docs.tmpl +355 -0
- package/commands/learn.md +636 -0
- package/commands/learn.tmpl +63 -0
- package/commands/map-testids.md +575 -0
- package/commands/map-testids.tmpl +81 -0
- package/commands/propose-scenario.md +623 -0
- package/commands/propose-scenario.tmpl +129 -0
- package/commands/qc-analyze.md +580 -0
- package/commands/qc-analyze.tmpl +86 -0
- package/commands/qc-design-test.md +562 -0
- package/commands/qc-design-test.tmpl +68 -0
- package/commands/qc-plan.md +543 -0
- package/commands/qc-plan.tmpl +49 -0
- package/commands/qc-report.md +554 -0
- package/commands/qc-report.tmpl +60 -0
- package/commands/qc-review.md +547 -0
- package/commands/qc-review.tmpl +53 -0
- package/commands/qc-run-test.md +604 -0
- package/commands/qc-run-test.tmpl +84 -0
- package/commands/refine-prd.md +772 -0
- package/commands/refine-prd.tmpl +140 -0
- package/commands/report-bug.md +639 -0
- package/commands/report-bug.tmpl +145 -0
- package/commands/review-code.md +677 -0
- package/commands/review-code.tmpl +104 -0
- package/commands/review-context.md +1047 -0
- package/commands/review-context.tmpl +415 -0
- package/commands/review-tech-docs.md +811 -0
- package/commands/review-tech-docs.tmpl +317 -0
- package/commands/setup-ai-first.md +545 -0
- package/commands/setup-ai-first.tmpl +358 -0
- package/commands/sync.md +451 -0
- package/commands/sync.tmpl +351 -0
- package/commands/update-framework.md +251 -0
- package/commands/update-framework.tmpl +151 -0
- package/commands/validate-traces.md +842 -0
- package/commands/validate-traces.tmpl +348 -0
- package/core/FRAMEWORK_VERSION +1 -0
- package/core/commands/debug.md +830 -0
- package/core/commands/define-product.md +652 -0
- package/core/commands/dev-gen-test.md +1010 -0
- package/core/commands/dev-run-test.md +744 -0
- package/core/commands/dev-smoke-test.md +711 -0
- package/core/commands/fix-bug.md +744 -0
- package/core/commands/generate-bdd.md +1054 -0
- package/core/commands/generate-code.md +869 -0
- package/core/commands/generate-design-spec.md +958 -0
- package/core/commands/generate-prd.md +748 -0
- package/core/commands/generate-spec-manifest.md +658 -0
- package/core/commands/generate-tech-docs.md +849 -0
- package/core/commands/learn.md +636 -0
- package/core/commands/map-testids.md +575 -0
- package/core/commands/propose-scenario.md +623 -0
- package/core/commands/qc-analyze.md +580 -0
- package/core/commands/qc-design-test.md +562 -0
- package/core/commands/qc-plan.md +543 -0
- package/core/commands/qc-report.md +554 -0
- package/core/commands/qc-review.md +547 -0
- package/core/commands/qc-run-test.md +604 -0
- package/core/commands/refine-prd.md +772 -0
- package/core/commands/report-bug.md +639 -0
- package/core/commands/review-code.md +677 -0
- package/core/commands/review-context.md +1047 -0
- package/core/commands/review-tech-docs.md +811 -0
- package/core/commands/setup-ai-first.md +545 -0
- package/core/commands/sync.md +451 -0
- package/core/commands/update-framework.md +251 -0
- package/core/commands/validate-traces.md +842 -0
- package/core/hooks/data-guard.js +141 -0
- package/core/hooks/settings.json +18 -0
- package/core/modules/android-compose/module.yaml +13 -0
- package/core/modules/android-compose/stack-profile.yaml +57 -0
- package/core/modules/angular/architecture-snippets/component-patterns.md +187 -0
- package/core/modules/angular/module.yaml +6 -0
- package/core/modules/angular/stack-profile.yaml +38 -0
- package/core/modules/context-engineering/architecture-snippets/context-design.md +119 -0
- package/core/modules/context-engineering/module.yaml +9 -0
- package/core/modules/context-engineering/stack-profile.yaml +61 -0
- package/core/modules/dotnet/architecture-snippets/clean-arch.md +160 -0
- package/core/modules/dotnet/module.yaml +6 -0
- package/core/modules/dotnet/stack-profile.yaml +50 -0
- package/core/modules/flutter/module.yaml +14 -0
- package/core/modules/flutter/stack-profile.yaml +59 -0
- package/core/modules/golang/architecture-snippets/domain-layout.md +283 -0
- package/core/modules/golang/module.yaml +6 -0
- package/core/modules/golang/stack-profile.yaml +40 -0
- package/core/modules/ios-swiftui/module.yaml +13 -0
- package/core/modules/ios-swiftui/stack-profile.yaml +55 -0
- package/core/modules/java-spring/architecture-snippets/layered-arch.md +201 -0
- package/core/modules/java-spring/module.yaml +15 -0
- package/core/modules/java-spring/stack-profile.yaml +28 -0
- package/core/modules/nextjs/architecture-snippets/app-router-patterns.md +269 -0
- package/core/modules/nextjs/module.yaml +14 -0
- package/core/modules/nextjs/stack-profile.yaml +74 -0
- package/core/modules/nuxt/module.yaml +14 -0
- package/core/modules/nuxt/stack-profile.yaml +58 -0
- package/core/modules/php-laravel/architecture-snippets/service-repository.md +302 -0
- package/core/modules/php-laravel/module.yaml +15 -0
- package/core/modules/php-laravel/stack-profile.yaml +56 -0
- package/core/modules/qc-playwright/stack-profile.yaml +66 -0
- package/core/modules/react/architecture-snippets/hooks-query-patterns.md +254 -0
- package/core/modules/react/module.yaml +14 -0
- package/core/modules/react/stack-profile.yaml +63 -0
- package/core/modules/react-native/module.yaml +14 -0
- package/core/modules/react-native/stack-profile.yaml +56 -0
- package/core/modules/vue/module.yaml +14 -0
- package/core/modules/vue/stack-profile.yaml +65 -0
- package/core/rules/data-protection.md +80 -0
- package/core/rules/workflow.md +44 -0
- package/core/skills/code/SKILL.md +770 -0
- package/core/skills/debug/SKILL.md +869 -0
- package/core/skills/design-spec/SKILL.md +589 -0
- package/core/skills/discovery/SKILL.md +554 -0
- package/core/skills/prd/SKILL.md +562 -0
- package/core/skills/qc/qa-analyst/DOC_GAPS.template.md +63 -0
- package/core/skills/qc/qa-analyst/acceptance-criteria.md +60 -0
- package/core/skills/qc/qa-analyst/business-rules.md +59 -0
- package/core/skills/qc/qa-analyst/data-flow.md +64 -0
- package/core/skills/qc/qa-analyst/spec-breakdown.md +61 -0
- package/core/skills/qc/qa-designer/e2e/journey.md +41 -0
- package/core/skills/qc/qa-designer/exploratory/charter.md +68 -0
- package/core/skills/qc/qa-designer/exploratory/explore-to-functional.md +43 -0
- package/core/skills/qc/qa-designer/functional/api.md +45 -0
- package/core/skills/qc/qa-designer/functional/gui-feature.md +46 -0
- package/core/skills/qc/qa-designer/functional/gui-screen.md +52 -0
- package/core/skills/qc/qa-designer/integration/api.md +42 -0
- package/core/skills/qc/qa-designer/integration/db.md +39 -0
- package/core/skills/qc/qa-designer/integration/gui.md +40 -0
- package/core/skills/qc/qa-designer/integration/kafka.md +40 -0
- package/core/skills/qc/qa-designer/non-functional.md +40 -0
- package/core/skills/qc/qa-planner/test-plan.md +120 -0
- package/core/skills/qc/qa-reviewer/script/e2e.md +87 -0
- package/core/skills/qc/qa-reviewer/script/exploratory.md +45 -0
- package/core/skills/qc/qa-reviewer/script/functional.md +101 -0
- package/core/skills/qc/qa-reviewer/script/integration.md +91 -0
- package/core/skills/qc/qa-reviewer/script/non-functional.md +126 -0
- package/core/skills/qc/qa-reviewer/test-case/e2e.md +73 -0
- package/core/skills/qc/qa-reviewer/test-case/exploratory.md +43 -0
- package/core/skills/qc/qa-reviewer/test-case/functional.md +76 -0
- package/core/skills/qc/qa-reviewer/test-case/integration.md +69 -0
- package/core/skills/qc/qa-reviewer/test-case/non-functional.md +73 -0
- package/core/skills/qc/qa-runner/e2e.md +49 -0
- package/core/skills/qc/qa-runner/exploratory/session.md +36 -0
- package/core/skills/qc/qa-runner/functional/api.md +35 -0
- package/core/skills/qc/qa-runner/functional/gui-feature.md +51 -0
- package/core/skills/qc/qa-runner/functional/gui-screen.md +55 -0
- package/core/skills/qc/qa-runner/integration.md +47 -0
- package/core/skills/qc/qa-runner/non-functional.md +49 -0
- package/core/skills/qc/qa-runner/report/report.md +37 -0
- package/core/skills/setup-ai-first/SKILL.md +216 -0
- package/core/skills/spec/SKILL.md +461 -0
- package/core/skills/test/SKILL.md +1297 -0
- package/core/steps/capture-lesson.md +79 -0
- package/core/steps/context-loader.md +307 -0
- package/core/steps/gate.md +87 -0
- package/core/steps/report-footer.md +100 -0
- package/core/steps/review-fanout.md +138 -0
- package/core/steps/spawn-agent.md +124 -0
- package/core/steps/trace-mirror.md +26 -0
- package/core/templates/architecture.template.md +113 -0
- package/core/templates/design-spec.template.md +217 -0
- package/core/templates/feature.template +259 -0
- package/core/templates/platform-guide.template.md +145 -0
- package/core/templates/prd.template.md +327 -0
- package/core/templates/product-definition.template.md +168 -0
- package/core/templates/project-context.yaml +161 -0
- package/docs/01-getting-started/README.md +19 -0
- package/docs/01-getting-started/core-concepts.md +102 -0
- package/docs/01-getting-started/installation.md +156 -0
- package/docs/01-getting-started/quickstart.md +85 -0
- package/docs/02-guides/README.md +26 -0
- package/docs/02-guides/developer/README.md +46 -0
- package/docs/02-guides/developer/bdd-and-trace.md +125 -0
- package/docs/02-guides/developer/commands.md +76 -0
- package/docs/02-guides/developer/pr-checklist.md +15 -0
- package/docs/02-guides/developer/scenarios.md +460 -0
- package/docs/02-guides/developer/workflow.md +121 -0
- package/docs/02-guides/product-owner/README.md +79 -0
- package/docs/02-guides/product-owner/commands.md +30 -0
- package/docs/02-guides/product-owner/handoff-checklist.md +42 -0
- package/docs/02-guides/product-owner/prd-writing-rules.md +45 -0
- package/docs/02-guides/product-owner/scenarios.md +436 -0
- package/docs/02-guides/tester/README.md +75 -0
- package/docs/02-guides/tester/bug-reporting.md +117 -0
- package/docs/02-guides/tester/qc-automation.md +165 -0
- package/docs/02-guides/tester/reading-specs.md +79 -0
- package/docs/02-guides/tester/scenarios.md +186 -0
- package/docs/02-guides/tester/spec-manifest.md +130 -0
- package/docs/02-guides/tester/test-checklist.md +31 -0
- package/docs/02-guides/tester/workflow.md +77 -0
- package/docs/03-concepts/README.md +19 -0
- package/docs/03-concepts/architecture.md +248 -0
- package/docs/03-concepts/pipeline.md +274 -0
- package/docs/03-concepts/traceability.md +149 -0
- package/docs/04-operations/README.md +33 -0
- package/docs/04-operations/bug-flow.md +362 -0
- package/docs/04-operations/publishing.md +137 -0
- package/docs/04-operations/sync-and-update.md +522 -0
- package/docs/05-reference/README.md +32 -0
- package/docs/05-reference/command-cheatsheet.md +147 -0
- package/docs/05-reference/commands.md +232 -0
- package/docs/05-reference/modules.md +110 -0
- package/docs/05-reference/trace-schema.md +153 -0
- package/docs/README.md +49 -0
- package/hooks/data-guard.js +141 -0
- package/hooks/settings.json +18 -0
- package/modules/android-compose/module.yaml +13 -0
- package/modules/android-compose/stack-profile.yaml +57 -0
- package/modules/angular/architecture-snippets/component-patterns.md +187 -0
- package/modules/angular/module.yaml +6 -0
- package/modules/angular/stack-profile.yaml +38 -0
- package/modules/context-engineering/architecture-snippets/context-design.md +119 -0
- package/modules/context-engineering/module.yaml +9 -0
- package/modules/context-engineering/stack-profile.yaml +61 -0
- package/modules/dotnet/architecture-snippets/clean-arch.md +160 -0
- package/modules/dotnet/module.yaml +6 -0
- package/modules/dotnet/stack-profile.yaml +50 -0
- package/modules/flutter/module.yaml +14 -0
- package/modules/flutter/stack-profile.yaml +59 -0
- package/modules/golang/architecture-snippets/domain-layout.md +283 -0
- package/modules/golang/module.yaml +6 -0
- package/modules/golang/stack-profile.yaml +40 -0
- package/modules/ios-swiftui/module.yaml +13 -0
- package/modules/ios-swiftui/stack-profile.yaml +55 -0
- package/modules/java-spring/architecture-snippets/layered-arch.md +201 -0
- package/modules/java-spring/module.yaml +15 -0
- package/modules/java-spring/stack-profile.yaml +28 -0
- package/modules/nextjs/architecture-snippets/app-router-patterns.md +269 -0
- package/modules/nextjs/module.yaml +14 -0
- package/modules/nextjs/stack-profile.yaml +74 -0
- package/modules/nuxt/module.yaml +14 -0
- package/modules/nuxt/stack-profile.yaml +58 -0
- package/modules/php-laravel/architecture-snippets/service-repository.md +302 -0
- package/modules/php-laravel/module.yaml +15 -0
- package/modules/php-laravel/stack-profile.yaml +56 -0
- package/modules/qc-playwright/stack-profile.yaml +66 -0
- package/modules/react/architecture-snippets/hooks-query-patterns.md +254 -0
- package/modules/react/module.yaml +14 -0
- package/modules/react/stack-profile.yaml +63 -0
- package/modules/react-native/module.yaml +14 -0
- package/modules/react-native/stack-profile.yaml +56 -0
- package/modules/vue/module.yaml +14 -0
- package/modules/vue/stack-profile.yaml +65 -0
- package/package.json +49 -0
- package/rules/data-protection.md +80 -0
- package/rules/workflow.md +44 -0
- package/scripts/init.sh +49 -0
- package/scripts/migrate-specs.js +256 -0
- package/scripts/upgrade.sh +94 -0
- package/skills/code/SKILL.md +770 -0
- package/skills/code/SKILL.tmpl +176 -0
- package/skills/debug/SKILL.md +869 -0
- package/skills/debug/SKILL.tmpl +262 -0
- package/skills/design-spec/SKILL.md +589 -0
- package/skills/design-spec/SKILL.tmpl +95 -0
- package/skills/discovery/SKILL.md +554 -0
- package/skills/discovery/SKILL.tmpl +147 -0
- package/skills/prd/SKILL.md +562 -0
- package/skills/prd/SKILL.tmpl +188 -0
- package/skills/qc/qa-analyst/DOC_GAPS.template.md +63 -0
- package/skills/qc/qa-analyst/acceptance-criteria.md +60 -0
- package/skills/qc/qa-analyst/business-rules.md +59 -0
- package/skills/qc/qa-analyst/data-flow.md +64 -0
- package/skills/qc/qa-analyst/spec-breakdown.md +61 -0
- package/skills/qc/qa-designer/e2e/journey.md +41 -0
- package/skills/qc/qa-designer/exploratory/charter.md +68 -0
- package/skills/qc/qa-designer/exploratory/explore-to-functional.md +43 -0
- package/skills/qc/qa-designer/functional/api.md +45 -0
- package/skills/qc/qa-designer/functional/gui-feature.md +46 -0
- package/skills/qc/qa-designer/functional/gui-screen.md +52 -0
- package/skills/qc/qa-designer/integration/api.md +42 -0
- package/skills/qc/qa-designer/integration/db.md +39 -0
- package/skills/qc/qa-designer/integration/gui.md +40 -0
- package/skills/qc/qa-designer/integration/kafka.md +40 -0
- package/skills/qc/qa-designer/non-functional.md +40 -0
- package/skills/qc/qa-planner/test-plan.md +120 -0
- package/skills/qc/qa-reviewer/script/e2e.md +87 -0
- package/skills/qc/qa-reviewer/script/exploratory.md +45 -0
- package/skills/qc/qa-reviewer/script/functional.md +101 -0
- package/skills/qc/qa-reviewer/script/integration.md +91 -0
- package/skills/qc/qa-reviewer/script/non-functional.md +126 -0
- package/skills/qc/qa-reviewer/test-case/e2e.md +73 -0
- package/skills/qc/qa-reviewer/test-case/exploratory.md +43 -0
- package/skills/qc/qa-reviewer/test-case/functional.md +76 -0
- package/skills/qc/qa-reviewer/test-case/integration.md +69 -0
- package/skills/qc/qa-reviewer/test-case/non-functional.md +73 -0
- package/skills/qc/qa-runner/e2e.md +49 -0
- package/skills/qc/qa-runner/exploratory/session.md +36 -0
- package/skills/qc/qa-runner/functional/api.md +35 -0
- package/skills/qc/qa-runner/functional/gui-feature.md +51 -0
- package/skills/qc/qa-runner/functional/gui-screen.md +55 -0
- package/skills/qc/qa-runner/integration.md +47 -0
- package/skills/qc/qa-runner/non-functional.md +49 -0
- package/skills/qc/qa-runner/report/report.md +37 -0
- package/skills/setup-ai-first/SKILL.md +216 -0
- package/skills/setup-ai-first/SKILL.tmpl +116 -0
- package/skills/spec/SKILL.md +461 -0
- package/skills/spec/SKILL.tmpl +174 -0
- package/skills/test/SKILL.md +1297 -0
- package/skills/test/SKILL.tmpl +296 -0
- package/steps/capture-lesson.md +79 -0
- package/steps/context-loader.md +307 -0
- package/steps/gate.md +87 -0
- package/steps/report-footer.md +100 -0
- package/steps/review-fanout.md +138 -0
- package/steps/spawn-agent.md +124 -0
- package/steps/trace-mirror.md +26 -0
- package/templates/architecture.template.md +113 -0
- package/templates/design-spec.template.md +217 -0
- package/templates/feature.template +259 -0
- package/templates/platform-guide.template.md +145 -0
- package/templates/prd.template.md +327 -0
- package/templates/product-definition.template.md +168 -0
- package/templates/project-context.yaml +161 -0
|
@@ -0,0 +1,869 @@
|
|
|
1
|
+
# /generate-code — Generate Implementation Code
|
|
2
|
+
|
|
3
|
+
## Gate
|
|
4
|
+
# Gate — Universal Entry Procedure
|
|
5
|
+
|
|
6
|
+
Every command must execute this gate before proceeding with its specific logic.
|
|
7
|
+
|
|
8
|
+
## Step 0 — Sub-Agent Mode Check
|
|
9
|
+
|
|
10
|
+
Before anything else, check if `$ARGUMENTS` is a JSON payload from an orchestrator:
|
|
11
|
+
|
|
12
|
+
1. Attempt to parse `$ARGUMENTS` as JSON.
|
|
13
|
+
2. If it parses successfully **and** contains `"_agent_mode": true`:
|
|
14
|
+
- **Skip Steps 1, 2, and 3 of this Gate entirely.**
|
|
15
|
+
- Set target file = `payload.target_file`
|
|
16
|
+
- Set loaded context = `payload.context` (do NOT run context-loader.md)
|
|
17
|
+
- Set UC scope = `payload.uc_id` (process only this UC)
|
|
18
|
+
- Set line range = `payload.uc_section` (read only that PRD section)
|
|
19
|
+
- Proceed directly to the command-specific logic.
|
|
20
|
+
3. If `$ARGUMENTS` is not JSON or `_agent_mode` is absent → continue to Step 1 (normal mode).
|
|
21
|
+
|
|
22
|
+
## Step 0-B — Model Check
|
|
23
|
+
|
|
24
|
+
*Skip this step if `_agent_mode: true` (sub-agent — orchestrator already validated).*
|
|
25
|
+
|
|
26
|
+
Complex generation and review commands require strong reasoning.
|
|
27
|
+
Using a smaller model risks missed edge cases, incomplete spec analysis, and architecture violations.
|
|
28
|
+
|
|
29
|
+
Display and wait for response:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
⚙️ MODEL CHECK
|
|
33
|
+
──────────────────────────────────────────────────────────────────
|
|
34
|
+
Recommended : claude-opus-4 (or latest Opus model)
|
|
35
|
+
Why needed : Spec analysis, architecture review, code generation
|
|
36
|
+
require deep reasoning. Smaller models miss edge cases.
|
|
37
|
+
|
|
38
|
+
To switch in Claude Code:
|
|
39
|
+
• Settings → Model → select "claude-opus"
|
|
40
|
+
• or: /model → choose claude-opus
|
|
41
|
+
|
|
42
|
+
Running on claude-opus?
|
|
43
|
+
Y — yes, on claude-opus → proceed
|
|
44
|
+
S — skip check (I accept lower quality risk with current model)
|
|
45
|
+
──────────────────────────────────────────────────────────────────
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
- "Y" → proceed to Step 1.
|
|
49
|
+
- "S" → proceed to Step 1 (user accepts risk, add ⚠️ to final report).
|
|
50
|
+
- "N" or anything else → **STOP.** Output: "Please switch to claude-opus, then re-run this command."
|
|
51
|
+
|
|
52
|
+
## Step 1 — Resolve Target File
|
|
53
|
+
|
|
54
|
+
1. If `$ARGUMENTS` is provided and points to an existing file → use it directly as the target.
|
|
55
|
+
2. If `$ARGUMENTS` is a **bare UC-ID / ticket ID / partial name** (no path) → resolve it to a file by globbing the feature-package layout. The `{prd-slug}` is **not known yet**, so use a `*` wildcard for that segment, and a recursive `**` under `bdd/` so the platform subfolders (`bdd/web/`, `bdd/app/`, `bdd/system/`) are all covered:
|
|
56
|
+
- **BDD commands** (target is a `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — or `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` if the domain is also unknown. If a platform/scope is implied by the command (e.g. a system tech-doc needs the `system/` BDD), prefer the match under that platform subfolder.
|
|
57
|
+
- **PRD commands** (target is `prd.md`): `{specs_dir}/{domain}/*/prd.md` (match the feature folder whose id corresponds), else `{specs_dir}/*/*/prd.md`.
|
|
58
|
+
- **tech-docs commands**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
59
|
+
- **design-spec commands**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
60
|
+
|
|
61
|
+
Once a file matches: set it as the target **and** record `domain` + `prd_slug` from its path (per the extraction rule in `context-loader.md` Step 1 — `prd_slug` = first segment after `{specs_dir}/{domain}/`). Every path the command later reads or writes (sibling BDD/tech-docs/design-spec/trace) uses **that resolved `prd_slug`**, so all artifacts stay in one feature package. If several files match (e.g. multiple platforms), pick per the command's platform/scope or list them and ask.
|
|
62
|
+
3. If `$ARGUMENTS` is empty or no match found:
|
|
63
|
+
- List files in the relevant directory for this command (e.g., `specs/*/*/prd.md` for PRD commands, `specs/*/*/bdd/**/*.feature` for BDD commands).
|
|
64
|
+
- Present the list to the user and ask: "Which file do you want to work with? (Enter number or filename)"
|
|
65
|
+
- Wait for user selection before continuing.
|
|
66
|
+
|
|
67
|
+
## Step 2 — Execute Context Loader
|
|
68
|
+
|
|
69
|
+
Load all project context by following the procedure in `steps/context-loader.md`.
|
|
70
|
+
Store all loaded context in memory for use throughout this command session.
|
|
71
|
+
|
|
72
|
+
## Step 3 — CHECKPOINT
|
|
73
|
+
|
|
74
|
+
After completing Steps 1 and 2, display a summary and wait for confirmation:
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
CHECKPOINT
|
|
78
|
+
-----------
|
|
79
|
+
Target : {resolved file path}
|
|
80
|
+
Project : {project.name from project-context.yaml}
|
|
81
|
+
Tech stack : {language} / {framework}
|
|
82
|
+
Module : {module if set, else "not configured"}
|
|
83
|
+
Domains : {comma-separated domain list}
|
|
84
|
+
|
|
85
|
+
Proceed? (Y/N)
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Wait for explicit "Y" or "N" from the user before continuing.
|
|
89
|
+
- "Y" → proceed to the command-specific steps below.
|
|
90
|
+
- "N" → stop and ask what the user wants to change.
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
*Note: For this command, the target in Step 1 is a `.feature` file or UC-ID. If `$ARGUMENTS` is a UC-ID, find the matching feature file by globbing `{paths.specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` (wildcard `*` for the unknown prd-slug, recursive `**` to cover the `web/`·`app/`·`system/` platform subfolders); take `domain` + `prd_slug` from the matched path. Also check `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` for drift (new vs drifted vs synced).*
|
|
94
|
+
|
|
95
|
+
## Context
|
|
96
|
+
# Context Loader — Load All Project Context
|
|
97
|
+
|
|
98
|
+
Execute these steps in order. Store everything in memory for the duration of the command session.
|
|
99
|
+
|
|
100
|
+
**Priority guide (anti-lost-in-middle):**
|
|
101
|
+
- Steps 1–2 are PROJECT-CONFIG — loaded first, resolve all paths and metadata.
|
|
102
|
+
- Step 3 is CRITICAL — architecture + coding standards, the highest-priority facts for generation.
|
|
103
|
+
- Step 4 is SAFETY — data protection rules, enforced silently for the entire session.
|
|
104
|
+
- Steps 5–6 are DOMAIN KNOWLEDGE — terminology and entity definitions.
|
|
105
|
+
- Step 7 is the WORKING MEMORY RECAP — locks critical facts into the top of working memory.
|
|
106
|
+
|
|
107
|
+
---
|
|
108
|
+
|
|
109
|
+
## Step 1 — [PROJECT-CONFIG] Load project-context.yaml
|
|
110
|
+
|
|
111
|
+
Read `.agent/project-context.yaml`. Extract and store:
|
|
112
|
+
|
|
113
|
+
**Tech Stack:**
|
|
114
|
+
- `tech_stack.language` → active language (e.g., Java 17, TypeScript, C#, Go)
|
|
115
|
+
- `tech_stack.framework` → active framework (e.g., Spring Boot 3.2, Angular 17, .NET 8)
|
|
116
|
+
- `tech_stack.build_tool` → build tool (e.g., Maven, npm, dotnet, go)
|
|
117
|
+
- `tech_stack.test_framework` → test framework (e.g., JUnit 5 + Mockito, Jest, xUnit)
|
|
118
|
+
- `tech_stack.database` → database (e.g., PostgreSQL, MySQL, MongoDB)
|
|
119
|
+
- `tech_stack.module` → active module profile (e.g., java-spring, angular, dotnet, golang, context-engineering)
|
|
120
|
+
|
|
121
|
+
**Conventions:**
|
|
122
|
+
- `conventions.build_command` → how to compile/build
|
|
123
|
+
- `conventions.test_command` → how to run tests
|
|
124
|
+
- `conventions.service_run` → how to start the service
|
|
125
|
+
- `conventions.ticket_prefix` → ticket ID prefix (e.g., PROJ, FEAT, UC)
|
|
126
|
+
|
|
127
|
+
**Domains:**
|
|
128
|
+
- `domains` → list of active business domains
|
|
129
|
+
|
|
130
|
+
**Paths (if present):**
|
|
131
|
+
- `paths.specs_dir` → spec artifacts root — PRD, BDD, tech-docs, design-spec. Structure: `{specs_dir}/{domain}/{prd-slug}/{prd.md | bdd/ | tech-docs/ | design-spec/}`
|
|
132
|
+
- `paths.refinement_dir` → findings/review output dir
|
|
133
|
+
- `paths.qc_dir` → QC automation artifacts root (visible top-level, one subfolder per UC: `{qc_dir}/{UC-ID}/`)
|
|
134
|
+
- `paths.qc_skills_dir` → where qc-* commands load QC skills from (default bundled `.agent/skills/qc`; override to the QC team's own repo/submodule so framework upgrade won't overwrite them)
|
|
135
|
+
- `paths.product_definitions_dir` → product definitions root
|
|
136
|
+
- `paths.domain_knowledge_dir` → domain knowledge root
|
|
137
|
+
- `paths.business_dictionary` → path to business-dictionary.md
|
|
138
|
+
- `paths.core_entities` → path to core-entities.md
|
|
139
|
+
- `paths.tech_docs_dir` → technical documentation root (merged with specs_dir in feature-package layout — tech-docs live under `{specs_dir}/{domain}/{prd-slug}/tech-docs/`)
|
|
140
|
+
- `paths.trace_dir` → trace state directory; structure: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
141
|
+
|
|
142
|
+
If `paths` section is absent, use these defaults:
|
|
143
|
+
- `specs_dir` = `specs`
|
|
144
|
+
- `refinement_dir` = `.agent/review`
|
|
145
|
+
- `qc_dir` = `docs`
|
|
146
|
+
- `qc_skills_dir` = `.agent/skills/qc`
|
|
147
|
+
- `product_definitions_dir` = `specs/product-definition`
|
|
148
|
+
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
149
|
+
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
150
|
+
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
151
|
+
- `tech_docs_dir` = `specs`
|
|
152
|
+
- `trace_dir` = `.trace`
|
|
153
|
+
|
|
154
|
+
Note: In the feature-package layout, `specs_dir` is the unified root. All spec artifact types (PRD, BDD, tech-docs, design-spec) live under `{specs_dir}/{domain}/{prd-slug}/`. The `prd-slug` is the feature-package folder name, not a separate config variable.
|
|
155
|
+
|
|
156
|
+
**How to extract `prd_slug` (works for ANY target file, regardless of nesting depth):** given a target path of the form `{specs_dir}/{domain}/{prd-slug}/...`, take the **first path segment after `{specs_dir}/{domain}/`** — i.e. the `{prd-slug}` position. Do NOT use the file's immediate parent folder, because BDD/tech-docs/design-spec artifacts are nested one or two levels deeper inside the package. Examples:
|
|
157
|
+
- `specs/payment/create-invoice/prd.md` → `prd_slug = create-invoice`
|
|
158
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(NOT `system`)*
|
|
159
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(NOT `web`)*
|
|
160
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(NOT `tech-docs`)*
|
|
161
|
+
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
162
|
+
|
|
163
|
+
All sibling artifacts of one feature (PRD, every platform's BDD, the BE + FE tech-docs, the design-spec, and the trace TSV) therefore resolve to the **same `prd_slug`** — so a synthesized **system** BDD or **system/BE** tech-doc lands in the same `{specs_dir}/{domain}/{prd-slug}/` package as the web/app artifacts it was derived from.
|
|
164
|
+
|
|
165
|
+
If `tech_stack.module` is set, also load `.agent/modules/{module}/stack-profile.yaml` if it exists.
|
|
166
|
+
|
|
167
|
+
---
|
|
168
|
+
|
|
169
|
+
## Step 1.5 — [SERVICE ROUTING] Resolve service paths (umbrella mode)
|
|
170
|
+
|
|
171
|
+
*Skip this step entirely if `setup.mode` is not `"umbrella"` and `services` section is absent from project-context.yaml.*
|
|
172
|
+
|
|
173
|
+
If `services` section is present:
|
|
174
|
+
|
|
175
|
+
**1. Detect active domain** (in priority order):
|
|
176
|
+
- Read `@trace.domain` from target file frontmatter (if Gate loaded a target file)
|
|
177
|
+
- Extract from target file path: `domain` = the first segment after the `specs_dir` base path; `prd_slug` = the next segment (the feature-package folder). This holds for any target depth — see the `prd_slug` extraction rule in Step 1.
|
|
178
|
+
*(e.g., `specs/user/create-account/prd.md` **and** `specs/user/create-account/bdd/system/UC1.feature` both → domain = `user`, prd_slug = `create-account`)*
|
|
179
|
+
- If `$ARGUMENTS` contains a path, extract the domain segment after `specs_dir`
|
|
180
|
+
|
|
181
|
+
**2. Route to service** — if active domain matches a key in `services`:
|
|
182
|
+
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **only if `setup.spec_source` is NOT set.** When `spec_source` IS set, ALL BDD (web/app/**system**) is a shared cross-team artifact → leave `specs_dir` for step 4 to route to the spec repo; do NOT pin it per-service here.
|
|
183
|
+
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **only if `setup.spec_source` is NOT set.** When `spec_source` IS set, the tech-design (API contract) is a cross-team artifact and must live in the shared spec repo (handled in step 4), so leave `tech_docs_dir` for step 4 to route — do NOT pin it per-service here.
|
|
184
|
+
- Store `active_service` = `services.{domain}.path`
|
|
185
|
+
- Store `active_service_module` = `services.{domain}.module`
|
|
186
|
+
- If service has its own `module` → use it as `active_module` (overrides `tech_stack.module`)
|
|
187
|
+
|
|
188
|
+
**3. Fallback** — if domain not detected or no matching service key:
|
|
189
|
+
- Keep default paths from Step 1
|
|
190
|
+
- Set `active_service = unresolved`
|
|
191
|
+
|
|
192
|
+
**4. Spec source auto-override** — if `setup.spec_source` is set AND the corresponding path was not already explicitly set in `paths:`:
|
|
193
|
+
- Override `paths.specs_dir` → `{spec_source}/specs` — **always when `spec_source` is set.** All spec artifacts (PRD, BDD, tech-docs, design-spec) live under the unified spec root in the shared spec repo using the feature-package layout: `{spec_source}/specs/{domain}/{prd-slug}/`. Every umbrella (FE/App/BE) reads from here. *(Per-service `specs/` only when there is no `spec_source`.)*
|
|
194
|
+
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **always when `spec_source` is set** (step 2 no longer pins tech-docs per-service in this case). Tech-docs live at `{spec_source}/specs/{domain}/{prd-slug}/tech-docs/`. The tech-design IS the cross-team API contract: BE authors it here, and FE/App read it from the same spec submodule at `/generate-code --phase=integration`. *(Per-service tech-docs only happen when there is no `spec_source` — a pure multi-service BE repo with no shared spec module.)*
|
|
195
|
+
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
196
|
+
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
197
|
+
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
198
|
+
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
199
|
+
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
200
|
+
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
201
|
+
- Override `paths.trace_dir` → `{spec_source}/.trace` — **always when `spec_source` is set.** Trace TSVs are consolidated in the spec repo (single authoritative location, no per-service split) so the PM/PO has one place to manage status. Internal structure: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`. Code-side commands (`/generate-code`, `/dev-run-test`, `/qc-run-test`) run from `service_root` but **write their trace row into `{spec_source}/.trace/{domain}/{prd-slug}/`** — like they already push `feedback/` there. *(Per-service `.trace` only when there is no `spec_source`.)*
|
|
202
|
+
|
|
203
|
+
> **Why under `spec_source`:** PRD, BDD, tech-docs, design-spec, domain knowledge, tester feedback, **and the `.trace/` coverage state** are all **cross-team artifacts** — they live in the **shared spec repo** using the feature-package layout so every umbrella (FE/App/BE) and the PM read one source via `/sync`. In the feature-package layout, a single `specs/{domain}/{prd-slug}/` folder groups all artifact types for one PRD, making the spec repo self-contained and navigable by feature. The service submodule holds only **code** (+ build/test tooling). `.trace/` and `feedback/` are the dev/QC **write areas** in the spec repo. In single-service mode (no `spec_source`), everything defaults under the repo root — still one repo.
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## Step 1.6 — [SERVICE CONVENTIONS] Load service-specific conventions (umbrella mode)
|
|
208
|
+
|
|
209
|
+
*Skip this step entirely if `active_service` is `"unresolved"` or context is single-service mode.*
|
|
210
|
+
|
|
211
|
+
When `active_service` has been resolved to a real path in Step 1.5 (e.g., `user-service/`):
|
|
212
|
+
|
|
213
|
+
**1. Locate service config** — try in priority order:
|
|
214
|
+
- `{active_service}/.agent/project-context.yaml`
|
|
215
|
+
- `{active_service}/project-context.yaml`
|
|
216
|
+
|
|
217
|
+
**2. If found, override with service-specific values:**
|
|
218
|
+
|
|
219
|
+
| Variable | Source |
|
|
220
|
+
|----------|--------|
|
|
221
|
+
| `conventions.test_command` | service's `conventions.test_command` |
|
|
222
|
+
| `conventions.build_command` | service's `conventions.build_command` |
|
|
223
|
+
| `paths.trace_dir` | **If `spec_source` is set → keep the Step 4 spec-repo route (`{spec_source}/.trace`); ignore any service-level `trace_dir`.** Only when there is no `spec_source`: `{active_service}/{service paths.trace_dir}` (default `{active_service}/.trace`). |
|
|
224
|
+
| `paths.specs_dir` | **If `spec_source` is set → keep the Step 4 spec-repo route (`{spec_source}/specs`); ignore any service-level `specs_dir`** (all spec artifacts are cross-team, never per-service in this mode). Only when there is no `spec_source`: `{active_service}/{service paths.specs_dir}` if set, else the Step 1.5 override. |
|
|
225
|
+
|
|
226
|
+
**3. Store** `service_root = {active_service}` as the working directory anchor for all downstream commands:
|
|
227
|
+
- Shell commands (`/dev-run-test`, `/dev-gen-test`) run **from within** `service_root`
|
|
228
|
+
- **Source/test files** are written relative to `service_root`; **trace TSVs** are written to `{paths.trace_dir}` (the spec repo when `spec_source` is set — a cross-repo write, committed/pushed to the spec submodule like `feedback/`).
|
|
229
|
+
|
|
230
|
+
**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).
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Step 2 — [PROJECT-CONFIG] Load module stack profile (conditional)
|
|
235
|
+
|
|
236
|
+
If `tech_stack.module` is set, read `.agent/modules/{module}/stack-profile.yaml`.
|
|
237
|
+
Merge framework-specific conventions (layer patterns, test patterns, naming rules) into the loaded context.
|
|
238
|
+
If the file does not exist → skip silently.
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## Step 3 — [CRITICAL] Load CLAUDE.md (layered: root + service overlay)
|
|
243
|
+
|
|
244
|
+
*This is the highest-priority context — it defines HOW to write code and documents for this project.*
|
|
245
|
+
|
|
246
|
+
CLAUDE.md is loaded in **two layers** so umbrella-wide rules and service-specific
|
|
247
|
+
architecture/coding standards compose correctly. The agent always sits at the umbrella
|
|
248
|
+
root, but the implementation code lives in a service submodule with its OWN stack,
|
|
249
|
+
architecture, and conventions — so the service's CLAUDE.md must win for code generation.
|
|
250
|
+
|
|
251
|
+
**Layer 1 — [BASE] Root CLAUDE.md (umbrella-wide).**
|
|
252
|
+
Read `CLAUDE.md` at the repo root. Treat its contents as the **shared baseline** for the
|
|
253
|
+
whole umbrella — git conventions, data-protection posture, cross-cutting rules, and (in
|
|
254
|
+
single-service mode) the project's only architecture + coding standards.
|
|
255
|
+
|
|
256
|
+
**Layer 2 — [OVERLAY] Service CLAUDE.md (umbrella mode only).**
|
|
257
|
+
*Run only if `service_root` was set in Step 1.6 (i.e. a real service was routed to).*
|
|
258
|
+
Read `{service_root}/CLAUDE.md`. This file defines the architecture + coding standards of
|
|
259
|
+
the **actual stack being implemented** (e.g. `user-service` = java-spring, `web` = nextjs).
|
|
260
|
+
Overlay it on top of Layer 1: **on any conflict, the service value WINS** for architecture,
|
|
261
|
+
coding standards, and error handling. Layer-1 values that the service does not redefine
|
|
262
|
+
(e.g. git conventions, banned patterns shared org-wide) remain in effect.
|
|
263
|
+
|
|
264
|
+
From the **merged** result, extract and store:
|
|
265
|
+
|
|
266
|
+
- **§1 Project Overview** → project name, language, framework, build/test commands, domains
|
|
267
|
+
- **§2 Architecture** → layer order (e.g., Controller → Facade → Service → Repository), architectural rules — *service overlay wins*
|
|
268
|
+
- **§3 Coding Standards** → naming conventions (classes, methods), response wrapper type, forbidden patterns — *service overlay wins*
|
|
269
|
+
- **§5 Error Handling** → exception types, HTTP status code mapping, not-found exception class name — *service overlay wins*
|
|
270
|
+
- **§7 Git Conventions** → branch naming pattern, commit message format — *root baseline unless service redefines*
|
|
271
|
+
|
|
272
|
+
**Resolution rules:**
|
|
273
|
+
- If both layers exist → merge as above; record `claude_md_source = root + {service_root}`.
|
|
274
|
+
- If only the service overlay exists (no root CLAUDE.md) → use the service file alone; `claude_md_source = {service_root}`.
|
|
275
|
+
- If `service_root` is set but `{service_root}/CLAUDE.md` is **missing** → fall back to root CLAUDE.md and flag ⚠️ in the Step 7 recap (the service has no architecture/coding-standards definition — code generation will use umbrella defaults, which may be the wrong stack).
|
|
276
|
+
- If neither exists → note CLAUDE.md as missing and continue with project-context.yaml data only.
|
|
277
|
+
|
|
278
|
+
---
|
|
279
|
+
|
|
280
|
+
## Step 4 — [SAFETY] Load Data Protection Rules
|
|
281
|
+
|
|
282
|
+
Read `.agent/rules/data-protection.md` (or `rules/data-protection.md` from the framework installation).
|
|
283
|
+
|
|
284
|
+
Store the sensitive file patterns — you must **never** read, write, display, or reference content from files matching those patterns for the entire session.
|
|
285
|
+
|
|
286
|
+
If neither file exists → apply built-in defaults: never access `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
|
|
287
|
+
|
|
288
|
+
---
|
|
289
|
+
|
|
290
|
+
## Step 5 — [DOMAIN] Load Business Dictionary (conditional)
|
|
291
|
+
|
|
292
|
+
Check if the business dictionary file exists (use `paths.business_dictionary` resolved in Step 1).
|
|
293
|
+
|
|
294
|
+
If it exists, read it and extract:
|
|
295
|
+
- **Canonical Terms** → complete list of approved terms and their definitions
|
|
296
|
+
- **Banned Terms** → complete list of banned terms and their canonical replacements
|
|
297
|
+
- **Status / Enum Registry** → allowed enum values per entity
|
|
298
|
+
|
|
299
|
+
Store the banned terms list for **active enforcement** throughout the command session:
|
|
300
|
+
- When generating any text (PRD, BDD, code comments, tech docs), verify no banned terms appear
|
|
301
|
+
- Replace banned terms with their canonical equivalents automatically
|
|
302
|
+
|
|
303
|
+
If the file does not exist → skip silently. Do not warn or block.
|
|
304
|
+
|
|
305
|
+
---
|
|
306
|
+
|
|
307
|
+
## Step 6 — [DOMAIN] Load Core Entities (conditional)
|
|
308
|
+
|
|
309
|
+
Check if the core entities file exists at `paths.core_entities` (resolved in Step 1).
|
|
310
|
+
Default path: `specs/domain-knowledge/core-entities.md`.
|
|
311
|
+
|
|
312
|
+
If it exists, read it and store:
|
|
313
|
+
- **Entity catalog** → for each entity: its name, purpose, owner service, key fields (name + type), business invariants, and relationships
|
|
314
|
+
- **Field name registry** → canonical field names to use in generated code and documents
|
|
315
|
+
- **Relationship map** → how entities relate to each other (1:N, N:N, embedded, etc.)
|
|
316
|
+
|
|
317
|
+
**How to use this catalog:**
|
|
318
|
+
- When generating code: use the field names, types, and relationships defined here — do NOT infer from existing code
|
|
319
|
+
- When generating PRD/BDD: reference entity names from this catalog for consistency
|
|
320
|
+
- When generating tech-docs: use this catalog as the source-of-truth for entity definitions
|
|
321
|
+
|
|
322
|
+
If the file does not exist → skip silently.
|
|
323
|
+
|
|
324
|
+
---
|
|
325
|
+
|
|
326
|
+
## Step 6.5 — [PLATFORM] Derive active_module and platform_type
|
|
327
|
+
|
|
328
|
+
Using `tech_stack.module` loaded in Step 1, derive and store two variables for use by all downstream commands:
|
|
329
|
+
|
|
330
|
+
```
|
|
331
|
+
active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
| `platform_type` | Modules |
|
|
335
|
+
|---|---|
|
|
336
|
+
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
337
|
+
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
338
|
+
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
339
|
+
|
|
340
|
+
If `tech_stack.module` is blank or not recognized → set `platform_type = "unknown"` and flag as ⚠️ in the Step 7 recap.
|
|
341
|
+
|
|
342
|
+
These two variables (`active_module`, `platform_type`) are the canonical source for all branching logic in commands that need platform-specific behavior (dev-gen-test, debug, fix-bug, dev-smoke-test).
|
|
343
|
+
|
|
344
|
+
---
|
|
345
|
+
|
|
346
|
+
## Step 6.7 — [GUARDRAILS] Load Project Lessons (conditional)
|
|
347
|
+
|
|
348
|
+
*Accumulated mistakes the AI must not repeat in this project. These are added over time via `/learn`
|
|
349
|
+
or accepted during `/review-code`, `/fix-bug`, `/debug`.*
|
|
350
|
+
|
|
351
|
+
Resolve the lessons file path:
|
|
352
|
+
- Use `paths.lessons_file` if set (may be service-overridden in umbrella mode, Step 1.6)
|
|
353
|
+
- Else default `specs/domain-knowledge/lessons-learned.md`
|
|
354
|
+
- In umbrella/service mode (when `service_root` is set), if `paths.lessons_file` is unset, default to `{service_root}/.agent/project-lessons.md`
|
|
355
|
+
|
|
356
|
+
If the file exists, read it and store ALL lessons as **ACTIVE GUARDRAILS** for the session:
|
|
357
|
+
- Treat each lesson's **Rule** as a hard constraint — same priority as CLAUDE.md coding standards (Step 3).
|
|
358
|
+
- 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).
|
|
359
|
+
- If a generated output would violate a lesson → correct it **before** presenting, and note which lesson (`L-NNN`) was applied.
|
|
360
|
+
|
|
361
|
+
If the file does not exist → skip silently (no lessons captured yet).
|
|
362
|
+
|
|
363
|
+
---
|
|
364
|
+
|
|
365
|
+
## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
|
|
366
|
+
|
|
367
|
+
After loading all context, synthesize and output a compact summary block.
|
|
368
|
+
This recap ensures the most critical facts are stated at the END of context loading
|
|
369
|
+
(recency effect — freshest in working memory when the task begins).
|
|
370
|
+
|
|
371
|
+
Output exactly this block:
|
|
372
|
+
```
|
|
373
|
+
[CTX LOADED]
|
|
374
|
+
Stack : {language} / {framework} / {database}
|
|
375
|
+
Platform : {active_module} ({platform_type})
|
|
376
|
+
Layers : {layer order from merged CLAUDE.md §2, e.g., Controller → Facade → Service → Repository}
|
|
377
|
+
CLAUDE.md : {root + {service_root} | {service_root} only | root only | ⚠️ service overlay MISSING — using root | missing}
|
|
378
|
+
Ticket : {ticket_prefix}-
|
|
379
|
+
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
380
|
+
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
381
|
+
Lessons : {loaded — N guardrails | none yet}
|
|
382
|
+
Service : {active_service} ({active_service_module}) | single-service
|
|
383
|
+
Svc Root : {service_root} — conventions + trace_dir loaded from service config | —
|
|
384
|
+
Status : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
If any CRITICAL file is missing (CLAUDE.md), flag it clearly so the user can decide whether to proceed.
|
|
388
|
+
|
|
389
|
+
---
|
|
390
|
+
|
|
391
|
+
## Context Load Complete
|
|
392
|
+
|
|
393
|
+
After completing all steps, you have loaded:
|
|
394
|
+
- Project identity, tech stack, module conventions
|
|
395
|
+
- Architecture rules and layer order ← **[CRITICAL — hold in working memory]**
|
|
396
|
+
- Coding standards and naming conventions ← **[CRITICAL — hold in working memory]**
|
|
397
|
+
- Data protection rules (sensitive file patterns to never access)
|
|
398
|
+
- Terminology rules with banned-term list ← **[DOMAIN — apply to every generated word]**
|
|
399
|
+
- Entity catalog (field names, types, invariants) ← **[DOMAIN — use for code generation]**
|
|
400
|
+
- All configured paths
|
|
401
|
+
|
|
402
|
+
Proceed to the next step of the calling command.
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
---
|
|
406
|
+
|
|
407
|
+
## Scope Lock
|
|
408
|
+
|
|
409
|
+
This command is strictly scoped to the **single feature file** passed as `$ARGUMENTS`:
|
|
410
|
+
|
|
411
|
+
- Feature file: `{exact path from $ARGUMENTS}`
|
|
412
|
+
- UC: `{UC-ID}` (read from `@trace.id` in that file's header)
|
|
413
|
+
|
|
414
|
+
**Do NOT read or implement scenarios from any other `.feature` file** in the same domain folder, even if they share the same entity, domain concept, or service name.
|
|
415
|
+
|
|
416
|
+
---
|
|
417
|
+
|
|
418
|
+
## Context Load (additional)
|
|
419
|
+
|
|
420
|
+
Read:
|
|
421
|
+
1. The scoped `.feature` file only
|
|
422
|
+
2. Tech-doc at `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` (if exists)
|
|
423
|
+
3. CLAUDE.md §architecture + §coding_standards
|
|
424
|
+
4. **(FE/App only)** Design Spec at `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-*{slug}.md` (if exists) — source of screens, component inventory, and the per-screen Figma frame links.
|
|
425
|
+
|
|
426
|
+
---
|
|
427
|
+
|
|
428
|
+
## Phase Detection
|
|
429
|
+
|
|
430
|
+
Parse `$ARGUMENTS` for a `--phase` flag:
|
|
431
|
+
|
|
432
|
+
| Flag | Meaning |
|
|
433
|
+
|---|---|
|
|
434
|
+
| `--phase=ui` | FE Phase 1 — generate UI + mock API layer from System BDD contract |
|
|
435
|
+
| `--phase=integration` | FE Phase 2 — replace mock adapter with real API calls from tech docs |
|
|
436
|
+
| *(none)* | Default — full implementation (BE or full-stack without mock split) |
|
|
437
|
+
|
|
438
|
+
**If `--phase` is set — confirm platform:**
|
|
439
|
+
Read `@trace.platform` from the feature file header.
|
|
440
|
+
- If `system` → warn: "`--phase` flag is not applicable for system BDD (BE-facing). Proceeding with default mode." Treat as no flag.
|
|
441
|
+
- If `web` or `app` → continue with phase logic below.
|
|
442
|
+
|
|
443
|
+
**If `--phase=ui`:**
|
|
444
|
+
Resolve the **mock shape source** (hybrid — prefer the real contract, fall back to System BDD):
|
|
445
|
+
- **BE contract** `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` — if it exists, the mock adapter's port/DTO **shape** (request/response fields, types, error codes) comes from here → `mock_source = contract`. Most accurate; no shape rework at integration.
|
|
446
|
+
- **System BDD** `{paths.specs_dir}/{domain}/{prd-slug}/bdd/system/{TICKET-ID}*.feature` — always load `Then` clauses for **behavior + fixture values**. If no BE contract, the shape is inferred from these too → `mock_source = system-bdd`, and WARN:
|
|
447
|
+
```
|
|
448
|
+
⚠ BE contract not found — mock shape inferred from System BDD only.
|
|
449
|
+
System BDD describes behavior, not full request/response shape — the mock
|
|
450
|
+
may differ from the real API; expect adjustment at --phase=integration.
|
|
451
|
+
(Recommended: have BE publish {prd-slug}/tech-docs/{UC-ID}-tech-design.md first for an accurate mock.)
|
|
452
|
+
```
|
|
453
|
+
- If System BDD is also missing → warn "System BDD not found — mock layer will use placeholder fixtures." Continue.
|
|
454
|
+
|
|
455
|
+
Store `mock_source` (`contract` | `system-bdd`) for the mock tags below.
|
|
456
|
+
|
|
457
|
+
**Then run the Figma Dev Mode MCP Check below** before generating any UI — the Design
|
|
458
|
+
Spec's frame links are the visual contract, and the local MCP reads them with far more
|
|
459
|
+
fidelity than a plain web link.
|
|
460
|
+
|
|
461
|
+
---
|
|
462
|
+
|
|
463
|
+
## Figma Dev Mode MCP Check *(FE/App UI generation only)*
|
|
464
|
+
|
|
465
|
+
*Run this only when `platform` is `web`/`app` AND generating UI (`--phase=ui`, or default
|
|
466
|
+
mode for an FE/App feature). Skip entirely for BE / `system` platform.*
|
|
467
|
+
|
|
468
|
+
The PO authored the Design Spec from **Figma web links** (read-only, limited). For
|
|
469
|
+
codegen, the **local Figma Dev Mode MCP server** (built into the Figma **desktop app**)
|
|
470
|
+
gives far more: exact layout, design **variables/tokens**, **Code Connect** component
|
|
471
|
+
mappings, selection context, and code snippets — things a web URL alone cannot return.
|
|
472
|
+
|
|
473
|
+
**Step 1 — Detect the local MCP.** Check whether a Figma Dev Mode MCP server is connected
|
|
474
|
+
(a `get_design_context` / `get_code` style Figma tool is available via MCP).
|
|
475
|
+
|
|
476
|
+
**Step 2 — If NOT connected → suggest the dev enable it, then wait:**
|
|
477
|
+
|
|
478
|
+
```
|
|
479
|
+
🎨 Figma Dev Mode MCP not detected.
|
|
480
|
+
For accurate FE code (real tokens, components, Code Connect), use the LOCAL server:
|
|
481
|
+
|
|
482
|
+
1. Open the Figma DESKTOP app (not the browser)
|
|
483
|
+
2. Open the file/frame for this feature
|
|
484
|
+
3. Enable the Dev Mode MCP server:
|
|
485
|
+
Figma menu → Preferences → "Enable Dev Mode MCP Server"
|
|
486
|
+
(requires Dev or Full seat; server runs at http://127.0.0.1:3845)
|
|
487
|
+
4. Make sure this MCP server is added in your Claude Code MCP config
|
|
488
|
+
5. Select the frame for the screen you're implementing, then continue
|
|
489
|
+
|
|
490
|
+
Type C to continue once enabled, or S to skip (fall back to web links + text spec).
|
|
491
|
+
```
|
|
492
|
+
|
|
493
|
+
- `C` → re-detect; if now connected → proceed using the local MCP.
|
|
494
|
+
- `S` → proceed in **fallback mode**: use the Design Spec's web frame links + textual spec
|
|
495
|
+
only; add a ⚠️ note in the final report that UI was generated without local Figma fidelity.
|
|
496
|
+
|
|
497
|
+
**Step 3 — When the local MCP IS connected:** for each screen being implemented, pull the
|
|
498
|
+
selected frame via the Figma MCP and ground the UI on the returned layout, variables, and
|
|
499
|
+
Code Connect mappings. Prefer Code-Connect-mapped components over inventing markup; use the
|
|
500
|
+
real token names, not hardcoded values.
|
|
501
|
+
|
|
502
|
+
**If `--phase=integration`:**
|
|
503
|
+
Resolve the design that drives the adapter (two layers):
|
|
504
|
+
- **FE tech-design** (preferred — the port→endpoint→DTO mapping): `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md` §4, produced by `/generate-tech-docs` (FE path).
|
|
505
|
+
- **BE API contract** (endpoint/shape source): `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md`.
|
|
506
|
+
|
|
507
|
+
Read `@trace.status` of whichever drives the adapter (the FE doc if present, else the BE contract).
|
|
508
|
+
If `draft` or `in-review` → warn:
|
|
509
|
+
```
|
|
510
|
+
⚠ Tech design for {UC-ID} ({platform}) is {status}.
|
|
511
|
+
Contract / adapter mapping may still change.
|
|
512
|
+
Proceeding — ensure BE endpoint is deployed or confirm the mapping manually.
|
|
513
|
+
```
|
|
514
|
+
If the FE tech-design is **missing** → warn: "No FE tech-design found — falling back to the BE contract directly (adapter mapping inferred). Recommended: run `/generate-tech-docs {web|app .feature}` first."
|
|
515
|
+
Locate existing mock adapter from `--phase=ui` run (search for `{UC-ID}MockApiAdapter` in `{paths.src_dir}/{domain}/`).
|
|
516
|
+
If not found → warn: "Mock adapter not found — generating real API adapter from scratch using tech-doc contract."
|
|
517
|
+
|
|
518
|
+
---
|
|
519
|
+
|
|
520
|
+
## Read Trace State
|
|
521
|
+
|
|
522
|
+
Read `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` if it exists. For each scenario row, note its current `status`:
|
|
523
|
+
|
|
524
|
+
| Status | Meaning | Action in this run |
|
|
525
|
+
|--------|---------|-------------------|
|
|
526
|
+
| `UNTRACKED` | `implemented_by == —` | Generate — scenario has no code yet |
|
|
527
|
+
| `DRIFT` | `spec_ver != gen_ver` | Regenerate — scenario updated since last codegen |
|
|
528
|
+
| `OK` | implemented + tested | Skip unless explicitly re-generating |
|
|
529
|
+
| `GAP` | implemented, no tests | Skip codegen — already coded; run `/dev-gen-test` instead |
|
|
530
|
+
|
|
531
|
+
Use these statuses to populate the **Scenarios** count in the CHECKPOINT plan (`{X} new, {Y} drifted, {Z} synced-skip`).
|
|
532
|
+
If `.tsv` does not exist → treat all scenarios as `UNTRACKED`.
|
|
533
|
+
|
|
534
|
+
---
|
|
535
|
+
|
|
536
|
+
## File Scan
|
|
537
|
+
|
|
538
|
+
Before generating, determine which files will be needed for this UC's scenarios. Check whether each file already exists on disk.
|
|
539
|
+
|
|
540
|
+
Classify each file:
|
|
541
|
+
|
|
542
|
+
| Status | Meaning | Action |
|
|
543
|
+
|--------|---------|--------|
|
|
544
|
+
| `CREATE` | File does not exist | Generate full new file |
|
|
545
|
+
| `EXTEND` | File exists, new methods needed | Add new methods only — do NOT rewrite existing code |
|
|
546
|
+
| `SKIP` | File exists and already covers all UC scenarios | Leave untouched |
|
|
547
|
+
|
|
548
|
+
> **EXTEND rule:** Read the existing file fully. Locate the correct class/interface. Add only the methods required by `{UC-ID}` scenarios. Preserve all existing methods, fields, and annotations exactly as-is. Attach `@trace.implements={UC-ID}-SC{N}` on each new method.
|
|
549
|
+
|
|
550
|
+
---
|
|
551
|
+
|
|
552
|
+
## CHECKPOINT — Code Generation Plan
|
|
553
|
+
|
|
554
|
+
Before generating any code, show:
|
|
555
|
+
|
|
556
|
+
```
|
|
557
|
+
Code Generation Plan — {UC-ID}
|
|
558
|
+
──────────────────────────────────────────────────────
|
|
559
|
+
Feature : {name}
|
|
560
|
+
Ticket : {TICKET_ID if known}
|
|
561
|
+
Domain : {domain}
|
|
562
|
+
UC : {UC-ID} only ← other feature files in this folder are NOT read
|
|
563
|
+
Tech : {language} / {framework}
|
|
564
|
+
Phase : {UI — mock layer | Integration — real API | Default — full} ← omit if no --phase flag
|
|
565
|
+
Scenarios: {N} total ({X} new, {Y} drifted, {Z} synced-skip)
|
|
566
|
+
Layer : {from CLAUDE.md §2}
|
|
567
|
+
|
|
568
|
+
Files:
|
|
569
|
+
CREATE {N} new files
|
|
570
|
+
+ {path/FileName.ext}
|
|
571
|
+
EXTEND {M} existing files (add methods only)
|
|
572
|
+
~ {path/FileName.ext} — adding: {methodA}, {methodB}
|
|
573
|
+
SKIP {K} files (no change needed)
|
|
574
|
+
= {path/FileName.ext}
|
|
575
|
+
──────────────────────────────────────────────────────
|
|
576
|
+
Proceed? (Y/N)
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
Wait for explicit "Y" before generating.
|
|
580
|
+
|
|
581
|
+
## Branch
|
|
582
|
+
```bash
|
|
583
|
+
git checkout -b feature/{TICKET_ID}-{slug}
|
|
584
|
+
```
|
|
585
|
+
|
|
586
|
+
## Generate (layer order from CLAUDE.md §2)
|
|
587
|
+
|
|
588
|
+
Default order (override from CLAUDE.md if different):
|
|
589
|
+
DTOs → Entity/Model → Repository → Service interface → Service impl → Facade (if applicable) → Controller
|
|
590
|
+
|
|
591
|
+
**For `CREATE` files:** generate the full file.
|
|
592
|
+
|
|
593
|
+
**For `EXTEND` files:** open the existing file → add only the new methods for `{UC-ID}` → do not touch anything else.
|
|
594
|
+
|
|
595
|
+
**Traceability tags on controller/handler (adapt to your language's comment syntax):**
|
|
596
|
+
```
|
|
597
|
+
@trace.implements={UC-ID}-SC{N}
|
|
598
|
+
@trace.prd_version={read @trace.prd_version from the .feature file header}
|
|
599
|
+
@trace.bdd_version={read @trace.bdd_version from the .feature file header}
|
|
600
|
+
@trace.tech_doc_revision={read @trace.revision from tech-doc header, or omit if no tech-doc}
|
|
601
|
+
@trace.source={paths.specs_dir}/{domain}/{prd-slug}/bdd/{UC-ID}-{slug}.feature
|
|
602
|
+
```
|
|
603
|
+
|
|
604
|
+
`@trace.prd_version` records which PRD version this code was written against.
|
|
605
|
+
`@trace.bdd_version` records which BDD version this code was generated from.
|
|
606
|
+
`@trace.tech_doc_revision` records which tech-design revision this code follows.
|
|
607
|
+
`/validate-traces` will flag drift if any upstream artifact is updated to a newer version.
|
|
608
|
+
|
|
609
|
+
> **Entry-point rule:** `@trace.implements` must appear on the **entry-point layer** as defined in `CLAUDE.md §2`. For REST APIs → Controller. For event-driven modules → event handler / consumer class. For context-engineering → the prompt orchestration function. Never put it only on an inner layer.
|
|
610
|
+
|
|
611
|
+
### Test Selectors — emit stable element IDs *(FE/App UI only)*
|
|
612
|
+
|
|
613
|
+
*Applies when `platform` is `web`/`app` and generating UI (`--phase=ui`, or default FE/App mode). Skip for BE.*
|
|
614
|
+
|
|
615
|
+
Every **actionable** element (button, input, link, select, toggle, form-submit) MUST carry a **stable test-id** so QC locates it directly (no runtime scan):
|
|
616
|
+
|
|
617
|
+
1. **Source the id.** If the FE tech-design `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md` exists, take ids **verbatim** from its §2b Test Selectors table (the contract). If it does not exist yet (e.g. `--phase=ui` before the FE tech-design), **generate ids by the convention** `{uc-lower}-{screen}-{element}-{type}` (e.g. `ft001-login-submit-btn`) so QC still has stable handles — they will be reconciled to the tech-design's §2b at integration.
|
|
618
|
+
2. **Emit via the platform attribute** (from `@trace.testid_attr`, or by module):
|
|
619
|
+
- web (`react`/`nextjs`/`vue`/`angular`) → `data-testid="..."`
|
|
620
|
+
- React Native → `testID="..."`
|
|
621
|
+
- Flutter → `Key('...')` (+ `Semantics(identifier: '...')` where the action needs it)
|
|
622
|
+
- native iOS → `accessibilityIdentifier = "..."`
|
|
623
|
+
3. Only actionable elements; do not spam ids on static text. Keep ids identical to the tech-design map so QC Page Objects match on the first try.
|
|
624
|
+
4. **Reused catalog component?** Pass the id via its **forwarding prop** (see the catalog `## Test-ID Forwarding` section — e.g. `<Button testId="ft001-login-submit-btn">`), not a raw attribute. If the component does not forward a test-id, or you are backfilling **existing/brownfield** screens (not freshly generated here), that is `/map-testids {UC-ID}`'s job — run it instead of editing shared components inline.
|
|
625
|
+
|
|
626
|
+
## Mock API Layer (`--phase=ui` only)
|
|
627
|
+
|
|
628
|
+
*Skip this section entirely if `--phase` is not `ui`.*
|
|
629
|
+
|
|
630
|
+
Build the mock from the `mock_source` resolved in Phase Detection — **shape** from the BE contract when present, **fixture values + behavior** always from System BDD `Then` clauses:
|
|
631
|
+
|
|
632
|
+
1. **Define the port shape** `{UC-ID}ApiPort` (request/response DTOs + error codes):
|
|
633
|
+
- `mock_source = contract` → field names / types / error codes taken **verbatim from the BE contract** §2 (API Endpoints) / §3 (Data Model) — the real shape.
|
|
634
|
+
- `mock_source = system-bdd` → shape **inferred** from System BDD `Then` clauses (provisional — see warning above).
|
|
635
|
+
2. **Extract fixture data** per scenario from System BDD `Then` clauses — success + error responses (BDD is the source of truth for *values / behavior*, regardless of shape source).
|
|
636
|
+
3. **Generate mock adapter** at `{paths.src_dir}/{domain}/{UC-ID}MockApiAdapter.{ext}`:
|
|
637
|
+
- Implements interface `{UC-ID}ApiPort` (same interface the real adapter will implement)
|
|
638
|
+
- Each method returns fixture data matching the BDD `Then` clause, in the port shape
|
|
639
|
+
- Include both success and error states (map to error scenarios in BDD)
|
|
640
|
+
- Traceability tags:
|
|
641
|
+
```
|
|
642
|
+
@trace.mock_for={UC-ID}
|
|
643
|
+
@trace.mock_source={contract | system-bdd}
|
|
644
|
+
@trace.system_bdd={paths.specs_dir}/{domain}/{prd-slug}/bdd/system/{UC-ID}*.feature
|
|
645
|
+
{@trace.be_contract={UC-ID}-tech-design.md # only when mock_source=contract}
|
|
646
|
+
```
|
|
647
|
+
4. **Wire into service/hook layer** via environment flag or DI:
|
|
648
|
+
```
|
|
649
|
+
const adapter = IS_MOCK ? new {UC-ID}MockApiAdapter() : new {UC-ID}ApiAdapter()
|
|
650
|
+
```
|
|
651
|
+
- `IS_MOCK` defaults to `true` in development/test env until real adapter is generated.
|
|
652
|
+
|
|
653
|
+
> Tester uses the mock adapter to test all FE scenarios without waiting for BE to **deploy**.
|
|
654
|
+
> Shape comes from the BE contract when available (accurate, no integration rework); else from System BDD (provisional — adjust at `--phase=integration`). Fixture *values* always come from System BDD — BDD is the source of truth for behavior.
|
|
655
|
+
|
|
656
|
+
---
|
|
657
|
+
|
|
658
|
+
## Integration Phase (`--phase=integration` only)
|
|
659
|
+
|
|
660
|
+
*Skip this section entirely if `--phase` is not `integration`.*
|
|
661
|
+
|
|
662
|
+
1. **Read the integration design.** Prefer the FE tech-design §4 (port→endpoint→DTO→error mapping) at `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md`, using the BE API contract `{UC-ID}-tech-design.md` as the endpoint / request-response / error-code source. If no FE tech-design exists, extract endpoints + shapes + error codes directly from the BE contract.
|
|
663
|
+
2. **Read existing mock adapter** interface (`{UC-ID}ApiPort`) from the `--phase=ui` output.
|
|
664
|
+
3. **Generate real API adapter** at `{paths.src_dir}/{domain}/{UC-ID}ApiAdapter.{ext}`:
|
|
665
|
+
- Implements the same `{UC-ID}ApiPort` interface as mock adapter
|
|
666
|
+
- Makes real HTTP calls to endpoints from tech-doc contract
|
|
667
|
+
- Maps response fields to the same shapes the mock adapter returned
|
|
668
|
+
- Traceability tags:
|
|
669
|
+
```
|
|
670
|
+
@trace.implements={UC-ID}-SC{N}
|
|
671
|
+
@trace.tech_doc_revision={read from tech-doc header}
|
|
672
|
+
```
|
|
673
|
+
4. **Flip wire-up**: switch DI binding / env flag so service/hook uses `{UC-ID}ApiAdapter` (real) instead of mock.
|
|
674
|
+
5. **Do NOT delete mock adapter** — keep it for unit testing.
|
|
675
|
+
|
|
676
|
+
---
|
|
677
|
+
|
|
678
|
+
## Self-Review (3 rounds)
|
|
679
|
+
- [ ] Every scenario has a corresponding endpoint
|
|
680
|
+
- [ ] @trace.implements on every endpoint
|
|
681
|
+
- [ ] Architecture layer rules respected (CLAUDE.md §2)
|
|
682
|
+
- [ ] Error handling matches CLAUDE.md §5
|
|
683
|
+
- [ ] No magic numbers, no debug logging
|
|
684
|
+
|
|
685
|
+
## Build Verify
|
|
686
|
+
```bash
|
|
687
|
+
{conventions.build_command} # from project-context.yaml, max 3 retries
|
|
688
|
+
```
|
|
689
|
+
|
|
690
|
+
## Write Trace State
|
|
691
|
+
|
|
692
|
+
Update `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` — for each implemented scenario, find the existing row by `sc_id` and update only these columns. *(Umbrella + `spec_source`: `trace_dir` resolves to `{spec_source}/.trace` — this command runs from `service_root` but writes the trace row into the **spec repo** (cross-repo); commit/push the spec submodule for the trace update, alongside the 2-tier code push.)*
|
|
693
|
+
|
|
694
|
+
| Column | Value |
|
|
695
|
+
|--------|-------|
|
|
696
|
+
| `gen_ver` | copy `spec_ver` from the current `.tsv` row (= scenario version at time of codegen) |
|
|
697
|
+
| `implemented_by` | `{ControllerClass}.{methodName}` |
|
|
698
|
+
| `bdd_version` | `@trace.bdd_version` from `.feature` header |
|
|
699
|
+
| `tech_doc_revision` | `@trace.revision` from the **BE** contract `{UC-ID}-tech-design.md`, or `—` if none |
|
|
700
|
+
| `fe_tech_doc_revision` | `@trace.revision` from the **FE** tech-design `{UC-ID}-tech-design-{platform}.md` when generating FE with `--phase=integration` (the doc whose §4 drove this adapter); `—` for BE, or for FE `--phase=ui` / no FE tech-design |
|
|
701
|
+
| `fe_phase` | `ui` if `--phase=ui` \| `integrated` if `--phase=integration` \| `—` if no phase flag |
|
|
702
|
+
| `last_updated` | today `YYYY-MM-DD` |
|
|
703
|
+
|
|
704
|
+
Leave all other columns (`sc_title`, `spec_ver`, `prd_version`, `prd_status`, `uc_status`, `test_count`, `test_classes`, `dev_selftest`, `dev_selftest_at`, `qc_status`, `qc_run_at`, `qc_owner`, `qc_blocked_by`) unchanged.
|
|
705
|
+
`status` is computed by `/validate-traces` — do not set here.
|
|
706
|
+
|
|
707
|
+
## Refresh Panel Mirror
|
|
708
|
+
# Refresh Living Docs panel mirror *(local, umbrella mode)*
|
|
709
|
+
|
|
710
|
+
*Skip entirely in single-service mode (no `services` and no `setup.spec_source`) — there
|
|
711
|
+
the repo's own `.trace/` IS the panel location, so nothing to mirror.*
|
|
712
|
+
|
|
713
|
+
After updating the authoritative TSV(s) at `{paths.trace_dir}`:
|
|
714
|
+
|
|
715
|
+
**When `setup.spec_source` is set (consolidated trace — the common case):**
|
|
716
|
+
`{paths.trace_dir}` resolves to `{spec_source}/.trace` — the single authoritative location.
|
|
717
|
+
This command runs from `service_root`, so the write is **cross-repo into the spec submodule**;
|
|
718
|
+
commit/push the spec submodule for the trace update (same as `feedback/`).
|
|
719
|
+
1. Resolve `panel_mirror = ./.trace` at the **current workspace root**.
|
|
720
|
+
2. If `panel_mirror` resolves to a different path than `{paths.trace_dir}`, copy each
|
|
721
|
+
just-updated `{UC-ID}.tsv` → `{panel_mirror}/{UC-ID}.tsv` (create the dir; overwrite).
|
|
722
|
+
No per-service namespacing — there is one trace set; the owning service is carried in each
|
|
723
|
+
row's `@trace.service`.
|
|
724
|
+
|
|
725
|
+
**Legacy (no `spec_source` — per-service trace):**
|
|
726
|
+
Copy each just-updated `{UC-ID}.tsv` → `{panel_mirror}/{service-name}/{UC-ID}.tsv`
|
|
727
|
+
(namespaced by `active_service`).
|
|
728
|
+
|
|
729
|
+
This keeps the open workspace's Living Docs panel current **between syncs** — it is a
|
|
730
|
+
**local convenience mirror only**. The merged `trace-report.json` (canonical, in
|
|
731
|
+
`{spec_source}/.living-docs/`) is rebuilt by `/sync` or `/validate-traces`. For orchestrated
|
|
732
|
+
commands, do this once in the orchestrator after all sub-agents return — not inside each
|
|
733
|
+
sub-agent.
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
## Commit
|
|
737
|
+
```bash
|
|
738
|
+
git add {files}
|
|
739
|
+
git commit -m "{commit_format}: {description}"
|
|
740
|
+
```
|
|
741
|
+
|
|
742
|
+
## Output
|
|
743
|
+
|
|
744
|
+
# Report Footer — Standard Command Output Format
|
|
745
|
+
|
|
746
|
+
Every command report must end with this standard footer section.
|
|
747
|
+
|
|
748
|
+
## Status Badge
|
|
749
|
+
|
|
750
|
+
Choose one based on outcome:
|
|
751
|
+
- `✅ Complete` — all steps succeeded, no issues found
|
|
752
|
+
- `❌ Failed` — command could not complete due to a blocking error
|
|
753
|
+
- `⚠️ Warnings` — completed with non-blocking issues that should be reviewed
|
|
754
|
+
|
|
755
|
+
## Output Artifacts
|
|
756
|
+
|
|
757
|
+
List every file created or modified by this command:
|
|
758
|
+
```
|
|
759
|
+
Output Artifacts:
|
|
760
|
+
{created|updated} {file-path} ({brief description})
|
|
761
|
+
{created|updated} {file-path} ({brief description})
|
|
762
|
+
```
|
|
763
|
+
|
|
764
|
+
If no files were written (e.g., review or analysis commands) → write `Output Artifacts: none (read-only)`.
|
|
765
|
+
|
|
766
|
+
## Pipeline Position
|
|
767
|
+
|
|
768
|
+
Print a one-line map of the pipeline with the CURRENT command's phase marked `◀ bạn ở đây`,
|
|
769
|
+
so the user always sees where this command sits in the end-to-end flow:
|
|
770
|
+
|
|
771
|
+
```
|
|
772
|
+
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
773
|
+
```
|
|
774
|
+
|
|
775
|
+
Find the current command in this phase legend and mark **its** phase in the map above:
|
|
776
|
+
|
|
777
|
+
| Phase | Commands |
|
|
778
|
+
|-------|----------|
|
|
779
|
+
| Discovery | `/define-product` |
|
|
780
|
+
| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
781
|
+
| Design Spec | `/generate-design-spec` |
|
|
782
|
+
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
783
|
+
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
784
|
+
| Code | `/generate-code` · `/review-code` |
|
|
785
|
+
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
786
|
+
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
787
|
+
| Trace Audit | `/validate-traces` |
|
|
788
|
+
|
|
789
|
+
For a **review command**, also append the 3-step review loop with the current step marked, e.g.:
|
|
790
|
+
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
791
|
+
|
|
792
|
+
**Cross-cutting commands** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
793
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) sit outside the linear pipeline —
|
|
794
|
+
**omit the Pipeline line entirely** for these (do not force-fit them onto the map).
|
|
795
|
+
|
|
796
|
+
## Next Command Suggestion
|
|
797
|
+
|
|
798
|
+
Suggest the logical next command based on workflow phase:
|
|
799
|
+
|
|
800
|
+
| Current command | Suggest next |
|
|
801
|
+
|-------------------------|-----------------------------------------------|
|
|
802
|
+
| /setup-ai-first | `/define-product` to start your first feature |
|
|
803
|
+
| /define-product | `/generate-prd {product-definition-file}` |
|
|
804
|
+
| /generate-prd | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
|
|
805
|
+
| /refine-prd | Open Review Board → update PRD → `/review-context {prd-file}` |
|
|
806
|
+
| /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 |
|
|
807
|
+
| /generate-design-spec | Designer review → Figma links confirmed → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
808
|
+
| /generate-bdd | `/review-context {feature-file}` to verify coverage |
|
|
809
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
|
|
810
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (resolve 🔴 blocker gaps first) |
|
|
811
|
+
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
812
|
+
| /qc-design-test | `/qc-review {UC-ID}` (test-case review) |
|
|
813
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` if APPROVED; fix TCs if NEEDS_FIX |
|
|
814
|
+
| /qc-run-test | `/qc-report {UC-ID}` then `/qc-review {UC-ID}` (script review) |
|
|
815
|
+
| /qc-review (script) | `/qc-report {UC-ID}` then create PR if APPROVED |
|
|
816
|
+
| /qc-report | `/validate-traces {UC-ID}` to refresh Living Docs (qc_status) |
|
|
817
|
+
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
818
|
+
| /review-tech-docs | `/generate-code {feature-file}` if APPROVED; fix doc if NEEDS_FIX |
|
|
819
|
+
| /generate-code | First gen → `/review-code {UC-ID}`; re-gen → `/dev-gen-test {UC-ID}` |
|
|
820
|
+
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
821
|
+
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
822
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` or `/debug {error}` |
|
|
823
|
+
| /review-code | `/dev-smoke-test {UC-ID}` or create PR |
|
|
824
|
+
| /dev-smoke-test | Create PR and link to ticket |
|
|
825
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; all OK → create PR |
|
|
826
|
+
| /fix-bug | Create PR and link to ticket |
|
|
827
|
+
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
828
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
829
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
830
|
+
| /learn | Continue working — lesson applies on next command |
|
|
831
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
832
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
833
|
+
|
|
834
|
+
Format the footer as:
|
|
835
|
+
```
|
|
836
|
+
---
|
|
837
|
+
Status : {badge}
|
|
838
|
+
{Output Artifacts block}
|
|
839
|
+
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
840
|
+
(review cmd) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
841
|
+
Next : {suggested command with example arguments}
|
|
842
|
+
```
|
|
843
|
+
*(Omit the `Pipeline` line for cross-cutting commands listed above.)*
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
```
|
|
847
|
+
/generate-code Complete — {UC-ID}
|
|
848
|
+
Files: created={N}, extended={M}, skipped={K} | Build: SUCCESS
|
|
849
|
+
Branch: feature/{TICKET_ID}-{slug}
|
|
850
|
+
Phase : {UI (mock layer) | Integration (real API) | Default (full)}
|
|
851
|
+
fe_phase : {ui | integrated | —}
|
|
852
|
+
Figma : {local Dev Mode MCP (grounded) | ⚠️ web links + text spec only (no local MCP) | n/a for BE} ← FE/App UI only
|
|
853
|
+
|
|
854
|
+
Next:
|
|
855
|
+
--phase=ui done:
|
|
856
|
+
→ Notify tester: FE is testable via mock adapter
|
|
857
|
+
→ Collect BE sign-offs → /review-tech-docs {tech-design-file}
|
|
858
|
+
→ When BE ready → /generate-code {feature-file} --phase=integration
|
|
859
|
+
|
|
860
|
+
--phase=integration done:
|
|
861
|
+
→ /review-code {UC-ID} ← code review required
|
|
862
|
+
→ /dev-gen-test {UC-ID} ← integration test suite
|
|
863
|
+
|
|
864
|
+
Default (no phase flag):
|
|
865
|
+
→ /review-code {UC-ID} ← code review required before tests
|
|
866
|
+
→ /dev-gen-test {UC-ID}
|
|
867
|
+
|
|
868
|
+
📊 Living Docs: run /validate-traces (or /sync) to push this trace to the spec-module dashboard.
|
|
869
|
+
```
|