@educa-corp/sdd-framework 0.4.2 → 0.5.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.
Files changed (116) hide show
  1. package/bin/self-check.js +124 -6
  2. package/bin/trace-schema.json +1199 -692
  3. package/commands/debug.md +3 -2
  4. package/commands/define-product.md +3 -2
  5. package/commands/dev-gen-test.md +37 -9
  6. package/commands/dev-run-test.md +37 -9
  7. package/commands/dev-smoke-test.md +3 -2
  8. package/commands/extend-prd.md +907 -0
  9. package/commands/extend-prd.tmpl +270 -0
  10. package/commands/fix-bug.md +37 -9
  11. package/commands/generate-architecture.md +3 -2
  12. package/commands/generate-bdd.md +56 -13
  13. package/commands/generate-bdd.tmpl +18 -3
  14. package/commands/generate-code.md +73 -16
  15. package/commands/generate-code.tmpl +36 -7
  16. package/commands/generate-design-spec.md +3 -2
  17. package/commands/generate-prd.md +28 -2
  18. package/commands/generate-prd.tmpl +25 -0
  19. package/commands/generate-spec-manifest.md +3 -2
  20. package/commands/generate-tech-docs.md +3 -2
  21. package/commands/learn.md +3 -2
  22. package/commands/map-testids.md +3 -2
  23. package/commands/propose-scenario.md +55 -3
  24. package/commands/propose-scenario.tmpl +52 -1
  25. package/commands/qc-analyze.md +3 -2
  26. package/commands/qc-design-test.md +4 -2
  27. package/commands/qc-design-test.tmpl +1 -0
  28. package/commands/qc-plan.md +3 -2
  29. package/commands/qc-report.md +3 -2
  30. package/commands/qc-review.md +3 -2
  31. package/commands/qc-run-test.md +50 -10
  32. package/commands/qc-run-test.tmpl +13 -1
  33. package/commands/refine-prd.md +3 -2
  34. package/commands/report-bug.md +3 -2
  35. package/commands/review-code.md +7 -5
  36. package/commands/review-code.tmpl +4 -3
  37. package/commands/review-context.md +6 -4
  38. package/commands/review-context.tmpl +3 -2
  39. package/commands/review-tech-docs.md +3 -2
  40. package/commands/setup-ai-first.md +3 -2
  41. package/commands/sync.md +40 -16
  42. package/commands/sync.tmpl +37 -14
  43. package/commands/update-framework.md +3 -2
  44. package/commands/validate-traces.md +318 -33
  45. package/commands/validate-traces.tmpl +315 -31
  46. package/core/FRAMEWORK_VERSION +1 -1
  47. package/core/commands/debug.md +3 -2
  48. package/core/commands/define-product.md +3 -2
  49. package/core/commands/dev-gen-test.md +37 -9
  50. package/core/commands/dev-run-test.md +37 -9
  51. package/core/commands/dev-smoke-test.md +3 -2
  52. package/core/commands/extend-prd.md +907 -0
  53. package/core/commands/fix-bug.md +37 -9
  54. package/core/commands/generate-architecture.md +3 -2
  55. package/core/commands/generate-bdd.md +56 -13
  56. package/core/commands/generate-code.md +73 -16
  57. package/core/commands/generate-design-spec.md +3 -2
  58. package/core/commands/generate-prd.md +28 -2
  59. package/core/commands/generate-spec-manifest.md +3 -2
  60. package/core/commands/generate-tech-docs.md +3 -2
  61. package/core/commands/learn.md +3 -2
  62. package/core/commands/map-testids.md +3 -2
  63. package/core/commands/propose-scenario.md +55 -3
  64. package/core/commands/qc-analyze.md +3 -2
  65. package/core/commands/qc-design-test.md +4 -2
  66. package/core/commands/qc-plan.md +3 -2
  67. package/core/commands/qc-report.md +3 -2
  68. package/core/commands/qc-review.md +3 -2
  69. package/core/commands/qc-run-test.md +50 -10
  70. package/core/commands/refine-prd.md +3 -2
  71. package/core/commands/report-bug.md +3 -2
  72. package/core/commands/review-code.md +7 -5
  73. package/core/commands/review-context.md +6 -4
  74. package/core/commands/review-tech-docs.md +3 -2
  75. package/core/commands/setup-ai-first.md +3 -2
  76. package/core/commands/sync.md +40 -16
  77. package/core/commands/update-framework.md +3 -2
  78. package/core/commands/validate-traces.md +318 -33
  79. package/core/rules/workflow.md +18 -0
  80. package/core/steps/report-footer.md +3 -2
  81. package/core/steps/trace-mirror.md +34 -7
  82. package/core/templates/feature.template +1 -1
  83. package/docs/01-getting-started/installation.md +18 -1
  84. package/docs/01-getting-started/what-is-sdd.md +4 -2
  85. package/docs/02-concepts/architecture.md +27 -3
  86. package/docs/02-concepts/pipeline-steps/02-specification.md +39 -3
  87. package/docs/02-concepts/pipeline-steps/04-bdd.md +24 -2
  88. package/docs/02-concepts/pipeline-steps/05-tech-docs.md +18 -1
  89. package/docs/02-concepts/pipeline-steps/06-code.md +35 -4
  90. package/docs/02-concepts/pipeline-steps/09-validate-traces.md +137 -12
  91. package/docs/02-concepts/pipeline-steps/10-feedback-loop.md +59 -3
  92. package/docs/02-concepts/roles-and-hitl.md +1 -1
  93. package/docs/02-concepts/traceability.md +126 -117
  94. package/docs/03-guides/developer.md +20 -4
  95. package/docs/03-guides/product-owner.md +72 -68
  96. package/docs/03-guides/tester-qa.md +81 -70
  97. package/docs/04-reference/commands.md +134 -105
  98. package/docs/04-reference/configuration.md +146 -94
  99. package/docs/04-reference/trace-schema.md +26 -9
  100. package/docs/explain/02-generate-prd.md +80 -78
  101. package/docs/explain/02b-extend-prd.md +125 -0
  102. package/docs/explain/03-refine-prd.md +86 -86
  103. package/docs/explain/04-review-context.md +18 -1
  104. package/docs/explain/06-generate-bdd.md +23 -0
  105. package/docs/explain/08-review-tech-docs.md +20 -5
  106. package/docs/explain/10-review-code.md +36 -2
  107. package/docs/explain/19-qc-run-test.md +87 -67
  108. package/docs/explain/21-validate-traces.md +74 -68
  109. package/docs/explain/23-fix-bug.md +19 -3
  110. package/docs/explain/26-propose-scenario.md +70 -63
  111. package/docs/explain/README.md +135 -134
  112. package/package.json +50 -50
  113. package/rules/workflow.md +18 -0
  114. package/steps/report-footer.md +3 -2
  115. package/steps/trace-mirror.md +34 -7
  116. package/templates/feature.template +1 -1
