@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,811 @@
|
|
|
1
|
+
# /review-tech-docs — Review Technical Design Document
|
|
2
|
+
|
|
3
|
+
**READ-ONLY analysis mode — writes a findings file, does NOT modify the target.**
|
|
4
|
+
**Use `--resume` to apply accepted findings.**
|
|
5
|
+
|
|
6
|
+
## Gate
|
|
7
|
+
# Gate — Universal Entry Procedure
|
|
8
|
+
|
|
9
|
+
Every command must execute this gate before proceeding with its specific logic.
|
|
10
|
+
|
|
11
|
+
## Step 0 — Sub-Agent Mode Check
|
|
12
|
+
|
|
13
|
+
Before anything else, check if `$ARGUMENTS` is a JSON payload from an orchestrator:
|
|
14
|
+
|
|
15
|
+
1. Attempt to parse `$ARGUMENTS` as JSON.
|
|
16
|
+
2. If it parses successfully **and** contains `"_agent_mode": true`:
|
|
17
|
+
- **Skip Steps 1, 2, and 3 of this Gate entirely.**
|
|
18
|
+
- Set target file = `payload.target_file`
|
|
19
|
+
- Set loaded context = `payload.context` (do NOT run context-loader.md)
|
|
20
|
+
- Set UC scope = `payload.uc_id` (process only this UC)
|
|
21
|
+
- Set line range = `payload.uc_section` (read only that PRD section)
|
|
22
|
+
- Proceed directly to the command-specific logic.
|
|
23
|
+
3. If `$ARGUMENTS` is not JSON or `_agent_mode` is absent → continue to Step 1 (normal mode).
|
|
24
|
+
|
|
25
|
+
## Step 0-B — Model Check
|
|
26
|
+
|
|
27
|
+
*Skip this step if `_agent_mode: true` (sub-agent — orchestrator already validated).*
|
|
28
|
+
|
|
29
|
+
Complex generation and review commands require strong reasoning.
|
|
30
|
+
Using a smaller model risks missed edge cases, incomplete spec analysis, and architecture violations.
|
|
31
|
+
|
|
32
|
+
Display and wait for response:
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
⚙️ MODEL CHECK
|
|
36
|
+
──────────────────────────────────────────────────────────────────
|
|
37
|
+
Recommended : claude-opus-4 (or latest Opus model)
|
|
38
|
+
Why needed : Spec analysis, architecture review, code generation
|
|
39
|
+
require deep reasoning. Smaller models miss edge cases.
|
|
40
|
+
|
|
41
|
+
To switch in Claude Code:
|
|
42
|
+
• Settings → Model → select "claude-opus"
|
|
43
|
+
• or: /model → choose claude-opus
|
|
44
|
+
|
|
45
|
+
Running on claude-opus?
|
|
46
|
+
Y — yes, on claude-opus → proceed
|
|
47
|
+
S — skip check (I accept lower quality risk with current model)
|
|
48
|
+
──────────────────────────────────────────────────────────────────
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
- "Y" → proceed to Step 1.
|
|
52
|
+
- "S" → proceed to Step 1 (user accepts risk, add ⚠️ to final report).
|
|
53
|
+
- "N" or anything else → **STOP.** Output: "Please switch to claude-opus, then re-run this command."
|
|
54
|
+
|
|
55
|
+
## Step 1 — Resolve Target File
|
|
56
|
+
|
|
57
|
+
1. If `$ARGUMENTS` is provided and points to an existing file → use it directly as the target.
|
|
58
|
+
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:
|
|
59
|
+
- **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.
|
|
60
|
+
- **PRD commands** (target is `prd.md`): `{specs_dir}/{domain}/*/prd.md` (match the feature folder whose id corresponds), else `{specs_dir}/*/*/prd.md`.
|
|
61
|
+
- **tech-docs commands**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
62
|
+
- **design-spec commands**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
63
|
+
|
|
64
|
+
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.
|
|
65
|
+
3. If `$ARGUMENTS` is empty or no match found:
|
|
66
|
+
- List files in the relevant directory for this command (e.g., `specs/*/*/prd.md` for PRD commands, `specs/*/*/bdd/**/*.feature` for BDD commands).
|
|
67
|
+
- Present the list to the user and ask: "Which file do you want to work with? (Enter number or filename)"
|
|
68
|
+
- Wait for user selection before continuing.
|
|
69
|
+
|
|
70
|
+
## Step 2 — Execute Context Loader
|
|
71
|
+
|
|
72
|
+
Load all project context by following the procedure in `steps/context-loader.md`.
|
|
73
|
+
Store all loaded context in memory for use throughout this command session.
|
|
74
|
+
|
|
75
|
+
## Step 3 — CHECKPOINT
|
|
76
|
+
|
|
77
|
+
After completing Steps 1 and 2, display a summary and wait for confirmation:
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
CHECKPOINT
|
|
81
|
+
-----------
|
|
82
|
+
Target : {resolved file path}
|
|
83
|
+
Project : {project.name from project-context.yaml}
|
|
84
|
+
Tech stack : {language} / {framework}
|
|
85
|
+
Module : {module if set, else "not configured"}
|
|
86
|
+
Domains : {comma-separated domain list}
|
|
87
|
+
|
|
88
|
+
Proceed? (Y/N)
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
Wait for explicit "Y" or "N" from the user before continuing.
|
|
92
|
+
- "Y" → proceed to the command-specific steps below.
|
|
93
|
+
- "N" → stop and ask what the user wants to change.
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
*Note: For this command, the target in Step 1 is a tech-design `.md` file in `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/`.
|
|
97
|
+
If `$ARGUMENTS` contains `--resume` → skip to Resume Mode below.*
|
|
98
|
+
|
|
99
|
+
## Context
|
|
100
|
+
# Context Loader — Load All Project Context
|
|
101
|
+
|
|
102
|
+
Execute these steps in order. Store everything in memory for the duration of the command session.
|
|
103
|
+
|
|
104
|
+
**Priority guide (anti-lost-in-middle):**
|
|
105
|
+
- Steps 1–2 are PROJECT-CONFIG — loaded first, resolve all paths and metadata.
|
|
106
|
+
- Step 3 is CRITICAL — architecture + coding standards, the highest-priority facts for generation.
|
|
107
|
+
- Step 4 is SAFETY — data protection rules, enforced silently for the entire session.
|
|
108
|
+
- Steps 5–6 are DOMAIN KNOWLEDGE — terminology and entity definitions.
|
|
109
|
+
- Step 7 is the WORKING MEMORY RECAP — locks critical facts into the top of working memory.
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Step 1 — [PROJECT-CONFIG] Load project-context.yaml
|
|
114
|
+
|
|
115
|
+
Read `.agent/project-context.yaml`. Extract and store:
|
|
116
|
+
|
|
117
|
+
**Tech Stack:**
|
|
118
|
+
- `tech_stack.language` → active language (e.g., Java 17, TypeScript, C#, Go)
|
|
119
|
+
- `tech_stack.framework` → active framework (e.g., Spring Boot 3.2, Angular 17, .NET 8)
|
|
120
|
+
- `tech_stack.build_tool` → build tool (e.g., Maven, npm, dotnet, go)
|
|
121
|
+
- `tech_stack.test_framework` → test framework (e.g., JUnit 5 + Mockito, Jest, xUnit)
|
|
122
|
+
- `tech_stack.database` → database (e.g., PostgreSQL, MySQL, MongoDB)
|
|
123
|
+
- `tech_stack.module` → active module profile (e.g., java-spring, angular, dotnet, golang, context-engineering)
|
|
124
|
+
|
|
125
|
+
**Conventions:**
|
|
126
|
+
- `conventions.build_command` → how to compile/build
|
|
127
|
+
- `conventions.test_command` → how to run tests
|
|
128
|
+
- `conventions.service_run` → how to start the service
|
|
129
|
+
- `conventions.ticket_prefix` → ticket ID prefix (e.g., PROJ, FEAT, UC)
|
|
130
|
+
|
|
131
|
+
**Domains:**
|
|
132
|
+
- `domains` → list of active business domains
|
|
133
|
+
|
|
134
|
+
**Paths (if present):**
|
|
135
|
+
- `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/}`
|
|
136
|
+
- `paths.refinement_dir` → findings/review output dir
|
|
137
|
+
- `paths.qc_dir` → QC automation artifacts root (visible top-level, one subfolder per UC: `{qc_dir}/{UC-ID}/`)
|
|
138
|
+
- `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)
|
|
139
|
+
- `paths.product_definitions_dir` → product definitions root
|
|
140
|
+
- `paths.domain_knowledge_dir` → domain knowledge root
|
|
141
|
+
- `paths.business_dictionary` → path to business-dictionary.md
|
|
142
|
+
- `paths.core_entities` → path to core-entities.md
|
|
143
|
+
- `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/`)
|
|
144
|
+
- `paths.trace_dir` → trace state directory; structure: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
145
|
+
|
|
146
|
+
If `paths` section is absent, use these defaults:
|
|
147
|
+
- `specs_dir` = `specs`
|
|
148
|
+
- `refinement_dir` = `.agent/review`
|
|
149
|
+
- `qc_dir` = `docs`
|
|
150
|
+
- `qc_skills_dir` = `.agent/skills/qc`
|
|
151
|
+
- `product_definitions_dir` = `specs/product-definition`
|
|
152
|
+
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
153
|
+
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
154
|
+
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
155
|
+
- `tech_docs_dir` = `specs`
|
|
156
|
+
- `trace_dir` = `.trace`
|
|
157
|
+
|
|
158
|
+
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.
|
|
159
|
+
|
|
160
|
+
**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:
|
|
161
|
+
- `specs/payment/create-invoice/prd.md` → `prd_slug = create-invoice`
|
|
162
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(NOT `system`)*
|
|
163
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(NOT `web`)*
|
|
164
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(NOT `tech-docs`)*
|
|
165
|
+
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
166
|
+
|
|
167
|
+
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.
|
|
168
|
+
|
|
169
|
+
If `tech_stack.module` is set, also load `.agent/modules/{module}/stack-profile.yaml` if it exists.
|
|
170
|
+
|
|
171
|
+
---
|
|
172
|
+
|
|
173
|
+
## Step 1.5 — [SERVICE ROUTING] Resolve service paths (umbrella mode)
|
|
174
|
+
|
|
175
|
+
*Skip this step entirely if `setup.mode` is not `"umbrella"` and `services` section is absent from project-context.yaml.*
|
|
176
|
+
|
|
177
|
+
If `services` section is present:
|
|
178
|
+
|
|
179
|
+
**1. Detect active domain** (in priority order):
|
|
180
|
+
- Read `@trace.domain` from target file frontmatter (if Gate loaded a target file)
|
|
181
|
+
- 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.
|
|
182
|
+
*(e.g., `specs/user/create-account/prd.md` **and** `specs/user/create-account/bdd/system/UC1.feature` both → domain = `user`, prd_slug = `create-account`)*
|
|
183
|
+
- If `$ARGUMENTS` contains a path, extract the domain segment after `specs_dir`
|
|
184
|
+
|
|
185
|
+
**2. Route to service** — if active domain matches a key in `services`:
|
|
186
|
+
- 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.
|
|
187
|
+
- 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.
|
|
188
|
+
- Store `active_service` = `services.{domain}.path`
|
|
189
|
+
- Store `active_service_module` = `services.{domain}.module`
|
|
190
|
+
- If service has its own `module` → use it as `active_module` (overrides `tech_stack.module`)
|
|
191
|
+
|
|
192
|
+
**3. Fallback** — if domain not detected or no matching service key:
|
|
193
|
+
- Keep default paths from Step 1
|
|
194
|
+
- Set `active_service = unresolved`
|
|
195
|
+
|
|
196
|
+
**4. Spec source auto-override** — if `setup.spec_source` is set AND the corresponding path was not already explicitly set in `paths:`:
|
|
197
|
+
- 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`.)*
|
|
198
|
+
- 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.)*
|
|
199
|
+
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
200
|
+
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
201
|
+
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
202
|
+
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
203
|
+
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
204
|
+
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
205
|
+
- 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`.)*
|
|
206
|
+
|
|
207
|
+
> **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.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
## Step 1.6 — [SERVICE CONVENTIONS] Load service-specific conventions (umbrella mode)
|
|
212
|
+
|
|
213
|
+
*Skip this step entirely if `active_service` is `"unresolved"` or context is single-service mode.*
|
|
214
|
+
|
|
215
|
+
When `active_service` has been resolved to a real path in Step 1.5 (e.g., `user-service/`):
|
|
216
|
+
|
|
217
|
+
**1. Locate service config** — try in priority order:
|
|
218
|
+
- `{active_service}/.agent/project-context.yaml`
|
|
219
|
+
- `{active_service}/project-context.yaml`
|
|
220
|
+
|
|
221
|
+
**2. If found, override with service-specific values:**
|
|
222
|
+
|
|
223
|
+
| Variable | Source |
|
|
224
|
+
|----------|--------|
|
|
225
|
+
| `conventions.test_command` | service's `conventions.test_command` |
|
|
226
|
+
| `conventions.build_command` | service's `conventions.build_command` |
|
|
227
|
+
| `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`). |
|
|
228
|
+
| `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. |
|
|
229
|
+
|
|
230
|
+
**3. Store** `service_root = {active_service}` as the working directory anchor for all downstream commands:
|
|
231
|
+
- Shell commands (`/dev-run-test`, `/dev-gen-test`) run **from within** `service_root`
|
|
232
|
+
- **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/`).
|
|
233
|
+
|
|
234
|
+
**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).
|
|
235
|
+
|
|
236
|
+
---
|
|
237
|
+
|
|
238
|
+
## Step 2 — [PROJECT-CONFIG] Load module stack profile (conditional)
|
|
239
|
+
|
|
240
|
+
If `tech_stack.module` is set, read `.agent/modules/{module}/stack-profile.yaml`.
|
|
241
|
+
Merge framework-specific conventions (layer patterns, test patterns, naming rules) into the loaded context.
|
|
242
|
+
If the file does not exist → skip silently.
|
|
243
|
+
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
## Step 3 — [CRITICAL] Load CLAUDE.md (layered: root + service overlay)
|
|
247
|
+
|
|
248
|
+
*This is the highest-priority context — it defines HOW to write code and documents for this project.*
|
|
249
|
+
|
|
250
|
+
CLAUDE.md is loaded in **two layers** so umbrella-wide rules and service-specific
|
|
251
|
+
architecture/coding standards compose correctly. The agent always sits at the umbrella
|
|
252
|
+
root, but the implementation code lives in a service submodule with its OWN stack,
|
|
253
|
+
architecture, and conventions — so the service's CLAUDE.md must win for code generation.
|
|
254
|
+
|
|
255
|
+
**Layer 1 — [BASE] Root CLAUDE.md (umbrella-wide).**
|
|
256
|
+
Read `CLAUDE.md` at the repo root. Treat its contents as the **shared baseline** for the
|
|
257
|
+
whole umbrella — git conventions, data-protection posture, cross-cutting rules, and (in
|
|
258
|
+
single-service mode) the project's only architecture + coding standards.
|
|
259
|
+
|
|
260
|
+
**Layer 2 — [OVERLAY] Service CLAUDE.md (umbrella mode only).**
|
|
261
|
+
*Run only if `service_root` was set in Step 1.6 (i.e. a real service was routed to).*
|
|
262
|
+
Read `{service_root}/CLAUDE.md`. This file defines the architecture + coding standards of
|
|
263
|
+
the **actual stack being implemented** (e.g. `user-service` = java-spring, `web` = nextjs).
|
|
264
|
+
Overlay it on top of Layer 1: **on any conflict, the service value WINS** for architecture,
|
|
265
|
+
coding standards, and error handling. Layer-1 values that the service does not redefine
|
|
266
|
+
(e.g. git conventions, banned patterns shared org-wide) remain in effect.
|
|
267
|
+
|
|
268
|
+
From the **merged** result, extract and store:
|
|
269
|
+
|
|
270
|
+
- **§1 Project Overview** → project name, language, framework, build/test commands, domains
|
|
271
|
+
- **§2 Architecture** → layer order (e.g., Controller → Facade → Service → Repository), architectural rules — *service overlay wins*
|
|
272
|
+
- **§3 Coding Standards** → naming conventions (classes, methods), response wrapper type, forbidden patterns — *service overlay wins*
|
|
273
|
+
- **§5 Error Handling** → exception types, HTTP status code mapping, not-found exception class name — *service overlay wins*
|
|
274
|
+
- **§7 Git Conventions** → branch naming pattern, commit message format — *root baseline unless service redefines*
|
|
275
|
+
|
|
276
|
+
**Resolution rules:**
|
|
277
|
+
- If both layers exist → merge as above; record `claude_md_source = root + {service_root}`.
|
|
278
|
+
- If only the service overlay exists (no root CLAUDE.md) → use the service file alone; `claude_md_source = {service_root}`.
|
|
279
|
+
- 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).
|
|
280
|
+
- If neither exists → note CLAUDE.md as missing and continue with project-context.yaml data only.
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
## Step 4 — [SAFETY] Load Data Protection Rules
|
|
285
|
+
|
|
286
|
+
Read `.agent/rules/data-protection.md` (or `rules/data-protection.md` from the framework installation).
|
|
287
|
+
|
|
288
|
+
Store the sensitive file patterns — you must **never** read, write, display, or reference content from files matching those patterns for the entire session.
|
|
289
|
+
|
|
290
|
+
If neither file exists → apply built-in defaults: never access `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
|
|
294
|
+
## Step 5 — [DOMAIN] Load Business Dictionary (conditional)
|
|
295
|
+
|
|
296
|
+
Check if the business dictionary file exists (use `paths.business_dictionary` resolved in Step 1).
|
|
297
|
+
|
|
298
|
+
If it exists, read it and extract:
|
|
299
|
+
- **Canonical Terms** → complete list of approved terms and their definitions
|
|
300
|
+
- **Banned Terms** → complete list of banned terms and their canonical replacements
|
|
301
|
+
- **Status / Enum Registry** → allowed enum values per entity
|
|
302
|
+
|
|
303
|
+
Store the banned terms list for **active enforcement** throughout the command session:
|
|
304
|
+
- When generating any text (PRD, BDD, code comments, tech docs), verify no banned terms appear
|
|
305
|
+
- Replace banned terms with their canonical equivalents automatically
|
|
306
|
+
|
|
307
|
+
If the file does not exist → skip silently. Do not warn or block.
|
|
308
|
+
|
|
309
|
+
---
|
|
310
|
+
|
|
311
|
+
## Step 6 — [DOMAIN] Load Core Entities (conditional)
|
|
312
|
+
|
|
313
|
+
Check if the core entities file exists at `paths.core_entities` (resolved in Step 1).
|
|
314
|
+
Default path: `specs/domain-knowledge/core-entities.md`.
|
|
315
|
+
|
|
316
|
+
If it exists, read it and store:
|
|
317
|
+
- **Entity catalog** → for each entity: its name, purpose, owner service, key fields (name + type), business invariants, and relationships
|
|
318
|
+
- **Field name registry** → canonical field names to use in generated code and documents
|
|
319
|
+
- **Relationship map** → how entities relate to each other (1:N, N:N, embedded, etc.)
|
|
320
|
+
|
|
321
|
+
**How to use this catalog:**
|
|
322
|
+
- When generating code: use the field names, types, and relationships defined here — do NOT infer from existing code
|
|
323
|
+
- When generating PRD/BDD: reference entity names from this catalog for consistency
|
|
324
|
+
- When generating tech-docs: use this catalog as the source-of-truth for entity definitions
|
|
325
|
+
|
|
326
|
+
If the file does not exist → skip silently.
|
|
327
|
+
|
|
328
|
+
---
|
|
329
|
+
|
|
330
|
+
## Step 6.5 — [PLATFORM] Derive active_module and platform_type
|
|
331
|
+
|
|
332
|
+
Using `tech_stack.module` loaded in Step 1, derive and store two variables for use by all downstream commands:
|
|
333
|
+
|
|
334
|
+
```
|
|
335
|
+
active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
| `platform_type` | Modules |
|
|
339
|
+
|---|---|
|
|
340
|
+
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
341
|
+
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
342
|
+
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
343
|
+
|
|
344
|
+
If `tech_stack.module` is blank or not recognized → set `platform_type = "unknown"` and flag as ⚠️ in the Step 7 recap.
|
|
345
|
+
|
|
346
|
+
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).
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
## Step 6.7 — [GUARDRAILS] Load Project Lessons (conditional)
|
|
351
|
+
|
|
352
|
+
*Accumulated mistakes the AI must not repeat in this project. These are added over time via `/learn`
|
|
353
|
+
or accepted during `/review-code`, `/fix-bug`, `/debug`.*
|
|
354
|
+
|
|
355
|
+
Resolve the lessons file path:
|
|
356
|
+
- Use `paths.lessons_file` if set (may be service-overridden in umbrella mode, Step 1.6)
|
|
357
|
+
- Else default `specs/domain-knowledge/lessons-learned.md`
|
|
358
|
+
- In umbrella/service mode (when `service_root` is set), if `paths.lessons_file` is unset, default to `{service_root}/.agent/project-lessons.md`
|
|
359
|
+
|
|
360
|
+
If the file exists, read it and store ALL lessons as **ACTIVE GUARDRAILS** for the session:
|
|
361
|
+
- Treat each lesson's **Rule** as a hard constraint — same priority as CLAUDE.md coding standards (Step 3).
|
|
362
|
+
- 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).
|
|
363
|
+
- If a generated output would violate a lesson → correct it **before** presenting, and note which lesson (`L-NNN`) was applied.
|
|
364
|
+
|
|
365
|
+
If the file does not exist → skip silently (no lessons captured yet).
|
|
366
|
+
|
|
367
|
+
---
|
|
368
|
+
|
|
369
|
+
## Step 7 — [RECAP] Working Memory Recap (anti-lost-in-middle)
|
|
370
|
+
|
|
371
|
+
After loading all context, synthesize and output a compact summary block.
|
|
372
|
+
This recap ensures the most critical facts are stated at the END of context loading
|
|
373
|
+
(recency effect — freshest in working memory when the task begins).
|
|
374
|
+
|
|
375
|
+
Output exactly this block:
|
|
376
|
+
```
|
|
377
|
+
[CTX LOADED]
|
|
378
|
+
Stack : {language} / {framework} / {database}
|
|
379
|
+
Platform : {active_module} ({platform_type})
|
|
380
|
+
Layers : {layer order from merged CLAUDE.md §2, e.g., Controller → Facade → Service → Repository}
|
|
381
|
+
CLAUDE.md : {root + {service_root} | {service_root} only | root only | ⚠️ service overlay MISSING — using root | missing}
|
|
382
|
+
Ticket : {ticket_prefix}-
|
|
383
|
+
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
384
|
+
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
385
|
+
Lessons : {loaded — N guardrails | none yet}
|
|
386
|
+
Service : {active_service} ({active_service_module}) | single-service
|
|
387
|
+
Svc Root : {service_root} — conventions + trace_dir loaded from service config | —
|
|
388
|
+
Status : {FULL | PARTIAL — missing: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
389
|
+
```
|
|
390
|
+
|
|
391
|
+
If any CRITICAL file is missing (CLAUDE.md), flag it clearly so the user can decide whether to proceed.
|
|
392
|
+
|
|
393
|
+
---
|
|
394
|
+
|
|
395
|
+
## Context Load Complete
|
|
396
|
+
|
|
397
|
+
After completing all steps, you have loaded:
|
|
398
|
+
- Project identity, tech stack, module conventions
|
|
399
|
+
- Architecture rules and layer order ← **[CRITICAL — hold in working memory]**
|
|
400
|
+
- Coding standards and naming conventions ← **[CRITICAL — hold in working memory]**
|
|
401
|
+
- Data protection rules (sensitive file patterns to never access)
|
|
402
|
+
- Terminology rules with banned-term list ← **[DOMAIN — apply to every generated word]**
|
|
403
|
+
- Entity catalog (field names, types, invariants) ← **[DOMAIN — use for code generation]**
|
|
404
|
+
- All configured paths
|
|
405
|
+
|
|
406
|
+
Proceed to the next step of the calling command.
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
---
|
|
410
|
+
|
|
411
|
+
## Load Review Materials
|
|
412
|
+
|
|
413
|
+
After loading base context, read the following in order:
|
|
414
|
+
|
|
415
|
+
1. **Target tech-doc** — read fully. Extract from header:
|
|
416
|
+
- `@trace.id` → UC-ID
|
|
417
|
+
- `@trace.domain` → domain
|
|
418
|
+
- `@trace.prd` → source PRD ticket ID
|
|
419
|
+
- `@trace.status` → current status (draft / in-review / approved)
|
|
420
|
+
|
|
421
|
+
2. **Source feature file** — load `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{UC-ID}*.feature` if exists.
|
|
422
|
+
|
|
423
|
+
3. **Other tech-docs in same domain** — list and load all `.md` files in
|
|
424
|
+
`{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/` excluding the target. Used for conflict checking (T4).
|
|
425
|
+
|
|
426
|
+
4. **Architecture reference** — re-confirm CLAUDE.md §2: layer order, architectural rules.
|
|
427
|
+
|
|
428
|
+
5. **Core entities** — already loaded in context (Step 6 of context-loader).
|
|
429
|
+
|
|
430
|
+
Derive findings filename:
|
|
431
|
+
`{paths.refinement_dir}/{uc-id}-tech-review-findings.yaml`
|
|
432
|
+
|
|
433
|
+
---
|
|
434
|
+
|
|
435
|
+
## Review Dimensions
|
|
436
|
+
|
|
437
|
+
### T1 — Architecture Alignment *(always CRITICAL if violated)*
|
|
438
|
+
|
|
439
|
+
Cross-reference the proposed design against CLAUDE.md §2 rules:
|
|
440
|
+
|
|
441
|
+
| Violation type | Severity |
|
|
442
|
+
|----------------|----------|
|
|
443
|
+
| Controller calls Repository directly (layer skip) | Critical |
|
|
444
|
+
| Business logic in Controller or DTO | Critical |
|
|
445
|
+
| Forbidden pattern from §3 | Critical |
|
|
446
|
+
| Dependency going upstream (Service → Controller DTO) | Critical |
|
|
447
|
+
| Transaction annotation on wrong layer | Major |
|
|
448
|
+
| Missing separation (no Facade when arch requires it) | Major |
|
|
449
|
+
|
|
450
|
+
For each finding:
|
|
451
|
+
```
|
|
452
|
+
Component: {class or method name}
|
|
453
|
+
Violates: "{rule text}" (CLAUDE.md §2)
|
|
454
|
+
Fix: {which layer/component should own this instead}
|
|
455
|
+
```
|
|
456
|
+
→ **Not auto-fixable.** Human must decide structural fix. Note required in Review Board.
|
|
457
|
+
|
|
458
|
+
### T2 — Entity Consistency
|
|
459
|
+
|
|
460
|
+
Using the loaded core-entities catalog:
|
|
461
|
+
|
|
462
|
+
| Issue | Severity | Auto-fixable? |
|
|
463
|
+
|-------|----------|---------------|
|
|
464
|
+
| Entity mentioned not in core-entities.md | Major | No — human confirms if DTO or domain entity |
|
|
465
|
+
| Field name differs from core-entities.md | Major | Yes — rename to canonical |
|
|
466
|
+
| Relationship described differently | Major | No — human decides |
|
|
467
|
+
| New entity introduced but not in core-entities.md | Minor | No — add to core-entities first |
|
|
468
|
+
|
|
469
|
+
### T3 — BDD Traceability
|
|
470
|
+
|
|
471
|
+
Cross-reference against the source `.feature` file:
|
|
472
|
+
|
|
473
|
+
| Issue | Severity | Auto-fixable? |
|
|
474
|
+
|-------|----------|---------------|
|
|
475
|
+
| Tech-doc proposes behavior not in any BDD scenario | Major | No — create scenario first |
|
|
476
|
+
| Tech-doc contradicts a BDD scenario | Critical | No — resolve conflict first |
|
|
477
|
+
| UC scenario has no corresponding design decision | Minor | Yes — add missing design note |
|
|
478
|
+
|
|
479
|
+
### T4 — Domain Conflict Check
|
|
480
|
+
|
|
481
|
+
Compare against other tech-docs in `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/`:
|
|
482
|
+
|
|
483
|
+
| Issue | Severity | Auto-fixable? |
|
|
484
|
+
|-------|----------|---------------|
|
|
485
|
+
| Same endpoint defined with different request/response | Critical | No — human resolves |
|
|
486
|
+
| Same service method with different behavior | Critical | No — human resolves |
|
|
487
|
+
| Entity status transitions differ between docs | Critical | No — human resolves |
|
|
488
|
+
| Overlapping responsibility (both docs claim ownership of same logic) | Major | No — human resolves |
|
|
489
|
+
|
|
490
|
+
### T5 — Internal Consistency
|
|
491
|
+
|
|
492
|
+
Within the tech-doc itself:
|
|
493
|
+
|
|
494
|
+
| Check | Severity | Auto-fixable? |
|
|
495
|
+
|-------|----------|---------------|
|
|
496
|
+
| Sequence diagram shows different flow than written description | Major | No |
|
|
497
|
+
| API spec return type differs from code sketch | Major | Yes — align one to the other |
|
|
498
|
+
| Section references a component/concept never defined later | Minor | Yes — add definition |
|
|
499
|
+
| Assumption stated but no design addresses it | Minor | Yes — add note or remove assumption |
|
|
500
|
+
|
|
501
|
+
### T6 — Structural Completeness
|
|
502
|
+
|
|
503
|
+
Check all standard sections are present and non-empty:
|
|
504
|
+
|
|
505
|
+
| Section | Missing severity |
|
|
506
|
+
|---------|-----------------|
|
|
507
|
+
| Header (`@trace.id`, `@trace.prd`, `@trace.domain`, `@trace.status`) | Major |
|
|
508
|
+
| Overview / Context | Major |
|
|
509
|
+
| Architecture Decision with rationale | Major |
|
|
510
|
+
| Component Diagram or Layer Description | Major |
|
|
511
|
+
| Sequence Diagram or Flow Steps | Major |
|
|
512
|
+
| API Contract (if HTTP-facing) | Major |
|
|
513
|
+
| Data Model Changes (if entity changes) | Major |
|
|
514
|
+
| Error Handling Strategy | Major |
|
|
515
|
+
| Open Questions / Assumptions | Minor |
|
|
516
|
+
|
|
517
|
+
→ All T6 missing-section findings are **auto-fixable**: AI adds skeleton section with prompts.
|
|
518
|
+
|
|
519
|
+
### T7 — Cross-Team API Contract Review
|
|
520
|
+
|
|
521
|
+
*Only applies when ALL of the following are true:*
|
|
522
|
+
*1. Source BDD has `@trace.platform: system`.*
|
|
523
|
+
*2. Tech-doc header does NOT have `@trace.api_source: existing`.*
|
|
524
|
+
|
|
525
|
+
*If `@trace.api_source: existing` → **skip T7 entirely**. Contract đã được PO xác định trong PRD — không có API design mới để đồng thuận.*
|
|
526
|
+
|
|
527
|
+
This dimension ensures FE, App, and BE teams all agree on the API contract before implementation starts.
|
|
528
|
+
|
|
529
|
+
**Step 1 — Check sign-off status in tech-doc header:**
|
|
530
|
+
|
|
531
|
+
Read the `@trace.sign_off` block in the tech doc header. If absent → add it as a finding (auto-fixable: add skeleton).
|
|
532
|
+
|
|
533
|
+
```yaml
|
|
534
|
+
# @trace.sign_off:
|
|
535
|
+
# be_team: pending # author — set to "done" when BE satisfied with design
|
|
536
|
+
# fe_team: pending # FE/Web — must confirm contract matches web BDD expectations
|
|
537
|
+
# app_team: pending # App — must confirm contract matches app BDD expectations (if applicable)
|
|
538
|
+
# sa: pending # SA/Tech Lead — final approval
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
**Step 2 — Contract vs BDD cross-check:**
|
|
542
|
+
|
|
543
|
+
Load the web and app BDDs for this TICKET-ID (from `{paths.specs_dir}/{domain}/{prd-slug}/bdd/web/` and `{paths.specs_dir}/{domain}/{prd-slug}/bdd/app/` in the spec submodule or spec repo).
|
|
544
|
+
|
|
545
|
+
For each platform BDD, verify the tech doc's API contract satisfies the BDD's `Then` clauses:
|
|
546
|
+
|
|
547
|
+
| Check | Severity |
|
|
548
|
+
|---|---|
|
|
549
|
+
| Response fields in API contract don't cover what web BDD `Then` expects | Critical |
|
|
550
|
+
| Response fields in API contract don't cover what app BDD `Then` expects | Critical |
|
|
551
|
+
| Error response shape doesn't match what platform BDDs expect | Major |
|
|
552
|
+
| System BDD `@system.resolution` annotation contradicts the API contract design | Critical |
|
|
553
|
+
|
|
554
|
+
**Step 3 — Pending sign-off report:**
|
|
555
|
+
|
|
556
|
+
After the review, list which sign-offs are still `pending`:
|
|
557
|
+
|
|
558
|
+
```
|
|
559
|
+
⏳ Pending sign-offs before tech docs can be approved:
|
|
560
|
+
fe_team — FE/Web team must confirm API contract matches web BDD expectations
|
|
561
|
+
app_team — App team must confirm API contract matches app BDD expectations
|
|
562
|
+
sa — SA/Tech Lead final approval
|
|
563
|
+
|
|
564
|
+
Once sign-offs are collected → update @trace.sign_off in tech doc header, then re-run /review-tech-docs.
|
|
565
|
+
Tech docs cannot be set to "approved" while any required sign-off is pending.
|
|
566
|
+
```
|
|
567
|
+
|
|
568
|
+
**Approval gate:**
|
|
569
|
+
- If `be_team: done` AND `fe_team: done` AND `app_team: done` (or N/A) AND `sa: done` → tech docs may be set to `approved`
|
|
570
|
+
- Otherwise → `@trace.status` stays `in-review` — `generate-code` is blocked
|
|
571
|
+
|
|
572
|
+
---
|
|
573
|
+
|
|
574
|
+
## Write Findings File
|
|
575
|
+
|
|
576
|
+
After running all checks, write findings to `{paths.refinement_dir}/{uc-id}-tech-review-findings.yaml`:
|
|
577
|
+
|
|
578
|
+
```yaml
|
|
579
|
+
source_file: "{absolute path to tech-doc}"
|
|
580
|
+
uc_id: "{UC-ID}"
|
|
581
|
+
domain: "{domain}"
|
|
582
|
+
generated_at: "{ISO datetime}"
|
|
583
|
+
review_type: "tech-design"
|
|
584
|
+
status: "pending_review"
|
|
585
|
+
is_system_bdd: {true | false} # true if source BDD has @trace.platform: system
|
|
586
|
+
|
|
587
|
+
sign_off: # only present when is_system_bdd: true
|
|
588
|
+
be_team: pending # read from @trace.sign_off in tech-doc header
|
|
589
|
+
fe_team: pending
|
|
590
|
+
app_team: pending # "n/a" if project has no app platform
|
|
591
|
+
sa: pending
|
|
592
|
+
sign_off_gate: blocked # blocked | ready — "ready" only when all required are "done"
|
|
593
|
+
|
|
594
|
+
findings:
|
|
595
|
+
- id: "F001"
|
|
596
|
+
check_id: "T1" # T1–T7
|
|
597
|
+
severity: "critical" # critical | major | minor
|
|
598
|
+
section: "{section heading or component name where issue was found}"
|
|
599
|
+
uc_id: "{UC-ID}" # same as top-level uc_id (the UC this tech-doc designs)
|
|
600
|
+
quote: "{verbatim snippet copied EXACTLY from the tech-doc at the issue location, ≤120 chars}"
|
|
601
|
+
finding: "{clear description of the violation or gap}"
|
|
602
|
+
suggestion: "{specific fix — AI applies this in --resume if accepted}"
|
|
603
|
+
auto_fixable: false # true = AI can apply; false = human must write decision in note
|
|
604
|
+
status: "pending" # pending | accepted | modified | rejected | deferred
|
|
605
|
+
|
|
606
|
+
summary:
|
|
607
|
+
total_findings: {N}
|
|
608
|
+
by_severity: { critical: {N}, major: {N}, minor: {N} }
|
|
609
|
+
auto_fixable: {N}
|
|
610
|
+
requires_human_decision: {N}
|
|
611
|
+
recommendation: "APPROVED | NEEDS_REVISION | BLOCKED"
|
|
612
|
+
sign_off_gate: "{blocked — pending: fe_team, app_team, sa | ready}"
|
|
613
|
+
```
|
|
614
|
+
|
|
615
|
+
> **Locator fields (`quote` + `uc_id`) — required for Review Board source-jump.**
|
|
616
|
+
> For every finding, copy a short **verbatim** `quote` straight from the tech-doc at the exact spot
|
|
617
|
+
> the issue occurs — do NOT paraphrase; it is matched against the document to locate the line.
|
|
618
|
+
> These let a reviewer click a finding in the Review Board and jump to the precise source location.
|
|
619
|
+
|
|
620
|
+
## Report
|
|
621
|
+
|
|
622
|
+
# Report Footer — Standard Command Output Format
|
|
623
|
+
|
|
624
|
+
Every command report must end with this standard footer section.
|
|
625
|
+
|
|
626
|
+
## Status Badge
|
|
627
|
+
|
|
628
|
+
Choose one based on outcome:
|
|
629
|
+
- `✅ Complete` — all steps succeeded, no issues found
|
|
630
|
+
- `❌ Failed` — command could not complete due to a blocking error
|
|
631
|
+
- `⚠️ Warnings` — completed with non-blocking issues that should be reviewed
|
|
632
|
+
|
|
633
|
+
## Output Artifacts
|
|
634
|
+
|
|
635
|
+
List every file created or modified by this command:
|
|
636
|
+
```
|
|
637
|
+
Output Artifacts:
|
|
638
|
+
{created|updated} {file-path} ({brief description})
|
|
639
|
+
{created|updated} {file-path} ({brief description})
|
|
640
|
+
```
|
|
641
|
+
|
|
642
|
+
If no files were written (e.g., review or analysis commands) → write `Output Artifacts: none (read-only)`.
|
|
643
|
+
|
|
644
|
+
## Pipeline Position
|
|
645
|
+
|
|
646
|
+
Print a one-line map of the pipeline with the CURRENT command's phase marked `◀ bạn ở đây`,
|
|
647
|
+
so the user always sees where this command sits in the end-to-end flow:
|
|
648
|
+
|
|
649
|
+
```
|
|
650
|
+
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
651
|
+
```
|
|
652
|
+
|
|
653
|
+
Find the current command in this phase legend and mark **its** phase in the map above:
|
|
654
|
+
|
|
655
|
+
| Phase | Commands |
|
|
656
|
+
|-------|----------|
|
|
657
|
+
| Discovery | `/define-product` |
|
|
658
|
+
| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
659
|
+
| Design Spec | `/generate-design-spec` |
|
|
660
|
+
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
661
|
+
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
662
|
+
| Code | `/generate-code` · `/review-code` |
|
|
663
|
+
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
664
|
+
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
665
|
+
| Trace Audit | `/validate-traces` |
|
|
666
|
+
|
|
667
|
+
For a **review command**, also append the 3-step review loop with the current step marked, e.g.:
|
|
668
|
+
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
669
|
+
|
|
670
|
+
**Cross-cutting commands** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
671
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) sit outside the linear pipeline —
|
|
672
|
+
**omit the Pipeline line entirely** for these (do not force-fit them onto the map).
|
|
673
|
+
|
|
674
|
+
## Next Command Suggestion
|
|
675
|
+
|
|
676
|
+
Suggest the logical next command based on workflow phase:
|
|
677
|
+
|
|
678
|
+
| Current command | Suggest next |
|
|
679
|
+
|-------------------------|-----------------------------------------------|
|
|
680
|
+
| /setup-ai-first | `/define-product` to start your first feature |
|
|
681
|
+
| /define-product | `/generate-prd {product-definition-file}` |
|
|
682
|
+
| /generate-prd | `/refine-prd {prd-file}` then `/review-context {prd-file}` |
|
|
683
|
+
| /refine-prd | Open Review Board → update PRD → `/review-context {prd-file}` |
|
|
684
|
+
| /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 |
|
|
685
|
+
| /generate-design-spec | Designer review → Figma links confirmed → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
686
|
+
| /generate-bdd | `/review-context {feature-file}` to verify coverage |
|
|
687
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` if APPROVED; regenerate if NEEDS_FIX |
|
|
688
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (resolve 🔴 blocker gaps first) |
|
|
689
|
+
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
690
|
+
| /qc-design-test | `/qc-review {UC-ID}` (test-case review) |
|
|
691
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` if APPROVED; fix TCs if NEEDS_FIX |
|
|
692
|
+
| /qc-run-test | `/qc-report {UC-ID}` then `/qc-review {UC-ID}` (script review) |
|
|
693
|
+
| /qc-review (script) | `/qc-report {UC-ID}` then create PR if APPROVED |
|
|
694
|
+
| /qc-report | `/validate-traces {UC-ID}` to refresh Living Docs (qc_status) |
|
|
695
|
+
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
696
|
+
| /review-tech-docs | `/generate-code {feature-file}` if APPROVED; fix doc if NEEDS_FIX |
|
|
697
|
+
| /generate-code | First gen → `/review-code {UC-ID}`; re-gen → `/dev-gen-test {UC-ID}` |
|
|
698
|
+
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
699
|
+
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
700
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` or `/debug {error}` |
|
|
701
|
+
| /review-code | `/dev-smoke-test {UC-ID}` or create PR |
|
|
702
|
+
| /dev-smoke-test | Create PR and link to ticket |
|
|
703
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; all OK → create PR |
|
|
704
|
+
| /fix-bug | Create PR and link to ticket |
|
|
705
|
+
| /debug | `/fix-bug {ticket-id}` if fix needed |
|
|
706
|
+
| /report-bug | Send to dev (`/fix-bug {BUG-ID}`); if coverage gap → `/propose-scenario {UC-ID}` |
|
|
707
|
+
| /propose-scenario | Notify PO/Dev to review the proposal in `feedback/bdd-proposals/` |
|
|
708
|
+
| /learn | Continue working — lesson applies on next command |
|
|
709
|
+
| /sync | `/validate-traces` for full coverage; act on any `📥 tester feedback` surfaced |
|
|
710
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` for project content |
|
|
711
|
+
|
|
712
|
+
Format the footer as:
|
|
713
|
+
```
|
|
714
|
+
---
|
|
715
|
+
Status : {badge}
|
|
716
|
+
{Output Artifacts block}
|
|
717
|
+
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
718
|
+
(review cmd) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
719
|
+
Next : {suggested command with example arguments}
|
|
720
|
+
```
|
|
721
|
+
*(Omit the `Pipeline` line for cross-cutting commands listed above.)*
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
```
|
|
725
|
+
/review-tech-docs Complete — {target file}
|
|
726
|
+
UC: {UC-ID} | Domain: {domain}
|
|
727
|
+
Findings: {total} | 🔴 Critical: {N} | 🟡 Major: {N} | 🟢 Minor: {N}
|
|
728
|
+
Auto-fixable: {N} | Needs human decision: {N}
|
|
729
|
+
|
|
730
|
+
Sign-off gate (system BDD only):
|
|
731
|
+
be_team : {done | pending}
|
|
732
|
+
fe_team : {done | pending} ← {name / "needs sign-off" }
|
|
733
|
+
app_team : {done | pending | n/a}
|
|
734
|
+
sa : {done | pending}
|
|
735
|
+
Gate : {🔒 BLOCKED — pending: fe_team, sa | ✅ READY}
|
|
736
|
+
|
|
737
|
+
Findings file: {paths.refinement_dir}/{uc-id}-tech-review-findings.yaml
|
|
738
|
+
Next: Open in Review Board → Accept/Modify/Reject each finding
|
|
739
|
+
Then run: /review-tech-docs --resume {tech-design-file}
|
|
740
|
+
After all sign-offs collected → update @trace.sign_off in tech doc, re-run review
|
|
741
|
+
```
|
|
742
|
+
|
|
743
|
+
---
|
|
744
|
+
|
|
745
|
+
## Resume Mode — Apply Accepted Findings
|
|
746
|
+
|
|
747
|
+
*Triggered when `$ARGUMENTS` contains `--resume`.*
|
|
748
|
+
*Example: `/review-tech-docs --resume {paths.tech_docs_dir}/payment/{prd-slug}/tech-docs/PAY-UC1-tech-design.md`*
|
|
749
|
+
|
|
750
|
+
### Phase 1 — Read accepted findings
|
|
751
|
+
|
|
752
|
+
1. Derive findings file from target: `{paths.refinement_dir}/{uc-id}-tech-review-findings.yaml`
|
|
753
|
+
2. Read the file. Collect findings where `status: "accepted"` or `status: "modified"`.
|
|
754
|
+
3. If none → report "No accepted findings. File unchanged." and stop.
|
|
755
|
+
|
|
756
|
+
### Phase 2 — Apply fixes
|
|
757
|
+
|
|
758
|
+
Apply in order: critical → major → minor.
|
|
759
|
+
|
|
760
|
+
| check_id | What to do |
|
|
761
|
+
|----------|-----------|
|
|
762
|
+
| T1 (Architecture) | Apply the structural fix from finding note — move logic to correct layer, update component description |
|
|
763
|
+
| T2 (Field name) | Rename field to canonical name from core-entities.md throughout the document |
|
|
764
|
+
| T3 (Missing design note) | Add design decision note for the uncovered scenario |
|
|
765
|
+
| T5 (Internal inconsistency) | Align the conflicting sections to the decision stated in the note |
|
|
766
|
+
| T6 (Missing section) | Add skeleton section with placeholder prompts for the tech lead to fill |
|
|
767
|
+
|
|
768
|
+
**T1, T2, T4 findings with `auto_fixable: false`:** require a human-written resolution in the
|
|
769
|
+
Review Board "Modify" note. Apply exactly what the note says. Do not invent the fix.
|
|
770
|
+
|
|
771
|
+
### Phase 3 — Update header + TSV + Report
|
|
772
|
+
|
|
773
|
+
Edit the tech-doc file directly:
|
|
774
|
+
1. Find `@trace.revision:` in the header — increment its integer value by 1.
|
|
775
|
+
2. Find `@trace.status:` in the header:
|
|
776
|
+
- If sign_off_gate = `ready` (all sign-offs done) → set to `approved`
|
|
777
|
+
- Otherwise → set to `in-review` (blocks `/generate-code`)
|
|
778
|
+
3. If `@trace.sign_off` block is absent and this is a system BDD tech doc → add it with all values `pending`.
|
|
779
|
+
|
|
780
|
+
Write both changes to the file.
|
|
781
|
+
|
|
782
|
+
Then update `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` — pick the column by which tech-doc was reviewed (read the filename):
|
|
783
|
+
- **BE contract** (`{UC-ID}-tech-design.md`) → set `tech_doc_revision` to the new `@trace.revision` integer for all rows of this UC.
|
|
784
|
+
- **FE tech-design** (`{UC-ID}-tech-design-{platform}.md`) → set `fe_tech_doc_revision` instead, for the rows of this UC on that platform (leave `tech_doc_revision` untouched).
|
|
785
|
+
- Set `last_updated` to today's date (`YYYY-MM-DD`) for all rows of this UC.
|
|
786
|
+
|
|
787
|
+
Print the report after all file writes are complete.
|
|
788
|
+
|
|
789
|
+
```
|
|
790
|
+
/review-tech-docs --resume Applied — {target file}
|
|
791
|
+
UC: {UC-ID}
|
|
792
|
+
|
|
793
|
+
Applied : {N} findings ({critical} critical, {major} major, {minor} minor)
|
|
794
|
+
Skipped : {N} rejected/deferred
|
|
795
|
+
|
|
796
|
+
Changes:
|
|
797
|
+
- {change 1}
|
|
798
|
+
- {change 2}
|
|
799
|
+
|
|
800
|
+
Revision : {old} → {new}
|
|
801
|
+
Status : {approved | in-review}
|
|
802
|
+
|
|
803
|
+
Sign-off : {✅ All done — status set to approved
|
|
804
|
+
| 🔒 Pending: fe_team, sa — status set to in-review
|
|
805
|
+
Update @trace.sign_off in tech doc when each team confirms, then re-run /review-tech-docs}
|
|
806
|
+
|
|
807
|
+
Re-run /review-tech-docs {file} to confirm 0 remaining critical findings.
|
|
808
|
+
Next: {/generate-code {feature-file} ← only if status = approved
|
|
809
|
+
| Collect pending sign-offs → update @trace.sign_off → re-run /review-tech-docs}
|
|
810
|
+
→ if the tech-doc lives in the shared spec repo: commit + push it to the spec submodule so FE/App `/sync` the updated contract
|
|
811
|
+
```
|