@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,982 +0,0 @@
|
|
|
1
|
-
# /review-tech-docs — Review Technical Design Document
|
|
2
|
-
|
|
3
|
-
**Chế độ phân tích READ-ONLY — ghi file findings, KHÔNG sửa target.**
|
|
4
|
-
**Dùng `--resume` để áp dụng các finding được chấp nhận.**
|
|
5
|
-
|
|
6
|
-
## Gate
|
|
7
|
-
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
8
|
-
|
|
9
|
-
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ó.
|
|
10
|
-
|
|
11
|
-
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
12
|
-
|
|
13
|
-
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
14
|
-
|
|
15
|
-
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
16
|
-
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
17
|
-
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
18
|
-
- Đặt target file = `payload.target_file`
|
|
19
|
-
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
20
|
-
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
21
|
-
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
22
|
-
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
23
|
-
- Đi thẳng tới phần logic riêng của lệnh.
|
|
24
|
-
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).
|
|
25
|
-
|
|
26
|
-
## Bước 0-B — Kiểm tra Model
|
|
27
|
-
|
|
28
|
-
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
29
|
-
|
|
30
|
-
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.
|
|
31
|
-
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.
|
|
32
|
-
|
|
33
|
-
Hiển thị và chờ phản hồi:
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
⚙️ MODEL CHECK
|
|
37
|
-
──────────────────────────────────────────────────────────────────
|
|
38
|
-
Recommended : model Opus mới nhất
|
|
39
|
-
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
40
|
-
suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
|
|
41
|
-
|
|
42
|
-
Cách đổi trong Claude Code:
|
|
43
|
-
• /model → chọn model Opus
|
|
44
|
-
• hoặc: Settings → Model
|
|
45
|
-
|
|
46
|
-
Đang chạy một model Opus?
|
|
47
|
-
Y — đúng → tiếp tục
|
|
48
|
-
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)
|
|
49
|
-
──────────────────────────────────────────────────────────────────
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
- "Y" → tiếp tục sang Bước 1.
|
|
53
|
-
- "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).
|
|
54
|
-
- "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."
|
|
55
|
-
|
|
56
|
-
## Bước 1 — Xác định Target File
|
|
57
|
-
|
|
58
|
-
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.)
|
|
59
|
-
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.
|
|
60
|
-
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/`):
|
|
61
|
-
- **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 đó.
|
|
62
|
-
- **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.)*
|
|
63
|
-
- **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:
|
|
64
|
-
- `$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`.
|
|
65
|
-
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
66
|
-
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
67
|
-
- 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.
|
|
68
|
-
*(Đừ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`.)*
|
|
69
|
-
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
70
|
-
|
|
71
|
-
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.
|
|
72
|
-
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
73
|
-
- 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).
|
|
74
|
-
- 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)"
|
|
75
|
-
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
76
|
-
|
|
77
|
-
## Bước 2 — Chạy Context Loader
|
|
78
|
-
|
|
79
|
-
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`.
|
|
80
|
-
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.
|
|
81
|
-
|
|
82
|
-
## Bước 3 — CHECKPOINT
|
|
83
|
-
|
|
84
|
-
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:
|
|
85
|
-
|
|
86
|
-
```
|
|
87
|
-
CHECKPOINT
|
|
88
|
-
-----------
|
|
89
|
-
Target : {resolved file path}
|
|
90
|
-
Project : {project.name từ project-context.yaml}
|
|
91
|
-
Tech stack : {language} / {framework}
|
|
92
|
-
Module : {module nếu có, else "not configured"}
|
|
93
|
-
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
94
|
-
|
|
95
|
-
Tiếp tục? (Y/N)
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
99
|
-
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
100
|
-
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
*Lưu ý: Với lệnh này, target ở Bước 1 là **file tech-design gộp của PRD** `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md` — MỘT doc full-stack phủ mọi UC của PRD (không còn per-UC / per-platform). Review chạy trên cả doc; findings gom theo từng UC (đọc §10 UC Coverage để biết finding thuộc UC nào).
|
|
104
|
-
Nếu `$ARGUMENTS` chứa `--resume` → bỏ qua sang Resume Mode bên dưới.*
|
|
105
|
-
|
|
106
|
-
## Context
|
|
107
|
-
# Context Loader — Nạp toàn bộ context dự án
|
|
108
|
-
|
|
109
|
-
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.
|
|
110
|
-
|
|
111
|
-
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
112
|
-
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
113
|
-
- 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.
|
|
114
|
-
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
115
|
-
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
116
|
-
- 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.
|
|
117
|
-
|
|
118
|
-
---
|
|
119
|
-
|
|
120
|
-
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
121
|
-
|
|
122
|
-
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
123
|
-
|
|
124
|
-
**Tech Stack:**
|
|
125
|
-
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
126
|
-
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
127
|
-
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
128
|
-
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
129
|
-
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
130
|
-
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
131
|
-
|
|
132
|
-
**Conventions:**
|
|
133
|
-
- `conventions.build_command` → cách compile/build
|
|
134
|
-
- `conventions.test_command` → cách chạy test
|
|
135
|
-
- `conventions.service_run` → cách khởi động service
|
|
136
|
-
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
137
|
-
|
|
138
|
-
**Domains:**
|
|
139
|
-
- `domains` → danh sách các business domain đang hoạt động
|
|
140
|
-
|
|
141
|
-
**Paths (nếu có):**
|
|
142
|
-
- `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)
|
|
143
|
-
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
144
|
-
- `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}/`)
|
|
145
|
-
- `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 đè)
|
|
146
|
-
- `paths.product_definitions_dir` → gốc product definition
|
|
147
|
-
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
148
|
-
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
149
|
-
- `paths.core_entities` → path tới core-entities.md
|
|
150
|
-
- `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/`)
|
|
151
|
-
- `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)
|
|
152
|
-
- `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ổ)
|
|
153
|
-
|
|
154
|
-
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
155
|
-
- `specs_dir` = `specs`
|
|
156
|
-
- `refinement_dir` = `.agent/review`
|
|
157
|
-
- `qc_dir` = `docs`
|
|
158
|
-
- `qc_skills_dir` = `.agent/skills/qc`
|
|
159
|
-
- `product_definitions_dir` = `specs/product-definition`
|
|
160
|
-
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
161
|
-
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
162
|
-
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
163
|
-
- `tech_docs_dir` = `specs`
|
|
164
|
-
- `src_dir` = `src`
|
|
165
|
-
- `trace_dir` = `.trace`
|
|
166
|
-
|
|
167
|
-
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.
|
|
168
|
-
|
|
169
|
-
**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ụ:
|
|
170
|
-
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
171
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
172
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
173
|
-
- `specs/payment/create-invoice/tech-docs/PAY01-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
174
|
-
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
175
|
-
|
|
176
|
-
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ừ đó.
|
|
177
|
-
|
|
178
|
-
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.
|
|
179
|
-
|
|
180
|
-
---
|
|
181
|
-
|
|
182
|
-
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
183
|
-
|
|
184
|
-
*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.*
|
|
185
|
-
|
|
186
|
-
Nếu có section `services`:
|
|
187
|
-
|
|
188
|
-
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
189
|
-
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
190
|
-
- 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.
|
|
191
|
-
*(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`)*
|
|
192
|
-
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
193
|
-
|
|
194
|
-
**1b. Phát hiện active platform** (chỉ cần khi service ở dạng map-theo-platform — bước 2b):
|
|
195
|
-
- Đọc `@trace.platform` từ header của target `.feature` (`system` | `web` | `app`) — Gate đã resolve target trước bước này.
|
|
196
|
-
- Nếu target không mang `@trace.platform` (vd target là PRD `.md`), thử suy từ segment `bdd/{platform}/` trong path target.
|
|
197
|
-
- Nếu vẫn không xác định được → `active_platform = null`.
|
|
198
|
-
|
|
199
|
-
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
200
|
-
|
|
201
|
-
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.
|
|
202
|
-
|
|
203
|
-
Thứ trỏ tới đích gọi là một **service entry**. Nó chỉ có hai kiểu:
|
|
204
|
-
|
|
205
|
-
| Kiểu | Nhận ra bằng | Nghĩa |
|
|
206
|
-
|---|---|---|
|
|
207
|
-
| **Đã chốt** | có `path` | Xong — đây là submodule cần tìm |
|
|
208
|
-
| **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) |
|
|
209
|
-
|
|
210
|
-
**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ì):
|
|
211
|
-
|
|
212
|
-
| Entry trông thế nào | Xử lý |
|
|
213
|
-
|---|---|
|
|
214
|
-
| có `path`, không có `by_prd_slug` | hợp lệ → dùng |
|
|
215
|
-
| có `by_prd_slug`, không có `path` | hợp lệ → tra tiếp (2c) |
|
|
216
|
-
| **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. |
|
|
217
|
-
| **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` |
|
|
218
|
-
| `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 |
|
|
219
|
-
|
|
220
|
-
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:
|
|
221
|
-
|
|
222
|
-
| Thấy gì trong `services.{domain}` | Đi nhánh |
|
|
223
|
-
|---|---|
|
|
224
|
-
| có `path` | **2a** — chốt luôn |
|
|
225
|
-
| có `by_prd_slug` | **2c** — tra bằng `prd_slug` |
|
|
226
|
-
| 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 |
|
|
227
|
-
|
|
228
|
-
**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ũ:
|
|
229
|
-
- Lưu `active_service` = `services.{domain}.path`
|
|
230
|
-
- Lưu `active_service_module` = `services.{domain}.module`
|
|
231
|
-
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
232
|
-
|
|
233
|
-
**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):
|
|
234
|
-
- 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 đó.
|
|
235
|
-
- 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ể.
|
|
236
|
-
- 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}`".
|
|
237
|
-
|
|
238
|
-
**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.
|
|
239
|
-
|
|
240
|
-
Đến đây `prd_slug` đã được trích ở bước 1 (không cần detect thêm gì). Route:
|
|
241
|
-
|
|
242
|
-
- 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`).
|
|
243
|
-
**"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.
|
|
244
|
-
- 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}`).
|
|
245
|
-
⚠️ Đâ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.
|
|
246
|
-
- 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.
|
|
247
|
-
|
|
248
|
-
Vị trí đặt `by_prd_slug` — hợp lệ ở **cả hai cấp**:
|
|
249
|
-
- **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.
|
|
250
|
-
- **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.
|
|
251
|
-
|
|
252
|
-
*(`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.)*
|
|
253
|
-
|
|
254
|
-
Ví dụ (một domain trải nhiều platform, riêng `webview` chia theo feature):
|
|
255
|
-
```yaml
|
|
256
|
-
services:
|
|
257
|
-
learning:
|
|
258
|
-
system: { path: "backend", module: "java-spring" }
|
|
259
|
-
web: { path: "web-app", module: "nextjs" }
|
|
260
|
-
webview:
|
|
261
|
-
by_prd_slug:
|
|
262
|
-
dap-chuot: { path: "games/whac-a-mole", module: "phaser-game" }
|
|
263
|
-
ban-cung: { path: "games/archery", module: "phaser-game" }
|
|
264
|
-
```
|
|
265
|
-
→ target `specs/learning/dap-chuot/bdd/webview/UC1.feature` cho `domain = learning`,
|
|
266
|
-
`active_platform = webview`, `prd_slug = dap-chuot` → `active_service = games/whac-a-mole`.
|
|
267
|
-
|
|
268
|
-
*(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.)*
|
|
269
|
-
|
|
270
|
-
**3. Fallback**:
|
|
271
|
-
- 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`.
|
|
272
|
-
- 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).
|
|
273
|
-
- 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).
|
|
274
|
-
- 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`.
|
|
275
|
-
|
|
276
|
-
**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:`:
|
|
277
|
-
- 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`.)*
|
|
278
|
-
- 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.)*
|
|
279
|
-
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
280
|
-
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
281
|
-
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
282
|
-
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
283
|
-
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
284
|
-
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
285
|
-
- 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`.)*
|
|
286
|
-
- 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`.)*
|
|
287
|
-
|
|
288
|
-
> **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.
|
|
289
|
-
|
|
290
|
-
---
|
|
291
|
-
|
|
292
|
-
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
293
|
-
|
|
294
|
-
*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.*
|
|
295
|
-
|
|
296
|
-
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
297
|
-
|
|
298
|
-
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
299
|
-
- `{active_service}/.agent/project-context.yaml`
|
|
300
|
-
- `{active_service}/project-context.yaml`
|
|
301
|
-
|
|
302
|
-
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
303
|
-
|
|
304
|
-
| Biến | Nguồn |
|
|
305
|
-
|----------|--------|
|
|
306
|
-
| `conventions.test_command` | `conventions.test_command` của service |
|
|
307
|
-
| `conventions.build_command` | `conventions.build_command` của service |
|
|
308
|
-
| `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`). |
|
|
309
|
-
| `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. |
|
|
310
|
-
| `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`. |
|
|
311
|
-
|
|
312
|
-
**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:
|
|
313
|
-
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
314
|
-
- **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/`).
|
|
315
|
-
|
|
316
|
-
**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).
|
|
317
|
-
|
|
318
|
-
---
|
|
319
|
-
|
|
320
|
-
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
321
|
-
|
|
322
|
-
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
323
|
-
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
324
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
325
|
-
|
|
326
|
-
---
|
|
327
|
-
|
|
328
|
-
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
329
|
-
|
|
330
|
-
*Đâ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.*
|
|
331
|
-
|
|
332
|
-
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
333
|
-
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
|
|
334
|
-
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
|
|
335
|
-
service phải thắng khi sinh code.
|
|
336
|
-
|
|
337
|
-
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
338
|
-
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
339
|
-
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
340
|
-
kiến trúc + coding standards duy nhất của dự án.
|
|
341
|
-
|
|
342
|
-
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
343
|
-
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
344
|
-
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
345
|
-
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
346
|
-
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,
|
|
347
|
-
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
348
|
-
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
349
|
-
|
|
350
|
-
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
351
|
-
|
|
352
|
-
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
353
|
-
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
354
|
-
- **§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*.
|
|
355
|
-
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
356
|
-
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
357
|
-
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
358
|
-
|
|
359
|
-
**Quy tắc phân giải:**
|
|
360
|
-
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
361
|
-
- 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}`.
|
|
362
|
-
- 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).
|
|
363
|
-
- 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.
|
|
364
|
-
|
|
365
|
-
---
|
|
366
|
-
|
|
367
|
-
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
368
|
-
|
|
369
|
-
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
370
|
-
|
|
371
|
-
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.
|
|
372
|
-
|
|
373
|
-
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*`.
|
|
374
|
-
|
|
375
|
-
---
|
|
376
|
-
|
|
377
|
-
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
378
|
-
|
|
379
|
-
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).
|
|
380
|
-
|
|
381
|
-
Nếu tồn tại, đọc và trích xuất:
|
|
382
|
-
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
383
|
-
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
384
|
-
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
385
|
-
|
|
386
|
-
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
387
|
-
- 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
|
|
388
|
-
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
389
|
-
|
|
390
|
-
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
391
|
-
|
|
392
|
-
---
|
|
393
|
-
|
|
394
|
-
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
395
|
-
|
|
396
|
-
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).
|
|
397
|
-
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
398
|
-
|
|
399
|
-
Nếu tồn tại, đọc và lưu:
|
|
400
|
-
- **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ệ
|
|
401
|
-
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
402
|
-
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
403
|
-
|
|
404
|
-
**Cách dùng catalog này:**
|
|
405
|
-
- 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
|
|
406
|
-
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
407
|
-
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
408
|
-
|
|
409
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
410
|
-
|
|
411
|
-
---
|
|
412
|
-
|
|
413
|
-
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
414
|
-
|
|
415
|
-
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:
|
|
416
|
-
|
|
417
|
-
```
|
|
418
|
-
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
419
|
-
```
|
|
420
|
-
|
|
421
|
-
| `platform_type` | Modules |
|
|
422
|
-
|---|---|
|
|
423
|
-
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
424
|
-
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular`, `phaser-game` |
|
|
425
|
-
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
426
|
-
|
|
427
|
-
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.
|
|
428
|
-
|
|
429
|
-
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).
|
|
430
|
-
|
|
431
|
-
---
|
|
432
|
-
|
|
433
|
-
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
434
|
-
|
|
435
|
-
*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`
|
|
436
|
-
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
437
|
-
|
|
438
|
-
Phân giải path file lessons:
|
|
439
|
-
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
440
|
-
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
441
|
-
- Ở 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`
|
|
442
|
-
|
|
443
|
-
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:
|
|
444
|
-
- 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).
|
|
445
|
-
- 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).
|
|
446
|
-
- 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.
|
|
447
|
-
|
|
448
|
-
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
449
|
-
|
|
450
|
-
---
|
|
451
|
-
|
|
452
|
-
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
453
|
-
|
|
454
|
-
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.
|
|
455
|
-
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
|
|
456
|
-
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
457
|
-
|
|
458
|
-
Xuất đúng khối này:
|
|
459
|
-
```
|
|
460
|
-
[CTX LOADED]
|
|
461
|
-
Stack : {language} / {framework} / {database}
|
|
462
|
-
Platform : {active_module} ({platform_type})
|
|
463
|
-
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
464
|
-
Package : {code_base_package}.{layer} · {by-layer | by-feature} ← feature/UC → tên class, KHÔNG thành package (nếu by-layer)
|
|
465
|
-
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
466
|
-
Ticket : {ticket_prefix}-
|
|
467
|
-
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
468
|
-
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
469
|
-
Lessons : {loaded — N guardrails | chưa có}
|
|
470
|
-
Platform : {active_platform: system | web | app | — nếu chưa xác định}
|
|
471
|
-
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
|
|
472
|
-
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
473
|
-
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
474
|
-
```
|
|
475
|
-
|
|
476
|
-
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.
|
|
477
|
-
|
|
478
|
-
---
|
|
479
|
-
|
|
480
|
-
## Hoàn tất nạp Context
|
|
481
|
-
|
|
482
|
-
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
483
|
-
- Định danh dự án, tech stack, convention module
|
|
484
|
-
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
485
|
-
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
486
|
-
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
487
|
-
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
488
|
-
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
489
|
-
- Toàn bộ path đã cấu hình
|
|
490
|
-
|
|
491
|
-
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
---
|
|
495
|
-
|
|
496
|
-
## Nạp tài liệu Review
|
|
497
|
-
|
|
498
|
-
Sau khi nạp context nền, đọc các thứ sau theo thứ tự:
|
|
499
|
-
|
|
500
|
-
1. **Tech-doc target** — đọc đầy đủ. Trích từ header:
|
|
501
|
-
- `@trace.ucs` → danh sách UC mà doc phủ (đối chiếu §10 UC Coverage)
|
|
502
|
-
- `@trace.domain` → domain
|
|
503
|
-
- `@trace.prd` → TICKET-ID của PRD nguồn
|
|
504
|
-
- `@trace.platforms` → các platform có mặt (system / web / app)
|
|
505
|
-
- `@trace.status` → status hiện tại (draft / in-review / approved)
|
|
506
|
-
|
|
507
|
-
2. **Các file BDD nguồn** — nạp **mọi** feature của PRD này: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/**/*.feature` (system/web/app). Đây là nguồn đối chiếu cho T3/T7 — mỗi UC trong doc phải trace về scenario BDD tương ứng.
|
|
508
|
-
|
|
509
|
-
3. **Index endpoint cho T4 (KHÔNG nạp full doc khác)** — trích danh sách endpoint (§4.1) + entity chính của doc target. T4 sẽ `grep` các path đó trong `{paths.tech_docs_dir}/{domain}/*/tech-docs/*-tech-design.md` (các PRD khác) và chỉ nạp đoạn liên quan **khi có va chạm** — xem T4.
|
|
510
|
-
|
|
511
|
-
4. **Tham chiếu kiến trúc** — xác nhận lại CLAUDE.md §2: thứ tự layer, quy tắc kiến trúc.
|
|
512
|
-
|
|
513
|
-
5. **Core entities** — đã nạp trong context (Bước 6 của context-loader).
|
|
514
|
-
|
|
515
|
-
6. **PRD nguồn — §Business Rules (cho T8)** — nạp file PRD `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md`, trích bảng Business Rule/Business Logic của các UC mà doc phủ. Đây là nguồn đối chiếu-ngược của **T8** (BR nào yêu cầu nguồn/sự kiện/generic-contract mà doc bỏ sót). Chỉ đọc §BR + §AC liên quan — KHÔNG cần toàn PRD.
|
|
516
|
-
|
|
517
|
-
Suy ra tên file findings (per-PRD):
|
|
518
|
-
`{paths.refinement_dir}/{TICKET-ID}-tech-review-findings.yaml`
|
|
519
|
-
|
|
520
|
-
---
|
|
521
|
-
|
|
522
|
-
## Review Dimensions
|
|
523
|
-
|
|
524
|
-
### T1 — Architecture Alignment *(luôn CRITICAL nếu vi phạm)*
|
|
525
|
-
|
|
526
|
-
Đối chiếu design đề xuất với quy tắc CLAUDE.md §2:
|
|
527
|
-
|
|
528
|
-
| Loại vi phạm | Severity |
|
|
529
|
-
|----------------|----------|
|
|
530
|
-
| Controller gọi Repository trực tiếp (skip layer) | Critical |
|
|
531
|
-
| Business logic trong Controller hoặc DTO | Critical |
|
|
532
|
-
| Pattern bị cấm từ §3 | Critical |
|
|
533
|
-
| Phụ thuộc đi ngược upstream (Service → Controller DTO) | Critical |
|
|
534
|
-
| Annotation transaction sai layer | Major |
|
|
535
|
-
| Thiếu tách lớp (không có Facade khi kiến trúc yêu cầu) | Major |
|
|
536
|
-
|
|
537
|
-
Với mỗi finding:
|
|
538
|
-
```
|
|
539
|
-
Component: {tên class hoặc method}
|
|
540
|
-
Violates: "{rule text}" (CLAUDE.md §2)
|
|
541
|
-
Fix: {layer/component nào nên sở hữu cái này}
|
|
542
|
-
```
|
|
543
|
-
→ **Không auto-fix.** Người phải quyết định fix cấu trúc. Bắt buộc note trong Review Board.
|
|
544
|
-
|
|
545
|
-
### T2 — Entity Consistency
|
|
546
|
-
|
|
547
|
-
Dùng catalog core-entities đã nạp:
|
|
548
|
-
|
|
549
|
-
| Vấn đề | Severity | Auto-fixable? |
|
|
550
|
-
|-------|----------|---------------|
|
|
551
|
-
| Entity được nhắc nhưng không có trong core-entities.md | Major | No — người confirm là DTO hay domain entity |
|
|
552
|
-
| Tên field khác core-entities.md | Major | Yes — đổi về canonical |
|
|
553
|
-
| Quan hệ được mô tả khác đi | Major | No — người quyết định |
|
|
554
|
-
| Entity mới được đưa ra nhưng chưa có trong core-entities.md | Minor | No — thêm vào core-entities trước |
|
|
555
|
-
|
|
556
|
-
### T3 — BDD Traceability
|
|
557
|
-
|
|
558
|
-
Đối chiếu với **mọi** feature BDD của PRD (system/web/app). Với mỗi UC trong §10 UC Coverage, kiểm tra design khớp scenario **2 chiều**.
|
|
559
|
-
|
|
560
|
-
> ⚠ **SC scope theo platform:** `{UC}-SC{N}` chỉ unique trong (UC × platform) — `system UC1-SC1` và `web UC1-SC1` là **hai scenario khác nhau**. Khi đối chiếu, match SC **trong đúng lane platform** (system SC ↔ system BDD, web SC ↔ web BDD, app SC ↔ app BDD). KHÔNG so chéo platform. §5 phải để mỗi SC trong lane 5.A/5.B/5.C của nó; §10 mỗi dòng có cột Platform.
|
|
561
|
-
|
|
562
|
-
| Vấn đề | Severity | Auto-fixable? |
|
|
563
|
-
|-------|----------|---------------|
|
|
564
|
-
| Tech-doc đề xuất behavior không có trong scenario BDD nào (cùng platform) | Major | No — tạo scenario trước |
|
|
565
|
-
| Tech-doc mâu thuẫn một scenario BDD | Critical | No — giải quyết conflict trước |
|
|
566
|
-
| Scenario (platform, SC) không có design tương ứng (thiếu ở §5 lane hoặc §10) | Minor | Yes — thêm design note còn thiếu |
|
|
567
|
-
| §10 UC Coverage sót một (platform, SC) đã có BDD | Major | Yes — thêm dòng coverage + section tương ứng |
|
|
568
|
-
| SC ghi trong §5/§10 **không kèm platform** (bare `UC1-SC1`) → nhập nhằng | Major | Yes — gắn platform vào SC ref |
|
|
569
|
-
|
|
570
|
-
### T3b — BDD Freshness *(tech-doc còn khớp BDD hiện tại không)*
|
|
571
|
-
|
|
572
|
-
*T3 kiểm **nội dung** khớp không. T3b kiểm **độ tươi**: doc này dựng từ BDD version nào, BDD giờ ở version nào. Đây là lỗ hổng cũ — không lệnh nào so hai giá trị này, nên tech-doc âm thầm lỗi thời mà vẫn giữ `@trace.status: approved`.*
|
|
573
|
-
|
|
574
|
-
Header tech-doc mang `@trace.bdd_versions` (**số nhiều** — map theo platform, vd `system=1.5, web=1.9`). Với **mỗi** entry trong map, đọc `@trace.bdd_version` (**số ít**, scalar) của `.feature` tương ứng (`{paths.specs_dir}/{domain}/{prd-slug}/bdd/{platform}/{TICKET-ID}-UC*.feature`):
|
|
575
|
-
|
|
576
|
-
| Điều kiện | Severity | Auto-fixable? |
|
|
577
|
-
|---|---|---|
|
|
578
|
-
| Map khớp `.feature` | *(sạch)* | — |
|
|
579
|
-
| `.feature` **mới hơn** map | **Major** | **No** — cần người review §4/§4.5 rồi bump `@trace.revision` |
|
|
580
|
-
| Platform có `.feature` nhưng **vắng** trong map | **Major** | Yes — thêm entry sau khi xác nhận §4 đã phủ platform đó |
|
|
581
|
-
| Map có platform mà **không** có `.feature` | Minor | Yes — xoá entry (BDD đã bỏ platform đó) |
|
|
582
|
-
|
|
583
|
-
Prose của finding "`.feature` mới hơn": *"tech-doc dựng từ BDD {platform}=v{old}, BDD giờ v{new} — §4 contract có thể đã lệch so với behavior đã chốt. Review lại §4.1–4.3 (+ §4.5 nếu FE) rồi bump `@trace.revision`."*
|
|
584
|
-
|
|
585
|
-
> **Vì sao là Major chứ không phải Minor:** `/generate-code` DS3 thấy tech-doc `@trace.status: approved` + 0 blocker-GAP thì lấy shape DTO/endpoint/error ở §4 **nguyên văn** làm contract "đã chốt". Contract dựng từ BDD cũ sẽ lan **thẳng** vào code, không cảnh báo. Đây là ca tệ hơn drift-về-code vì nó sai từ nguồn.
|
|
586
|
-
|
|
587
|
-
**Cổng chặn `approved` (chặn MỀM — đồng bộ với DS3/DS4 của `/generate-code`, không chặn cứng):** còn ≥1 finding T3b Major ở trạng thái `open` → khi người dùng định đặt `@trace.status: approved`, hiện CHECKPOINT:
|
|
588
|
-
```
|
|
589
|
-
⚠️ {n} platform có BDD mới hơn bản mà tech-doc này dựng từ:
|
|
590
|
-
{platform}: doc dựng từ v{old} · .feature giờ v{new}
|
|
591
|
-
Duyệt doc bây giờ = chốt một contract có thể đã lệch behavior.
|
|
592
|
-
Vẫn đặt approved? (Y/N)
|
|
593
|
-
```
|
|
594
|
-
Chỉ tiếp khi `Y`. *(Khác GATE của §12 blocker-GAP — cái đó chặn cứng. Ở đây chặn mềm vì BDD có thể bump vì lý do không chạm contract, vd sửa từ ngữ step; người review là người biết.)*
|
|
595
|
-
|
|
596
|
-
### T4 — Cross-PRD Endpoint Conflict Check *(targeted, load-on-hit)*
|
|
597
|
-
|
|
598
|
-
Mỗi PRD giờ chỉ 1 doc → xung đột TRONG doc đã do **T5** lo. T4 chỉ soi xung đột **liên-PRD** theo cách rẻ, KHÔNG nạp full doc khác:
|
|
599
|
-
|
|
600
|
-
1. Trích danh sách endpoint (method + path, §4.1) + entity chính của doc target.
|
|
601
|
-
2. `grep` từng path/entity đó trong `{paths.tech_docs_dir}/{domain}/*/tech-docs/*-tech-design.md` (trừ target) — chỉ đọc dòng match.
|
|
602
|
-
3. **Chỉ khi có va chạm** (một path/entity xuất hiện ở doc PRD khác) → nạp đúng đoạn §4.1/§4.2 (hoặc §3) của doc đó để so shape.
|
|
603
|
-
|
|
604
|
-
| Vấn đề *(chỉ khi grep dính)* | Severity | Auto-fixable? |
|
|
605
|
-
|-------|----------|---------------|
|
|
606
|
-
| Cùng endpoint path, request/response khác shape giữa 2 PRD | Critical | No — người giải quyết |
|
|
607
|
-
| Cùng service method với behavior khác | Critical | No — người giải quyết |
|
|
608
|
-
| Status transition của cùng entity khác nhau giữa các doc PRD | Critical | No — người giải quyết |
|
|
609
|
-
| Trách nhiệm chồng lấn (2 PRD cùng nhận sở hữu 1 endpoint/logic) | Major | No — người giải quyết |
|
|
610
|
-
|
|
611
|
-
Không có va chạm grep → T4 pass, không nạp thêm gì.
|
|
612
|
-
|
|
613
|
-
### T5 — Internal Consistency
|
|
614
|
-
|
|
615
|
-
Trong nội bộ tech-doc:
|
|
616
|
-
|
|
617
|
-
| Check | Severity | Auto-fixable? |
|
|
618
|
-
|-------|----------|---------------|
|
|
619
|
-
| Sequence diagram thể hiện flow khác phần mô tả viết | Major | No |
|
|
620
|
-
| API spec return type khác code sketch | Major | Yes — căn chỉnh cái này theo cái kia |
|
|
621
|
-
| Section tham chiếu một component/concept không bao giờ được định nghĩa sau đó | Minor | Yes — thêm định nghĩa |
|
|
622
|
-
| Assumption được nêu nhưng không design nào xử lý nó | Minor | Yes — thêm note hoặc bỏ assumption |
|
|
623
|
-
|
|
624
|
-
### T6 — Structural Completeness
|
|
625
|
-
|
|
626
|
-
Kiểm tra tất cả section chuẩn có mặt và không rỗng:
|
|
627
|
-
|
|
628
|
-
| Section | Missing severity |
|
|
629
|
-
|---------|-----------------|
|
|
630
|
-
| Header (`@trace.prd`, `@trace.ucs`, `@trace.domain`, `@trace.status`) | Major |
|
|
631
|
-
| Overview / Context | Major |
|
|
632
|
-
| Architecture Decision kèm lý do | Major |
|
|
633
|
-
| Component Diagram hoặc Layer Description | Major |
|
|
634
|
-
| Sequence Diagram hoặc Flow Steps | Major |
|
|
635
|
-
| API Contract (nếu hướng HTTP) | Major |
|
|
636
|
-
| Data Model Changes (nếu entity đổi) | Major |
|
|
637
|
-
| Error Handling Strategy | Major |
|
|
638
|
-
| Open Questions / Assumptions | Minor |
|
|
639
|
-
|
|
640
|
-
→ Mọi finding section-thiếu T6 đều **auto-fixable**: AI thêm skeleton section kèm prompt.
|
|
641
|
-
|
|
642
|
-
### T7 — Cross-Team API Contract Review
|
|
643
|
-
|
|
644
|
-
*Chỉ áp dụng khi TẤT CẢ điều sau đúng:*
|
|
645
|
-
*1. Doc có phần backend/API (`@trace.platforms` gồm `system`, tức PRD có System BDD).*
|
|
646
|
-
*2. Header tech-doc KHÔNG có `@trace.api_source: existing`.*
|
|
647
|
-
|
|
648
|
-
*Nếu `@trace.api_source: existing` → **skip T7 hoàn toàn**. Contract đã được PO xác định trong PRD — không có API design mới để đồng thuận.*
|
|
649
|
-
|
|
650
|
-
Dimension này đảm bảo team FE, App, và BE đều đồng thuận API contract trước khi bắt đầu implement.
|
|
651
|
-
|
|
652
|
-
**Step 1 — Check status sign-off trong header tech-doc:**
|
|
653
|
-
|
|
654
|
-
Đọc block `@trace.sign_off` trong header tech doc. Nếu vắng → thêm như một finding (auto-fixable: thêm skeleton).
|
|
655
|
-
|
|
656
|
-
```yaml
|
|
657
|
-
# @trace.sign_off:
|
|
658
|
-
# be_team: pending # author — set "done" khi BE hài lòng với design
|
|
659
|
-
# fe_team: pending # FE/Web — phải confirm contract khớp expectation của web BDD
|
|
660
|
-
# app_team: pending # App — phải confirm contract khớp expectation của app BDD (nếu áp dụng)
|
|
661
|
-
# sa: pending # SA/Tech Lead — approval cuối
|
|
662
|
-
```
|
|
663
|
-
|
|
664
|
-
**Step 2 — Contract vs BDD cross-check:**
|
|
665
|
-
|
|
666
|
-
Nạp web và app BDD cho TICKET-ID này (từ `{paths.specs_dir}/{domain}/{prd-slug}/bdd/web/` và `{paths.specs_dir}/{domain}/{prd-slug}/bdd/app/` trong spec submodule hoặc spec repo).
|
|
667
|
-
|
|
668
|
-
Với mỗi platform BDD, kiểm tra API contract của tech doc có thoả các mệnh đề `Then` của BDD không:
|
|
669
|
-
|
|
670
|
-
| Check | Severity |
|
|
671
|
-
|---|---|
|
|
672
|
-
| Field response trong API contract không phủ những gì web BDD `Then` mong | Critical |
|
|
673
|
-
| Field response trong API contract không phủ những gì app BDD `Then` mong | Critical |
|
|
674
|
-
| Shape error response không khớp những gì các platform BDD mong | Major |
|
|
675
|
-
| Annotation `@system.resolution` của System BDD mâu thuẫn với design API contract | Critical |
|
|
676
|
-
|
|
677
|
-
**Step 3 — Report sign-off pending:**
|
|
678
|
-
|
|
679
|
-
Sau review, liệt kê các sign-off còn `pending`:
|
|
680
|
-
|
|
681
|
-
```
|
|
682
|
-
⏳ Sign-off pending trước khi tech docs được approve:
|
|
683
|
-
fe_team — team FE/Web phải confirm API contract khớp expectation web BDD
|
|
684
|
-
app_team — team App phải confirm API contract khớp expectation app BDD
|
|
685
|
-
sa — SA/Tech Lead approval cuối
|
|
686
|
-
|
|
687
|
-
Khi thu đủ sign-off → cập nhật @trace.sign_off trong header tech doc, rồi chạy lại /review-tech-docs.
|
|
688
|
-
Tech docs không thể set "approved" khi còn bất kỳ sign-off bắt buộc nào pending.
|
|
689
|
-
```
|
|
690
|
-
|
|
691
|
-
**Approval gate:**
|
|
692
|
-
- Nếu `be_team: done` VÀ `fe_team: done` VÀ `app_team: done` (hoặc N/A) VÀ `sa: done` → tech docs có thể set `approved`
|
|
693
|
-
- Ngược lại → `@trace.status` giữ `in-review` — `generate-code` bị chặn
|
|
694
|
-
|
|
695
|
-
### T8 — Reconciliation & Completeness
|
|
696
|
-
|
|
697
|
-
*Bắt lỗi "đóng kín" + "coverage ≠ completeness" — cái mà Self-Review Gate của `generate-tech-docs` (Cổng 1/4) đáng lẽ chặn. Đối chiếu doc với PRD Business Rules, core-entities, và seam UC anh em (đọc-ngược có giới hạn — không kéo toàn bộ BDD của PRD).*
|
|
698
|
-
|
|
699
|
-
> **Nguyên tắc:** "mọi SC được map" (T3) là *cần*, KHÔNG *đủ*. T8 fail một doc dù T3 pass, nếu nó thiếu/mâu thuẫn ở tầng rộng hơn lát BDD.
|
|
700
|
-
|
|
701
|
-
> **Thuật ngữ cross-service (đọc nhanh):** *dedup* = cùng event tới ≥2 lần chỉ xử lý 1 lần (idempotency key) · *ordering* = event đúng thứ tự phát ra, hoặc bên nhận chịu được lệch · *ack path* = bên nhận xong báo lại bên gửi để ngừng gửi lại (thiếu → mất event / gửi lại vô hạn) · *cross-field invariant* = ràng buộc luôn đúng giữa nhiều field (vd `paid ⇒ paid_at ≠ null`).
|
|
702
|
-
|
|
703
|
-
| Vấn đề | Severity | Auto-fixable? |
|
|
704
|
-
|---|---|---|
|
|
705
|
-
| Enum/trạng thái dùng trong doc nhưng **không có producer** (không luồng nào sinh giá trị đó) | Major | No — người xác định owner |
|
|
706
|
-
| Cột/field ghi nhưng **không có writer** (không luồng nào set) | Major | No |
|
|
707
|
-
| **PRD Business Rule** yêu cầu một nguồn/sự kiện mà doc **bỏ sót** | Critical | No — thêm design trước |
|
|
708
|
-
| PRD-BR đưa **hợp đồng chung** (generic envelope) nhưng doc tự làm **typed-per-thing** | Major | No |
|
|
709
|
-
| **Leak boundary** — kéo định danh nội bộ của service khác vào lookup của mình thay vì abstraction tầng mình | Major | No |
|
|
710
|
-
| Cross-service **không tách** bên nào own dedup/ordering, hoặc thiếu **ack path** | Major | No |
|
|
711
|
-
| **Cross-field invariant** giữa các field/entity không được nêu | Minor | Yes — thêm note |
|
|
712
|
-
|
|
713
|
-
### T9 — Gap Honesty & Constants
|
|
714
|
-
|
|
715
|
-
*Bắt "bịa lặng" + "hard-code" + "happy-only" — cái mà Self-Review Gate Cổng 2/3/4 đáng lẽ chặn.*
|
|
716
|
-
|
|
717
|
-
| Vấn đề | Severity | Auto-fixable? |
|
|
718
|
-
|---|---|---|
|
|
719
|
-
| Policy/type/giá trị nêu **như fact không nguồn** (bịa), lẽ ra phải là `[GAP]`/`[ASSUMPTION]` | Critical | No — người xác nhận nguồn hoặc giữ GAP |
|
|
720
|
-
| Chỗ đáng lẽ khai gap lại **bỏ trắng / chép hình dạng ở boundary** | Major | No |
|
|
721
|
-
| **Constant/literal inline** như luật (chưa vào catalog / chưa đặt tên) | Major | Yes — tách vào bảng constants/enum |
|
|
722
|
-
| **Happy-only** — API/flow thiếu partial + error case + rollback | Major | No — thiết kế nhánh lỗi trước |
|
|
723
|
-
| **Hàm cốt lõi** được đặt tên nhưng **không tả** điều kiện chọn / nhánh / kết quả (dừng ở tên hàm + sequence-diagram) | Major | No — cần người bổ sung impl-spec |
|
|
724
|
-
| BDD **mâu thuẫn** invariant kiến trúc mà doc **lặng chép** thay vì ghi conflict + escalate PO sửa `.feature` | Critical | No — escalate, không tự quyết |
|
|
725
|
-
| Citation/tham chiếu **không resolve** (trỏ tới thứ không được định nghĩa) / policy nêu như fact | Minor | Yes — thêm định nghĩa hoặc bỏ ref |
|
|
726
|
-
| `[GAP]`/`[ASSUMPTION]` inline **mồ côi** — không có dòng ở §12 GAP Register (hoặc dòng §12 không có marker inline) | Major | Yes — đồng bộ register ↔ marker |
|
|
727
|
-
| §12 GAP Register còn **🔴 blocker `open`** (chưa đóng) | Critical | No — chặn approve tới khi owner đóng. *(GAP đã khai đúng KHÔNG tính là "bịa" — đây là finding về gate, không phạt trung thực)* |
|
|
728
|
-
|
|
729
|
-
> **T8/T9 phản chiếu Self-Review Gate** (4 cổng) của `generate-tech-docs` và `project-lessons` **L-012** — nếu gen bỏ lọt, cổng review bắt lại. Đặt trong nguồn `.tmpl` nên bền qua `/update-framework`.
|
|
730
|
-
|
|
731
|
-
---
|
|
732
|
-
|
|
733
|
-
## Ghi File Findings
|
|
734
|
-
|
|
735
|
-
Sau khi chạy hết các check, ghi findings vào `{paths.refinement_dir}/{TICKET-ID}-tech-review-findings.yaml`:
|
|
736
|
-
|
|
737
|
-
```yaml
|
|
738
|
-
source_file: "{absolute path to tech-doc}"
|
|
739
|
-
prd_id: "{TICKET-ID}"
|
|
740
|
-
ucs: [{UC-ID list phủ bởi doc}]
|
|
741
|
-
domain: "{domain}"
|
|
742
|
-
generated_at: "{ISO datetime}"
|
|
743
|
-
review_type: "tech-design"
|
|
744
|
-
status: "pending_review"
|
|
745
|
-
is_system_bdd: {true | false} # true nếu doc có phần backend (@trace.platforms gồm system)
|
|
746
|
-
|
|
747
|
-
sign_off: # chỉ có khi is_system_bdd: true
|
|
748
|
-
be_team: pending # đọc từ @trace.sign_off trong header tech-doc
|
|
749
|
-
fe_team: pending
|
|
750
|
-
app_team: pending # "n/a" nếu dự án không có platform app
|
|
751
|
-
sa: pending
|
|
752
|
-
sign_off_gate: blocked # blocked | ready — "ready" chỉ khi tất cả bắt buộc là "done"
|
|
753
|
-
|
|
754
|
-
findings:
|
|
755
|
-
- id: "F001"
|
|
756
|
-
check_id: "T1" # T1 · T2 · T3 · T3b · T4 · T5 · T6 · T7 · T8 · T9
|
|
757
|
-
severity: "critical" # critical | major | minor
|
|
758
|
-
section: "{section heading hoặc tên component nơi tìm thấy lỗi}"
|
|
759
|
-
uc_id: "{UC-ID}" # UC mà finding này thuộc về (một trong `ucs`; đọc §10 để xác định)
|
|
760
|
-
quote: "{trích đoạn nguyên văn copy CHÍNH XÁC từ tech-doc tại vị trí lỗi, ≤120 ký tự}"
|
|
761
|
-
finding: "{mô tả rõ ràng vi phạm hoặc gap}"
|
|
762
|
-
suggestion: "{bản fix cụ thể — AI áp dụng khi --resume nếu được chấp nhận}"
|
|
763
|
-
auto_fixable: false # true = AI áp dụng được; false = người phải ghi quyết định trong note
|
|
764
|
-
status: "pending" # pending | accepted | modified | rejected | deferred
|
|
765
|
-
|
|
766
|
-
summary:
|
|
767
|
-
total_findings: {N}
|
|
768
|
-
by_severity: { critical: {N}, major: {N}, minor: {N} }
|
|
769
|
-
auto_fixable: {N}
|
|
770
|
-
requires_human_decision: {N}
|
|
771
|
-
recommendation: "APPROVED | NEEDS_REVISION | BLOCKED"
|
|
772
|
-
sign_off_gate: "{blocked — pending: fe_team, app_team, sa | ready}"
|
|
773
|
-
```
|
|
774
|
-
|
|
775
|
-
> **Field định vị (`quote` + `uc_id`) — bắt buộc cho source-jump của Review Board.**
|
|
776
|
-
> Với mỗi finding, copy một đoạn `quote` **nguyên văn** thẳng từ tech-doc tại đúng chỗ
|
|
777
|
-
> lỗi xảy ra — KHÔNG diễn giải lại; nó được so khớp với tài liệu để định vị dòng.
|
|
778
|
-
> Field này cho phép reviewer click một finding trong Review Board và nhảy tới đúng vị trí nguồn.
|
|
779
|
-
|
|
780
|
-
## Report
|
|
781
|
-
|
|
782
|
-
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
783
|
-
|
|
784
|
-
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
785
|
-
|
|
786
|
-
## Status Badge
|
|
787
|
-
|
|
788
|
-
Chọn một theo kết quả:
|
|
789
|
-
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
790
|
-
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
791
|
-
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
792
|
-
|
|
793
|
-
## Output Artifacts
|
|
794
|
-
|
|
795
|
-
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
796
|
-
```
|
|
797
|
-
Output Artifacts:
|
|
798
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
799
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
800
|
-
```
|
|
801
|
-
|
|
802
|
-
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
803
|
-
|
|
804
|
-
## Pipeline Position
|
|
805
|
-
|
|
806
|
-
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`,
|
|
807
|
-
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
808
|
-
|
|
809
|
-
```
|
|
810
|
-
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
811
|
-
```
|
|
812
|
-
|
|
813
|
-
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:
|
|
814
|
-
|
|
815
|
-
| Phase | Commands |
|
|
816
|
-
|-------|----------|
|
|
817
|
-
| Discovery | `/define-product` |
|
|
818
|
-
| PRD | `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
819
|
-
| Design Spec | `/generate-design-spec` |
|
|
820
|
-
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
821
|
-
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
822
|
-
| Code | `/generate-code` · `/review-code` |
|
|
823
|
-
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
824
|
-
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
825
|
-
| Trace Audit | `/validate-traces` |
|
|
826
|
-
|
|
827
|
-
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
828
|
-
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
829
|
-
|
|
830
|
-
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
831
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
832
|
-
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
833
|
-
|
|
834
|
-
## Gợi ý lệnh tiếp theo
|
|
835
|
-
|
|
836
|
-
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
837
|
-
|
|
838
|
-
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
839
|
-
|-------------------------|-----------------------------------------------|
|
|
840
|
-
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
841
|
-
| /define-product | `/generate-prd {product-definition-file}` |
|
|
842
|
-
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
843
|
-
| /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}` |
|
|
844
|
-
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
845
|
-
| /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) |
|
|
846
|
-
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
847
|
-
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
848
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
849
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
850
|
-
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
851
|
-
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
852
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
853
|
-
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
854
|
-
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
855
|
-
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
856
|
-
| /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
|
|
857
|
-
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
858
|
-
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
859
|
-
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
860
|
-
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
861
|
-
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
862
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
863
|
-
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
864
|
-
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
865
|
-
| /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** |
|
|
866
|
-
| /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 |
|
|
867
|
-
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
868
|
-
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
869
|
-
| /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` |
|
|
870
|
-
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
871
|
-
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
872
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
873
|
-
|
|
874
|
-
Định dạng footer như sau:
|
|
875
|
-
```
|
|
876
|
-
---
|
|
877
|
-
Status : {badge}
|
|
878
|
-
{khối Output Artifacts}
|
|
879
|
-
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
880
|
-
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
881
|
-
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
882
|
-
```
|
|
883
|
-
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
```
|
|
887
|
-
/review-tech-docs Hoàn tất — {target file}
|
|
888
|
-
PRD: {TICKET-ID} | UCs: {UC list} | Domain: {domain}
|
|
889
|
-
Findings: {total} | 🔴 Critical: {N} | 🟡 Major: {N} | 🟢 Minor: {N}
|
|
890
|
-
Auto-fixable: {N} | Needs human decision: {N}
|
|
891
|
-
|
|
892
|
-
GAP Register (§12): {open_blocker} 🔴 blocker open / {total_open} open / {total} tracked
|
|
893
|
-
{🔒 còn blocker open → chặn approve | ✅ 0 blocker open}
|
|
894
|
-
|
|
895
|
-
Sign-off gate (chỉ system BDD):
|
|
896
|
-
be_team : {done | pending}
|
|
897
|
-
fe_team : {done | pending} ← {name / "needs sign-off" }
|
|
898
|
-
app_team : {done | pending | n/a}
|
|
899
|
-
sa : {done | pending}
|
|
900
|
-
Gate : {🔒 BLOCKED — pending: fe_team, sa | ✅ READY}
|
|
901
|
-
|
|
902
|
-
File findings: {paths.refinement_dir}/{TICKET-ID}-tech-review-findings.yaml
|
|
903
|
-
Next: Mở trong Review Board → Accept/Modify/Reject từng finding
|
|
904
|
-
Rồi chạy: /review-tech-docs --resume {tech-design-file}
|
|
905
|
-
Sau khi thu đủ sign-off → cập nhật @trace.sign_off trong tech doc, chạy lại review
|
|
906
|
-
```
|
|
907
|
-
|
|
908
|
-
---
|
|
909
|
-
|
|
910
|
-
## Resume Mode — Áp dụng các Finding được chấp nhận
|
|
911
|
-
|
|
912
|
-
*Kích hoạt khi `$ARGUMENTS` chứa `--resume`.*
|
|
913
|
-
*Ví dụ: `/review-tech-docs --resume {paths.tech_docs_dir}/payment/{prd-slug}/tech-docs/PAY-123-tech-design.md`*
|
|
914
|
-
|
|
915
|
-
### Phase 1 — Đọc các finding được chấp nhận
|
|
916
|
-
|
|
917
|
-
1. Suy ra file findings từ target: `{paths.refinement_dir}/{TICKET-ID}-tech-review-findings.yaml`
|
|
918
|
-
2. Đọc file. Gom các finding có `status: "accepted"` hoặc `status: "modified"`.
|
|
919
|
-
3. Nếu không có → báo "No accepted findings. File unchanged." và dừng.
|
|
920
|
-
|
|
921
|
-
### Phase 2 — Áp dụng fix
|
|
922
|
-
|
|
923
|
-
Áp dụng theo thứ tự: critical → major → minor.
|
|
924
|
-
|
|
925
|
-
| check_id | Làm gì |
|
|
926
|
-
|----------|-----------|
|
|
927
|
-
| T1 (Architecture) | Áp dụng fix cấu trúc từ note finding — chuyển logic về đúng layer, cập nhật mô tả component |
|
|
928
|
-
| T2 (Tên field) | Đổi field về tên canonical từ core-entities.md xuyên suốt tài liệu |
|
|
929
|
-
| T3 (Thiếu design note) | Thêm design decision note cho scenario chưa phủ |
|
|
930
|
-
| T3b (map bdd_version) | **Chỉ 2 ca auto-fixable:** platform vắng trong map → thêm entry `{platform}={bdd_version hiện tại}`; platform không còn `.feature` → xoá entry. Ca **`.feature` mới hơn** thì KHÔNG được chỉ sửa số trong map — làm vậy là dán nhãn "đã đồng bộ" lên một contract chưa ai review. Chỉ cập nhật entry sau khi note của reviewer xác nhận §4 đã được đối chiếu lại. |
|
|
931
|
-
| T5 (Internal inconsistency) | Căn chỉnh các section mâu thuẫn theo quyết định nêu trong note |
|
|
932
|
-
| T6 (Thiếu section) | Thêm skeleton section với prompt placeholder cho tech lead điền |
|
|
933
|
-
| T8 (cross-field invariant) | Thêm note invariant còn thiếu *(chỉ mục minor auto-fixable; enum mồ côi / PRD-BR bỏ sót / leak boundary cần người)* |
|
|
934
|
-
| T9 (constant / citation) | Tách constant inline vào bảng catalog/enum; thêm định nghĩa cho citation không resolve |
|
|
935
|
-
|
|
936
|
-
**Finding T1, T2, T4 và các mục Critical/Major của T8/T9 có `auto_fixable: false`:** cần một resolution do người viết trong
|
|
937
|
-
note "Modify" của Review Board (enum mồ côi, PRD-BR bỏ sót, leak boundary, bịa-lặng, happy-only, BDD↔kiến trúc mâu thuẫn — không tự đoán). Áp dụng đúng những gì note nói. Đừng bịa fix.
|
|
938
|
-
|
|
939
|
-
### Phase 3 — Cập nhật header + TSV + Report
|
|
940
|
-
|
|
941
|
-
Sửa file tech-doc trực tiếp:
|
|
942
|
-
1. Tìm `@trace.revision:` trong header — tăng giá trị integer lên 1.
|
|
943
|
-
2. Tìm `@trace.status:` trong header. Set `approved` **chỉ khi CẢ HAI**:
|
|
944
|
-
- (a) sign_off_gate = `ready` (tất cả sign-off done; hoặc doc không có phần system → không cần sign-off), **VÀ**
|
|
945
|
-
- (b) §12 GAP Register **không còn 🔴 blocker nào ở trạng thái `open`** (đếm ở T9).
|
|
946
|
-
Thiếu (a) hoặc (b) → set `in-review` (chặn `/generate-code`); ghi rõ lý do vào report (sign-off pending / còn N blocker-GAP open).
|
|
947
|
-
**Ngoài ra — cổng T3b (chặn MỀM):** còn ≥1 finding T3b Major `open` (`.feature` mới hơn map `@trace.bdd_versions`) → hiện CHECKPOINT ở T3b và chỉ set `approved` khi người dùng chọn `Y`; chọn `N` → `in-review` + nêu lý do.
|
|
948
|
-
3. **Làm mới map `@trace.bdd_versions`** — chỉ cho các platform mà finding T3b đã được **giải quyết** (reviewer xác nhận §4 đã đối chiếu lại, hoặc là ca thêm/xoá entry auto-fixable). Platform còn finding `open` thì **giữ nguyên số cũ**: để nó lệch chính là thứ giữ cờ `TECHDOC_STALE_VS_BDD` của `/validate-traces` sáng đèn.
|
|
949
|
-
4. Nếu block `@trace.sign_off` vắng và đây là tech doc system BDD → thêm nó với tất cả giá trị `pending`.
|
|
950
|
-
|
|
951
|
-
Ghi cả hai thay đổi vào file.
|
|
952
|
-
|
|
953
|
-
Rồi cập nhật TSV cho **mọi UC mà doc phủ** (`@trace.ucs`) — doc gộp có một `@trace.revision` chung cho cả BE và client:
|
|
954
|
-
- Với mỗi UC trong `@trace.ucs`: glob **mọi sổ platform** `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}-*.tsv` (system/web/app), và set `tech_doc_revision` thành integer `@trace.revision` mới cho mọi row trong từng sổ đó.
|
|
955
|
-
- **KHÔNG** đụng `fe_tech_doc_revision` ở đây — cột đó do `/generate-code --phase=integration` ghi khi FE thực sự wire adapter theo §4.5.4 (drift-detect riêng cho FE integration).
|
|
956
|
-
- Set `last_updated` thành ngày hôm nay (`YYYY-MM-DD`) cho các row vừa chạm.
|
|
957
|
-
|
|
958
|
-
In report sau khi hoàn tất mọi lần ghi file.
|
|
959
|
-
|
|
960
|
-
```
|
|
961
|
-
/review-tech-docs --resume Đã áp dụng — {target file}
|
|
962
|
-
PRD: {TICKET-ID} | UCs: {UC list}
|
|
963
|
-
|
|
964
|
-
Applied : {N} findings ({critical} critical, {major} major, {minor} minor)
|
|
965
|
-
Skipped : {N} rejected/deferred
|
|
966
|
-
|
|
967
|
-
Changes:
|
|
968
|
-
- {change 1}
|
|
969
|
-
- {change 2}
|
|
970
|
-
|
|
971
|
-
Revision : {old} → {new}
|
|
972
|
-
Status : {approved | in-review}
|
|
973
|
-
|
|
974
|
-
Sign-off : {✅ Tất cả done — status set approved
|
|
975
|
-
| 🔒 Pending: fe_team, sa — status set in-review
|
|
976
|
-
Cập nhật @trace.sign_off trong tech doc khi mỗi team confirm, rồi chạy lại /review-tech-docs}
|
|
977
|
-
|
|
978
|
-
Chạy lại /review-tech-docs {file} để xác nhận 0 finding critical còn lại.
|
|
979
|
-
Next: {/generate-code {feature-file} ← chỉ khi status = approved
|
|
980
|
-
| Thu các sign-off pending → cập nhật @trace.sign_off → chạy lại /review-tech-docs}
|
|
981
|
-
→ nếu tech-doc sống trong spec repo dùng chung: commit + push lên spec submodule để FE/App `/sync` contract đã cập nhật
|
|
982
|
-
```
|