@@ -32,11 +32,25 @@ Framework là pipeline **một chiều** — nhưng vẫn cần đường **ph
32
32
  | Lệnh | Ai dùng | Kết quả | Đi về đâu |
33
33
  |------|---------|---------|-----------|
34
34
  | `/report-bug` | Tester / QC | Bug **spec-anchored** (gồm product-gap từ `/qc-*`) | `feedback/bug-reports/` |
35
- | `/propose-scenario` | Tester / QC | Đề xuất BDD scenario mới | `feedback/bdd-proposals/` |
35
+ | `/propose-scenario` **Case A** | Tester / QC | Thiếu scenario cho **AC đã có** | `feedback/bdd-proposals/` |
36
+ | `/propose-scenario` **Case B** | Tester / QC | **Requirement MỚI** — không AC nào phủ | `feedback/prd-change-requests/` |
36
37
  | `/learn` | Tất cả | Guardrail lesson | `project-lessons.md` (qua step `capture-lesson`) |
37
38
  | `/fix-bug` | Dev | Sửa lỗi có root-cause + regression test | Code + `@trace.fixes/root_cause/regression` |
39
+ | `/extend-prd` | PO | **Drain** PRD change request → UC/AC/BR mới trong PRD | PRD v+1 · request → `archived/` |
38
40
  | `/sync` | Lead (umbrella) | Pull + submodule + **nổi feedback** + làm mới Living Docs | Chạy hằng ngày |
39
41
 
42
+ ### Ba hàng đợi — mỗi cái phải có người lấy ra
43
+
44
+ | Hàng đợi | Ai bỏ vào | Ai **lấy ra** | Ai **nhắc lại** |
45
+ |---|---|---|---|
46
+ | `bug-reports/` | `/report-bug` | `/fix-bug` (quét thư mục mỗi lần chạy) | cột `qc_blocked_by` của TSV |
47
+ | `bdd-proposals/` | `/propose-scenario` A | `/generate-bdd` (quét mỗi lần chạy, 9 bước: chèn → normalize → append row TSV → archive → commit) | — |
48
+ | `prd-change-requests/` | `/propose-scenario` B | **`/extend-prd`** | `/validate-traces` Step 7b — đếm `Status: Open` kèm **số ngày chờ** |
49
+
50
+ > **Vì sao cột "ai nhắc lại" quan trọng.** `/sync` chỉ hiện những gì về **trong đúng lần pull đó** (`git diff old..new`) — nó là **chuông cửa, không phải tồn kho**. Bỏ lỡ một lần là mất khỏi màn hình vĩnh viễn. Hai hàng đợi đầu không sao vì có lệnh **quét lại thư mục mỗi lần chạy**; riêng `prd-change-requests/` thì không — nên `/validate-traces` phải nhắc thay.
51
+ >
52
+ > Trước v0.4.3, hàng đợi thứ ba **không có người lấy ra**: có producer, có storage, có commit, có mặt trong `/sync` — nhưng 0 consumer, và **không gì báo**. Yêu cầu nghiệp vụ thật do tester phát hiện từ sản phẩm chạy thật rơi vào im lặng hoàn toàn. Từ v0.4.3, cả ba hàng đợi được khai vào `bin/trace-schema.json` §`queues` nên **self-check chặn build** nếu một hàng đợi mất consumer.
53
+
40
54
  ---
41
55
 
42
56
  ## Ai làm gì (Roles & responsibilities)
@@ -64,10 +78,47 @@ Framework là pipeline **một chiều** — nhưng vẫn cần đường **ph
64
78
 
65
79
  1. **`/report-bug` / `/propose-scenario`** — ghi feedback kèm tham chiếu spec vào `feedback/` (spec repo nếu umbrella).
66
80
  2. **`/learn`** — qua step `capture-lesson`, ghi guardrail vào `project-lessons.md`; các workflow sau **nạp lại** vào context → hệ thống *nhớ*.
67
- 3. **`/generate-bdd`** — có thể incorporate scenario proposal đã `accepted`.
68
- 4. **`/fix-bug`** — đọc bug spec-anchoredtạo branch `fix/{TICKET}-<slug>`root causesửa (tag `@trace.fixes/root_cause/regression`)regression test + build verifycommit sau khi user duyệt.
81
+ 3. **`/generate-bdd`** — incorporate scenario proposal đã `accepted`, kèm **normalize** (xem dưới).
82
+ 3b. **`/extend-prd`** — nhặt PRD change request `accepted` làm **nguyên liệu** (không chèn thẳng: yêu cầu nghiệp vụ phải qua PO chốt AC/BR đúng tầng) discovery delta + **kiểm va chạm** với UC/BR đã có đánh số **nối tiếp** ghi **add-only** + guard sau-ghi bump version + changelog nêu rõ scope đóng dấu `incorporated` + `archived/` + commit.
83
+ 4. **`/fix-bug`** — đọc bug spec-anchored → branch `fix/{TICKET}-<slug>` → root cause → sửa (tag `@trace.fixes/root_cause/regression`) → regression test + build verify → **cập nhật sổ trace** → commit sau khi user duyệt.
69
84
  5. **`/sync`** — pull, init submodule, **nổi feedback** lên PO/Dev, bootstrap config service, làm mới Living Docs. An toàn chạy lặp lại.
70
85
 
