@educa-corp/sdd-framework 0.5.0 → 0.7.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 +113 -19
- package/bin/gate-trace.js +487 -0
- package/bin/index.js +445 -146
- package/bin/lint-trace.js +643 -0
- package/bin/self-check.js +804 -2
- package/bin/trace-schema.json +621 -10
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/README.md +20 -0
- package/core/commands/amend-prd.md +518 -0
- package/core/commands/debug.md +123 -511
- package/core/commands/define-product.md +86 -510
- package/core/commands/dev-gen-test.md +86 -510
- package/core/commands/dev-run-test.md +133 -519
- package/core/commands/dev-smoke-test.md +86 -510
- package/core/commands/extend-prd.md +128 -522
- package/core/commands/fix-bug.md +118 -509
- package/core/commands/generate-architecture.md +94 -515
- package/core/commands/generate-bdd.md +128 -513
- package/core/commands/generate-code.md +119 -510
- package/core/commands/generate-design-spec.md +86 -510
- package/core/commands/generate-prd.md +89 -510
- package/core/commands/generate-spec-manifest.md +86 -510
- package/core/commands/generate-tech-docs.md +120 -512
- package/core/commands/learn.md +172 -496
- package/core/commands/map-testids.md +86 -510
- package/core/commands/propose-scenario.md +86 -510
- package/core/commands/qc-analyze.md +86 -510
- package/core/commands/qc-design-test.md +86 -510
- package/core/commands/qc-plan.md +86 -510
- package/core/commands/qc-report.md +86 -510
- package/core/commands/qc-review.md +86 -510
- package/core/commands/qc-run-test.md +115 -513
- package/core/commands/refine-prd.md +112 -522
- package/core/commands/report-bug.md +86 -510
- package/core/commands/review-code.md +123 -511
- package/core/commands/review-context.md +136 -522
- package/core/commands/review-tech-docs.md +90 -511
- package/core/commands/setup-ai-first.md +166 -138
- package/core/commands/sync.md +155 -107
- package/core/commands/update-framework.md +16 -103
- package/core/commands/validate-traces.md +426 -511
- package/core/hooks/data-guard.js +174 -83
- package/core/hooks/settings.json +2 -1
- package/core/rules/workflow.md +64 -4
- package/core/steps/capture-lesson.md +34 -1
- package/core/steps/context-loader.md +50 -8
- package/core/steps/gate.md +92 -35
- package/core/steps/report-footer.md +23 -0
- package/core/templates/README.md +24 -1
- package/core/templates/ci/trace-gate.yml +146 -0
- package/core/templates/feature.template +1 -1
- package/core/templates/hooks/pre-push +61 -0
- package/docs/02-concepts/architecture.md +61 -6
- package/docs/02-concepts/traceability.md +57 -0
- package/docs/03-guides/architect.md +63 -0
- package/docs/04-reference/commands.md +148 -134
- package/docs/04-reference/model-selection.md +32 -19
- package/docs/04-reference/trace-schema.md +39 -0
- package/docs/explain/02b-extend-prd.md +1 -1
- package/docs/explain/02c-amend-prd.md +152 -0
- package/docs/explain/21-validate-traces.md +2 -1
- package/docs/explain/27-learn.md +5 -3
- package/docs/explain/28-sync.md +25 -0
- package/docs/explain/README.md +136 -135
- package/package.json +5 -9
- package/commands/debug.md +0 -917
- package/commands/debug.tmpl +0 -257
- package/commands/define-product.md +0 -862
- package/commands/define-product.tmpl +0 -225
- package/commands/dev-gen-test.md +0 -1124
- package/commands/dev-gen-test.tmpl +0 -490
- package/commands/dev-run-test.md +0 -859
- package/commands/dev-run-test.tmpl +0 -225
- package/commands/dev-smoke-test.md +0 -798
- package/commands/dev-smoke-test.tmpl +0 -217
- package/commands/extend-prd.md +0 -907
- package/commands/extend-prd.tmpl +0 -270
- package/commands/fix-bug.md +0 -910
- package/commands/fix-bug.tmpl +0 -197
- package/commands/generate-architecture.md +0 -775
- package/commands/generate-architecture.tmpl +0 -194
- package/commands/generate-bdd.md +0 -1347
- package/commands/generate-bdd.tmpl +0 -590
- package/commands/generate-code.md +0 -1283
- package/commands/generate-code.tmpl +0 -649
- package/commands/generate-design-spec.md +0 -1161
- package/commands/generate-design-spec.tmpl +0 -524
- package/commands/generate-prd.md +0 -1143
- package/commands/generate-prd.tmpl +0 -223
- package/commands/generate-spec-manifest.md +0 -745
- package/commands/generate-spec-manifest.tmpl +0 -164
- package/commands/generate-tech-docs.md +0 -1344
- package/commands/generate-tech-docs.tmpl +0 -273
- package/commands/learn.md +0 -723
- package/commands/learn.tmpl +0 -63
- package/commands/map-testids.md +0 -662
- package/commands/map-testids.tmpl +0 -81
- package/commands/propose-scenario.md +0 -783
- package/commands/propose-scenario.tmpl +0 -202
- package/commands/qc-analyze.md +0 -693
- package/commands/qc-analyze.tmpl +0 -112
- package/commands/qc-design-test.md +0 -650
- package/commands/qc-design-test.tmpl +0 -69
- package/commands/qc-plan.md +0 -630
- package/commands/qc-plan.tmpl +0 -49
- package/commands/qc-report.md +0 -641
- package/commands/qc-report.tmpl +0 -60
- package/commands/qc-review.md +0 -634
- package/commands/qc-review.tmpl +0 -53
- package/commands/qc-run-test.md +0 -750
- package/commands/qc-run-test.tmpl +0 -116
- package/commands/refine-prd.md +0 -1074
- package/commands/refine-prd.tmpl +0 -278
- package/commands/report-bug.md +0 -729
- package/commands/report-bug.tmpl +0 -148
- package/commands/review-code.md +0 -803
- package/commands/review-code.tmpl +0 -143
- package/commands/review-context.md +0 -1323
- package/commands/review-context.tmpl +0 -527
- package/commands/review-tech-docs.md +0 -982
- package/commands/review-tech-docs.tmpl +0 -401
- package/commands/setup-ai-first.md +0 -574
- package/commands/setup-ai-first.tmpl +0 -378
- package/commands/sync.md +0 -486
- package/commands/sync.tmpl +0 -384
- package/commands/update-framework.md +0 -290
- package/commands/update-framework.tmpl +0 -188
- package/commands/validate-traces.md +0 -1435
- package/commands/validate-traces.tmpl +0 -854
- package/hooks/data-guard.js +0 -141
- package/hooks/settings.json +0 -18
- package/modules/android-compose/module.yaml +0 -13
- package/modules/android-compose/stack-profile.yaml +0 -57
- package/modules/angular/architecture-snippets/component-patterns.md +0 -187
- package/modules/angular/module.yaml +0 -6
- package/modules/angular/stack-profile.yaml +0 -38
- package/modules/context-engineering/architecture-snippets/context-design.md +0 -119
- package/modules/context-engineering/module.yaml +0 -9
- package/modules/context-engineering/stack-profile.yaml +0 -61
- package/modules/dotnet/architecture-snippets/clean-arch.md +0 -160
- package/modules/dotnet/module.yaml +0 -6
- package/modules/dotnet/stack-profile.yaml +0 -50
- package/modules/flutter/module.yaml +0 -14
- package/modules/flutter/stack-profile.yaml +0 -59
- package/modules/golang/architecture-snippets/domain-layout.md +0 -283
- package/modules/golang/module.yaml +0 -6
- package/modules/golang/stack-profile.yaml +0 -40
- package/modules/ios-swiftui/module.yaml +0 -13
- package/modules/ios-swiftui/stack-profile.yaml +0 -55
- package/modules/java-spring/architecture-snippets/layered-arch.md +0 -201
- package/modules/java-spring/module.yaml +0 -15
- package/modules/java-spring/stack-profile.yaml +0 -28
- package/modules/nextjs/architecture-snippets/app-router-patterns.md +0 -269
- package/modules/nextjs/module.yaml +0 -14
- package/modules/nextjs/stack-profile.yaml +0 -74
- package/modules/nuxt/module.yaml +0 -14
- package/modules/nuxt/stack-profile.yaml +0 -58
- package/modules/phaser-game/architecture-snippets/phaser-scene-patterns.md +0 -646
- package/modules/phaser-game/module.yaml +0 -15
- package/modules/phaser-game/stack-profile.yaml +0 -90
- package/modules/php-laravel/architecture-snippets/service-repository.md +0 -302
- package/modules/php-laravel/module.yaml +0 -15
- package/modules/php-laravel/stack-profile.yaml +0 -56
- package/modules/qc-playwright/stack-profile.yaml +0 -66
- package/modules/react/architecture-snippets/hooks-query-patterns.md +0 -254
- package/modules/react/module.yaml +0 -14
- package/modules/react/stack-profile.yaml +0 -63
- package/modules/react-native/module.yaml +0 -14
- package/modules/react-native/stack-profile.yaml +0 -56
- package/modules/vue/module.yaml +0 -14
- package/modules/vue/stack-profile.yaml +0 -65
- package/rules/data-protection.md +0 -80
- package/rules/workflow.md +0 -73
- package/scripts/init.sh +0 -49
- package/scripts/upgrade.sh +0 -94
- package/skills/code/SKILL.md +0 -19
- package/skills/code/SKILL.tmpl +0 -19
- package/skills/debug/SKILL.md +0 -19
- package/skills/debug/SKILL.tmpl +0 -19
- package/skills/design-spec/SKILL.md +0 -11
- package/skills/design-spec/SKILL.tmpl +0 -11
- package/skills/discovery/SKILL.md +0 -14
- package/skills/discovery/SKILL.tmpl +0 -14
- package/skills/prd/SKILL.md +0 -19
- package/skills/prd/SKILL.tmpl +0 -19
- package/skills/qc/qa-analyst/DOC_GAPS.template.md +0 -63
- package/skills/qc/qa-analyst/acceptance-criteria.md +0 -60
- package/skills/qc/qa-analyst/business-rules.md +0 -59
- package/skills/qc/qa-analyst/data-flow.md +0 -64
- package/skills/qc/qa-analyst/spec-breakdown.md +0 -61
- package/skills/qc/qa-designer/e2e/journey.md +0 -41
- package/skills/qc/qa-designer/exploratory/charter.md +0 -68
- package/skills/qc/qa-designer/exploratory/explore-to-functional.md +0 -43
- package/skills/qc/qa-designer/functional/api.md +0 -45
- package/skills/qc/qa-designer/functional/gui-feature.md +0 -46
- package/skills/qc/qa-designer/functional/gui-screen.md +0 -52
- package/skills/qc/qa-designer/integration/api.md +0 -42
- package/skills/qc/qa-designer/integration/db.md +0 -39
- package/skills/qc/qa-designer/integration/gui.md +0 -40
- package/skills/qc/qa-designer/integration/kafka.md +0 -40
- package/skills/qc/qa-designer/non-functional.md +0 -40
- package/skills/qc/qa-planner/test-plan.md +0 -120
- package/skills/qc/qa-reviewer/script/e2e.md +0 -87
- package/skills/qc/qa-reviewer/script/exploratory.md +0 -45
- package/skills/qc/qa-reviewer/script/functional.md +0 -101
- package/skills/qc/qa-reviewer/script/integration.md +0 -91
- package/skills/qc/qa-reviewer/script/non-functional.md +0 -126
- package/skills/qc/qa-reviewer/test-case/e2e.md +0 -73
- package/skills/qc/qa-reviewer/test-case/exploratory.md +0 -43
- package/skills/qc/qa-reviewer/test-case/functional.md +0 -76
- package/skills/qc/qa-reviewer/test-case/integration.md +0 -69
- package/skills/qc/qa-reviewer/test-case/non-functional.md +0 -73
- package/skills/qc/qa-runner/e2e.md +0 -49
- package/skills/qc/qa-runner/exploratory/session.md +0 -36
- package/skills/qc/qa-runner/functional/api.md +0 -35
- package/skills/qc/qa-runner/functional/gui-feature.md +0 -51
- package/skills/qc/qa-runner/functional/gui-screen.md +0 -55
- package/skills/qc/qa-runner/integration.md +0 -47
- package/skills/qc/qa-runner/non-functional.md +0 -49
- package/skills/qc/qa-runner/report/report.md +0 -37
- package/skills/setup-ai-first/SKILL.md +0 -19
- package/skills/setup-ai-first/SKILL.tmpl +0 -19
- package/skills/spec/SKILL.md +0 -19
- package/skills/spec/SKILL.tmpl +0 -19
- package/skills/test/SKILL.md +0 -18
- package/skills/test/SKILL.tmpl +0 -18
- package/steps/business-language.md +0 -56
- package/steps/capture-lesson.md +0 -79
- package/steps/context-loader.md +0 -385
- package/steps/gate.md +0 -94
- package/steps/report-footer.md +0 -102
- package/steps/review-fanout.md +0 -159
- package/steps/spawn-agent.md +0 -129
- package/steps/trace-mirror.md +0 -53
- package/templates/README.md +0 -47
- package/templates/architecture.template.md +0 -394
- package/templates/design-spec.template.md +0 -217
- package/templates/feature.template +0 -123
- package/templates/platform-guide.template.md +0 -145
- package/templates/prd.template.md +0 -283
- package/templates/product-definition.template.md +0 -188
- package/templates/project-context.yaml +0 -212
- package/templates/tech-design.template.md +0 -490
|
@@ -1,1283 +0,0 @@
|
|
|
1
|
-
# /generate-code — Sinh Implementation Code
|
|
2
|
-
|
|
3
|
-
## Gate
|
|
4
|
-
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
5
|
-
|
|
6
|
-
Mọi lệnh PHẢI chạy gate này trước khi thực thi phần logic riêng của nó.
|
|
7
|
-
|
|
8
|
-
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
9
|
-
|
|
10
|
-
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
11
|
-
|
|
12
|
-
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
13
|
-
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
14
|
-
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
15
|
-
- Đặt target file = `payload.target_file`
|
|
16
|
-
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
|
-
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
|
-
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
-
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
20
|
-
- Đi thẳng tới phần logic riêng của lệnh.
|
|
21
|
-
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
22
|
-
|
|
23
|
-
## Bước 0-B — Kiểm tra Model
|
|
24
|
-
|
|
25
|
-
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
26
|
-
|
|
27
|
-
Các lệnh sinh nội dung và review phức tạp đòi hỏi khả năng suy luận mạnh.
|
|
28
|
-
Dùng model nhỏ hơn sẽ rủi ro: bỏ sót edge case, phân tích spec thiếu sót, vi phạm kiến trúc.
|
|
29
|
-
|
|
30
|
-
Hiển thị và chờ phản hồi:
|
|
31
|
-
|
|
32
|
-
```
|
|
33
|
-
⚙️ MODEL CHECK
|
|
34
|
-
──────────────────────────────────────────────────────────────────
|
|
35
|
-
Recommended : model Opus mới nhất
|
|
36
|
-
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
37
|
-
suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
|
|
38
|
-
|
|
39
|
-
Cách đổi trong Claude Code:
|
|
40
|
-
• /model → chọn model Opus
|
|
41
|
-
• hoặc: Settings → Model
|
|
42
|
-
|
|
43
|
-
Đang chạy một model Opus?
|
|
44
|
-
Y — đúng → tiếp tục
|
|
45
|
-
S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
|
|
46
|
-
──────────────────────────────────────────────────────────────────
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
- "Y" → tiếp tục sang Bước 1.
|
|
50
|
-
- "S" → tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
|
|
51
|
-
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang một model Opus (`/model`) rồi chạy lại lệnh này."
|
|
52
|
-
|
|
53
|
-
## Bước 1 — Xác định Target File
|
|
54
|
-
|
|
55
|
-
0. **Tách cờ trước khi resolve target.** `$ARGUMENTS` có thể lẫn các `--flag` (vd `--phase=integration`, `--comment`, `--fix`). **Loại bỏ mọi token bắt đầu bằng `--`** ra khỏi phần dùng để tìm target — chỉ giữ phần path/UC-ID/ticket. (Các flag đó do phần logic riêng của lệnh parse ở bước sau, KHÔNG phải tên file.)
|
|
56
|
-
1. Nếu `$ARGUMENTS` (đã tách cờ) được cung cấp và trỏ tới một file tồn tại → dùng trực tiếp làm target.
|
|
57
|
-
2. Nếu `$ARGUMENTS` là một **UC-ID / ticket ID / tên rút gọn** (không có path) → phân giải thành file bằng cách glob theo bố cục feature-package. `{prd-slug}` lúc này **chưa biết**, nên dùng wildcard `*` cho segment đó, và `**` đệ quy dưới `bdd/` để phủ hết các thư mục con theo platform (`bdd/web/`, `bdd/app/`, `bdd/system/`):
|
|
58
|
-
- **Lệnh BDD** (target là `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — hoặc `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` nếu domain cũng chưa biết. Nếu lệnh ngụ ý một platform/scope cụ thể (vd: system tech-doc cần BDD `system/`), ưu tiên kết quả trong thư mục con platform đó.
|
|
59
|
-
- **Lệnh PRD** (target là file PRD `{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder, cạnh `bdd/`): `{specs_dir}/{domain}/*/{TICKET-ID}*.md` nếu biết TICKET-ID; nếu không, `{specs_dir}/{domain}/*/*.md` (khớp feature folder có id tương ứng), hoặc `{specs_dir}/*/*/*.md` nếu domain cũng chưa biết. *(Glob `*/*.md` ở cấp gốc folder chỉ khớp PRD — tech-docs/design-spec `.md` nằm sâu hơn trong thư mục con.)*
|
|
60
|
-
- **Lệnh tech-docs** — target là tech-doc **gộp cấp PRD** `{TICKET-ID}-tech-design.md` (MỘT doc phủ nhiều UC; danh sách UC nằm ở `@trace.ucs`). Vì tên file mang `{TICKET-ID}` chứ **không** mang `{UC-ID}`, phải tách trước khi glob:
|
|
61
|
-
- `$ARGUMENTS` là **UC-ID** (`{TICKET-ID}-UC{N}`) → lấy `{TICKET-ID}` = phần **trước** `-UC`, rồi glob `{specs_dir}/{domain}/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
62
|
-
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
63
|
-
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
64
|
-
- Vẫn không khớp → glob rộng `{specs_dir}/*/*/tech-docs/*tech-design*.md` rồi liệt kê để người dùng chọn.
|
|
65
|
-
*(Đừng glob `{UC-ID}*-tech-design*.md` — nó nở thành `FT-001-UC1*-tech-design*.md` và **không bao giờ** khớp `FT-001-tech-design.md`.)*
|
|
66
|
-
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
67
|
-
|
|
68
|
-
Khi một file khớp: đặt nó làm target **và** ghi lại `domain` + `prd_slug` từ path của nó (theo quy tắc trích xuất trong `context-loader.md` Bước 1 — `prd_slug` = segment đầu tiên sau `{specs_dir}/{domain}/`). Mọi path mà lệnh đọc/ghi về sau (BDD/tech-docs/design-spec/trace cùng cấp) đều dùng **`prd_slug` đã phân giải đó**, nên tất cả artifact nằm chung một feature package. Nếu nhiều file khớp (vd: nhiều platform), chọn theo platform/scope của lệnh hoặc liệt kê ra và hỏi.
|
|
69
|
-
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
70
|
-
- Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/*.md` — file PRD ở gốc mỗi feature folder — cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
|
|
71
|
-
- Hiển thị danh sách cho người dùng và hỏi: "Bạn muốn làm việc với file nào? (Nhập số thứ tự hoặc tên file)"
|
|
72
|
-
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
73
|
-
|
|
74
|
-
## Bước 2 — Chạy Context Loader
|
|
75
|
-
|
|
76
|
-
Nạp toàn bộ context của dự án bằng cách làm theo quy trình trong `steps/context-loader.md`.
|
|
77
|
-
Lưu toàn bộ context đã nạp vào bộ nhớ để dùng xuyên suốt phiên làm việc của lệnh.
|
|
78
|
-
|
|
79
|
-
## Bước 3 — CHECKPOINT
|
|
80
|
-
|
|
81
|
-
Sau khi hoàn thành Bước 1 và 2, hiển thị bản tóm tắt và chờ xác nhận:
|
|
82
|
-
|
|
83
|
-
```
|
|
84
|
-
CHECKPOINT
|
|
85
|
-
-----------
|
|
86
|
-
Target : {resolved file path}
|
|
87
|
-
Project : {project.name từ project-context.yaml}
|
|
88
|
-
Tech stack : {language} / {framework}
|
|
89
|
-
Module : {module nếu có, else "not configured"}
|
|
90
|
-
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
91
|
-
|
|
92
|
-
Tiếp tục? (Y/N)
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
96
|
-
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
97
|
-
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
*Lưu ý: Với lệnh này, target ở Bước 1 là một file `.feature` hoặc UC-ID. Nếu `$ARGUMENTS` là UC-ID, tìm file feature khớp bằng cách glob `{paths.specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` (wildcard `*` cho prd-slug chưa biết, `**` đệ quy để phủ các thư mục con platform `web/`·`app/`·`system/`); lấy `domain` + `prd_slug` từ path khớp. Cũng kiểm tra `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{@trace.platform}.tsv` tìm drift (new vs drifted vs synced).*
|
|
101
|
-
|
|
102
|
-
## Context
|
|
103
|
-
# Context Loader — Nạp toàn bộ context dự án
|
|
104
|
-
|
|
105
|
-
Thực hiện các bước theo đúng thứ tự. Lưu mọi thứ vào bộ nhớ trong suốt phiên làm việc của lệnh.
|
|
106
|
-
|
|
107
|
-
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
108
|
-
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
109
|
-
- Bước 3 là CRITICAL — kiến trúc + coding standards, là các sự thật ưu tiên cao nhất khi sinh nội dung.
|
|
110
|
-
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
111
|
-
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
112
|
-
- Bước 7 là WORKING MEMORY RECAP — chốt các sự thật quan trọng lên đầu bộ nhớ làm việc.
|
|
113
|
-
|
|
114
|
-
---
|
|
115
|
-
|
|
116
|
-
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
117
|
-
|
|
118
|
-
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
119
|
-
|
|
120
|
-
**Tech Stack:**
|
|
121
|
-
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
122
|
-
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
123
|
-
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
124
|
-
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
125
|
-
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
126
|
-
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
127
|
-
|
|
128
|
-
**Conventions:**
|
|
129
|
-
- `conventions.build_command` → cách compile/build
|
|
130
|
-
- `conventions.test_command` → cách chạy test
|
|
131
|
-
- `conventions.service_run` → cách khởi động service
|
|
132
|
-
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
133
|
-
|
|
134
|
-
**Domains:**
|
|
135
|
-
- `domains` → danh sách các business domain đang hoạt động
|
|
136
|
-
|
|
137
|
-
**Paths (nếu có):**
|
|
138
|
-
- `paths.specs_dir` → gốc của spec artifact — PRD, BDD, tech-docs, design-spec. Cấu trúc: `{specs_dir}/{domain}/{prd-slug}/{ {TICKET-ID}-{prd-slug}.md | bdd/ | tech-docs/ | design-spec/}` (file PRD đặt tên `{TICKET-ID}-{prd-slug}.md`, là file `.md` duy nhất ở gốc feature folder)
|
|
139
|
-
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
140
|
-
- `paths.qc_dir` → gốc artifact QC automation (hiện ở top-level, mỗi UC một thư mục con: `{qc_dir}/{UC-ID}/`)
|
|
141
|
-
- `paths.qc_skills_dir` → nơi các lệnh qc-* nạp QC skill (mặc định bundled `.agent/skills/qc`; override sang repo/submodule riêng của team QC để bản nâng cấp framework không ghi đè)
|
|
142
|
-
- `paths.product_definitions_dir` → gốc product definition
|
|
143
|
-
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
144
|
-
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
145
|
-
- `paths.core_entities` → path tới core-entities.md
|
|
146
|
-
- `paths.tech_docs_dir` → gốc tài liệu kỹ thuật (gộp với specs_dir trong bố cục feature-package — tech-docs nằm dưới `{specs_dir}/{domain}/{prd-slug}/tech-docs/`)
|
|
147
|
-
- `paths.src_dir` → gốc mã nguồn (nơi generate-code đặt & quét code; nguồn chính cho FE + phạm vi reuse-scan của DS5)
|
|
148
|
-
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` (mỗi UC × platform một sổ)
|
|
149
|
-
|
|
150
|
-
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
151
|
-
- `specs_dir` = `specs`
|
|
152
|
-
- `refinement_dir` = `.agent/review`
|
|
153
|
-
- `qc_dir` = `docs`
|
|
154
|
-
- `qc_skills_dir` = `.agent/skills/qc`
|
|
155
|
-
- `product_definitions_dir` = `specs/product-definition`
|
|
156
|
-
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
157
|
-
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
158
|
-
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
159
|
-
- `tech_docs_dir` = `specs`
|
|
160
|
-
- `src_dir` = `src`
|
|
161
|
-
- `trace_dir` = `.trace`
|
|
162
|
-
|
|
163
|
-
Lưu ý: Trong bố cục feature-package, `specs_dir` là gốc thống nhất. Mọi loại spec artifact (PRD, BDD, tech-docs, design-spec) đều nằm dưới `{specs_dir}/{domain}/{prd-slug}/`. `prd-slug` là tên folder feature-package, không phải một biến config riêng.
|
|
164
|
-
|
|
165
|
-
**Cách trích xuất `prd_slug` (đúng cho MỌI target file, bất kể độ sâu lồng nhau):** với một path target dạng `{specs_dir}/{domain}/{prd-slug}/...`, lấy **segment path đầu tiên sau `{specs_dir}/{domain}/`** — tức vị trí `{prd-slug}`. KHÔNG dùng folder cha trực tiếp của file, vì artifact BDD/tech-docs/design-spec lồng sâu hơn một hoặc hai cấp bên trong package. Ví dụ:
|
|
166
|
-
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
167
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
168
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
169
|
-
- `specs/payment/create-invoice/tech-docs/PAY01-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
170
|
-
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
171
|
-
|
|
172
|
-
Mọi artifact cùng cấp của một feature (PRD, BDD của từng platform, tech-docs BE + FE, design-spec, và trace TSV) đều phân giải về **cùng một `prd_slug`** — nên một BDD **system** hay tech-doc **system/BE** được tổng hợp sẽ nằm chung package `{specs_dir}/{domain}/{prd-slug}/` với các artifact web/app mà nó được suy ra từ đó.
|
|
173
|
-
|
|
174
|
-
Nếu `tech_stack.module` được đặt, đồng thời nạp `.agent/modules/{module}/stack-profile.yaml` nếu file tồn tại.
|
|
175
|
-
|
|
176
|
-
---
|
|
177
|
-
|
|
178
|
-
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
179
|
-
|
|
180
|
-
*Bỏ qua hoàn toàn bước này nếu `setup.mode` không phải `"umbrella"` và không có section `services` trong project-context.yaml.*
|
|
181
|
-
|
|
182
|
-
Nếu có section `services`:
|
|
183
|
-
|
|
184
|
-
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
185
|
-
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
186
|
-
- Trích xuất từ path target file: `domain` = segment đầu tiên sau base path `specs_dir`; `prd_slug` = segment kế tiếp (folder feature-package). Điều này đúng ở mọi độ sâu target — xem quy tắc trích xuất `prd_slug` ở Bước 1.
|
|
187
|
-
*(vd: `specs/user/create-account/USR01-create-account.md` **và** `specs/user/create-account/bdd/system/UC1.feature` đều → domain = `user`, prd_slug = `create-account`)*
|
|
188
|
-
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
189
|
-
|
|
190
|
-
**1b. Phát hiện active platform** (chỉ cần khi service ở dạng map-theo-platform — bước 2b):
|
|
191
|
-
- Đọc `@trace.platform` từ header của target `.feature` (`system` | `web` | `app`) — Gate đã resolve target trước bước này.
|
|
192
|
-
- Nếu target không mang `@trace.platform` (vd target là PRD `.md`), thử suy từ segment `bdd/{platform}/` trong path target.
|
|
193
|
-
- Nếu vẫn không xác định được → `active_platform = null`.
|
|
194
|
-
|
|
195
|
-
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
196
|
-
|
|
197
|
-
Hình dung việc này như **tra địa chỉ**: đi từ `domain`, có thể qua `platform`, có thể qua `prd_slug`, cho tới khi chỉ còn đúng một submodule.
|
|
198
|
-
|
|
199
|
-
Thứ trỏ tới đích gọi là một **service entry**. Nó chỉ có hai kiểu:
|
|
200
|
-
|
|
201
|
-
| Kiểu | Nhận ra bằng | Nghĩa |
|
|
202
|
-
|---|---|---|
|
|
203
|
-
| **Đã chốt** | có `path` | Xong — đây là submodule cần tìm |
|
|
204
|
-
| **Tra tiếp** | có `by_prd_slug` | Ô này còn nhiều submodule → tra thêm một nấc bằng `prd_slug` (2c) |
|
|
205
|
-
|
|
206
|
-
**Kiểm tra hợp lệ TRƯỚC khi dùng một entry** (làm ngay, đừng đợi tới 2a/2b/2c — sai ở đây mà đi tiếp là route nhầm repo mà không báo gì):
|
|
207
|
-
|
|
208
|
-
| Entry trông thế nào | Xử lý |
|
|
209
|
-
|---|---|
|
|
210
|
-
| có `path`, không có `by_prd_slug` | hợp lệ → dùng |
|
|
211
|
-
| có `by_prd_slug`, không có `path` | hợp lệ → tra tiếp (2c) |
|
|
212
|
-
| **có CẢ HAI** | ❌ lỗi cấu hình → `active_service = unresolved`. **KHÔNG** ưu tiên `path` rồi bỏ qua `by_prd_slug` — như vậy mọi feature sẽ âm thầm route về cùng một repo. Báo đúng key sai để người dùng sửa. |
|
|
213
|
-
| **không có cái nào** (và cũng không phải map platform) | ❌ lỗi cấu hình → `unresolved`, nêu rõ entry thiếu `path`/`by_prd_slug` |
|
|
214
|
-
| `by_prd_slug` chứa entry lại có `by_prd_slug` | ❌ lỗi cấu hình → `unresolved`. Chỉ tra đúng **một** nấc slug, không đệ quy |
|
|
215
|
-
|
|
216
|
-
Còn `services.{domain}` thì có thể là **một service entry** (chốt luôn ở cấp domain), hoặc **một map platform → service entry** (phải qua nấc platform trước). Nhận dạng theo đúng thứ tự này:
|
|
217
|
-
|
|
218
|
-
| Thấy gì trong `services.{domain}` | Đi nhánh |
|
|
219
|
-
|---|---|
|
|
220
|
-
| có `path` | **2a** — chốt luôn |
|
|
221
|
-
| có `by_prd_slug` | **2c** — tra bằng `prd_slug` |
|
|
222
|
-
| không có cả hai (chỉ có các sub-key `system`/`web`/`app`…) | **2b** — tra bằng `platform`, rồi lặp lại đúng bảng này cho entry con |
|
|
223
|
-
|
|
224
|
-
**2a. Dạng phẳng** — `services.{domain}` có **trực tiếp** `path`/`module` (một domain ↔ một service, mọi platform về cùng submodule). Route như cũ:
|
|
225
|
-
- Lưu `active_service` = `services.{domain}.path`
|
|
226
|
-
- Lưu `active_service_module` = `services.{domain}.module`
|
|
227
|
-
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
228
|
-
|
|
229
|
-
**2b. Dạng map-theo-platform** — `services.{domain}` **KHÔNG** có `path` trực tiếp mà chứa các sub-key platform (`system` / `web` / `app`), mỗi cái là một **service entry** (một business-domain trải trên nhiều platform/submodule). Route theo `active_platform` (bước 1b):
|
|
230
|
-
- Nếu `active_platform` khớp một sub-key → `entry = services.{domain}.{active_platform}`. Nếu `entry` có `path` → lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`). Nếu `entry` có `by_prd_slug` → **đi tiếp sang 2c** với entry đó.
|
|
231
|
-
- Nếu `active_platform = null` (chưa xác định platform, vd đang thao tác cấp PRD) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = platform`, và lưu `service_candidates` = map platform→`{path, module}`. **Làm phẳng luôn ở đây:** platform nào có entry `by_prd_slug` thì giải bằng `prd_slug` hiện tại (target cấp PRD vẫn nằm trong một feature-package nên `prd_slug` đã biết từ bước 1) → `service_candidates.{platform}` vẫn là `{path, module}` phẳng. Nếu `prd_slug` không khớp key nào, ghi platform đó là `unresolved` kèm lý do thay vì bỏ im. Nhờ vậy **mọi lệnh downstream chỉ cần biết một kiểu `service_candidates`**. Lệnh cần một service cụ thể (`/generate-code`, `/dev-*`, `/fix-bug`) luôn chạy trên target `.feature` có platform nên sẽ resolve được ở lần chạy đó; lệnh cấp PRD (`/generate-prd`, `/refine-prd`) không cần service cụ thể.
|
|
232
|
-
- Nếu `active_platform` xác định nhưng không có sub-key tương ứng → `active_service = unresolved` (xem Fallback) với lý do "domain `{domain}` chưa cấu hình platform `{active_platform}`".
|
|
233
|
-
|
|
234
|
-
**2c. Dạng map-theo-prd_slug** — một service entry chứa `by_prd_slug` thay cho `path`: **một ô của bảng định tuyến ứng với NHIỀU submodule**, mỗi feature-package một submodule. Dùng khi một platform (hoặc cả một domain) bị chia thành nhiều repo theo feature — ví dụ mỗi mini-game webview là một repo riêng.
|
|
235
|
-
|
|
236
|
-
Đến đây `prd_slug` đã được trích ở bước 1 (không cần detect thêm gì). Route:
|
|
237
|
-
|
|
238
|
-
- Nếu `prd_slug` khớp một key dưới `by_prd_slug` → `entry = {…}.by_prd_slug.{prd_slug}`; lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`).
|
|
239
|
-
**"Khớp" ở đây là khớp CHÍNH XÁC toàn chuỗi, phân biệt hoa/thường.** KHÔNG prefix, KHÔNG bỏ hậu tố, KHÔNG so gần đúng: `dap-chuot-v2` **không** khớp key `dap-chuot`; `Ban-Cung` **không** khớp `ban-cung`. Feature mới tách ra từ một feature cũ là một repo khác cho tới khi có người khai nó vào bảng.
|
|
240
|
-
- Nếu `prd_slug = null` (chưa xác định feature-package — chỉ xảy ra khi không có target file, vd `$ARGUMENTS` rỗng) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = prd_slug`, và lưu `service_candidates` = toàn map `by_prd_slug` (slug → `{path, module}`).
|
|
241
|
-
⚠️ Đây là kiểu `service_candidates` **khác** với 2b — lệnh nào duyệt `service_candidates` theo platform (vd `/generate-bdd` sinh `bdd/{platform}/`) phải kiểm `service_candidates_kind = platform` trước; gặp `prd_slug` thì DỪNG và yêu cầu người dùng chỉ rõ target, đừng coi slug là platform.
|
|
242
|
-
- Nếu `prd_slug` xác định nhưng **không** có key tương ứng → `active_service = unresolved` với lý do rõ: "domain `{domain}`{, platform `{active_platform}`} chưa cấu hình prd_slug `{prd_slug}`". **KHÔNG** tự đoán submodule gần đúng theo tên.
|
|
243
|
-
|
|
244
|
-
Vị trí đặt `by_prd_slug` — hợp lệ ở **cả hai cấp**:
|
|
245
|
-
- **Dưới một platform** (lồng trong 2b): `services.{domain}.{platform}.by_prd_slug` — platform đó có nhiều repo, các platform khác vẫn `{path, module}` như thường.
|
|
246
|
-
- **Ngay dưới domain** (thay cho `path` của 2a): `services.{domain}.by_prd_slug` — domain không chia platform nhưng vẫn nhiều repo theo feature.
|
|
247
|
-
|
|
248
|
-
*(`by_prd_slug` lồng trong `by_prd_slug` là vô nghĩa — nếu gặp, coi là lỗi cấu hình: `active_service = unresolved`, nêu rõ để người dùng sửa file. Một entry vừa có `path` vừa có `by_prd_slug` cũng là lỗi cấu hình — báo lỗi, không âm thầm ưu tiên cái nào.)*
|
|
249
|
-
|
|
250
|
-
Ví dụ (một domain trải nhiều platform, riêng `webview` chia theo feature):
|
|
251
|
-
```yaml
|
|
252
|
-
services:
|
|
253
|
-
learning:
|
|
254
|
-
system: { path: "backend", module: "java-spring" }
|
|
255
|
-
web: { path: "web-app", module: "nextjs" }
|
|
256
|
-
webview:
|
|
257
|
-
by_prd_slug:
|
|
258
|
-
dap-chuot: { path: "games/whac-a-mole", module: "phaser-game" }
|
|
259
|
-
ban-cung: { path: "games/archery", module: "phaser-game" }
|
|
260
|
-
```
|
|
261
|
-
→ target `specs/learning/dap-chuot/bdd/webview/UC1.feature` cho `domain = learning`,
|
|
262
|
-
`active_platform = webview`, `prd_slug = dap-chuot` → `active_service = games/whac-a-mole`.
|
|
263
|
-
|
|
264
|
-
*(Cả 2a/2b/2c: override `paths.specs_dir`/`paths.tech_docs_dir` per-service CHỈ khi `setup.spec_source` KHÔNG được đặt. Khi `spec_source` ĐƯỢC đặt, MỌI BDD/tech-doc là artifact liên team → để bước 4 route sang spec repo; KHÔNG pin per-service ở đây.)*
|
|
265
|
-
|
|
266
|
-
**3. Fallback**:
|
|
267
|
-
- Không phát hiện được domain, hoặc domain không khớp key nào trong `services` → giữ path mặc định từ Bước 1, đặt `active_service = unresolved`.
|
|
268
|
-
- Domain khớp một map-theo-platform (2b) nhưng `active_platform` xác định mà thiếu sub-key tương ứng → `active_service = unresolved`, ghi lý do rõ để lệnh DỪNG báo lỗi cấu hình (không tự đoán platform).
|
|
269
|
-
- Entry là map-theo-prd_slug (2c) nhưng `prd_slug` xác định mà thiếu key tương ứng → `active_service = unresolved`, ghi lý do rõ (không tự đoán submodule).
|
|
270
|
-
- Entry sai cấu trúc (vừa có `path` vừa có `by_prd_slug`, hoặc `by_prd_slug` lồng nhau) → `active_service = unresolved`, nêu đúng key sai để người dùng sửa `project-context.yaml`.
|
|
271
|
-
|
|
272
|
-
**4. Tự động override theo spec source** — nếu `setup.spec_source` được đặt VÀ path tương ứng chưa được set tường minh trong `paths:`:
|
|
273
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt.** Mọi spec artifact (PRD, BDD, tech-docs, design-spec) nằm dưới gốc spec thống nhất trong spec repo dùng chung theo bố cục feature-package: `{spec_source}/specs/{domain}/{prd-slug}/`. Mọi umbrella (FE/App/BE) đều đọc từ đây. *(`specs/` theo service chỉ khi không có `spec_source`.)*
|
|
274
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt** (bước 2 không còn pin tech-docs theo service trong trường hợp này). Tech-docs nằm tại `{spec_source}/specs/{domain}/{prd-slug}/tech-docs/`. Tech-design CHÍNH LÀ API contract liên team: BE viết ở đây, FE/App đọc nó từ cùng spec submodule tại `/generate-code --phase=integration`. *(tech-docs theo service chỉ xảy ra khi không có `spec_source` — repo BE thuần đa-service không có spec module dùng chung.)*
|
|
275
|
-
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
276
|
-
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
277
|
-
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
278
|
-
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
279
|
-
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
280
|
-
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
281
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **luôn khi `spec_source` được đặt.** Trace TSV được gộp vào spec repo (một nơi authoritative duy nhất, không tách theo service) để PM/PO có một chỗ duy nhất quản lý trạng thái. Cấu trúc bên trong: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv`. Các lệnh phía code (`/generate-code`, `/dev-run-test`, `/qc-run-test`) chạy từ `service_root` nhưng **ghi trace row của chúng vào `{spec_source}/.trace/{domain}/{prd-slug}/`** — giống như chúng đã push `feedback/` vào đó. *(`.trace` theo service chỉ khi không có `spec_source`.)*
|
|
282
|
-
- Override `paths.refinement_dir` → `{spec_source}/.agent/review` — **luôn khi `spec_source` được đặt.** Findings review (`/refine-prd`, `/review-context`, `/review-tech-docs`) là artifact liên-team *về* tài liệu trong spec repo (PRD/BDD/tech-design) — thuộc cùng khu vực ghi với `.trace/` và `feedback/`. Các lệnh review chạy từ working dir của service (BE repo) nhưng **ghi findings vào `{spec_source}/.agent/review/`**, KHÔNG phải `.agent/review` của service repo. Bên trong flat, phân biệt bằng tên file đã prefix `{prd-slug}`/`{UC-ID}`/`{TICKET-ID}`. *(`.agent/review` theo service chỉ khi không có `spec_source`.)*
|
|
283
|
-
|
|
284
|
-
> **Vì sao đặt dưới `spec_source`:** PRD, BDD, tech-docs, design-spec, domain knowledge, feedback của tester, **trạng thái coverage `.trace/`**, **và findings review `.agent/review/`** đều là **artifact liên team** — chúng nằm trong **spec repo dùng chung** theo bố cục feature-package để mọi umbrella (FE/App/BE) và PM đọc từ một nguồn qua `/sync`. Trong bố cục feature-package, một folder `specs/{domain}/{prd-slug}/` gom tất cả loại artifact của một PRD, giúp spec repo tự đủ và dễ điều hướng theo feature. Service submodule chỉ chứa **code** (+ tooling build/test). `.trace/`, `.agent/review/` và `feedback/` là khu vực **ghi** của dev/QC/reviewer trong spec repo. Ở chế độ single-service (không có `spec_source`), mọi thứ mặc định dưới gốc repo — vẫn là một repo.
|
|
285
|
-
|
|
286
|
-
---
|
|
287
|
-
|
|
288
|
-
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
289
|
-
|
|
290
|
-
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc `"multi"` (chưa chốt một service — dạng map-theo-platform ở cấp PRD) hoặc context ở chế độ single-service.*
|
|
291
|
-
|
|
292
|
-
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
293
|
-
|
|
294
|
-
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
295
|
-
- `{active_service}/.agent/project-context.yaml`
|
|
296
|
-
- `{active_service}/project-context.yaml`
|
|
297
|
-
|
|
298
|
-
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
299
|
-
|
|
300
|
-
| Biến | Nguồn |
|
|
301
|
-
|----------|--------|
|
|
302
|
-
| `conventions.test_command` | `conventions.test_command` của service |
|
|
303
|
-
| `conventions.build_command` | `conventions.build_command` của service |
|
|
304
|
-
| `paths.trace_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/.trace`); bỏ qua mọi `trace_dir` cấp service.** Chỉ khi không có `spec_source`: `{active_service}/{service paths.trace_dir}` (mặc định `{active_service}/.trace`). |
|
|
305
|
-
| `paths.specs_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/specs`); bỏ qua mọi `specs_dir` cấp service** (mọi spec artifact đều liên team, không bao giờ theo service ở chế độ này). Chỉ khi không có `spec_source`: `{active_service}/{service paths.specs_dir}` nếu được set, else dùng override ở Bước 1.5. |
|
|
306
|
-
| `paths.refinement_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/.agent/review`); bỏ qua mọi `refinement_dir` cấp service** (findings review là artifact liên team). Chỉ khi không có `spec_source`: `{active_service}/.agent/review`. |
|
|
307
|
-
|
|
308
|
-
**3. Lưu** `service_root = {active_service}` làm mốc thư mục làm việc cho mọi lệnh phía sau:
|
|
309
|
-
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
310
|
-
- **File source/test** được ghi tương đối với `service_root`; **trace TSV** được ghi vào `{paths.trace_dir}` (là spec repo khi `spec_source` được đặt — một thao tác ghi liên-repo, commit/push vào spec submodule giống như `feedback/`).
|
|
311
|
-
|
|
312
|
-
**4. Nếu không tìm thấy config của service** — giữ mặc định umbrella, vẫn set `service_root = {active_service}` (luôn cần mốc path kể cả khi không có config override).
|
|
313
|
-
|
|
314
|
-
---
|
|
315
|
-
|
|
316
|
-
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
317
|
-
|
|
318
|
-
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
319
|
-
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
320
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
321
|
-
|
|
322
|
-
---
|
|
323
|
-
|
|
324
|
-
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
325
|
-
|
|
326
|
-
*Đây là context ưu tiên cao nhất — nó định nghĩa CÁCH viết code và tài liệu cho dự án này.*
|
|
327
|
-
|
|
328
|
-
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
329
|
-
riêng của service kết hợp đúng cách. Agent luôn đứng ở gốc umbrella, nhưng code triển khai nằm
|
|
330
|
-
trong một service submodule với stack, kiến trúc, và convention RIÊNG của nó — nên CLAUDE.md của
|
|
331
|
-
service phải thắng khi sinh code.
|
|
332
|
-
|
|
333
|
-
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
334
|
-
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
335
|
-
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
336
|
-
kiến trúc + coding standards duy nhất của dự án.
|
|
337
|
-
|
|
338
|
-
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
339
|
-
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
340
|
-
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
341
|
-
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
342
|
-
Overlay nó lên trên Tầng 1: **khi có xung đột, giá trị của service THẮNG** cho kiến trúc,
|
|
343
|
-
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
344
|
-
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
345
|
-
|
|
346
|
-
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
347
|
-
|
|
348
|
-
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
349
|
-
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
350
|
-
- **§2 Package Layout** → **base package** (vd `vn.edupia.{service}`) + **chiến lược đặt package** (by-layer / by-feature) + nơi code một domain sống. Đây là **quy ước đặt code trên đĩa**, PHẢI enforce khi sinh code. Nếu §2 chỉ nêu base package + thứ tự layer mà **không** nói tới sub-package theo feature → hiểu là **by-layer**: các layer đặt **TRỰC TIẾP** dưới base package (vd `vn.edupia.{service}.service`, `.repository`); feature/UC/prd-slug **KHÔNG** thành sub-package, chỉ phân biệt ở **tên class**. Lưu `code_base_package` + `package_strategy` — *service overlay thắng*.
|
|
351
|
-
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
352
|
-
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
353
|
-
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
354
|
-
|
|
355
|
-
**Quy tắc phân giải:**
|
|
356
|
-
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
357
|
-
- Nếu chỉ có service overlay (không có root CLAUDE.md) → dùng file service một mình; `claude_md_source = {service_root}`.
|
|
358
|
-
- Nếu `service_root` được set nhưng `{service_root}/CLAUDE.md` **thiếu** → fallback về root CLAUDE.md và gắn cờ ⚠️ trong recap Bước 7 (service không có định nghĩa kiến trúc/coding-standards — việc sinh code sẽ dùng mặc định umbrella, có thể sai stack).
|
|
359
|
-
- Nếu cả hai đều không tồn tại → ghi nhận CLAUDE.md thiếu và tiếp tục chỉ với dữ liệu từ project-context.yaml.
|
|
360
|
-
|
|
361
|
-
---
|
|
362
|
-
|
|
363
|
-
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
364
|
-
|
|
365
|
-
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
366
|
-
|
|
367
|
-
Lưu các pattern file nhạy cảm — bạn **tuyệt đối không** đọc, ghi, hiển thị, hay tham chiếu nội dung từ các file khớp những pattern đó trong suốt cả phiên.
|
|
368
|
-
|
|
369
|
-
Nếu cả hai file đều không tồn tại → áp dụng mặc định built-in: không bao giờ truy cập `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
|
|
370
|
-
|
|
371
|
-
---
|
|
372
|
-
|
|
373
|
-
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
374
|
-
|
|
375
|
-
Kiểm tra file business dictionary có tồn tại không (dùng `paths.business_dictionary` đã phân giải ở Bước 1).
|
|
376
|
-
|
|
377
|
-
Nếu tồn tại, đọc và trích xuất:
|
|
378
|
-
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
379
|
-
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
380
|
-
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
381
|
-
|
|
382
|
-
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
383
|
-
- Khi sinh bất kỳ văn bản nào (PRD, BDD, comment code, tech docs), kiểm tra không có banned term nào xuất hiện
|
|
384
|
-
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
385
|
-
|
|
386
|
-
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
387
|
-
|
|
388
|
-
---
|
|
389
|
-
|
|
390
|
-
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
391
|
-
|
|
392
|
-
Kiểm tra file core entities có tồn tại tại `paths.core_entities` không (đã phân giải ở Bước 1).
|
|
393
|
-
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
394
|
-
|
|
395
|
-
Nếu tồn tại, đọc và lưu:
|
|
396
|
-
- **Entity catalog** → với mỗi entity: tên, mục đích, service sở hữu, các field chính (tên + kiểu), business invariant, và quan hệ
|
|
397
|
-
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
398
|
-
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
399
|
-
|
|
400
|
-
**Cách dùng catalog này:**
|
|
401
|
-
- Khi sinh code: dùng tên field, kiểu, và quan hệ định nghĩa ở đây — KHÔNG suy đoán từ code có sẵn
|
|
402
|
-
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
403
|
-
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
404
|
-
|
|
405
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
406
|
-
|
|
407
|
-
---
|
|
408
|
-
|
|
409
|
-
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
410
|
-
|
|
411
|
-
Dùng `tech_stack.module` đã nạp ở Bước 1, suy ra và lưu hai biến để mọi lệnh phía sau dùng:
|
|
412
|
-
|
|
413
|
-
```
|
|
414
|
-
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
415
|
-
```
|
|
416
|
-
|
|
417
|
-
| `platform_type` | Modules |
|
|
418
|
-
|---|---|
|
|
419
|
-
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
420
|
-
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular`, `phaser-game` |
|
|
421
|
-
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
422
|
-
|
|
423
|
-
Nếu `tech_stack.module` rỗng hoặc không nhận diện được → set `platform_type = "unknown"` và gắn cờ ⚠️ trong recap Bước 7.
|
|
424
|
-
|
|
425
|
-
Hai biến này (`active_module`, `platform_type`) là nguồn chuẩn cho mọi logic rẽ nhánh trong các lệnh cần hành vi riêng theo platform (dev-gen-test, debug, fix-bug, dev-smoke-test).
|
|
426
|
-
|
|
427
|
-
---
|
|
428
|
-
|
|
429
|
-
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
430
|
-
|
|
431
|
-
*Các lỗi tích luỹ mà AI không được lặp lại trong dự án này. Chúng được bổ sung dần qua `/learn`
|
|
432
|
-
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
433
|
-
|
|
434
|
-
Phân giải path file lessons:
|
|
435
|
-
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
436
|
-
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
437
|
-
- Ở chế độ umbrella/service (khi `service_root` được set), nếu `paths.lessons_file` chưa set, mặc định `{service_root}/.agent/project-lessons.md`
|
|
438
|
-
|
|
439
|
-
Nếu file tồn tại, đọc và lưu TẤT CẢ lesson làm **GUARDRAIL ĐANG HOẠT ĐỘNG** cho phiên:
|
|
440
|
-
- Coi **Rule** của mỗi lesson là ràng buộc cứng — cùng mức ưu tiên với coding standards trong CLAUDE.md (Bước 3).
|
|
441
|
-
- Trước khi sinh hoặc sửa bất kỳ artifact nào (PRD, BDD, tech-doc, code, test), đối chiếu output với mọi lesson có `category` khớp lệnh hiện tại VÀ `scope` khớp target (domain / file).
|
|
442
|
-
- Nếu output sinh ra vi phạm một lesson → sửa **trước khi** trình bày, và ghi rõ lesson nào (`L-NNN`) đã được áp dụng.
|
|
443
|
-
|
|
444
|
-
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
445
|
-
|
|
446
|
-
---
|
|
447
|
-
|
|
448
|
-
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
449
|
-
|
|
450
|
-
Sau khi nạp toàn bộ context, tổng hợp và xuất một khối tóm tắt gọn.
|
|
451
|
-
Recap này đảm bảo các sự thật quan trọng nhất được nêu ở CUỐI quá trình nạp context
|
|
452
|
-
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
453
|
-
|
|
454
|
-
Xuất đúng khối này:
|
|
455
|
-
```
|
|
456
|
-
[CTX LOADED]
|
|
457
|
-
Stack : {language} / {framework} / {database}
|
|
458
|
-
Platform : {active_module} ({platform_type})
|
|
459
|
-
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
460
|
-
Package : {code_base_package}.{layer} · {by-layer | by-feature} ← feature/UC → tên class, KHÔNG thành package (nếu by-layer)
|
|
461
|
-
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
462
|
-
Ticket : {ticket_prefix}-
|
|
463
|
-
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
464
|
-
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
465
|
-
Lessons : {loaded — N guardrails | chưa có}
|
|
466
|
-
Platform : {active_platform: system | web | app | — nếu chưa xác định}
|
|
467
|
-
Service : {active_service} ({active_service_module}) [← domain{/platform}{/prd_slug} nếu route qua by_prd_slug] | multi (map-theo-platform hoặc map-theo-prd_slug, chốt khi target đủ platform/prd_slug) | single-service
|
|
468
|
-
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
469
|
-
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
470
|
-
```
|
|
471
|
-
|
|
472
|
-
Nếu bất kỳ file CRITICAL nào thiếu (CLAUDE.md), gắn cờ rõ ràng để người dùng quyết định có tiếp tục hay không.
|
|
473
|
-
|
|
474
|
-
---
|
|
475
|
-
|
|
476
|
-
## Hoàn tất nạp Context
|
|
477
|
-
|
|
478
|
-
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
479
|
-
- Định danh dự án, tech stack, convention module
|
|
480
|
-
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
481
|
-
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
482
|
-
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
483
|
-
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
484
|
-
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
485
|
-
- Toàn bộ path đã cấu hình
|
|
486
|
-
|
|
487
|
-
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
---
|
|
491
|
-
|
|
492
|
-
## Scope Lock
|
|
493
|
-
|
|
494
|
-
Lệnh này giới hạn nghiêm ngặt trong **một file feature** được truyền qua `$ARGUMENTS`:
|
|
495
|
-
|
|
496
|
-
- File feature: `{path chính xác từ $ARGUMENTS}`
|
|
497
|
-
- UC: `{UC-ID}` (đọc từ `@trace.id` trong header file đó)
|
|
498
|
-
|
|
499
|
-
**KHÔNG đọc hay implement scenario từ bất kỳ file `.feature` nào khác** trong cùng folder domain, kể cả khi chúng dùng chung entity, khái niệm domain, hay tên service.
|
|
500
|
-
|
|
501
|
-
> **⚠️ Scope Lock CẤM implement UC khác — KHÔNG cấp phép XOÁ code UC khác.** Nhiều UC của cùng nghiệp vụ thường **dùng chung file code** (cùng Controller/Service). Khi một file như vậy đã tồn tại, **mọi member có sẵn là BẤT KHẢ XÂM PHẠM** — kể cả method mang `@trace.implements` của UC khác. Bảo toàn chúng là **YÊU CẦU BẮT BUỘC**, KHÔNG phải vi phạm scope. Bạn ĐƯỢC đọc các tag `@trace.implements` có sẵn trong file code (để biết member nào thuộc UC khác mà giữ) — điều bị cấm chỉ là **implement scenario** của `.feature` khác. Không bao giờ tái tạo file chung "chỉ gồm scenario của UC này" — đó là cách xoá nhầm nghiệp vụ UC trước.
|
|
502
|
-
|
|
503
|
-
---
|
|
504
|
-
|
|
505
|
-
## Context Load (bổ sung)
|
|
506
|
-
|
|
507
|
-
Đọc:
|
|
508
|
-
1. Chỉ file `.feature` đã giới hạn scope
|
|
509
|
-
2. Tech-doc gộp của PRD tại `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md` (nếu tồn tại) — **tra §10 UC Coverage làm mục lục** để định vị scenario/section của UC đang sinh; **endpoint liên quan = §4.1 entries mà §5 lane của UC này gọi tới** (đừng lấy endpoint/section của UC khác). Từ đó đọc §4 API, §4.5 client, §5 flow của đúng UC này. **Đọc thêm §7 (Security & Authorization)** — luật phân quyền/enforce của UC → áp vào code; **và §8 (Error Handling & Edge Cases)** — mỗi row lỗi/biên phải có nhánh xử lý tương ứng trong code (khớp §4.3 error code), đừng chỉ code happy-path.
|
|
510
|
-
3. CLAUDE.md §architecture + §coding_standards
|
|
511
|
-
4. **(chỉ FE/App)** Design Spec — nạp qua **Guard** bên dưới (gate approved/độ-tươi + sanity), là nguồn của màn hình, component inventory, và link Figma frame từng-màn.
|
|
512
|
-
|
|
513
|
-
> **Phạm vi vét nguồn (SRC-CHAIN):** khi một giá trị còn thiếu ở nguồn chính, được phép đọc thêm các artifact **cùng feature-package** `{paths.specs_dir}/{domain}/{prd-slug}/` — PRD `{TICKET-ID}-{prd-slug}.md`, các `.feature` khác (system/web/app), design-spec, tech-doc anh em — cùng `core-entities.md`/`business-dictionary.md`. Đọc **theo nhu cầu** để phân giải giá trị trước khi hỏi người (xem §Quy tắc nguồn giá trị).
|
|
514
|
-
|
|
515
|
-
---
|
|
516
|
-
|
|
517
|
-
## Guard — BDD & Design Spec đã sẵn sàng chưa *(cảnh báo MỀM — đồng bộ generate-bdd)*
|
|
518
|
-
|
|
519
|
-
**BDD (mọi platform) — DS1:** đọc `# @trace.status:` từ header `.feature` target.
|
|
520
|
-
- `approved` → tiếp tục. Khác `approved` → CHECKPOINT mềm:
|
|
521
|
-
```
|
|
522
|
-
⚠️ BDD {UC-ID} đang @trace.status: {status} (chưa duyệt). Code sinh từ BDD chưa chốt có thể phải làm lại.
|
|
523
|
-
Vẫn sinh code bây giờ? (Y/N)
|
|
524
|
-
```
|
|
525
|
-
Chỉ tiếp khi chọn Y.
|
|
526
|
-
|
|
527
|
-
**Design Spec (chỉ FE/App — `@trace.platform` = web/app) — DS2:** định vị `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{@trace.platform}-{slug}.md`, đọc `| **Status** |` + `| **Built from PRD** |`:
|
|
528
|
-
- Không có file, HOẶC `Status ≠ approved`, HOẶC còn màn ❌ Missing, HOẶC `Built from PRD` ≠ `| **Version** |` PRD hiện tại (lỗi thời) → CHECKPOINT mềm (liệt kê lý do + "Vẫn dùng design-spec này? (Y/N)"). Nếu Y mà KHÔNG có design-spec → sinh UI từ BDD + Wireframe PRD (thiếu chi tiết visual).
|
|
529
|
-
- **Sanity-scan** (như generate-bdd bước 2.5): màn thiếu state loading/error/empty, AC-UI không testable, component `[NEW]`/`[TODO]` chưa chốt, còn ❌ Missing frame → cảnh báo trong cùng CHECKPOINT.
|
|
530
|
-
- `Status: approved` VÀ `Built from PRD` khớp PRD hiện tại VÀ sạch cờ đỏ → dùng làm nguồn màn hình / component / Figma.
|
|
531
|
-
|
|
532
|
-
**Tech-doc contract (chỉ backend/system) — DS3:** *áp dụng khi lần sinh này tạo code **backend** — `@trace.platform = system` (nguồn chuẩn quyết BE/FE, xem Phase Detection). Bỏ qua FE (`@trace.platform` = `web`/`app`) — FE có nguồn shape riêng ở Phase Detection.*
|
|
533
|
-
|
|
534
|
-
Định vị tech-doc gộp `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md`, kiểm phần backend của UC này (§4.1 Endpoints / §4.2 Request-Response / §4.3 Error):
|
|
535
|
-
- **Brownfield** — nếu PRD Metadata `API Source: existing`: contract nằm ở Appendix "Existing API Contract" của PRD → nguồn hợp lệ, **bỏ qua DS3** (không cảnh báo).
|
|
536
|
-
- **Thiếu tech-doc, HOẶC thiếu §4 contract cho UC này** → CHECKPOINT chặn mềm:
|
|
537
|
-
```
|
|
538
|
-
⚠️ Sinh code BACKEND cho {UC-ID} mà chưa có contract chốt (thiếu tech-doc §4 API).
|
|
539
|
-
Code BE không có contract sẽ phải TỰ CHẾ shape API/DTO/error → rủi ro bịa, rework nặng.
|
|
540
|
-
Khuyến nghị: /generate-tech-docs {system .feature} → /review-tech-docs (approved) rồi sinh code.
|
|
541
|
-
Vẫn sinh bây giờ? (Y/N)
|
|
542
|
-
```
|
|
543
|
-
Chỉ tiếp khi Y. *(Khác FE: FE degrade êm để prototype qua mock; BE thì contract là sản phẩm chính → chặn mềm.)*
|
|
544
|
-
- **Có §4 nhưng `@trace.status = draft/in-review`, HOẶC §12 GAP Register còn 🔴 blocker `open` chạm UC này** → WARN (không chặn): "contract chưa chốt / còn {n} blocker-GAP open — có thể phải rework khi contract đổi."
|
|
545
|
-
- **Tech-doc lỗi thời so với BDD** — so entry `{@trace.platform}` trong map `@trace.bdd_versions` của tech-doc vs `@trace.bdd_version` của `.feature` target. Tech-doc **cũ hơn** → WARN (không chặn), kể cả khi `@trace.status: approved`:
|
|
546
|
-
```
|
|
547
|
-
⚠️ §4 contract dựng từ BDD v{old}, .feature này giờ v{new}.
|
|
548
|
-
Doc vẫn 'approved' nên shape dưới đây được lấy nguyên văn — nhưng nó phản ánh
|
|
549
|
-
behavior CŨ. Nếu BDD đổi request/response/error thì code sinh ra sẽ sai từ nguồn.
|
|
550
|
-
Khuyến nghị: /generate-tech-docs {feature-file} → /review-tech-docs (cổng T3b) trước.
|
|
551
|
-
```
|
|
552
|
-
*(Chỉ WARN chứ không chặn: BDD hay bump vì lý do không chạm contract — sửa từ ngữ step, thêm side-effect assertion. Người đọc warning là người biết. `/validate-traces` giữ cờ `TECHDOC_STALE_VS_BDD` song song.)*
|
|
553
|
-
- **Có §4 + `@trace.status: approved` + 0 blocker-GAP** → dùng §4 làm nguồn contract (shape DTO/endpoint/error lấy nguyên văn từ đây, KHÔNG tự chế).
|
|
554
|
-
|
|
555
|
-
---
|
|
556
|
-
|
|
557
|
-
## Phase Detection
|
|
558
|
-
|
|
559
|
-
> **Nguồn chuẩn quyết BE/FE = `@trace.platform` của FILE FEATURE** (`system` → BE · `web`/`app` → FE). KHÔNG dùng `platform_type` (suy từ module) để quyết BE/FE — nó chỉ dùng cho **idiom stack/module** (cú pháp, layer, thư viện). Lý do: repo fullstack một-module (vd Next.js có API route) có `platform_type` cố định một giá trị, nhưng vẫn có cả feature `system` (BE) lẫn `web` (FE) — chỉ tag của chính feature mới đúng.
|
|
560
|
-
|
|
561
|
-
Parse `$ARGUMENTS` tìm flag `--phase` và `--force`:
|
|
562
|
-
|
|
563
|
-
| Flag | Ý nghĩa |
|
|
564
|
-
|---|---|
|
|
565
|
-
| `--phase=ui` | FE Phase 1 — sinh UI + layer mock API từ System BDD contract |
|
|
566
|
-
| `--phase=integration` | FE Phase 2 — thay mock adapter bằng lời gọi API thật từ tech docs |
|
|
567
|
-
| `--force` | "Gen lại tường minh" — **CHỈ** bỏ qua guard status ở §Read Trace State (không skip row đang `OK`). Xem định nghĩa hẹp bên dưới. |
|
|
568
|
-
| *(không có)* | Default — full: **BE/`system`** → full backend; **FE (`web`/`app`)** → **FE full** (sinh UI + wire API thật trong một lần, không qua bước mock) |
|
|
569
|
-
|
|
570
|
-
> **`--force` có phạm vi HẸP — đây là ranh giới cứng, không phải khuyến nghị.**
|
|
571
|
-
> Nó bỏ qua **đúng một** thứ: luật "row `OK` thì skip" ở §Read Trace State. **Mọi guard khác giữ nguyên hiệu lực:** Scope Lock (cấm implement scenario của `.feature` khác) · quy tắc EXTEND phi-phá-huỷ (đọc lại trước khi ghi · CẤM full Write trên file đã tồn tại · output phải là superset chặt) · Guard sau-ghi · Fill-before-create · Build Verify.
|
|
572
|
-
> `--force` **KHÔNG** phải "ghi đè tất cả". Không có cờ nào trong lệnh này cho phép điều đó — mất member/tag của UC khác luôn là lỗi chặn, kể cả với `--force`.
|
|
573
|
-
>
|
|
574
|
-
> Dùng khi: tech-doc bump revision có đụng thật phần điều khiển UC này, hoặc cần dựng lại code cho một scenario đang `OK`. **Đọc diff của nguồn TRƯỚC** — nếu revision bump không đụng UC này (vd chỉ thêm UC khác vào doc gộp) thì sinh lại code chỉ để đồng bộ một dòng nhãn là rủi ro không đáng.
|
|
575
|
-
|
|
576
|
-
**Xác định `fe_full`:** khi **KHÔNG** có `--phase` VÀ `@trace.platform` là `web`/`app` → đây là **FE full mode**. Sinh UI **và** wire API thật trong cùng một lần chạy, **bỏ qua** layer mock. Cụ thể: các section **sinh UI** chạy · **Mock API Layer** bị bỏ (chỉ dành `--phase=ui`) · **DS4** và **Integration Phase** VẪN chạy (xem điều kiện của từng section). BE/`system` ở default vẫn là full backend như trước.
|
|
577
|
-
|
|
578
|
-
**Nếu `--phase` được set — xác nhận platform:**
|
|
579
|
-
Đọc `@trace.platform` từ header file feature.
|
|
580
|
-
- Nếu `system` → cảnh báo: "Flag `--phase` không áp dụng cho system BDD (hướng BE). Tiếp tục với chế độ default." Coi như không có flag.
|
|
581
|
-
- Nếu `web` hoặc `app` → tiếp tục logic phase bên dưới.
|
|
582
|
-
|
|
583
|
-
**Nếu `--phase=ui`:**
|
|
584
|
-
Phân giải **nguồn shape của mock** (hybrid — ưu tiên contract thật, fallback về System BDD):
|
|
585
|
-
- **BE contract** — tech-doc gộp `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md`, phần backend của UC này (§4.1 Endpoints / §4.2 Request-Response / §4.3 Error). Nếu tồn tại, **shape** port/DTO của mock adapter (field request/response, type, error code) lấy từ đây → `mock_source = contract`. Chính xác nhất; không phải rework shape lúc integration.
|
|
586
|
-
- **System BDD** `{paths.specs_dir}/{domain}/{prd-slug}/bdd/system/{TICKET-ID}*.feature` — luôn nạp mệnh đề `Then` để lấy **behavior + giá trị fixture**. Nếu không có §4 API contract, shape cũng được infer từ đây → `mock_source = system-bdd`, và WARN:
|
|
587
|
-
```
|
|
588
|
-
⚠ Không tìm thấy §4 API contract — shape mock được infer chỉ từ System BDD.
|
|
589
|
-
System BDD mô tả behavior, không phải full request/response shape — mock
|
|
590
|
-
có thể khác API thật; dự kiến điều chỉnh ở --phase=integration.
|
|
591
|
-
(Khuyến nghị: để BE publish {prd-slug}/tech-docs/{TICKET-ID}-tech-design.md (§4) trước để có mock chính xác.)
|
|
592
|
-
```
|
|
593
|
-
- Nếu System BDD cũng thiếu → cảnh báo "Không tìm thấy System BDD — layer mock sẽ dùng fixture placeholder." Tiếp tục.
|
|
594
|
-
|
|
595
|
-
Lưu `mock_source` (`contract` | `system-bdd`) cho các tag mock bên dưới.
|
|
596
|
-
|
|
597
|
-
**Rồi chạy Figma Dev Mode MCP Check bên dưới** trước khi sinh UI — link frame của Design
|
|
598
|
-
Spec là visual contract, và MCP local đọc chúng với độ trung thực cao hơn nhiều so với link web trần.
|
|
599
|
-
|
|
600
|
-
---
|
|
601
|
-
|
|
602
|
-
## Figma Dev Mode MCP Check *(chỉ sinh UI FE/App)*
|
|
603
|
-
|
|
604
|
-
*Chỉ chạy khi `platform` là `web`/`app` VÀ đang sinh UI (`--phase=ui`, hoặc chế độ default
|
|
605
|
-
cho feature FE/App). Bỏ qua hoàn toàn với BE / platform `system`.*
|
|
606
|
-
|
|
607
|
-
PO viết Design Spec từ **link web Figma** (read-only, giới hạn). Để codegen,
|
|
608
|
-
**Figma Dev Mode MCP server local** (tích hợp trong **app desktop** Figma) cho nhiều hơn
|
|
609
|
-
nhiều: layout chính xác, **variable/token** design, mapping component **Code Connect**,
|
|
610
|
-
selection context, và code snippet — những thứ một URL web đơn không trả về được.
|
|
611
|
-
|
|
612
|
-
**Step 1 — Phát hiện MCP local.** Kiểm tra xem Figma Dev Mode MCP server có kết nối không
|
|
613
|
-
(một Figma tool kiểu `get_design_context` / `get_code` sẵn có qua MCP).
|
|
614
|
-
|
|
615
|
-
**Step 2 — Nếu CHƯA kết nối → gợi ý dev bật nó, rồi chờ:**
|
|
616
|
-
|
|
617
|
-
```
|
|
618
|
-
🎨 Không phát hiện Figma Dev Mode MCP.
|
|
619
|
-
Để có code FE chính xác (token, component, Code Connect thật), dùng server LOCAL:
|
|
620
|
-
|
|
621
|
-
1. Mở app Figma DESKTOP (không phải browser)
|
|
622
|
-
2. Mở file/frame của feature này
|
|
623
|
-
3. Bật Dev Mode MCP server:
|
|
624
|
-
Menu Figma → Preferences → "Enable Dev Mode MCP Server"
|
|
625
|
-
(cần Dev hoặc Full seat; server chạy ở http://127.0.0.1:3845)
|
|
626
|
-
4. Đảm bảo MCP server này đã được thêm vào config MCP của Claude Code
|
|
627
|
-
5. Chọn frame của màn bạn đang implement, rồi tiếp tục
|
|
628
|
-
|
|
629
|
-
Gõ C để tiếp tục khi đã bật, hoặc S để skip (fallback về link web + text spec).
|
|
630
|
-
```
|
|
631
|
-
|
|
632
|
-
- `C` → phát hiện lại; nếu giờ đã kết nối → tiếp tục dùng MCP local.
|
|
633
|
-
- `S` → tiếp tục ở **fallback mode**: chỉ dùng link frame web + text spec của Design Spec;
|
|
634
|
-
thêm note ⚠️ trong report cuối rằng UI được sinh mà không có độ trung thực Figma local.
|
|
635
|
-
|
|
636
|
-
**Step 3 — Khi MCP local ĐÃ kết nối:** với mỗi màn đang implement, pull frame được chọn
|
|
637
|
-
qua Figma MCP và ground UI trên layout, variable, và mapping Code Connect trả về. Ưu tiên
|
|
638
|
-
component được map Code-Connect hơn là bịa markup; dùng tên token thật, không phải giá trị hardcode.
|
|
639
|
-
|
|
640
|
-
---
|
|
641
|
-
|
|
642
|
-
## Integration Gates — DS4 (contract) · DS5 (reuse)
|
|
643
|
-
|
|
644
|
-
*Áp dụng khi wire API thật: `--phase=integration` **HOẶC** `fe_full`. Bỏ qua `--phase=ui` và default BE.*
|
|
645
|
-
|
|
646
|
-
> **Sequencing ở `fe_full`:** hai cổng này chạy **trước** khi UI/adapter được sinh trong cùng lần chạy, nên chúng suy luận từ **BẢN THIẾT KẾ** (design-spec + tech-doc §4.5) — tức *kế hoạch*, KHÔNG phải code đã sinh. "Port do UI định nghĩa" và "mock adapter có sẵn" chỉ tồn tại ở luồng 2-pha (`--phase=integration` chạy sau `--phase=ui`); ở `fe_full` port thật được chốt tại bước Generate về sau.
|
|
647
|
-
|
|
648
|
-
Phân giải design điều khiển adapter từ **tech-doc gộp của PRD** `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md`:
|
|
649
|
-
- **Mapping port→endpoint→DTO→error** (ưu tiên): §4.5.4 (API Integration Layer của platform này) — mỗi client method → endpoint có thật.
|
|
650
|
-
- **Nguồn endpoint/shape**: §4.1 Endpoints + §4.2 Request-Response + §4.3 Error của cùng doc.
|
|
651
|
-
|
|
652
|
-
**Client contract gate — DS4** *(áp dụng khi `--phase=integration` **HOẶC** `fe_full`; KHÔNG áp dụng `--phase=ui` — UI vẫn degrade êm qua mock).* Đối xứng với DS3 của BE: soi §4.5.4 **đủ chưa** cho UC/platform này *trước khi* wire adapter thật.
|
|
653
|
-
|
|
654
|
-
1. **Xác định phạm vi cần:** các client method mà UC NÀY dùng — lấy từ §10 (định vị scenario của UC) → §4.5.4 rows. Nguồn interface port: `{UC-ID}ApiPort` của mock adapter (`--phase=integration`, đã có từ lần `--phase=ui` trước) HOẶC, ở `fe_full`, port do chính lần chạy này định nghĩa lúc sinh UI (§4.5.3 state + §4.5.4) — chưa có mock adapter.
|
|
655
|
-
2. **Kiểm tính đủ của §4.5.4 cho từng method:** có endpoint (resolve được ở §4.1) + map request + response→model + error→UI. *(Khác cảnh báo cũ: cái cũ chỉ bắt "thiếu HẲN §4.5.4"; DS4 bắt cả "thiếu MỘT PHẦN".)*
|
|
656
|
-
3. **Phân loại (giống DS3):**
|
|
657
|
-
- **Đủ + `@trace.status: approved` + 0 🔴 blocker-GAP (§12) chạm §4.5.4/UC này** → dùng làm nguồn, KHÔNG hỏi.
|
|
658
|
-
- **`@trace.status` = `draft`/`in-review`, HOẶC §12 còn 🔴 blocker `open` chạm UC này** → WARN (không chặn): "contract/mapping adapter chưa chốt / còn {n} blocker-GAP open — đảm bảo BE endpoint đã deploy hoặc confirm mapping thủ công; có thể rework khi §4.5.4 đổi."
|
|
659
|
-
- **Thiếu §4.5.4, HOẶC khuyết một phần cho method UC cần** →
|
|
660
|
-
a. Áp **SRC-CHAIN** (xem §Quy tắc nguồn giá trị) lấp phần thiếu từ nguồn khác (§4.1–4.3, PRD, BDD `Then`, core-entities, mock adapter đã sinh).
|
|
661
|
-
b. Phần SRC-CHAIN giải quyết được → tiếp tục.
|
|
662
|
-
c. Phần **thực sự còn trống** → **CHECKPOINT chặn mềm, GỘP mọi gap vào một lần** (mỗi gap ghi rõ "đã tìm ở: {nguồn}"):
|
|
663
|
-
```
|
|
664
|
-
⚠️ §4.5.4 chưa đủ cho {UC-ID}/{platform} — {n} mapping còn trống (đã vét SRC-CHAIN):
|
|
665
|
-
- {client method} → {thiếu gì: endpoint/field/error→UI}
|
|
666
|
-
Wire adapter thật với mapping chưa chốt sẽ phải rework.
|
|
667
|
-
Khuyến nghị (front-load): /generate-tech-docs {web|app .feature} → bổ sung §4.5.4 → /review-tech-docs.
|
|
668
|
-
Vẫn wire bây giờ? (Y = best-effort/giữ mock cho phần thiếu · N = dừng, đi hoàn thiện tech-docs)
|
|
669
|
-
```
|
|
670
|
-
Chỉ tiếp khi Y. *(Đây là "tư thế BE": trỏ ngược tech-docs thay vì hỏi live từng câu.)*
|
|
671
|
-
**FE component/service reuse gate — DS5** *(áp dụng khi `--phase=integration` **HOẶC** `fe_full`; KHÔNG áp dụng `--phase=ui`).* **Phát hiện & tái dùng** code FE đang tồn tại trước khi dựng mới — chống đẻ adapter/service **song song, mồ côi**, không nối vào app đang chạy.
|
|
672
|
-
|
|
673
|
-
1. **Định vị mock adapter framework:** tìm `{UC-ID}MockApiAdapter` trong `{paths.src_dir}/{domain}/` (output `--phase=ui`).
|
|
674
|
-
2. **Discovery code FE có sẵn:** quét `{paths.src_dir}` (phạm vi domain/feature) tìm **component / service / hook / api-client** mà các màn của UC này dùng — đối chiếu: component inventory của **design-spec**, path ở tech-doc **§4.5.2**, tên màn/UC. Lập danh sách "đã tồn tại" vs "chưa có".
|
|
675
|
-
3. **Quyết định reuse-or-new:**
|
|
676
|
-
- **CÓ mock adapter** (luồng 2-pha chuẩn) → tái dùng port/wiring của nó như cũ; **KHÔNG hỏi**.
|
|
677
|
-
- **KHÔNG có mock adapter NHƯNG discovery thấy component/service có sẵn** (brownfield / chạy integration một mình trên app đang chạy) → **CHECKPOINT hỏi, KHÔNG tự dựng mới:**
|
|
678
|
-
```
|
|
679
|
-
🔎 Thấy {N} phần FE đang tồn tại cho màn của {UC-ID}/{platform}:
|
|
680
|
-
- {path} ({component | service | hook | api-client})
|
|
681
|
-
Wire API thật vào code CÓ SẴN này, hay dựng mới?
|
|
682
|
-
R (reuse) — EXTEND/wire adapter vào component/service đang chạy (khuyến nghị)
|
|
683
|
-
N (new) — dựng adapter/service mới (chỉ khi code cũ không tái dùng được — ghi lý do)
|
|
684
|
-
```
|
|
685
|
-
- **R** → set `reuse_target` = các file có sẵn; Integration Phase **EXTEND/wire vào chúng** (áp Quy tắc EXTEND phi-phá-huỷ + Guard sau-ghi ở §File Scan), KHÔNG tạo file song song.
|
|
686
|
-
- **N** → dựng mới, ghi lý do vào report.
|
|
687
|
-
- **KHÔNG có mock adapter VÀ discovery KHÔNG thấy gì** → greenfield thật → sinh real adapter từ đầu dùng contract tech-doc (không cần hỏi).
|
|
688
|
-
4. Lưu `reuse_target` (hoặc `none`) cho Integration Phase dùng ở bước wire-up.
|
|
689
|
-
|
|
690
|
-
---
|
|
691
|
-
|
|
692
|
-
## Read Trace State
|
|
693
|
-
|
|
694
|
-
Đọc `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{@trace.platform}.tsv` nếu tồn tại. Với mỗi scenario row, ghi nhận `status` hiện tại:
|
|
695
|
-
|
|
696
|
-
| Status | Ý nghĩa | Hành động trong lần chạy này |
|
|
697
|
-
|--------|---------|-------------------|
|
|
698
|
-
| `UNTRACKED` | `implemented_by == —` | Generate — scenario chưa có code |
|
|
699
|
-
| `DRIFT` | `spec_ver != gen_ver` | Sửa **tại chỗ đúng method** của scenario đó (Edit) — KHÔNG viết lại cả file (file chung sẽ mất method UC khác) |
|
|
700
|
-
| `OK` | đã implement + test | **Skip** — trừ khi có `--force` (xem §Phase Detection). Sinh lại thì sửa **tại chỗ đúng method** (Edit), như hàng `DRIFT`.<br/>*(Tới đây vì cờ ⓘ `PRD_STALE_REF`/`TECHDOC_STALE_REF`? **Sai lệnh.** Hai cờ đó nghĩa là version bump KHÔNG đụng UC này — dùng `/validate-traces --realign-prd-version {UC-ID}` (chỉ sửa dòng nhãn, không đụng logic). Chỉ dùng `--force` khi cờ là 🟠 `PRD_DRIFT`/`TECHDOC_DRIFT` — nội dung đổi thật.)* |
|
|
701
|
-
| `GAP` | đã implement, chưa test | Skip codegen — đã code rồi; chạy `/dev-gen-test` thay vì |
|
|
702
|
-
| `ORPHANED` | SC không còn trong `.feature` nhưng code còn | **Skip codegen** — không có scenario nào để implement. **KHÔNG xoá** code/row (cần người quyết định behavior đó còn cần hay không). Nêu ở report cuối: `⚠️ {sc_id} ORPHANED — code {implemented_by} còn tồn tại nhưng scenario đã bị xoá khỏi .feature. Xử: xoá code+test, hoặc đưa scenario trở lại. (/validate-traces giữ cờ 🔴.)` |
|
|
703
|
-
|
|
704
|
-
Dùng các status này để điền số **Scenarios** trong plan CHECKPOINT (`{X} new, {Y} drifted, {Z} synced-skip`).
|
|
705
|
-
Nếu `.tsv` không tồn tại → coi mọi scenario là `UNTRACKED`.
|
|
706
|
-
|
|
707
|
-
---
|
|
708
|
-
|
|
709
|
-
## Package Placement *(đặt code đúng convention — chống phân mảnh package)*
|
|
710
|
-
|
|
711
|
-
Trước khi định vị file, chốt **package đích** theo **Package Layout của CLAUDE.md §2** (context-loader đã trích: `code_base_package` + `package_strategy`):
|
|
712
|
-
|
|
713
|
-
- **Path code = `{code_base_package}.{layer}`** — vd `vn.edupia.segment.service`, `.repository`, `.facade`. `{layer}` theo thứ tự layer §2 (dto/entity/repository/service/facade/controller…).
|
|
714
|
-
- **CẤM đưa `{prd-slug}` / tên feature / `{UC-ID}` vào package** (đây là lỗi hay gặp: map bố cục spec `specs/{domain}/{prd-slug}/` thành package code → đẻ `…{service}.{feature}.{layer}`, nhân bản layer). Feature/UC **chỉ** phân biệt ở **TÊN CLASS**: `EventCollectionService`, `IdentityResolutionService` **cùng nằm trong** `…segment.service`, KHÔNG phải `…segment.eventcollection.service`.
|
|
715
|
-
- *(Chỉ khi §2 khai `package_strategy = by-feature` mới đặt sub-package theo feature — mặc định là **by-layer**.)*
|
|
716
|
-
|
|
717
|
-
**Quét module TÁI DÙNG trước khi tạo:** với mỗi layer, kiểm `{code_base_package}.{layer}` đã tồn tại trên disk chưa. Nếu đã có class phục vụ cùng entity/nghiệp vụ → **đặt member mới vào class đó (EXTEND)**, KHÔNG dựng cây layer / class song song. Chỉ tạo mới khi thực sự chưa có.
|
|
718
|
-
|
|
719
|
-
**Đặt code FE (`@trace.platform` = web/app):** quy tắc trên là cho BE (Java-style `{package}.{layer}`). FE đặt file theo thứ tự ưu tiên:
|
|
720
|
-
1. **Path ở tech-doc §4.5.2 (Component File Mapping)** — nếu có, dùng **nguyên văn** đường dẫn cột `Path` (đây là contract đặt file của FE).
|
|
721
|
-
2. **Else** → gốc `{paths.src_dir}` + quy ước thư mục của module/framework (vd `src/features/{domain}/…` React · `lib/{domain}/…` Flutter). Component/hook/service/adapter của cùng feature nằm gần nhau; **KHÔNG** rải mỗi file một nơi.
|
|
722
|
-
Adapter API mặc định tại `{paths.src_dir}/{domain}/` (khi §4.5.2 không chỉ định). Luôn **quét `{paths.src_dir}` tái dùng** như BE trước khi tạo mới (đồng bộ DS5).
|
|
723
|
-
|
|
724
|
-
---
|
|
725
|
-
|
|
726
|
-
## Seam & Stub Ledger — nối/lấp chỗ chưa implement *(chống mồ côi)*
|
|
727
|
-
|
|
728
|
-
*Chạy TRƯỚC khi tạo bất kỳ chỗ giả lập nào. Đây là chỗ vá hai lỗi kinh điển khi gen từng BDD: (a) **hàm trắng mồ côi** — callee để trắng vì logic thuộc BDD khác, ghép luồng thì chạy vào no-op; (b) **hàm thật mồ côi** — BDD sau đẻ hàm mới thay vì lấp hàm trắng cũ, thành ra hàm thật không ai gọi.*
|
|
729
|
-
|
|
730
|
-
Có **hai loại chỗ chưa implement**, ghi chung vào **một sổ** — cột `kind` phân biệt:
|
|
731
|
-
|
|
732
|
-
| kind | Là gì | Ví dụ |
|
|
733
|
-
|---|---|---|
|
|
734
|
-
| `seam` | Gọi ra một **port cross-UC** do UC khác sở hữu | `A` gọi `ScoreAccumulationPort` (UC scoring sở hữu) |
|
|
735
|
-
| `stub` | Một **method/hàm trắng nội-feature** — callee mà logic thuộc BDD **khác của chính feature này** | `SegmentService.calculateSegment()` để trắng vì logic thuộc BDD2 |
|
|
736
|
-
|
|
737
|
-
Scope Lock cấm **implement scenario** của `.feature` khác — nhưng KHÔNG cấm **nối vào / lấp code đã tồn tại** (đọc `@trace.implements` sẵn có; xem Scope Lock). Đó là chìa khoá để không đẻ mồ côi.
|
|
738
|
-
|
|
739
|
-
### Sổ chung `_seams.tsv`
|
|
740
|
-
|
|
741
|
-
`{paths.trace_dir}/{domain}/{prd-slug}/_seams.tsv` — tạo file + header nếu chưa có, tab-separated:
|
|
742
|
-
|
|
743
|
-
```
|
|
744
|
-
kind name consumer_uc owner_uc artifact binding status last_updated
|
|
745
|
-
```
|
|
746
|
-
|
|
747
|
-
- `kind` = `seam` | `stub`
|
|
748
|
-
- `name` = tên port (seam) | trách nhiệm/tên logic ngắn (stub) — "cái gì đang thiếu"
|
|
749
|
-
- `consumer_uc` = UC có call-site / để trắng
|
|
750
|
-
- `owner_uc` = UC sở hữu logic thật (`?` nếu tech-doc chưa nói rõ)
|
|
751
|
-
- `artifact` = `StubClass` (seam) | `ClassName#method` (stub) — nơi tìm ra hàng giả
|
|
752
|
-
- `binding` = cách stub được wire, vd bean/config (seam) | `—` (stub lấp tại chỗ, không qua binding)
|
|
753
|
-
- `status` = `PENDING` (chưa có hàng thật — bình thường) · `READY` (hàng thật đã có nhưng chưa nối/lấp — 🔴) · `RESOLVED` (đã nối/lấp xong)
|
|
754
|
-
|
|
755
|
-
*(Sổ sống cạnh TSV trace — cùng `trace_dir`, cùng luật ghi liên-repo khi có `spec_source`.)*
|
|
756
|
-
|
|
757
|
-
### Loại A — Seam (port ra ngoài, cross-UC)
|
|
758
|
-
|
|
759
|
-
Khi scenario của `{UC-ID}` gọi qua một **port do UC khác sở hữu** (vd `ScoreAccumulationPort`):
|
|
760
|
-
|
|
761
|
-
**A1. Xác định port + chủ sở hữu.** Từ tech-doc gộp — §5 flow lane của UC này (participant nào bị gọi tới), §6.2 Cross-Service Dependencies, §11 Out-of-Scope Reference — lấy tên port và **UC nào sở hữu hàng thật**. Tech-doc không nói rõ chủ → `owner_uc = ?`.
|
|
762
|
-
|
|
763
|
-
**A2. Ngó vào kho TRƯỚC khi dán giấy nợ.** Quét disk tìm một class **thật** implement port đó dưới `{code_base_package}` — class KHÔNG phải `*Stub*`/`*Mock*` và mang `@trace.implements` của UC khác:
|
|
764
|
-
- **CÓ hàng thật → nối thẳng, KHÔNG tạo stub.** Wire DI binding của `{UC-ID}` vào class thật (constructor injection / `@Primary` bean / config hiện có). Đây là **cấu hình wiring của chính UC này** → không vi phạm Scope Lock/EXTEND.
|
|
765
|
-
- **CHƯA có hàng thật → tạo stub, NHƯNG ghi nợ** (A3).
|
|
766
|
-
|
|
767
|
-
**A3. Ghi sổ nợ (chỉ khi phải tạo stub).**
|
|
768
|
-
- Tag class stub: `@trace.seam_pending={owner_uc | ?}` + `@trace.seam_port={PortName}`.
|
|
769
|
-
- Append 1 dòng: `kind=seam` · `name={PortName}` · `consumer_uc={UC-ID}` · `owner_uc={owner|?}` · `artifact={StubClass}` · `binding={cách wire}` · `status=PENDING`.
|
|
770
|
-
|
|
771
|
-
**A4. Khi CHÍNH `{UC-ID}` là chủ nợ** (lần gen này sinh **hàng thật** của một port UC khác đã stub trước đó):
|
|
772
|
-
- Sinh class thật bình thường (đúng layer).
|
|
773
|
-
- Đọc sổ: mọi dòng `kind=seam` `status=PENDING` có `owner_uc == {UC-ID}` (hoặc `owner_uc == ?` mà `name` khớp port) → đổi `status → READY`.
|
|
774
|
-
- **KHÔNG tự sửa binding của UC consumer** (file/scope UC khác — tránh clobber). IN cảnh báo nổi bật ở report cuối:
|
|
775
|
-
```
|
|
776
|
-
🔌 SEAM READY — {port}: hàng thật {RealClass} vừa sinh, nhưng {consumer_uc} còn wire vào {stub_class}.
|
|
777
|
-
Nối: trỏ binding của {consumer_uc} sang {RealClass} (xoá/thay stub), rồi build lại.
|
|
778
|
-
(/validate-traces giữ cờ SEAM_UNWIRED tới khi nối xong.)
|
|
779
|
-
```
|
|
780
|
-
|
|
781
|
-
### Loại B — Stub (method/hàm trắng nội-feature) 🆕
|
|
782
|
-
|
|
783
|
-
Khi một scenario buộc gọi tới một callee mà **logic thuộc BDD khác của chính feature này** → KHÔNG để trắng vô hình. Làm hàm trắng thành **hiện hình + có sổ**:
|
|
784
|
-
|
|
785
|
-
**B1. Class thật GIỮ NGUYÊN TÊN** (vd `SegmentService` — KHÔNG đổi thành `StubSegmentService`; class là thật, chỉ **method** là placeholder).
|
|
786
|
-
|
|
787
|
-
**B2. Chữ ký suy từ CALL-SITE** — đúng cái caller cần (tên method, tham số, kiểu trả về). Thân method là placeholder rõ ràng: `throw new UnsupportedOperationException("stub: {trách nhiệm}")` (hoặc tương đương theo stack). **KHÔNG bịa logic** — chỉ dựng chữ ký.
|
|
788
|
-
|
|
789
|
-
**B3. Tag lên method trắng:**
|
|
790
|
-
```
|
|
791
|
-
@trace.stub={UC-ID} (ai để trắng — consumer)
|
|
792
|
-
@trace.stub_owner={owner_uc | ?} (BDD/UC sẽ điền logic thật)
|
|
793
|
-
@trace.stub_for={trách nhiệm ngắn} (để owner nhận ra đây là chỗ cần lấp)
|
|
794
|
-
```
|
|
795
|
-
|
|
796
|
-
**B4. Ghi sổ:** append 1 dòng: `kind=stub` · `name={trách nhiệm}` · `consumer_uc={UC-ID}` · `owner_uc={owner|?}` · `artifact={ClassName#method}` · `binding=—` · `status=PENDING`.
|
|
797
|
-
|
|
798
|
-
> *Phần lấp stub (khi BDD owner chạy) + cổng kiểm mồ côi nằm ở "Fill-before-create" và `/validate-traces` — xem các mục sau.*
|
|
799
|
-
|
|
800
|
-
> **Mẹo vận hành (né hẳn):** gen BDD **sở hữu logic TRƯỚC**, BDD **gọi SAU** — khi đó không bao giờ cần để trắng, không phát sinh nợ. Cơ chế trên chỉ để chịu được thứ tự ngược.
|
|
801
|
-
|
|
802
|
-
---
|
|
803
|
-
|
|
804
|
-
## File Scan
|
|
805
|
-
|
|
806
|
-
Trước khi sinh, xác định file nào cần cho các scenario của UC này — **path theo Package Placement ở trên**. Kiểm tra mỗi file đã tồn tại trên disk chưa.
|
|
807
|
-
|
|
808
|
-
Phân loại mỗi file:
|
|
809
|
-
|
|
810
|
-
| Status | Ý nghĩa | Hành động |
|
|
811
|
-
|--------|---------|--------|
|
|
812
|
-
| `CREATE` | File chưa tồn tại | Sinh file mới đầy đủ |
|
|
813
|
-
| `EXTEND` | File tồn tại, cần method mới | Chỉ thêm method mới — KHÔNG viết lại code có sẵn |
|
|
814
|
-
| `FILL` | File tồn tại, chứa **method stub trắng** mà `{UC-ID}` là chủ logic | **Lấp logic thật vào chính method đó** (Edit) — KHÔNG đẻ method song song (xem Fill-before-create) |
|
|
815
|
-
| `SKIP` | File tồn tại và đã phủ tất cả scenario của UC | Để nguyên |
|
|
816
|
-
|
|
817
|
-
> **Quy tắc EXTEND (phi-phá-huỷ — BẮT BUỘC ở mức thao tác):**
|
|
818
|
-
> 1. **Đọc lại file trên disk NGAY TRƯỚC khi ghi** (không dựa vào trí nhớ từ đầu phiên — file có thể đã đổi).
|
|
819
|
-
> 2. **CHỈ dùng thao tác chèn/sửa từng phần (Edit) để THÊM member mới.** **CẤM tuyệt đối ghi đè cả file (full Write)** cho file đã tồn tại — đây là nguyên nhân số 1 xoá nghiệp vụ UC trước.
|
|
820
|
-
> 3. Output PHẢI là **superset chặt** của nội dung cũ: **mọi** method, field, annotation, import, và `@trace.implements` cũ (kể cả của UC khác) **còn nguyên si**. Chỉ được **thêm**, không xoá/sửa member không thuộc `{UC-ID}` này.
|
|
821
|
-
> 4. Gắn `@trace.implements={UC-ID}-SC{N}` lên mỗi method **mới**.
|
|
822
|
-
>
|
|
823
|
-
> **Guard sau-ghi (lưới an toàn — chạy sau khi ghi mỗi file EXTEND):** đọc lại file vừa ghi, đối chiếu với bản trước khi sửa: **mọi `@trace.implements` và member cũ phải vẫn còn**. Nếu **mất bất kỳ member/tag cũ nào** (đặc biệt của UC khác) → **DỪNG NGAY, khôi phục file về bản cũ** (`git checkout -- {file}` nếu đã commit, hoặc hoàn tác edit), báo lỗi: *"EXTEND làm mất {member/tag} của {UC khác} — đã chặn clobber. Sửa lại theo add-only rồi chạy lại."* KHÔNG tiếp tục sinh các file sau khi chưa khôi phục.
|
|
824
|
-
|
|
825
|
-
> **Fill-before-create (chống hàm thật mồ côi — BẮT BUỘC trước khi tạo BẤT KỲ method mới nào):**
|
|
826
|
-
>
|
|
827
|
-
> Trước khi sinh một method mới cho scenario của `{UC-ID}`, phải kiểm tra: nó có phải là **logic thật cần lấp vào một stub đã tồn tại** không — thay vì đẻ một method song song mồ côi (nửa B của bug: BDD sau tạo hàm mới thay vì lấp hàm trắng cũ → hàm cũ được caller gọi mà rỗng, hàm mới không ai gọi).
|
|
828
|
-
>
|
|
829
|
-
> 1. **Quét chỗ chờ lấp** (hai nguồn):
|
|
830
|
-
> - Sổ `_seams.tsv`: dòng `kind=stub` `status=PENDING` có `owner_uc == {UC-ID}` (hoặc `owner_uc == ?` mà `name`/trách nhiệm khớp scenario đang làm).
|
|
831
|
-
> - Scan disk dưới `{code_base_package}`: method mang `@trace.stub_owner == {UC-ID}` (hoặc `?`) và `@trace.stub_for` khớp trách nhiệm.
|
|
832
|
-
> 2. **KHỚP → lấp TẠI CHỖ (Edit), KHÔNG tạo mới.** Ghi logic thật vào **đúng thân method stub đó**, **giữ nguyên chữ ký** (caller đang gọi vào đó — đổi chữ ký = gãy call-site). Gỡ 3 tag `@trace.stub*`, thay bằng `@trace.implements={UC-ID}-SC{N}`. **CẤM tạo method mới cùng trách nhiệm** — đó chính là hàm mồ côi.
|
|
833
|
-
> 3. **Cập nhật sổ:** dòng tương ứng `status → RESOLVED`, `owner_uc = {UC-ID}`, `last_updated`. *(Caller ở UC khác KHÔNG cần đổi — vẫn gọi đúng method cũ, giờ có logic; đây là điểm khác với seam: stub lấp tại chỗ, không cần rewire binding.)*
|
|
834
|
-
> 4. **Không khớp stub nào → tạo method mới bình thường** (theo EXTEND/CREATE ở trên).
|
|
835
|
-
>
|
|
836
|
-
> **Guard sau-lấp:** sau khi lấp, KHÔNG được còn method trắng cùng trách nhiệm, cũng KHÔNG được có method song song mới cùng trách nhiệm. Lỡ tạo song song → gộp về một, xoá method thừa (chỉ khi chắc chắn cùng trách nhiệm).
|
|
837
|
-
>
|
|
838
|
-
> *Nghi ngờ khớp mà không chắc (tên/chữ ký lệch nhiều) → KHÔNG tự ý xoá/gộp; giữ nguyên cả hai + để `/validate-traces` gắn cờ cho người soát.*
|
|
839
|
-
|
|
840
|
-
---
|
|
841
|
-
|
|
842
|
-
## CHECKPOINT — Code Generation Plan
|
|
843
|
-
|
|
844
|
-
Trước khi sinh code, hiện:
|
|
845
|
-
|
|
846
|
-
```
|
|
847
|
-
Code Generation Plan — {UC-ID}
|
|
848
|
-
──────────────────────────────────────────────────────
|
|
849
|
-
Feature : {name}
|
|
850
|
-
Ticket : {TICKET_ID nếu biết}
|
|
851
|
-
Domain : {domain}
|
|
852
|
-
UC : chỉ {UC-ID} ← các file feature khác trong folder này KHÔNG được đọc
|
|
853
|
-
Tech : {language} / {framework}
|
|
854
|
-
Package : {code_base_package}.{layer} · {by-layer | by-feature} ← feature/UC ở TÊN CLASS, KHÔNG thành package (nếu by-layer)
|
|
855
|
-
Phase : {UI — mock layer | Integration — real API | FE full — UI + real API | BE full} ← FE full = default trên web/app; bỏ dòng này với default BE
|
|
856
|
-
Scenarios: {N} total ({X} new, {Y} drifted, {Z} synced-skip)
|
|
857
|
-
Layer : {từ CLAUDE.md §2}
|
|
858
|
-
Client : {chỉ integration/fe_full — reuse: {reuse_target hoặc "dựng mới"} · gaps §4.5.4: {n còn trống hoặc "đủ"}} ← bỏ dòng này với BE / --phase=ui
|
|
859
|
-
|
|
860
|
-
Files:
|
|
861
|
-
CREATE {N} file mới
|
|
862
|
-
+ {path/FileName.ext}
|
|
863
|
-
EXTEND {M} file có sẵn (ADD-ONLY — chỉ Edit thêm, CẤM full Write)
|
|
864
|
-
~ {path/FileName.ext} — thêm: {methodA}, {methodB}
|
|
865
|
-
↳ GIỮ NGUYÊN (member có sẵn, gồm UC khác): {methodX [UC-other], methodY …} ← sẽ không bị đụng
|
|
866
|
-
FILL {F} stub trắng (lấp logic TẠI CHỖ — KHÔNG đẻ method song song)
|
|
867
|
-
⟲ {path/FileName.ext}#{method} — lấp: {trách nhiệm} (stub của {consumer_uc})
|
|
868
|
-
SKIP {K} file (không cần đổi)
|
|
869
|
-
= {path/FileName.ext}
|
|
870
|
-
──────────────────────────────────────────────────────
|
|
871
|
-
Proceed? (Y/N)
|
|
872
|
-
```
|
|
873
|
-
|
|
874
|
-
Chờ "Y" rõ ràng trước khi sinh.
|
|
875
|
-
|
|
876
|
-
## Branch
|
|
877
|
-
```bash
|
|
878
|
-
git checkout -b feature/{TICKET_ID}-{slug}
|
|
879
|
-
```
|
|
880
|
-
|
|
881
|
-
## Generate (thứ tự layer từ CLAUDE.md §2)
|
|
882
|
-
|
|
883
|
-
Thứ tự mặc định (override từ CLAUDE.md nếu khác):
|
|
884
|
-
DTOs → Entity/Model → Repository → Service interface → Service impl → Facade (nếu áp dụng) → Controller
|
|
885
|
-
|
|
886
|
-
**Với file `CREATE`:** sinh file đầy đủ.
|
|
887
|
-
|
|
888
|
-
**Với file `EXTEND`:** áp **Quy tắc EXTEND phi-phá-huỷ** (xem File Scan) — đọc lại file trên disk → **chỉ Edit thêm** method mới cho `{UC-ID}` → **KHÔNG full Write**, không đụng member cũ → chạy **Guard sau-ghi** để chắc không mất member/tag của UC khác.
|
|
889
|
-
|
|
890
|
-
**Với file `FILL`:** áp **Fill-before-create** (xem File Scan) — Edit logic thật vào **đúng thân method stub** đã có, giữ nguyên chữ ký, gỡ `@trace.stub*` → `@trace.implements`, cập nhật sổ `RESOLVED`. **KHÔNG** đẻ method mới cùng trách nhiệm.
|
|
891
|
-
|
|
892
|
-
**Tag traceability trên controller/handler (theo cú pháp comment của ngôn ngữ bạn):**
|
|
893
|
-
```
|
|
894
|
-
@trace.implements={UC-ID}-SC{N}
|
|
895
|
-
@trace.prd_version={đọc @trace.prd_version từ header file .feature}
|
|
896
|
-
@trace.bdd_version={đọc @trace.bdd_version từ header file .feature}
|
|
897
|
-
@trace.tech_doc_revision={đọc @trace.revision từ header tech-doc, hoặc bỏ nếu không có tech-doc}
|
|
898
|
-
@trace.design_spec_version={CHỈ FE/App (@trace.platform = web|app): đọc | **Version** | từ Metadata design-spec đã nạp. BỎ HẲN dòng này với system/backend}
|
|
899
|
-
@trace.source={paths.specs_dir}/{domain}/{prd-slug}/bdd/{@trace.platform}/{UC-ID}-{slug}.feature
|
|
900
|
-
```
|
|
901
|
-
|
|
902
|
-
`@trace.prd_version` ghi code này được viết theo version PRD nào.
|
|
903
|
-
`@trace.bdd_version` ghi code này được sinh từ version BDD nào.
|
|
904
|
-
`@trace.tech_doc_revision` ghi code này theo revision tech-design nào.
|
|
905
|
-
`@trace.design_spec_version` *(chỉ FE/App)* ghi code này dựng theo version design-spec nào — nguồn của `DESIGNSPEC_DRIFT`. **Vì sao cần:** design-spec là input BẮT BUỘC của code FE (màn hình, component inventory, link Figma frame) và của cả BDD FE/App, nhưng trước đây nó là artifact upstream **DUY NHẤT** không có cột TSV, không có tag trong code, không có cờ drift — designer sửa design-spec sau khi code đã sinh thì không gì phát hiện được.
|
|
906
|
-
`/validate-traces` sẽ gắn cờ drift nếu bất kỳ artifact upstream nào được cập nhật lên version mới hơn.
|
|
907
|
-
|
|
908
|
-
> **Quy tắc entry-point:** `@trace.implements` phải xuất hiện ở **layer entry-point** như định nghĩa trong `CLAUDE.md §2`. Với REST API → Controller. Với module event-driven → event handler / consumer class. Với context-engineering → hàm orchestration prompt. Không bao giờ chỉ đặt ở layer trong.
|
|
909
|
-
|
|
910
|
-
> **File phủ NHIỀU UC → lặp CẢ BLOCK 5 tag, đặt trên method của từng UC. CẤM trỏ thư mục, CẤM gộp về một header file.**
|
|
911
|
-
>
|
|
912
|
-
> Đây là hình dạng đúng:
|
|
913
|
-
> ```
|
|
914
|
-
> // @trace.implements=USR-UC1-SC3
|
|
915
|
-
> // @trace.prd_version=1.2 @trace.bdd_version=1.4 @trace.tech_doc_revision=3
|
|
916
|
-
> // @trace.source=specs/user/create-account/bdd/system/USR-UC1-create-account.feature
|
|
917
|
-
> public AccountDto createAccount(...) { }
|
|
918
|
-
>
|
|
919
|
-
> // @trace.implements=USR-UC3-SC1
|
|
920
|
-
> // @trace.prd_version=2.0 @trace.bdd_version=2.1 @trace.tech_doc_revision=5
|
|
921
|
-
> // @trace.source=specs/user/create-account/bdd/system/USR-UC3-verify-email.feature
|
|
922
|
-
> public void verifyEmail(...) { }
|
|
923
|
-
> ```
|
|
924
|
-
>
|
|
925
|
-
> **Vì sao không được gộp:** 3 tag version là **scalar theo từng UC**. Một file phủ UC1 + UC3 mà chỉ có một header thì không diễn đạt được "UC1 ở bdd v1.4, UC3 ở v2.1" → `/validate-traces` Step 4/5/5c báo drift oan hoặc **mù** drift thật. Version phải nằm cạnh member nó mô tả.
|
|
926
|
-
>
|
|
927
|
-
> **Vì sao không được trỏ thư mục** (`@trace.source=…/bdd/system/`): độ phân giải của trace là `UC × SC`, thư mục làm mất cả hai bậc. Và các lệnh tra tag bằng **khớp chuỗi chính xác** (`/dev-gen-test`, `/dev-smoke-test`, `/review-code` đều tìm "file gắn `@trace.implements={UC-ID}`") → tag trỏ folder ra 0 kết quả, UC rơi về `UNTRACKED` dù code đã có.
|
|
928
|
-
>
|
|
929
|
-
> Quy tắc EXTEND ở §File Scan vốn đã yêu cầu giữ **nguyên si** mọi `@trace.implements` cũ *kể cả của UC khác* — tức là thiết kế vốn là **tích luỹ nhiều block**, không phải gộp lại.
|
|
930
|
-
|
|
931
|
-
> **Quy tắc nguồn giá trị (chống hard-code):** MỌI giá trị cụ thể (endpoint path, error code, tên field/DTO, enum, limit/timeout, header) phải lấy từ **nguồn đã chốt** — **KHÔNG bịa inline**. Nếu một hằng số nghiệp vụ lặp lại hoặc mang ý nghĩa (retry count, ngưỡng, key) → **đặt tên hằng số** (constant/config), không rải magic number/string trong code.
|
|
932
|
-
>
|
|
933
|
-
> **VÉT CẠN NGUỒN TRƯỚC KHI HỎI (SRC-CHAIN) — bắt buộc.** Khi một giá trị chưa thấy ở nguồn chính, PHẢI quét lần lượt các nguồn đã có trong context/spec-package theo thứ tự sau, **dừng ngay khi tìm thấy** (skip-if-answered), KHÔNG hỏi người ngay:
|
|
934
|
-
> 1. Tech-doc gộp §4 (contract: §4.1 endpoint · §4.2 request/response · §4.3 error · §4.5.4 client integration)
|
|
935
|
-
> 2. `core-entities.md` (tên field / type / enum) · `business-dictionary.md` (thuật ngữ chuẩn)
|
|
936
|
-
> 3. PRD của UC (nhất là Appendix "Existing API Contract" khi `API Source: existing`, và metadata)
|
|
937
|
-
> 4. Design-spec (FE/App: field/label/state màn hình)
|
|
938
|
-
> 5. System/platform BDD — mệnh đề `Then` (behavior + giá trị fixture)
|
|
939
|
-
> 6. Code/adapter đã sinh ở lần chạy trước (vd mock adapter `--phase=ui` đã chốt shape port/DTO) · config/env
|
|
940
|
-
> 7. Tech-doc anh em cùng domain
|
|
941
|
-
>
|
|
942
|
-
> Chỉ giá trị **thật sự không nguồn nào có** mới là GAP. **Gom TẤT CẢ GAP còn lại vào MỘT checkpoint** (mỗi GAP ghi rõ "đã tìm ở: {các nguồn}"), hỏi một lượt — KHÔNG hỏi lắt nhắt từng câu, KHÔNG chế bừa (đồng bộ Cổng 2 của generate-tech-docs). *(DS3 đã đảm bảo có §4 contract trước khi tới đây với BE.)*
|
|
943
|
-
|
|
944
|
-
### Test Selectors — emit element ID ổn định *(chỉ UI FE/App)*
|
|
945
|
-
|
|
946
|
-
*Áp dụng khi `platform` là `web`/`app` và đang sinh UI (`--phase=ui`, hoặc chế độ default FE/App). Bỏ qua với BE.*
|
|
947
|
-
|
|
948
|
-
Mỗi element **có action** (button, input, link, select, toggle, form-submit) PHẢI mang một **test-id ổn định** để QC định vị trực tiếp (không scan runtime):
|
|
949
|
-
|
|
950
|
-
1. **Nguồn id.** Nếu tech-doc gộp `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md` có **§4.5.6 Test Selectors** cho platform này, lấy id **nguyên văn** từ bảng đó (contract). Nếu chưa có (vd `--phase=ui` trước khi §4.5 được vẽ), **sinh id theo quy ước** `{uc-lower}-{screen}-{element}-{type}` (vd `ft001-login-submit-btn`) để QC vẫn có handle ổn định — chúng sẽ được đối chiếu với §4.5.6 của tech-design lúc integration.
|
|
951
|
-
2. **Emit qua attribute platform** — chọn attribute theo **`active_module`** (bảng dưới, mặc định). Chỉ override khi header `.feature` khai tường minh `@trace.testid_attr={attr}` (hiếm; dùng cho stack lai). Không có khai báo → theo module:
|
|
952
|
-
- web (`react`/`nextjs`/`vue`/`angular`) → `data-testid="..."`
|
|
953
|
-
- React Native → `testID="..."`
|
|
954
|
-
- Flutter → `Key('...')` (+ `Semantics(identifier: '...')` khi action cần)
|
|
955
|
-
- native iOS → `accessibilityIdentifier = "..."`
|
|
956
|
-
3. Chỉ element có action; đừng spam id lên text tĩnh. Giữ id giống hệt map của tech-design để QC Page Object khớp ngay lần đầu.
|
|
957
|
-
4. **Component catalog tái dùng?** Truyền id qua **forwarding prop** của nó (xem section catalog `## Test-ID Forwarding` — vd `<Button testId="ft001-login-submit-btn">`), không phải attribute thô. Nếu component không forward test-id, hoặc bạn đang backfill màn **existing/brownfield** (không phải sinh mới ở đây), đó là việc của `/map-testids {UC-ID}` — chạy nó thay vì sửa component dùng chung inline.
|
|
958
|
-
|
|
959
|
-
## Mock API Layer (chỉ `--phase=ui`)
|
|
960
|
-
|
|
961
|
-
*Bỏ qua hoàn toàn section này nếu `--phase` không phải `ui`.*
|
|
962
|
-
|
|
963
|
-
Dựng mock từ `mock_source` đã phân giải ở Phase Detection — **shape** từ §4 API contract (tech-doc gộp) khi có, **giá trị fixture + behavior** luôn từ mệnh đề `Then` của System BDD:
|
|
964
|
-
|
|
965
|
-
1. **Định nghĩa shape port** `{UC-ID}ApiPort` (DTO request/response + error code):
|
|
966
|
-
- `mock_source = contract` → tên field / type / error code lấy **nguyên văn từ tech-doc gộp** §4.1 (Endpoints) / §4.2 (Request-Response) / §3 (Data Model) — shape thật.
|
|
967
|
-
- `mock_source = system-bdd` → shape **infer** từ mệnh đề `Then` của System BDD (tạm — xem cảnh báo ở trên).
|
|
968
|
-
2. **Trích dữ liệu fixture** theo từng scenario từ mệnh đề `Then` của System BDD — response success + error (BDD là source of truth cho *giá trị / behavior*, bất kể nguồn shape).
|
|
969
|
-
3. **Sinh mock adapter** tại `{paths.src_dir}/{domain}/{UC-ID}MockApiAdapter.{ext}`:
|
|
970
|
-
- Implements interface `{UC-ID}ApiPort` (cùng interface mà real adapter sẽ implement)
|
|
971
|
-
- Mỗi method trả về fixture data khớp mệnh đề `Then` của BDD, theo shape của port
|
|
972
|
-
- Gồm cả trạng thái success và error (map sang các error scenario trong BDD)
|
|
973
|
-
- Tag traceability:
|
|
974
|
-
```
|
|
975
|
-
@trace.mock_for={UC-ID}
|
|
976
|
-
@trace.mock_source={contract | system-bdd}
|
|
977
|
-
@trace.system_bdd={paths.specs_dir}/{domain}/{prd-slug}/bdd/system/{UC-ID}*.feature
|
|
978
|
-
{@trace.be_contract={TICKET-ID}-tech-design.md # chỉ khi mock_source=contract}
|
|
979
|
-
```
|
|
980
|
-
4. **Wire vào layer service/hook** qua environment flag hoặc DI:
|
|
981
|
-
```
|
|
982
|
-
const adapter = IS_MOCK ? new {UC-ID}MockApiAdapter() : new {UC-ID}ApiAdapter()
|
|
983
|
-
```
|
|
984
|
-
- `IS_MOCK` mặc định `true` ở môi trường development/test cho tới khi real adapter được sinh.
|
|
985
|
-
|
|
986
|
-
> Tester dùng mock adapter để test mọi FE scenario mà không cần đợi BE **deploy**.
|
|
987
|
-
> Shape lấy từ §4 API contract (tech-doc gộp) khi có (chính xác, không rework integration); else từ System BDD (tạm — điều chỉnh ở `--phase=integration`). Giá trị fixture luôn từ System BDD — BDD là source of truth cho behavior.
|
|
988
|
-
|
|
989
|
-
---
|
|
990
|
-
|
|
991
|
-
## Integration Phase (`--phase=integration` HOẶC `fe_full`)
|
|
992
|
-
|
|
993
|
-
*Bỏ qua hoàn toàn section này nếu KHÔNG phải `--phase=integration` và KHÔNG phải `fe_full` (vd `--phase=ui`, hoặc default BE/`system`).*
|
|
994
|
-
|
|
995
|
-
*Hai chế độ vào section này:*
|
|
996
|
-
- **`--phase=integration`** — đã có mock adapter + UI từ lần `--phase=ui` trước → **thay** mock bằng real (có lật wire-up).
|
|
997
|
-
- **`fe_full`** — UI vừa được sinh trong CHÍNH lần chạy này, **không có bước mock** → wire real adapter **thẳng** (không có mock để thay/lật).
|
|
998
|
-
|
|
999
|
-
1. **Đọc integration design.** Trong tech-doc gộp `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md`: ưu tiên §4.5.4 (mapping port→endpoint→DTO→error của platform), dùng §4.1/§4.2/§4.3 làm nguồn endpoint / request-response / error-code. Nếu doc chưa có §4.5.4 cho platform này, trích endpoint + shape + error code trực tiếp từ §4.1–§4.3.
|
|
1000
|
-
- **Tính đủ của §4.5.4 đã được cửa DS4 kiểm + vét SRC-CHAIN + gộp-hỏi TỪ TRƯỚC.** Ở bước này dùng thẳng kết quả đã phân giải của DS4 — **KHÔNG mở checkpoint/hỏi lại**. Nếu DS4 kết luận một mapping vẫn trống mà người đã chọn Y (best-effort) → ở `--phase=integration` giữ mock cho phần đó; ở `fe_full` để adapter trả stub, tag `@trace.stub`, ghi sổ seam; đừng bịa giá trị.
|
|
1001
|
-
2. **Nguồn interface port `{UC-ID}ApiPort`:**
|
|
1002
|
-
- `--phase=integration` (có mock) → đọc từ mock adapter có sẵn (output `--phase=ui`). Real adapter implements **cùng** interface → shape port/DTO đã cố định, **không hỏi lại shape**.
|
|
1003
|
-
- `reuse_target` (DS5 chọn **R**) → dùng interface/kiểu mà **service/hook có sẵn** đang khai báo; adapter mới phải khớp chữ ký chúng đang gọi (không đổi hợp đồng của code đang chạy).
|
|
1004
|
-
- `fe_full` greenfield → port do UI vừa sinh trong lần này định nghĩa (§4.5.3/§4.5.4). Không có mock adapter để đọc.
|
|
1005
|
-
3. **Sinh / lắp real API adapter** — theo kết quả **DS5**:
|
|
1006
|
-
- **`reuse_target` = none** (greenfield / DS5 chọn N) → sinh file mới `{paths.src_dir}/{domain}/{UC-ID}ApiAdapter.{ext}`, implements `{UC-ID}ApiPort`.
|
|
1007
|
-
- **`reuse_target` có file** (DS5 chọn R) → **EXTEND vào service/api-client/hook đang chạy** (áp Quy tắc EXTEND phi-phá-huỷ + Guard sau-ghi ở §File Scan): thay lời gọi mock/placeholder bằng lời gọi HTTP thật **tại chỗ**, giữ nguyên mọi member cũ; **KHÔNG** tạo `{UC-ID}ApiAdapter` song song.
|
|
1008
|
-
- Chung: gọi HTTP thật tới endpoint từ contract tech-doc; map field response sang shape port/service khai báo; tag:
|
|
1009
|
-
```
|
|
1010
|
-
@trace.implements={UC-ID}-SC{N}
|
|
1011
|
-
@trace.tech_doc_revision={đọc từ header tech-doc}
|
|
1012
|
-
```
|
|
1013
|
-
4. **Wire-up:**
|
|
1014
|
-
- `--phase=integration` (có mock) → **lật** DI binding / env flag để service/hook dùng adapter thật thay vì mock. **KHÔNG xoá mock adapter** — giữ cho unit test.
|
|
1015
|
-
- `reuse_target` (DS5 chọn R) → wiring đã nằm trong chính component/service có sẵn (đã EXTEND ở bước 3) → **không thêm binding song song**; chỉ chỉnh cấu hình bật đường thật nếu code cũ có cờ mock.
|
|
1016
|
-
- `fe_full` greenfield → wire service/hook thẳng vào `{UC-ID}ApiAdapter` (thật); không sinh mock adapter (unit test dùng stub/fake tại chỗ khi cần).
|
|
1017
|
-
|
|
1018
|
-
---
|
|
1019
|
-
|
|
1020
|
-
## Self-Review (3 vòng)
|
|
1021
|
-
- [ ] Mỗi scenario có endpoint tương ứng
|
|
1022
|
-
- [ ] @trace.implements trên mọi endpoint
|
|
1023
|
-
- [ ] Tôn trọng quy tắc layer kiến trúc (CLAUDE.md §2)
|
|
1024
|
-
- [ ] Error handling khớp CLAUDE.md §5
|
|
1025
|
-
- [ ] **Không hard-code:** giá trị cụ thể lấy từ tech-doc §4 / core-entities / config; hằng số nghiệp vụ được đặt tên; 0 magic number/string inline; không debug logging
|
|
1026
|
-
- [ ] **Add-only cho file EXTEND:** đọc lại file trên disk; mọi member + `@trace.implements` cũ (gồm UC khác) còn nguyên; Guard sau-ghi đã chạy, không mất member nào
|
|
1027
|
-
- [ ] **Seam/Stub ledger:** không tạo giả lập khi hàng thật đã tồn tại (đã nối/lấp thẳng); mọi seam mới có `@trace.seam_pending` + dòng `kind=seam PENDING`; mọi method trắng có `@trace.stub`/`@trace.stub_owner`/`@trace.stub_for` + dòng `kind=stub PENDING` trong `_seams.tsv`; nếu UC này là chủ nợ (seam) → đã set `READY` + in cảnh báo
|
|
1028
|
-
- [ ] **Fill-before-create:** trước khi tạo method mới đã quét sổ + `@trace.stub` — có stub khớp thì **lấp tại chỗ** (giữ chữ ký, gỡ `@trace.stub*` → `@trace.implements`, sổ `RESOLVED`); KHÔNG còn method song song cùng trách nhiệm
|
|
1029
|
-
|
|
1030
|
-
## Build Verify
|
|
1031
|
-
```bash
|
|
1032
|
-
{conventions.build_command} # từ project-context.yaml, tối đa 3 retry
|
|
1033
|
-
```
|
|
1034
|
-
|
|
1035
|
-
> **GATE build (BẮT BUỘC):** chỉ khi build **SUCCESS** mới được đi tiếp sang **Write Trace State** và **Commit**.
|
|
1036
|
-
> - Fail → sửa lỗi rồi retry (tối đa 3 lần).
|
|
1037
|
-
> - **Vẫn fail sau 3 retry → DỪNG.** KHÔNG ghi trace, KHÔNG commit (trace/repo không được nói "đã xong" khi chưa build được). Xuất:
|
|
1038
|
-
> ```
|
|
1039
|
-
> ❌ Build FAIL sau 3 lần thử — không ghi trace, không commit.
|
|
1040
|
-
> Lỗi cuối: {tóm tắt}
|
|
1041
|
-
> File đã sinh giữ nguyên trên working tree để bạn sửa tay hoặc chạy /debug.
|
|
1042
|
-
> ```
|
|
1043
|
-
> Đặt Status badge = ❌ ở report cuối và dừng (bỏ qua Write Trace / Refresh Panel / Commit).
|
|
1044
|
-
|
|
1045
|
-
## Write Trace State
|
|
1046
|
-
|
|
1047
|
-
Cập nhật `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-{@trace.platform}.tsv` — với mỗi scenario đã implement, tìm row có sẵn theo `sc_id` và chỉ cập nhật các cột sau. *(Umbrella + `spec_source`: `trace_dir` phân giải về `{spec_source}/.trace` — lệnh này chạy từ `service_root` nhưng ghi trace row vào **spec repo** (liên-repo); commit/push spec submodule cho lần cập nhật trace, cùng với push code 2 tầng.)*
|
|
1048
|
-
|
|
1049
|
-
| Cột | Giá trị |
|
|
1050
|
-
|--------|-------|
|
|
1051
|
-
| `gen_ver` | copy `spec_ver` từ row `.tsv` hiện tại (= version scenario tại thời điểm codegen) |
|
|
1052
|
-
| `implemented_by` | `{ControllerClass}.{methodName}` |
|
|
1053
|
-
| `bdd_version` | `@trace.bdd_version` từ header `.feature` |
|
|
1054
|
-
| `tech_doc_revision` | `@trace.revision` từ tech-doc gộp `{TICKET-ID}-tech-design.md` (§4 backend đã điều khiển codegen của UC này), hoặc `—` nếu chưa có doc |
|
|
1055
|
-
| `fe_tech_doc_revision` | `@trace.revision` của cùng tech-doc gộp, ghi khi sinh FE có wire adapter theo §4.5.4 (`--phase=integration` **hoặc** `fe_full`); `—` cho BE, hoặc cho FE `--phase=ui` / chưa có §4.5.4 |
|
|
1056
|
-
| `fe_phase` | `ui` nếu `--phase=ui` \| `integration` nếu `--phase=integration` **hoặc** `fe_full` (đều đã wire real adapter) \| `—` cho BE |
|
|
1057
|
-
| `last_updated` | hôm nay `YYYY-MM-DD` |
|
|
1058
|
-
|
|
1059
|
-
Giữ nguyên mọi cột khác (`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`) — **trừ ngoại lệ có kiểm soát ngay dưới đây**: khi logic vừa đổi thật (lấp stub, hoặc sửa method vì `DRIFT`), 4 cột nghiệm thu `dev_selftest`/`dev_selftest_at`/`qc_status`/`qc_run_at` **phải bị hạ** về "chưa biết". Giữ một `pass` đã hết hiệu lực là báo cáo sai, không phải tôn trọng quyền sở hữu cột.
|
|
1060
|
-
`status` được tính bởi `/validate-traces` — không set ở đây.
|
|
1061
|
-
|
|
1062
|
-
**Hạ hiệu lực tín hiệu kiểm thử khi logic vừa đổi thật.** Áp cho **HAI** trường hợp — cùng một lý do, cùng một tập cột *(luật "Làm mất hiệu lực ≠ ghi đè", `rules/workflow.md`)*:
|
|
1063
|
-
|
|
1064
|
-
| Trường hợp | Phạm vi scenario bị ảnh hưởng |
|
|
1065
|
-
|---|---|
|
|
1066
|
-
| **A. Lấp stub** (Fill-before-create — dòng sổ `→ RESOLVED`) | **Mọi** scenario chạy qua method vừa lấp — gồm cả scenario của **consumer_uc** (UC đã để trắng, thường nằm ở file TSV khác `{consumer_uc}-{platform}.tsv`) |
|
|
1067
|
-
| **B. Sửa method vì row đang `DRIFT`** (spec đổi sau lần gen trước) | Đúng các SC vừa được sửa method trong lần chạy này |
|
|
1068
|
-
|
|
1069
|
-
Với mỗi scenario trong phạm vi:
|
|
1070
|
-
- `dev_selftest → not_run` · `dev_selftest_at → —` · `qc_status → not_run` · `qc_run_at → —`.
|
|
1071
|
-
- **CHỈ** đụng 4 cột này — ngoại lệ có kiểm soát của luật "giữ nguyên cột khác" ở trên; là thao tác an-toàn (không sửa code UC khác, chỉ hạ cờ nghiệm thu đã hết hiệu lực).
|
|
1072
|
-
- **KHÔNG** đụng `test_count`/`test_classes` (test vẫn tồn tại — số lượng không sai, chỉ nội dung cũ; hạ số sẽ làm tỷ lệ coverage nhảy loạn) và **KHÔNG** đụng `qc_owner`/`qc_blocked_by` (con trỏ tới bug — code đổi không làm bug biến mất).
|
|
1073
|
-
- Gom danh sách `{consumer_uc}` bị ảnh hưởng (trường hợp A) để in ở "Next".
|
|
1074
|
-
|
|
1075
|
-
> **Vì sao trường hợp B cũng phải hạ:** lý do giống hệt A — logic vừa đổi thật, nên test cũ đang nghiệm thu một hành vi không còn tồn tại. Trước đây chỉ A được xử lý, nên chuỗi "spec đổi → `DRIFT` → sửa code → `OK`" kết thúc với `qc_status = pass` từ lần QC chạy trên **spec cũ**, và dashboard hiện xanh hoàn toàn. `/fix-bug` đã làm đúng việc này từ trước với chính lời giải thích đó: *"code vừa đổi nên tín hiệu self-test cũ hết hiệu lực"*.
|
|
1076
|
-
|
|
1077
|
-
Bất kể trường hợp nào, in khối này ở report cuối để dev không tưởng là hệ thống hỏng:
|
|
1078
|
-
```
|
|
1079
|
-
🔻 Tín hiệu kiểm thử bị hạ ({spec vừa đổi | vừa lấp stub} — nghiệm thu cũ hết hiệu lực):
|
|
1080
|
-
{sc_id}: dev_selftest pass→not_run · qc_status pass→not_run
|
|
1081
|
-
⚠️ {n} test của các SC này viết cho bản cũ — rà lại nội dung, đừng chỉ chạy lại.
|
|
1082
|
-
→ /dev-run-test {UC-ID} rồi QC chạy /qc-run-test {UC-ID}
|
|
1083
|
-
ℹ️ Coverage "đã kiểm đạt" trên dashboard sẽ TỤT sau lần này — đó là số đúng;
|
|
1084
|
-
số cũ mới là số sai. (Tỷ lệ phủ code/test không đổi — test_count giữ nguyên.)
|
|
1085
|
-
```
|
|
1086
|
-
|
|
1087
|
-
## Refresh Panel Mirror
|
|
1088
|
-
# Làm mới panel mirror của Living Docs *(local)*
|
|
1089
|
-
|
|
1090
|
-
> **Hai vị trí, HAI TÊN KHÁC NHAU — đọc trước khi sửa gì ở đây.**
|
|
1091
|
-
>
|
|
1092
|
-
> | Đường dẫn | Vai trò | Git |
|
|
1093
|
-
> |---|---|---|
|
|
1094
|
-
> | `{paths.trace_dir}` (`.trace/` hoặc `{spec_source}/.trace/`) | **AUTHORITATIVE** — TSV + `trace-history.jsonl`. Không regenerate được. | **PHẢI commit** |
|
|
1095
|
-
> | `./.trace-mirror/` ở gốc workspace hiện tại | **MIRROR** — bản sao tiện cho panel VS Code. Sinh lại được bất cứ lúc nào. | **Luôn gitignore** |
|
|
1096
|
-
>
|
|
1097
|
-
> Trước v0.4.3 cả hai đều tên `.trace`, nên một luật gitignore theo tên có thể **xoá sạch sổ gốc**
|
|
1098
|
-
> khi dev mở thẳng spec repo làm workspace (lúc đó hai path bằng nhau). Hai tên khác nhau làm
|
|
1099
|
-
> luật git đọc được bằng mắt và **không còn ca nhập nhằng nào**: `.trace-mirror/` không bao giờ
|
|
1100
|
-
> commit, `.trace/` không bao giờ gitignore.
|
|
1101
|
-
|
|
1102
|
-
## Khi nào CÓ mirror
|
|
1103
|
-
|
|
1104
|
-
Mirror chỉ tồn tại khi **`{paths.trace_dir}` nằm NGOÀI workspace hiện tại** — panel đọc từ workspace đang mở nên cần một bản sao ở đây.
|
|
1105
|
-
|
|
1106
|
-
| Tình huống | `{paths.trace_dir}` | Có mirror? |
|
|
1107
|
-
|---|---|---|
|
|
1108
|
-
| Single-service | `./.trace` — **trong** workspace | ❌ Không. Panel đọc thẳng `.trace/trace-report.json`. Bỏ qua cả file này. |
|
|
1109
|
-
| Dev mở thẳng **spec repo** | `./.trace` — **trong** workspace | ❌ Không. Như trên. |
|
|
1110
|
-
| Umbrella + `spec_source`, dev đứng ở umbrella hoặc service submodule | `{spec_source}/.trace` — **ngoài** workspace | ✅ Có |
|
|
1111
|
-
| Umbrella legacy (không `spec_source`) | `.trace` theo từng service | ✅ Có |
|
|
1112
|
-
|
|
1113
|
-
Quy tắc một dòng: **phân giải `panel_mirror = ./.trace-mirror` ở gốc workspace hiện tại; nếu `{paths.trace_dir}` đã nằm trong workspace này thì bỏ qua toàn bộ bước mirror.**
|
|
1114
|
-
|
|
1115
|
-
---
|
|
1116
|
-
|
|
1117
|
-
Sau khi cập nhật TSV authoritative tại `{paths.trace_dir}`:
|
|
1118
|
-
|
|
1119
|
-
**Khi `setup.spec_source` được đặt (trace gộp — trường hợp phổ biến):**
|
|
1120
|
-
`{paths.trace_dir}` phân giải về `{spec_source}/.trace` — vị trí authoritative duy nhất.
|
|
1121
|
-
Lệnh này chạy từ `service_root`, nên thao tác ghi là **liên-repo vào spec submodule**;
|
|
1122
|
-
commit/push spec submodule cho lần cập nhật trace (giống như `feedback/`).
|
|
1123
|
-
|
|
1124
|
-
1. Phân giải `panel_mirror = ./.trace-mirror` tại **gốc workspace hiện tại**.
|
|
1125
|
-
2. Nếu `{paths.trace_dir}` **không** nằm trong workspace hiện tại, copy mỗi
|
|
1126
|
-
`{UC-ID}-{platform}.tsv` vừa cập nhật → `{panel_mirror}/{UC-ID}-{platform}.tsv` (tạo thư mục; ghi đè).
|
|
1127
|
-
Không namespace theo service — chỉ có một bộ trace; service sở hữu được mang ở
|
|
1128
|
-
**cột `service` (cột 23)** của chính từng row, do `/generate-bdd` ghi từ `@trace.service`.
|
|
1129
|
-
3. **KHÔNG copy `trace-history.jsonl`.** Nó là dữ liệu tích luỹ, không phải thứ sinh lại được —
|
|
1130
|
-
nhân bản nó ra một thư mục gitignore là tạo hai lịch sử lệch nhau rồi mất bản thật.
|
|
1131
|
-
|
|
1132
|
-
**Legacy (không có `spec_source` — trace theo service):**
|
|
1133
|
-
Copy mỗi `{UC-ID}-{platform}.tsv` vừa cập nhật → `{panel_mirror}/{service-name}/{UC-ID}-{platform}.tsv`
|
|
1134
|
-
(namespace theo `active_service`).
|
|
1135
|
-
|
|
1136
|
-
Cách này giữ panel Living Docs của workspace đang mở luôn mới **giữa các lần sync** — nó chỉ là
|
|
1137
|
-
một **mirror tiện lợi cục bộ**. File `trace-report.json` đã merge (canonical, trong
|
|
1138
|
-
`{spec_source}/.living-docs/`) được build lại bởi `/sync` hoặc `/validate-traces`. Với các lệnh
|
|
1139
|
-
được orchestrate, làm việc này một lần trong orchestrator sau khi tất cả sub-agent trả về — không phải
|
|
1140
|
-
bên trong từng sub-agent.
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
## Commit
|
|
1144
|
-
```bash
|
|
1145
|
-
git add {files}
|
|
1146
|
-
git commit -m "{commit_format}: {description}"
|
|
1147
|
-
```
|
|
1148
|
-
|
|
1149
|
-
## Output
|
|
1150
|
-
|
|
1151
|
-
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
1152
|
-
|
|
1153
|
-
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
1154
|
-
|
|
1155
|
-
## Status Badge
|
|
1156
|
-
|
|
1157
|
-
Chọn một theo kết quả:
|
|
1158
|
-
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
1159
|
-
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
1160
|
-
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
1161
|
-
|
|
1162
|
-
## Output Artifacts
|
|
1163
|
-
|
|
1164
|
-
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
1165
|
-
```
|
|
1166
|
-
Output Artifacts:
|
|
1167
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
1168
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
1169
|
-
```
|
|
1170
|
-
|
|
1171
|
-
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
1172
|
-
|
|
1173
|
-
## Pipeline Position
|
|
1174
|
-
|
|
1175
|
-
In một sơ đồ pipeline một dòng, đánh dấu phase của lệnh HIỆN TẠI bằng `◀ bạn ở đây`,
|
|
1176
|
-
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
1177
|
-
|
|
1178
|
-
```
|
|
1179
|
-
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
1180
|
-
```
|
|
1181
|
-
|
|
1182
|
-
Tìm lệnh hiện tại trong bảng phase dưới đây và đánh dấu **phase của nó** trong sơ đồ trên:
|
|
1183
|
-
|
|
1184
|
-
| Phase | Commands |
|
|
1185
|
-
|-------|----------|
|
|
1186
|
-
| Discovery | `/define-product` |
|
|
1187
|
-
| PRD | `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
1188
|
-
| Design Spec | `/generate-design-spec` |
|
|
1189
|
-
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
1190
|
-
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
1191
|
-
| Code | `/generate-code` · `/review-code` |
|
|
1192
|
-
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
1193
|
-
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
1194
|
-
| Trace Audit | `/validate-traces` |
|
|
1195
|
-
|
|
1196
|
-
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
1197
|
-
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
1198
|
-
|
|
1199
|
-
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
1200
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
1201
|
-
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
1202
|
-
|
|
1203
|
-
## Gợi ý lệnh tiếp theo
|
|
1204
|
-
|
|
1205
|
-
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
1206
|
-
|
|
1207
|
-
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
1208
|
-
|-------------------------|-----------------------------------------------|
|
|
1209
|
-
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
1210
|
-
| /define-product | `/generate-prd {product-definition-file}` |
|
|
1211
|
-
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
1212
|
-
| /extend-prd | `/refine-prd {prd-file}` (soi phần vừa thêm) rồi `/review-context {prd-file}` → PO duyệt → `/generate-bdd` **chỉ cho UC MỚI**; UC cũ dùng `/validate-traces --realign-prd-version {UC-ID}` |
|
|
1213
|
-
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
1214
|
-
| /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
|
|
1215
|
-
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
1216
|
-
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
1217
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
1218
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
1219
|
-
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
1220
|
-
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
1221
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
1222
|
-
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
1223
|
-
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
1224
|
-
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
1225
|
-
| /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
|
|
1226
|
-
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
1227
|
-
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
1228
|
-
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
1229
|
-
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
1230
|
-
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
1231
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
1232
|
-
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
1233
|
-
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
1234
|
-
| /validate-traces | **Cờ 🔴 trước (chặn PR):** SEAM_UNWIRED → nối binding sang class thật, xoá/thay stub · STUB_UNRESOLVED → `/generate-code {owner_uc}` (lấp logic tại chỗ + xoá hàm song song) · ORPHANED/TRACE_ORPHAN → quyết định thủ công (xoá code+test, đưa scenario trở lại `.feature`, hoặc sửa `sc_id` của tag). **Rồi:** DRIFT/UNTRACKED → `/generate-code {UC-ID}` · BDD_DRIFT → `/generate-code {feature-file}` · tech-doc lỗi thời vs BDD → `/generate-tech-docs` → `/review-tech-docs` · PRD drift → `/generate-bdd {prd-file}` · GAP → `/dev-gen-test {UC-ID}`. **Chỉ tạo PR khi mọi cờ 🔴 = 0** |
|
|
1235
|
-
| /fix-bug | `/dev-run-test {UC-ID}` (dev_selftest vừa reset về not_run) → tạo PR; nếu fix một `{BUG-ID}` → QC chạy `/qc-run-test {UC-ID}` để verify + đóng bug |
|
|
1236
|
-
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
1237
|
-
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
1238
|
-
| /propose-scenario | **Case A** (thiếu scenario cho AC có sẵn) → báo PO/Dev review trong `feedback/bdd-proposals/`; `/generate-bdd` tự chèn khi `Status: accepted`. **Case B** (requirement mới) → `feedback/prd-change-requests/` — PO phải đưa vào PRD trước, KHÔNG tự vào BDD được; `/validate-traces` nhắc lại kèm số ngày chờ chừng nào `Status: Open` |
|
|
1239
|
-
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
1240
|
-
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
1241
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
1242
|
-
|
|
1243
|
-
Định dạng footer như sau:
|
|
1244
|
-
```
|
|
1245
|
-
---
|
|
1246
|
-
Status : {badge}
|
|
1247
|
-
{khối Output Artifacts}
|
|
1248
|
-
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
1249
|
-
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
1250
|
-
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
1251
|
-
```
|
|
1252
|
-
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
```
|
|
1256
|
-
/generate-code Hoàn tất — {UC-ID}
|
|
1257
|
-
Files: created={N}, extended={M}, filled={F} stub, skipped={K} | Build: SUCCESS
|
|
1258
|
-
Branch: feature/{TICKET_ID}-{slug}
|
|
1259
|
-
Phase : {UI (mock layer) | Integration (real API) | FE full (UI + real API) | BE full}
|
|
1260
|
-
fe_phase : {ui | integration (—phase=integration | fe_full) | —}
|
|
1261
|
-
Figma : {Dev Mode MCP local (grounded) | ⚠️ chỉ link web + text spec (không có MCP local) | n/a cho BE} ← chỉ UI FE/App
|
|
1262
|
-
|
|
1263
|
-
Next:
|
|
1264
|
-
--phase=ui xong:
|
|
1265
|
-
→ Báo tester: FE test được qua mock adapter
|
|
1266
|
-
→ Thu sign-off BE → /review-tech-docs {tech-design-file}
|
|
1267
|
-
→ Khi BE sẵn sàng → /generate-code {feature-file} --phase=integration
|
|
1268
|
-
|
|
1269
|
-
--phase=integration xong:
|
|
1270
|
-
→ /review-code {UC-ID} ← cần code review
|
|
1271
|
-
→ /dev-gen-test {UC-ID} ← bộ integration test
|
|
1272
|
-
|
|
1273
|
-
Default (không có flag phase):
|
|
1274
|
-
→ /review-code {UC-ID} ← cần code review trước khi test
|
|
1275
|
-
→ /dev-gen-test {UC-ID}
|
|
1276
|
-
|
|
1277
|
-
Nếu lần này LẤP stub (filled > 0):
|
|
1278
|
-
→ /dev-gen-test {owner_uc} ← test cho logic vừa lấp
|
|
1279
|
-
→ /dev-gen-test {consumer_uc} ← RE-GEN: test cũ của {consumer_uc} viết trên hàm trắng, giờ đã cũ
|
|
1280
|
-
(dev_selftest các scenario này đã bị reset → not_run; /validate-traces sẽ hiện chúng là GAP tới khi test lại)
|
|
1281
|
-
|
|
1282
|
-
📊 Living Docs: chạy /validate-traces (hoặc /sync) để push trace này lên dashboard spec-module.
|
|
1283
|
-
```
|