86
+ ### Vòng đời bug — mỗi bước có đúng một chủ
87
+
88
+ | State | Ai đặt | Khi nào |
89
+ |---|---|---|
90
+ | `🟢 Open` | `/report-bug` | tester/QC file bug |
91
+ | `🟡 Fixed` | `/fix-bug` Phase 5.5 | fix đã commit + push |
92
+ | `🟢 Closed` | **`/qc-run-test`** | QC chạy lại và `qc_status` của SC liên kết flip `pass` |
93
+
94
+ > **Dev không tự đóng bug của mình** — QC sở hữu verification. `/qc-run-test` đọc `qc_blocked_by` **trước** khi clear nó (cột đó chính là con trỏ tới bug; clear xong là mất đường về).
95
+ >
96
+ > Ngoại lệ có chủ đích: SC pass mà bug còn `🟢 Open` (chưa ai fix) → **không đóng**, giữ `Open` + cảnh báo kiểm tra lại test. Test pass trên bug chưa fix là dấu hiệu **test sai**, không phải bug hết — tự đóng ở đây sẽ chôn một defect thật.
97
+
98
+ ### `/fix-bug` ghi gì vào sổ trace
99
+
100
+ Regression test không phải test "ngoài luồng" — nó phải hiện lên coverage:
101
+
102
+ | Cột | Ghi gì |
103
+ |---|---|
104
+ | `test_count` | **+=** số test regression (cộng dồn, không ghi đè) |
105
+ | `test_classes` | **append** tên class mới |
106
+ | `dev_selftest` → `not_run` · `dev_selftest_at` → `—` | code vừa đổi nên tín hiệu self-test cũ hết hiệu lực |
107
+
108
+ **Không** đụng `qc_*` (QC sở hữu) và **không** đụng `spec_ver`/`gen_ver` — fix bug không đổi spec, đụng vào là tạo `DRIFT` giả. Next của `/fix-bug` là `/dev-run-test` để lấy lại tín hiệu xanh, rồi mới tạo PR.
109
+
110
+ ### Proposal của tester — normalize khi chèn
111
+
112
+ `/propose-scenario` viết scenario theo **đúng** bộ tag canonical (`@trace.scenario` với placeholder `SC?` · `@trace.sc_version: 1.0` · `@trace.business_rules`; AC ghi thành comment `# Covers:` chứ **không** phải trace key). Khi `/generate-bdd` chèn proposal `accepted`, nó phải:
113
+
114
+ 1. gán `sc_id` = số SC **kế tiếp** trong file (thay `SC?`)
115
+ 2. bổ sung `@trace.business_rules` nếu proposal để `—`
116
+ 3. **strip** `@proposed` / `@from-test` — nhãn vòng đời proposal, không thuộc BDD canonical
117
+ 4. đặt scenario vào **đúng NHÓM** theo business theme
118
+ 5. **append row `.tsv`** (`spec_ver = 1.0`, `status = UNTRACKED`)
119
+
120
+ > Thiếu bước 1/5 thì scenario vào file mà **không có row trace** → vô hình với toàn bộ coverage và drift.
121
+
71
122
  ---
72
123
 
73
124
  ## HITL / Gate
@@ -86,6 +137,11 @@ QC phát hiện: link reset vẫn dùng được sau khi đổi mật khẩu
86
137
  /fix-bug BUG-217 → branch fix/BUG-217-invalidate-link
87
138
  → root cause: thiếu invalidate token
88
139
  → fix + regression test + build ✅
140
+ → trace: test_count +2, dev_selftest → not_run
141
+ → BUG-217 State: 🟡 Fixed
142
+ /dev-run-test AUTH-UC2 → dev_selftest → pass
143
+ /qc-run-test AUTH-UC2 → qc_status SC1 → pass
144
+ → BUG-217 State: 🟢 Closed (verified)
89
145
  /learn "luôn invalidate one-time token sau khi dùng"
90
146
  → project-lessons.md (nạp lại lần sau)
91
147
  ```
@@ -70,4 +70,4 @@ QC █████ 🟠 cổng review test & script
70
70
 
71
71
  ## Đọc theo vai trò của bạn (Role Guides)
72
72
 
73
- → [Product Owner](../../03-guides/product-owner.md) · [Developer](../../03-guides/developer.md) · [Architect](../../03-guides/architect.md) · [Tester/QA](../../03-guides/tester-qa.md)
73
+ → [Product Owner](../03-guides/product-owner.md) · [Developer](../03-guides/developer.md) · [Architect](../03-guides/architect.md) · [Tester/QA](../03-guides/tester-qa.md)
@@ -1,117 +1,126 @@
1
- [← Roles & HITL](roles-and-hitl.md) · [Concepts](./) · [Architecture →](architecture.md)
2
-
3
- # Traceability — Truy vết đầu-cuối (End-to-end Trace)
4
-
5
- > Từ scenario nhìn xuống biết code nào hiện thực; từ code nhìn lên biết scenario nào yêu cầu. Đây là một trong ba "trái tim" của framework.
6
-
7
- ---
8
-
9
- ## Trace tags theo artifact
10
-
11
- | Artifact | Trace tag |
12
- |----------|-----------|
13
- | **BDD file** (header) | `@trace.id` · **`@trace.platform`** · `@trace.domain` · `@trace.prd` · `@trace.prd_version` · `@trace.bdd_version` · `@trace.status` |
14
- | **BDD scenario** (mỗi SC) | `@trace.scenario` · **`@trace.sc_version`** · `@trace.business_rules` |
15
- | **Code** (boundary only) | `@trace.implements` · `@trace.source` · **`@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision`** — lặp cả block theo **từng UC** trong file đa-UC |
16
- | **Code** (chỗ chưa implement) | `@trace.stub` · `@trace.stub_owner` · `@trace.stub_for` · `@trace.seam_pending` · `@trace.seam_port` |
17
- | **Test** | `@trace.verifies` |
18
- | **Bug fix** | `@trace.fixes` · `@trace.root_cause` · `@trace.regression` |
19
-
20
- → Đầy đủ field & format: [Reference › Trace Schema](../04-reference/trace-schema.md).
21
-
22
- ---
23
-
24
- ## Boundary-only tagging
25
-
26
- Chỉ tag `@trace` ở **boundary**, không tag mọi file → tránh **tag explosion**:
27
-
28
- | ✅ Tag | ❌ Không tag |
29
- |--------|-------------|
30
- | Controller / Handler / Middleware / Steps file | Entity / Repository / DTO / Interface / Base class |
31
-
32
- > Shared code (entity, repo) được dò qua **import chain** từ boundary — không cần tag riêng.
33
-
34
- ---
35
-
36
- ## Trace state — file `.tsv`
37
-
38
- `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` — mỗi UC × platform một sổ. Trong umbrella, nằm ở **spec repo dùng chung** (một nơi authoritative để PM/PO quản lý).
39
-
40
- | Cột | Chủ sở hữu | Ý nghĩa |
41
- |-----|-----------|---------|
42
- | `status` | `/generate-code`, `/validate-traces` | OK / GAP / DRIFT / UNTRACKED |
43
- | `implemented_by` | `/generate-code` | File code hiện thực SC |
44
- | `dev_selftest` | `/dev-run-test` | Smoke của **dev** |
45
- | `qc_status` | `/qc-run-test`, `/report-bug` | Trạng thái QC **chính thức** (Playwright) |
46
- | `bdd_version` / `spec_ver` | spec | Version để phát hiện drift |
47
- | `gen_ver` | `/generate-code` | Version lúc sinh code (so với `spec_ver`) |
48
- | `test_count` | test | Số test phủ SC |
49
- | `last_updated` | nhiều | Mốc cập nhật |
50
-
51
- > **`dev_selftest` ≠ `qc_status`.** Dev smoke (nhanh, tự kiểm) và QC chính thức (Playwright, evidence) là **hai trục độc lập** — không lấn quyền nhau.
52
-
53
- ---
54
-
55
- ## Phân loại coverage (Coverage Status)
56
-
57
- `/validate-traces` phân loại mỗi SC theo **thứ tự ưu tiên** (rule sớm thắng):
58
-
59
- | # | Trạng thái | Điều kiện | Hành động |
60
- |---|-----------|-----------|-----------|
61
- | 1 | **UNTRACKED** | `gen_ver == —` | Chưa sinh code → `/generate-code` |
62
- | 2 | **DRIFT** | có code **và** `spec_ver != gen_ver` | Spec đổi → **regen trước khi test** |
63
- | 3 | **GAP** | code **và** `test_count == / 0` | Có code, chưa test → bù test |
64
- | 4 | **OK** | version khớp, có code, có test | Đủ phủ |
65
-
66
- > **DRIFT xét trước GAP:** SC có code + chưa test + spec vừa drift phải hiện `DRIFT` (không phải `GAP`) — vì `/generate-code` xử GAP = "skip codegen" còn DRIFT = "regenerate". Nếu GAP thắng, code lỗi thời bị bỏ qua.
67
-
68
- ---
69
-
70
- ## Version sống đâu sao code CŨNG mang version
71
-
72
- **Spec SSOT của "version hiện tại". Code mang version của "lúc tôi được sinh ra".** Hai thứ khác nhau, nên không phải dual SSOT.
73
-
74
- | Nơi | Ghi cái gì | Ai ghi |
75
- |---|---|---|
76
- | `.feature` / PRD / tech-doc | version **hiện tại** của spec — SSOT | tác giả spec |
77
- | `.tsv` `spec_ver` | gương của `@trace.sc_version` hiện tại | `/generate-bdd`, `/validate-traces` |
78
- | `.tsv` `gen_ver` | version scenario **tại thời điểm codegen**, theo từng SC | `/generate-code` |
79
- | **Code** `@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision` | version của **từng artifact upstream** tại thời điểm codegen, theo từng **method** | `/generate-code` |
80
-
81
- Drift = **so các mốc này với nhau**; sự lệch nhau chính là tín hiệu, không phải lỗi dữ liệu:
82
-
83
- - `spec_ver != gen_ver` `DRIFT` (scenario đổi sau khi sinh code)
84
- - `@trace.prd_version` trong code < Version PRD hiện tại `PRD_DRIFT`
85
- - `@trace.bdd_version` trong code < `.feature` hiện tại `BDD_DRIFT`
86
- - `@trace.tech_doc_revision` trong code < `@trace.revision` của tech-doc → `TECHDOC_DRIFT`
87
-
88
- **Vì sao không thể bỏ tag version trong code và chỉ dựa vào `.tsv`:**
89
-
90
- 1. **Độ phân giải khác nhau.** `.tsv` một sổ cho mỗi UC × platform. Một **file code** thể phục vụ nhiều UC, mỗi UC ở một version khác nhau — chỉ tag đặt cạnh từng method mới diễn đạt được "UC1 ở bdd v1.4, UC3 ở v2.1".
91
- 2. **Vòng đời khác nhau.** `.tsv` là artifact **sinh ra**, có thể regen/xoá/mirror; ở chế độ umbrella nó còn nằm ở **repo khác** (spec submodule) với code. Tag trong code bản ghi duy nhất **đi cùng** code qua mọi lần copy/move/merge.
92
- 3. **Sự lệch nhau thứ ta muốn đo.** Nếu chỉ có một bản ghi thì không có gì để so — đó mới là lúc drift trở nên không phát hiện được.
93
-
94
- > ⚠️ **Đừng "tối ưu" bằng cách gỡ tag version khỏi code.** `/validate-traces` Step 4/5/5c **đọc chính các tag đó**; gỡ đi là làm drift detection mù **im lặng** — build vẫn xanh, dashboard vẫn đẹp. `/review-code` lăng kính 1 gắn cờ **major** cho mỗi block `@trace.implements` thiếu tag version đi kèm.
95
-
96
- ---
97
-
98
- ## Luồng truy vết (Trace Flow)
99
-
100
- ```mermaid
101
- flowchart LR
102
- PRD["PRD<br/>prd_version"] --> BDD["Scenario<br/>@trace.id + bdd_version"]
103
- BDD --> CODE["Code boundary<br/>@trace.implements/source"]
104
- CODE --> TEST["Test<br/>@trace.verifies"]
105
- BDD -.-> TSV[".tsv state<br/>status/gen_ver/qc_status"]
106
- CODE -.-> TSV
107
- TEST -.-> TSV
108
- TSV --> VM["/validate-traces<br/>Coverage Matrix"]
109
- ```
110
-
111
- ---
112
-
113
- ## Đọc tiếp (Next)
114
-
115
- - [Architecture](architecture.md) — 3 lớp & context-loader
116
- - [Pipeline › Validate Traces](pipeline-steps/09-validate-traces.md) — dùng ma trận coverage
117
- - [Reference › Trace Schema](../04-reference/trace-schema.md) — field đầy đủ
1
+ [← Roles & HITL](roles-and-hitl.md) · [Concepts](./) · [Architecture →](architecture.md)
2
+
3
+ # Traceability — Truy vết đầu-cuối (End-to-end Trace)
4
+
5
+ > Từ scenario nhìn xuống biết code nào hiện thực; từ code nhìn lên biết scenario nào yêu cầu. Đây là một trong ba "trái tim" của framework.
6
+
7
+ ---
8
+
9
+ ## Trace tags theo artifact
10
+
11
+ | Artifact | Trace tag |
12
+ |----------|-----------|
13
+ | **BDD file** (header) | `@trace.id` · **`@trace.platform`** · **`@trace.service`** · `@trace.module` · `@trace.domain` · `@trace.prd` · `@trace.prd_version` · `@trace.bdd_version` · `@trace.status` · `@trace.dataset` |
14
+ | **BDD scenario** (mỗi SC) | `@trace.scenario` · **`@trace.sc_version`** · `@trace.business_rules` |
15
+ | **Code** (boundary only) | `@trace.implements` · `@trace.source` · **`@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision`** · **`@trace.design_spec_version`** *(chỉ FE/App)* — lặp cả block theo **từng UC** trong file đa-UC |
16
+ | **Code** (chỗ chưa implement) | `@trace.stub` · `@trace.stub_owner` · `@trace.stub_for` · `@trace.seam_pending` · `@trace.seam_port` |
17
+ | **Test** | `@trace.verifies` |
18
+ | **Bug fix** | `@trace.fixes` · `@trace.root_cause` · `@trace.regression` |
19
+
20
+ → Đầy đủ field & format: [Reference › Trace Schema](../04-reference/trace-schema.md).
21
+
22
+ ---
23
+
24
+ ## Boundary-only tagging
25
+
26
+ Chỉ tag `@trace` ở **boundary**, không tag mọi file → tránh **tag explosion**:
27
+
28
+ | ✅ Tag | ❌ Không tag |
29
+ |--------|-------------|
30
+ | Controller / Handler / Middleware / Steps file | Entity / Repository / DTO / Interface / Base class |
31
+
32
+ > Shared code (entity, repo) được dò qua **import chain** từ boundary — không cần tag riêng.
33
+
34
+ ---
35
+
36
+ ## Trace state — file `.tsv`
37
+
38
+ `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` — mỗi UC × platform một sổ. Trong umbrella, nằm ở **spec repo dùng chung** (một nơi authoritative để PM/PO quản lý).
39
+
40
+ | Cột | Chủ sở hữu | Ý nghĩa |
41
+ |-----|-----------|---------|
42
+ | `status` | `/generate-code`, `/validate-traces` | OK / GAP / DRIFT / UNTRACKED |
43
+ | `implemented_by` | `/generate-code` | File code hiện thực SC |
44
+ | `dev_selftest` | `/dev-run-test` | Smoke của **dev** |
45
+ | `qc_status` | `/qc-run-test`, `/report-bug` | Trạng thái QC **chính thức** (Playwright) |
46
+ | `bdd_version` / `spec_ver` | spec | Version để phát hiện drift |
47
+ | `service` *(cột 23)* | `/generate-bdd` | Đội/submodule sở hữu SC nguồn của `by_service` trên dashboard |
48
+ | `design_spec_version` *(cột 24)* | `/generate-bdd` | Version design-spec lúc sinh BDD *(FE/App; `—` cho backend)* |
49
+
50
+ **24 cột.** TSV cũ thiếu cột mới → đọc thành giá trị rỗng, **không báo lỗi**; header tự nâng ở lần `/generate-bdd` gen lại kế tiếp. Đọc theo **tên cột ở header row**, không theo vị trí.
51
+
52
+ > **Làm mất hiệu lực ≠ ghi đè.** Chủ sở hữu là người **duy nhất** ghi giá trị **khẳng định** (`pass`/`fail`/số lượng). Nhưng lệnh nào làm giá trị đó **hết đúng** (spec đổi, code đổi) **bắt buộc** hạ nó về `not_run`/`—`. Giữ một `pass` sinh ra từ spec đã bị sửa là **báo cáo sai**, không phải tôn trọng quyền sở hữu cột. Ngoại lệ có chủ ý: `qc_owner`/`qc_blocked_by` (con trỏ bug vẫn còn giá trị) và `test_count`/`test_classes` (test vẫn trên đĩa — **cảnh báo**, không hạ số, để tỷ lệ coverage không nhảy loạn).
53
+ | `gen_ver` | `/generate-code` | Version lúc sinh code (so với `spec_ver`) |
54
+ | `test_count` | test | Số test phủ SC |
55
+ | `last_updated` | nhiều | Mốc cập nhật |
56
+
57
+ > **`dev_selftest` `qc_status`.** Dev smoke (nhanh, tự kiểm) và QC chính thức (Playwright, evidence) là **hai trục độc lập** không lấn quyền nhau.
58
+
59
+ ---
60
+
61
+ ## Phân loại coverage (Coverage Status)
62
+
63
+ `/validate-traces` phân loại mỗi SC theo **thứ tự ưu tiên** (rule sớm thắng):
64
+
65
+ | # | Trạng thái | Điều kiện | Hành động |
66
+ |---|-----------|-----------|-----------|
67
+ | 1 | **UNTRACKED** | `gen_ver == —` | Chưa sinh code → `/generate-code` |
68
+ | 2 | **DRIFT** | có code **và** `spec_ver != gen_ver` | Spec đổi → **regen trước khi test** |
69
+ | 3 | **GAP** | có code **và** `test_count == — / 0` | Có code, chưa test → bù test |
70
+ | 4 | **OK** | version khớp, code, test | Đủ phủ |
71
+
72
+ > **DRIFT xét trước GAP:** SC có code + chưa test + spec vừa drift phải hiện `DRIFT` (không phải `GAP`) vì `/generate-code` xử GAP = "skip codegen" còn DRIFT = "regenerate". Nếu GAP thắng, code lỗi thời bị bỏ qua.
73
+
74
+ ---
75
+
76
+ ## Version sống đâu sao code CŨNG mang version
77
+
78
+ **Spec SSOT của "version hiện tại". Code mang version của "lúc tôi được sinh ra".** Hai thứ khác nhau, nên không phải dual SSOT.
79
+
80
+ | Nơi | Ghi cái gì | Ai ghi |
81
+ |---|---|---|
82
+ | `.feature` / PRD / tech-doc | version **hiện tại** của spec — SSOT | tác giả spec |
83
+ | `.tsv` `spec_ver` | gương của `@trace.sc_version` hiện tại | `/generate-bdd`, `/validate-traces` |
84
+ | `.tsv` `gen_ver` | version scenario **tại thời điểm codegen**, theo từng SC | `/generate-code` |
85
+ | **Code** `@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision` · `@trace.design_spec_version` | version của **từng artifact upstream** tại thời điểm codegen, theo từng **method** | `/generate-code` |
86
+
87
+ Drift = **so các mốc này với nhau**; sự lệch nhau chính là tín hiệu, không phải lỗi dữ liệu:
88
+
89
+ - `spec_ver != gen_ver` → `DRIFT` (scenario đổi sau khi sinh code)
90
+ - `@trace.prd_version` trong code < Version PRD hiện tại `PRD_DRIFT`
91
+ - `@trace.bdd_version` trong code < `.feature` hiện tại `BDD_DRIFT`
92
+ - `@trace.tech_doc_revision` trong code < `@trace.revision` của tech-doc `TECHDOC_DRIFT`
93
+ - `@trace.design_spec_version` trong code FE < Version design-spec → `DESIGNSPEC_DRIFT`
94
+
95
+ > **Lệch version KHÔNG luôn là drift.** PRD và tech-doc là tài liệu **gộp** phủ nhiều UC nhưng chỉ có **một** số version. Thêm UC7 làm mọi UC cũ lệch số dù không đổi một chữ. Nên `/validate-traces` **lọc theo scope của row changelog**: UC có trong danh sách bị ảnh hưởng → `PRD_DRIFT` 🟠; không có → `PRD_STALE_REF` ⓘ (chỉ con trỏ cũ, sạch bằng `--realign-prd-version`); row changelog **mơ hồ** → 🟠 cho mọi UC (lưới an toàn).
96
+
97
+ **Vì sao không thể bỏ tag version trong code và chỉ dựa vào `.tsv`:**
98
+
99
+ 1. **Độ phân giải khác nhau.** `.tsv` là một sổ cho mỗi UC × platform. Một **file code** có thể phục vụ nhiều UC, mỗi UC ở một version khác nhau — chỉ tag đặt cạnh từng method mới diễn đạt được "UC1 ở bdd v1.4, UC3 ở v2.1".
100
+ 2. **Vòng đời khác nhau.** `.tsv` là artifact **sinh ra**, có thể regen/xoá/mirror; ở chế độ umbrella nó còn nằm ở **repo khác** (spec submodule) với code. Tag trong code là bản ghi duy nhất **đi cùng** code qua mọi lần copy/move/merge.
101
+ 3. **Sự lệch nhau là thứ ta muốn đo.** Nếu chỉ có một bản ghi thì không có gì để so — đó mới là lúc drift trở nên không phát hiện được.
102
+
103
+ > ⚠️ **Đừng "tối ưu" bằng cách gỡ tag version khỏi code.** `/validate-traces` Step 4/5/5c **đọc chính các tag đó**; gỡ đi là làm drift detection mù **im lặng** — build vẫn xanh, dashboard vẫn đẹp. `/review-code` lăng kính 1 gắn cờ **major** cho mỗi block `@trace.implements` thiếu tag version đi kèm.
104
+
105
+ ---
106
+
107
+ ## Luồng truy vết (Trace Flow)
108
+
109
+ ```mermaid
110
+ flowchart LR
111
+ PRD["PRD<br/>prd_version"] --> BDD["Scenario<br/>@trace.id + bdd_version"]
112
+ BDD --> CODE["Code boundary<br/>@trace.implements/source"]
113
+ CODE --> TEST["Test<br/>@trace.verifies"]
114
+ BDD -.-> TSV[".tsv state<br/>status/gen_ver/qc_status"]
115
+ CODE -.-> TSV
116
+ TEST -.-> TSV
117
+ TSV --> VM["/validate-traces<br/>Coverage Matrix"]
118
+ ```
119
+
120
+ ---
121
+
122
+ ## Đọc tiếp (Next)
123
+
124
+ - [Architecture](architecture.md) — 3 lớp & context-loader
125
+ - [Pipeline › Validate Traces](pipeline-steps/09-validate-traces.md) — dùng ma trận coverage
126
+ - [Reference › Trace Schema](../04-reference/trace-schema.md) — field đầy đủ
@@ -34,11 +34,22 @@ flowchart LR
34
34
  ## Nguyên tắc sống còn cho Dev
35
35
 
36
36
  1. **Không sinh code cho file không có `.feature` backing** (ngoài fix-bug/debug).
37
- 2. **Boundary-only tagging** — tag `@trace.implements` ở controller/handler, không tag entity/repo.
37
+ 2. **Boundary-only tagging** — tag `@trace` ở controller/handler, không tag entity/repo. Nhưng ở boundary thì phải **đủ block 5 tag** (dưới).
38
38
  3. **Scope Lock** — chỉ implement UC target; code UC khác trong file dùng chung là **bất khả xâm phạm**. Đọc `@trace.implements` để bảo toàn, đừng xoá.
39
- 4. **Version chỉ spec** — code không lưu version; drift qua `.tsv`.
40
- 5. **Build phải pass** trước commit (`{conventions.build_command}`, ≤3 retry).
41
- 6. `CLAUDE.md` (§2 layer/package, §3 coding standards, §5 error handling) nguồn AI *follow*, bạn giữ cập nhật.
39
+ 4. **Code CŨNG mang version** — `@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision` ghi *"tôi được sinh theo bản nào"*, còn spec giữ *"bản hiện tại"*. Sự **lệch nhau** giữa hai mốc chính là tín hiệu drift. Đừng "tối ưu" bằng cách gỡ chúng — `/validate-traces` đọc đúng các tag đó.
40
+ 5. **File phủ nhiều UC lặp cả block theo từng method.** Không gộp header, không trỏ `@trace.source` vào thư mục.
41
+ 6. **Sửa scenario thì bump `@trace.sc_version`** của chính SC đó nếu bạn sửa `.feature` bằng tay. Quên bump = code vĩnh viễn hiện `OK`.
42
+ 7. **Build phải pass** trước commit (`{conventions.build_command}`, ≤3 retry).
43
+ 8. `CLAUDE.md` (§2 layer/package, §3 coding standards, §5 error handling) là nguồn — AI *follow*, bạn giữ nó cập nhật.
44
+
45
+ ```java
46
+ // @trace.implements=AUTH-UC1-SC3
47
+ // @trace.prd_version=1.2 @trace.bdd_version=1.4 @trace.tech_doc_revision=3
48
+ // @trace.source=specs/auth/login/bdd/system/AUTH-UC1-login.feature
49
+ public TokenDto login(...) { }
50
+ ```
51
+
52
+ → Lý do đầy đủ (vì sao **không** phải dual-SSOT): [Traceability](../02-concepts/traceability.md)
42
53
 
43
54
  ---
44
55
 
@@ -67,8 +78,13 @@ flowchart LR
67
78
 
68
79
  - ❌ Tag `@trace` mọi file → tag explosion.
69
80
  - ❌ Tái tạo file dùng chung "chỉ gồm scenario UC này" → xoá nhầm nghiệp vụ UC khác.
81
+ - ❌ Gộp tag của nhiều UC về một header file, hoặc trỏ `@trace.source` vào thư mục → drift báo oan hoặc mù; UC rơi về `UNTRACKED` dù đã có code.
82
+ - ❌ Gỡ tag version khỏi code cho "gọn" → `/validate-traces` mù, **im lặng**.
70
83
  - ❌ Coi `dev_selftest` thay QC chính thức.
71
84
  - ❌ Để AI tự review code nó vừa sinh.
85
+ - ❌ Tạo PR khi `/validate-traces` còn cờ 🔴 (`SEAM_UNWIRED` · `STUB_UNRESOLVED` · `ORPHANED` · `TRACE_ORPHAN`) — build xanh không chứng minh luồng ghép chạy đúng.
86
+ - ❌ Coi FE `fe_phase = ui` là xong vì status đã `OK` — test đang chạy trên **mock**.
87
+ - ❌ Tự đóng bug mình vừa fix — `/fix-bug` chỉ đặt `🟡 Fixed`; `🟢 Closed` là của `/qc-run-test`.
72
88
 
73
89
  ---
74
90
 
@@ -1,68 +1,72 @@
1
- [← Docs Home](../README.md) · [Guides](./)
2
-
3
- # Guide · Product Owner / BA
4
-
5
- > Bạn **định nghĩa cái gì đáng làm**. Vai trò của bạn nặng nhất ở **thượng nguồn** (Discovery → PRD → BDD) — nơi sai một ly đi một dặm.
6
-
7
- ---
8
-
9
- ## Chuỗi bước của bạn (Your path)
10
-
11
- ```mermaid
12
- flowchart LR
13
- A["/define-product<br/>🟢 Lead"] --> B["/generate-prd<br/>🟢 Lead"]
14
- B --> C["/refine-prd<br/>🟢 accept findings"]
15
- C --> D["/review-context PRD<br/>🔒 approve"]
16
- D --> E["/generate-design-spec<br/>🟡 review (FE/App)"]
17
- E --> F["/generate-bdd<br/>🟢 UC decomposition"]
18
- F --> G["/review-context BDD<br/>🔒 approve"]
19
- ```
20
-
21
- Sau khi BDD `approved`, bạn bàn giao xuống Dev/SA — nhưng vẫn nhận **product-gap** từ QC.
22
-
23
- ---
24
-
25
- ## Việc của bạn ở mỗi bước
26
-
27
- | Bước | Bạn làm gì | Quyết định |
28
- |------|-----------|------------|
29
- | [Discovery](../02-concepts/pipeline-steps/01-discovery.md) | Trả lời Q&A 8 chặng, **chốt từng chặng** | Vấn đề, user, UC, BR, AC, edge case, scope |
30
- | [Specification](../02-concepts/pipeline-steps/02-specification.md) | Duyệt PRD draft; **accept/reject từng finding** của `/refine-prd`; đặt `Status: approved` | Scope & terminology đúng chưa |
31
- | [Design-Spec](../02-concepts/pipeline-steps/03-design-spec.md) | Review spec visual bám Figma (FE/App) | Visual khớp intent |
32
- | [BDD](../02-concepts/pipeline-steps/04-bdd.md) | Chốt **UC decomposition**; đặt `@trace.status: approved` | Cấu trúc UC/SC đúng |
33
- | [QC](../02-concepts/pipeline-steps/08-qc-automation.md) | Nhận **product-gap**, quyết ưu tiên sửa | Gap nào lỗi sản phẩm |
34
-
35
- ---
36
-
37
- ## Nguyên tắc sống còn cho PO
38
-
39
- 1. **Viết thuần ngôn ngữ nghiệp vụ** — đừng nhét API/retry/timeout vào PRD/BDD. Business Language Guard sẽ chặn, nhưng bạn nên tự giữ altitude.
40
- 2. **Bốn ngăn không lộn**: AC (nghiệm thu) · BR/BL (cơ chế) · Scope (ranh giới) · Dictionary (định nghĩa).
41
- 3. **Gate trạng thái, không phải lệnh** "duyệt" = bạn tự đặt `| Status | approved |`. Chỉ đặt khi **sạch finding critical**.
42
- 4. **Chốt từng chặng, đừng "để AI tự hiểu"** AI sẽ suy diễn bạn trả giá downstream.
43
- 5. Khi bạn sửa cùng một kiểu nhiều lần gợi ý team `/learn` để ghi lesson.
44
-
45
- ---
46
-
47
- ## Câu hỏi bạn cần trả lời được
48
-
49
- - Tính năng này giải quyết pain point gì? Cho ai?
50
- - Gồm những UC/BR/AC nào? Edge case nào?
51
- - Cái **trong** scope, cái **ngoài**?
52
- - Mỗi scenario BDD phủ đúng một AC/BR không?
53
-
54
- ---
55
-
56
- ## Anti-pattern
57
-
58
- - ❌ Đặt `approved` khi còn finding critical → phá gate, code rác.
59
- - ❌ Bỏ `/refine-prd` "vì PRD trông ổn".
60
- - ❌ Nhảy từ ý tưởng thẳng sang yêu cầu Dev code.
61
-
62
- ---
63
-
64
- ## Lệnh của bạn (Your commands)
65
-
66
- `/define-product` · `/generate-prd` · `/refine-prd` · `/review-context` · `/generate-design-spec` · `/generate-bdd`
67
-
68
- [Bảng lệnh đầy đủ](../04-reference/commands.md) · [Glossary](../02-concepts/glossary.md)
1
+ [← Docs Home](../README.md) · [Guides](./)
2
+
3
+ # Guide · Product Owner / BA
4
+
5
+ > Bạn **định nghĩa cái gì đáng làm**. Vai trò của bạn nặng nhất ở **thượng nguồn** (Discovery → PRD → BDD) — nơi sai một ly đi một dặm.
6
+
7
+ ---
8
+
9
+ ## Chuỗi bước của bạn (Your path)
10
+
11
+ ```mermaid
12
+ flowchart LR
13
+ A["/define-product<br/>🟢 Lead"] --> B["/generate-prd<br/>🟢 Lead"]
14
+ B2["/extend-prd<br/>🟢 Lead — PRD đã có"] --> C
15
+ B --> C["/refine-prd<br/>🟢 accept findings"]
16
+ C --> D["/review-context PRD<br/>🔒 approve"]
17
+ D --> E["/generate-design-spec<br/>🟡 review (FE/App)"]
18
+ E --> F["/generate-bdd<br/>🟢 UC decomposition"]
19
+ F --> G["/review-context BDD<br/>🔒 approve"]
20
+ ```
21
+
22
+ Sau khi BDD `approved`, bạn bàn giao xuống Dev/SA — nhưng vẫn nhận **product-gap** từ QC.
23
+
24
+ ---
25
+
26
+ ## Việc của bạn ở mỗi bước
27
+
28
+ | Bước | Bạn làm gì | Quyết định |
29
+ |------|-----------|------------|
30
+ | [Discovery](../02-concepts/pipeline-steps/01-discovery.md) | Trả lời Q&A 8 chặng, **chốt từng chặng** | Vấn đề, user, UC, BR, AC, edge case, scope |
31
+ | [Specification](../02-concepts/pipeline-steps/02-specification.md) | Duyệt PRD draft; **accept/reject từng finding** của `/refine-prd`; đặt `Status: approved` | Scope & terminology đúng chưa |
32
+ | [Design-Spec](../02-concepts/pipeline-steps/03-design-spec.md) | Review spec visual bám Figma (FE/App) | Visual khớp intent |
33
+ | [BDD](../02-concepts/pipeline-steps/04-bdd.md) | Chốt **UC decomposition**; đặt `@trace.status: approved` | Cấu trúc UC/SC đúng |
34
+ | [QC](../02-concepts/pipeline-steps/08-qc-automation.md) | Nhận **product-gap**, quyết ưu tiên sửa | Gap nào là lỗi sản phẩm |
35
+
36
+ ---
37
+
38
+ ## Nguyên tắc sống còn cho PO
39
+
40
+ 1. **Viết thuần ngôn ngữ nghiệp vụ** đừng nhét API/retry/timeout vào PRD/BDD. Business Language Guard sẽ chặn, nhưng bạn nên tự giữ altitude.
41
+ 2. **Bốn ngăn không lộn**: AC (nghiệm thu) · BR/BL (cơ chế) · Scope (ranh giới) · Dictionary (định nghĩa).
42
+ 3. **Gate trạng thái, không phải lệnh** — "duyệt" = bạn tự đặt `| Status | approved |`. Chỉ đặt khi **sạch finding critical**.
43
+ 4. **Chốt từng chặng, đừng "để AI tự hiểu"** AI sẽ suy diễn bạn trả giá ở downstream.
44
+ 5. Khi bạn sửa cùng một kiểu nhiều lần → gợi ý team `/learn` để ghi lesson.
45
+
46
+ ---
47
+
48
+ ## Câu hỏi bạn cần trả lời được
49
+
50
+ - Tính năng này giải quyết pain point gì? Cho ai?
51
+ - Gồm những UC/BR/AC nào? Edge case nào?
52
+ - Cái **trong** scope, cái **ngoài**?
53
+ - Mỗi scenario BDD có phủ đúng một AC/BR không?
54
+
55
+ ---
56
+
57
+ ## Anti-pattern
58
+
59
+ - ❌ Đặt `approved` khi còn finding critical → phá gate, code rác.
60
+ - ❌ Bỏ `/refine-prd` "vì PRD trông ổn".
61
+ - ❌ Chạy `/generate-prd` lại trên PRD đã có để "cập nhật" — nó **từ chối chạy**, và đúng vậy: ghi đè sẽ mất changelog + đánh số lại BR (phá liên kết ở mọi `.feature` đã sinh). Thêm yêu cầu thì dùng **`/extend-prd`**.
62
+ - ❌ Viết dòng changelog kiểu `"cập nhật theo yêu cầu mới"` — dòng đó là **contract**. Mơ hồ thì `/generate-bdd` gen lại **toàn bộ**, và `/validate-traces` báo động oan cho **mọi** UC thay vì chỉ UC vừa đổi. Luôn nêu **UC/AC/BR bị ảnh hưởng**.
63
+ - ❌ Để `feedback/prd-change-requests/` chất đống — đó là yêu cầu thật tester phát hiện từ sản phẩm chạy thật, và **không cờ trace nào bắt được** (chưa có AC thì theo mọi thước đo coverage nó *không tồn tại*). `/validate-traces` nhắc kèm số ngày chờ; xử bằng `/extend-prd`.
64
+ - Nhảy từ ý tưởng thẳng sang yêu cầu Dev code.
65
+
66
+ ---
67
+
68
+ ## Lệnh của bạn (Your commands)
69
+
70
+ `/define-product` · `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` · `/generate-design-spec` · `/generate-bdd`
71
+
72
+ → [Bảng lệnh đầy đủ](../04-reference/commands.md) · [Glossary](../02-concepts/glossary.md)