@educa-corp/sdd-framework 0.6.0 → 0.7.1

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 (223) hide show
  1. package/bin/gate-trace.js +25 -2
  2. package/bin/index.js +32 -5
  3. package/bin/lint-trace.js +41 -0
  4. package/bin/self-check.js +430 -3
  5. package/bin/trace-schema.json +418 -31
  6. package/core/FRAMEWORK_VERSION +1 -1
  7. package/{commands/extend-prd.md → core/commands/amend-prd.md} +206 -173
  8. package/core/commands/dev-run-test.md +48 -10
  9. package/core/commands/extend-prd.md +39 -12
  10. package/core/commands/generate-bdd.md +52 -10
  11. package/core/commands/generate-code.md +35 -2
  12. package/core/commands/generate-tech-docs.md +36 -4
  13. package/core/commands/map-testids.md +1 -1
  14. package/core/commands/qc-run-test.md +29 -3
  15. package/core/commands/refine-prd.md +13 -2
  16. package/core/commands/review-context.md +43 -8
  17. package/core/commands/sync.md +105 -1
  18. package/core/commands/validate-traces.md +289 -16
  19. package/core/rules/workflow.md +34 -0
  20. package/core/steps/context-loader.md +27 -6
  21. package/core/templates/feature.template +1 -1
  22. package/core/templates/project-context.yaml +3 -3
  23. package/core/templates/tech-design.template.md +2 -2
  24. package/docs/02-concepts/architecture.md +37 -1
  25. package/docs/02-concepts/overview.md +1 -1
  26. package/docs/02-concepts/pipeline-steps/02-specification.md +13 -7
  27. package/docs/02-concepts/pipeline-steps/07-dev-selftest.md +2 -0
  28. package/docs/02-concepts/pipeline-steps/08-qc-automation.md +1 -0
  29. package/docs/02-concepts/pipeline-steps/09-validate-traces.md +34 -3
  30. package/docs/02-concepts/pipeline-steps/10-feedback-loop.md +10 -1
  31. package/docs/02-concepts/traceability.md +187 -183
  32. package/docs/03-guides/architect.md +13 -4
  33. package/docs/03-guides/developer.md +1 -0
  34. package/docs/03-guides/product-owner.md +89 -72
  35. package/docs/03-guides/tester-qa.md +81 -81
  36. package/docs/04-reference/commands.md +148 -134
  37. package/docs/04-reference/trace-schema.md +45 -1
  38. package/docs/explain/02b-extend-prd.md +1 -1
  39. package/docs/explain/02c-amend-prd.md +152 -0
  40. package/docs/explain/06-generate-bdd.md +1 -1
  41. package/docs/explain/13-dev-run-test.md +15 -1
  42. package/docs/explain/19-qc-run-test.md +91 -87
  43. package/docs/explain/21-validate-traces.md +79 -75
  44. package/docs/explain/28-sync.md +25 -0
  45. package/docs/explain/README.md +136 -135
  46. package/package.json +1 -8
  47. package/commands/debug.md +0 -529
  48. package/commands/debug.tmpl +0 -260
  49. package/commands/define-product.md +0 -438
  50. package/commands/define-product.tmpl +0 -225
  51. package/commands/dev-gen-test.md +0 -700
  52. package/commands/dev-gen-test.tmpl +0 -490
  53. package/commands/dev-run-test.md +0 -435
  54. package/commands/dev-run-test.tmpl +0 -225
  55. package/commands/dev-smoke-test.md +0 -374
  56. package/commands/dev-smoke-test.tmpl +0 -217
  57. package/commands/extend-prd.tmpl +0 -273
  58. package/commands/fix-bug.md +0 -519
  59. package/commands/fix-bug.tmpl +0 -197
  60. package/commands/generate-architecture.md +0 -354
  61. package/commands/generate-architecture.tmpl +0 -197
  62. package/commands/generate-bdd.md +0 -923
  63. package/commands/generate-bdd.tmpl +0 -590
  64. package/commands/generate-code.md +0 -859
  65. package/commands/generate-code.tmpl +0 -649
  66. package/commands/generate-design-spec.md +0 -737
  67. package/commands/generate-design-spec.tmpl +0 -524
  68. package/commands/generate-prd.md +0 -722
  69. package/commands/generate-prd.tmpl +0 -226
  70. package/commands/generate-spec-manifest.md +0 -321
  71. package/commands/generate-spec-manifest.tmpl +0 -164
  72. package/commands/generate-tech-docs.md +0 -920
  73. package/commands/generate-tech-docs.tmpl +0 -273
  74. package/commands/learn.md +0 -399
  75. package/commands/learn.tmpl +0 -130
  76. package/commands/map-testids.md +0 -238
  77. package/commands/map-testids.tmpl +0 -81
  78. package/commands/propose-scenario.md +0 -359
  79. package/commands/propose-scenario.tmpl +0 -202
  80. package/commands/qc-analyze.md +0 -269
  81. package/commands/qc-analyze.tmpl +0 -112
  82. package/commands/qc-design-test.md +0 -226
  83. package/commands/qc-design-test.tmpl +0 -69
  84. package/commands/qc-plan.md +0 -206
  85. package/commands/qc-plan.tmpl +0 -49
  86. package/commands/qc-report.md +0 -217
  87. package/commands/qc-report.tmpl +0 -60
  88. package/commands/qc-review.md +0 -210
  89. package/commands/qc-review.tmpl +0 -53
  90. package/commands/qc-run-test.md +0 -326
  91. package/commands/qc-run-test.tmpl +0 -116
  92. package/commands/refine-prd.md +0 -653
  93. package/commands/refine-prd.tmpl +0 -281
  94. package/commands/report-bug.md +0 -305
  95. package/commands/report-bug.tmpl +0 -148
  96. package/commands/review-code.md +0 -415
  97. package/commands/review-code.tmpl +0 -146
  98. package/commands/review-context.md +0 -902
  99. package/commands/review-context.tmpl +0 -530
  100. package/commands/review-tech-docs.md +0 -561
  101. package/commands/review-tech-docs.tmpl +0 -404
  102. package/commands/setup-ai-first.md +0 -602
  103. package/commands/setup-ai-first.tmpl +0 -450
  104. package/commands/sync.md +0 -430
  105. package/commands/sync.tmpl +0 -429
  106. package/commands/update-framework.md +0 -203
  107. package/commands/update-framework.tmpl +0 -202
  108. package/commands/validate-traces.md +0 -1077
  109. package/commands/validate-traces.tmpl +0 -920
  110. package/hooks/data-guard.js +0 -232
  111. package/hooks/settings.json +0 -19
  112. package/modules/android-compose/module.yaml +0 -13
  113. package/modules/android-compose/stack-profile.yaml +0 -57
  114. package/modules/angular/architecture-snippets/component-patterns.md +0 -187
  115. package/modules/angular/module.yaml +0 -6
  116. package/modules/angular/stack-profile.yaml +0 -38
  117. package/modules/context-engineering/architecture-snippets/context-design.md +0 -119
  118. package/modules/context-engineering/module.yaml +0 -9
  119. package/modules/context-engineering/stack-profile.yaml +0 -61
  120. package/modules/dotnet/architecture-snippets/clean-arch.md +0 -160
  121. package/modules/dotnet/module.yaml +0 -6
  122. package/modules/dotnet/stack-profile.yaml +0 -50
  123. package/modules/flutter/module.yaml +0 -14
  124. package/modules/flutter/stack-profile.yaml +0 -59
  125. package/modules/golang/architecture-snippets/domain-layout.md +0 -283
  126. package/modules/golang/module.yaml +0 -6
  127. package/modules/golang/stack-profile.yaml +0 -40
  128. package/modules/ios-swiftui/module.yaml +0 -13
  129. package/modules/ios-swiftui/stack-profile.yaml +0 -55
  130. package/modules/java-spring/architecture-snippets/layered-arch.md +0 -201
  131. package/modules/java-spring/module.yaml +0 -15
  132. package/modules/java-spring/stack-profile.yaml +0 -28
  133. package/modules/nextjs/architecture-snippets/app-router-patterns.md +0 -269
  134. package/modules/nextjs/module.yaml +0 -14
  135. package/modules/nextjs/stack-profile.yaml +0 -74
  136. package/modules/nuxt/module.yaml +0 -14
  137. package/modules/nuxt/stack-profile.yaml +0 -58
  138. package/modules/phaser-game/architecture-snippets/phaser-scene-patterns.md +0 -646
  139. package/modules/phaser-game/module.yaml +0 -15
  140. package/modules/phaser-game/stack-profile.yaml +0 -90
  141. package/modules/php-laravel/architecture-snippets/service-repository.md +0 -302
  142. package/modules/php-laravel/module.yaml +0 -15
  143. package/modules/php-laravel/stack-profile.yaml +0 -56
  144. package/modules/qc-playwright/stack-profile.yaml +0 -66
  145. package/modules/react/architecture-snippets/hooks-query-patterns.md +0 -254
  146. package/modules/react/module.yaml +0 -14
  147. package/modules/react/stack-profile.yaml +0 -63
  148. package/modules/react-native/module.yaml +0 -14
  149. package/modules/react-native/stack-profile.yaml +0 -56
  150. package/modules/vue/module.yaml +0 -14
  151. package/modules/vue/stack-profile.yaml +0 -65
  152. package/rules/data-protection.md +0 -80
  153. package/rules/workflow.md +0 -99
  154. package/skills/code/SKILL.md +0 -19
  155. package/skills/code/SKILL.tmpl +0 -19
  156. package/skills/debug/SKILL.md +0 -19
  157. package/skills/debug/SKILL.tmpl +0 -19
  158. package/skills/design-spec/SKILL.md +0 -11
  159. package/skills/design-spec/SKILL.tmpl +0 -11
  160. package/skills/discovery/SKILL.md +0 -14
  161. package/skills/discovery/SKILL.tmpl +0 -14
  162. package/skills/prd/SKILL.md +0 -19
  163. package/skills/prd/SKILL.tmpl +0 -19
  164. package/skills/qc/qa-analyst/DOC_GAPS.template.md +0 -63
  165. package/skills/qc/qa-analyst/acceptance-criteria.md +0 -60
  166. package/skills/qc/qa-analyst/business-rules.md +0 -59
  167. package/skills/qc/qa-analyst/data-flow.md +0 -64
  168. package/skills/qc/qa-analyst/spec-breakdown.md +0 -61
  169. package/skills/qc/qa-designer/e2e/journey.md +0 -41
  170. package/skills/qc/qa-designer/exploratory/charter.md +0 -68
  171. package/skills/qc/qa-designer/exploratory/explore-to-functional.md +0 -43
  172. package/skills/qc/qa-designer/functional/api.md +0 -45
  173. package/skills/qc/qa-designer/functional/gui-feature.md +0 -46
  174. package/skills/qc/qa-designer/functional/gui-screen.md +0 -52
  175. package/skills/qc/qa-designer/integration/api.md +0 -42
  176. package/skills/qc/qa-designer/integration/db.md +0 -39
  177. package/skills/qc/qa-designer/integration/gui.md +0 -40
  178. package/skills/qc/qa-designer/integration/kafka.md +0 -40
  179. package/skills/qc/qa-designer/non-functional.md +0 -40
  180. package/skills/qc/qa-planner/test-plan.md +0 -120
  181. package/skills/qc/qa-reviewer/script/e2e.md +0 -87
  182. package/skills/qc/qa-reviewer/script/exploratory.md +0 -45
  183. package/skills/qc/qa-reviewer/script/functional.md +0 -101
  184. package/skills/qc/qa-reviewer/script/integration.md +0 -91
  185. package/skills/qc/qa-reviewer/script/non-functional.md +0 -126
  186. package/skills/qc/qa-reviewer/test-case/e2e.md +0 -73
  187. package/skills/qc/qa-reviewer/test-case/exploratory.md +0 -43
  188. package/skills/qc/qa-reviewer/test-case/functional.md +0 -76
  189. package/skills/qc/qa-reviewer/test-case/integration.md +0 -69
  190. package/skills/qc/qa-reviewer/test-case/non-functional.md +0 -73
  191. package/skills/qc/qa-runner/e2e.md +0 -49
  192. package/skills/qc/qa-runner/exploratory/session.md +0 -36
  193. package/skills/qc/qa-runner/functional/api.md +0 -35
  194. package/skills/qc/qa-runner/functional/gui-feature.md +0 -51
  195. package/skills/qc/qa-runner/functional/gui-screen.md +0 -55
  196. package/skills/qc/qa-runner/integration.md +0 -47
  197. package/skills/qc/qa-runner/non-functional.md +0 -49
  198. package/skills/qc/qa-runner/report/report.md +0 -37
  199. package/skills/setup-ai-first/SKILL.md +0 -19
  200. package/skills/setup-ai-first/SKILL.tmpl +0 -19
  201. package/skills/spec/SKILL.md +0 -19
  202. package/skills/spec/SKILL.tmpl +0 -19
  203. package/skills/test/SKILL.md +0 -18
  204. package/skills/test/SKILL.tmpl +0 -18
  205. package/steps/business-language.md +0 -56
  206. package/steps/capture-lesson.md +0 -112
  207. package/steps/context-loader.md +0 -406
  208. package/steps/gate.md +0 -151
  209. package/steps/report-footer.md +0 -125
  210. package/steps/review-fanout.md +0 -159
  211. package/steps/spawn-agent.md +0 -129
  212. package/steps/trace-mirror.md +0 -53
  213. package/templates/README.md +0 -70
  214. package/templates/architecture.template.md +0 -394
  215. package/templates/ci/trace-gate.yml +0 -146
  216. package/templates/design-spec.template.md +0 -217
  217. package/templates/feature.template +0 -123
  218. package/templates/hooks/pre-push +0 -61
  219. package/templates/platform-guide.template.md +0 -145
  220. package/templates/prd.template.md +0 -283
  221. package/templates/product-definition.template.md +0 -188
  222. package/templates/project-context.yaml +0 -212
  223. package/templates/tech-design.template.md +0 -490
@@ -1,920 +0,0 @@
1
- # /validate-traces — Traceability Coverage Matrix
2
-
3
- Check read-only độ phủ giữa spec, code, và test — gồm cả PRD version drift.
4
-
5
- ## Gate
6
-
7
- *Checkpoint: **không chặn** — read-only (ghi trace-report.json + TSV status, không đụng spec/code). Gate Bước 3 bỏ qua CHECKPOINT (Bước 3a).*
8
-
9
- {{include:steps/gate.md}}
10
-
11
- *Lưu ý: Với lệnh này, target ở Bước 1 là một tên domain hoặc UC-ID cụ thể từ `$ARGUMENTS`. Không có một file đơn để phân giải — lệnh quét nhiều thư mục.*
12
-
13
- ## Context
14
- {{include:steps/context-loader.md}}
15
-
16
- ---
17
-
18
- ## Process
19
-
20
- ### Step 0 — Umbrella Mode Detection
21
-
22
- Kiểm tra mảng `services` có tồn tại trong `project-context.yaml` không.
23
-
24
- **Nếu `services` tồn tại (umbrella mode):**
25
- - Phân giải trace dir:
26
- - **Nếu `setup.spec_source` được set (consolidated trace):** `all_trace_dirs = [ {spec_source}/.trace ]` — một vị trí authoritative **duy nhất** trong spec repo. Không cần tách theo service vì **mỗi row TSV mang service sở hữu ở cột `service` (cột 23)** — `/generate-bdd` ghi nó từ `@trace.service` của header `.feature`. Đây là trường hợp phổ biến.
27
- > *Trước v0.4.3, câu này nói "scenario mang service qua `@trace.service`" nhưng TSV **không có cột nào** cho nó và JSON report cũng không — nên ở đúng chế độ phổ biến nhất, trace hoàn toàn không trả lời được "scenario này thuộc đội nào". Cột 23 là thứ làm câu trên trở thành sự thật.*
28
- - **Else (không có spec_source — legacy per-service trace):** một dir mỗi service — `services[N].trace_dir` nếu set, else `{services[N].path}/.trace`; `all_trace_dirs = [ dir1, dir2, … ]`, gắn tag tên service khi đọc.
29
- - Step 1 đọc TSV từ `all_trace_dirs`.
30
- - **Phân giải Living Docs home (vị trí report sinh ra):**
31
- - Nếu `setup.spec_source` được set → `living_docs_dir = {spec_source}/.living-docs`
32
- *(specs module dùng chung — mount trong mọi service/umbrella workspace, nên panel phân giải nó bất kể dev đứng ở submodule nào)*
33
- - Else (umbrella không có spec repo riêng) → `living_docs_dir = .living-docs` ở umbrella root
34
- - **Phân giải panel mirror:** `panel_mirror = ./.trace-mirror` ở **gốc workspace hiện tại** (nơi lệnh chạy). Panel VS Code đọc report từ workspace đang mở — ghi ở đây là cái làm view không rỗng khi dev mở một service submodule trực tiếp.
35
- **Bỏ qua toàn bộ mirror nếu `{paths.trace_dir}` đã nằm trong workspace hiện tại** (single-service, hoặc dev mở thẳng spec repo) — panel đọc `.trace/trace-report.json` tại chỗ, không cần bản sao.
36
- > ⚠️ **`.trace-mirror` ≠ `.trace` — cố ý khác tên.** Trước v0.4.3 cả hai cùng tên `.trace`, nên một luật gitignore theo tên có thể xoá sạch sổ gốc khi hai path trùng nhau. Giờ luật git là tuyệt đối, không có ca nhập nhằng: `.trace-mirror/` **luôn** gitignore · `{paths.trace_dir}` **luôn** commit.
37
-
38
- **Nếu không có key `services` (single-service mode):**
39
- - Set `all_trace_dirs = [ {paths.trace_dir} ]`
40
- - Không cần umbrella sync
41
-
42
- ---
43
-
44
- ### Step 1.0 — Lint sổ trace TRƯỚC khi đọc *(bắt buộc, không bỏ qua được)*
45
-
46
- Chạy checker xác định trên mọi trace dir đã phân giải ở Step 0:
47
-
48
- ```bash
49
- npx @educa-corp/sdd-framework --lint-trace --trace {all_trace_dirs, ngăn cách bởi dấu phẩy} --specs {paths.specs_dir}
50
- ```
51
-
52
- *`bin/` sống trong package npm, không được cài vào project — nên `npx` là đường duy nhất. Không có mạng / npx fail → **bỏ qua step này**, in `⚠️ Chưa lint được sổ trace (npx không khả dụng) — kết quả dưới đây chưa được kiểm cấu trúc` vào report, rồi tiếp Step 1. Đừng để nó chặn cả lệnh.*
53
-
54
- **Exit 0 → tiếp Step 1.**
55
-
56
- **Exit 1 → DỪNG NGAY.** Đừng nạp, đừng tính `status`, đừng ghi lại gì:
57
-
58
- ```
59
- 🔴 SỔ TRACE HỎNG — không phán trạng thái trên dữ liệu này.
60
-
61
- {nguyên văn output của lint-trace}
62
-
63
- Vì sao dừng thay vì cố đọc tiếp: Step 3 tính lại `status` rồi Step 6 GHI NGƯỢC
64
- vào TSV. Chạy tiếp trên một row đã lệch cột sẽ nướng cái lệch đó vào sổ vĩnh viễn —
65
- và sổ trace là dữ liệu KHÔNG regenerate được.
66
-
67
- Sửa:
68
- 1. Xem lần ghi nào làm hỏng : git log -p {file}
69
- 2. Sửa file (thường là thêm/bớt một dấu tab, hoặc giữ cả hai row sau merge)
70
- 3. Kiểm lại : npx @educa-corp/sdd-framework --lint-trace
71
- 4. Rồi chạy lại /validate-traces
72
- ```
73
-
74
- > **Vì sao step này tồn tại (G38):** `bin/self-check.js` canh **contract** — nó đọc file lệnh
75
- > và kiểm "lệnh có gọi đúng tên cột không". Nó không bao giờ mở một `.tsv` thật. Trong khi sổ
76
- > 24 cột được ghi **bằng tay**, hàng chục lần mỗi feature. Một dấu tab thiếu ở ô 17 dồn mọi ô
77
- > sau đó sang trái một bậc — ô 21 `status` nhận một ngày tháng — và **trước step này không gì
78
- > báo lỗi**: lệnh đọc tiếp, in ra số, số chảy vào `trace-report.json` rồi vào dashboard.
79
-
80
- ---
81
-
82
- ### Step 1 — Nạp dữ liệu TSV
83
-
84
- **Umbrella mode:** đọc tất cả file `{trace_dir}/**/*.tsv` từ mọi dir trong `all_trace_dirs`. Với mỗi TSV, gắn tag row với tên service gốc.
85
-
86
- **Single-service mode:** đọc tất cả file `{paths.trace_dir}/{domain}/**/*.tsv` khớp domain target (hoặc `{paths.trace_dir}/**/*.tsv` cho mọi domain nếu không có domain filter).
87
-
88
- Mỗi file cho trace state đã lưu của UC đó.
89
-
90
- **Nếu không tìm thấy file `.tsv` nào** trong bất kỳ trace dir nào:
91
- - Quét tất cả file `{paths.specs_dir}/**/*.feature` trong domain target để dựng list in-memory mọi scenario.
92
- - Coi mọi scenario là `UNTRACKED` (chưa sinh code).
93
- - In: "⚠️ No trace files found. All {N} scenarios across {M} UCs are UNTRACKED."
94
- - Đề xuất: "Run `/generate-bdd {prd-file}` to initialize trace state, or `/generate-code {feature-file}` to generate code."
95
- - **Bỏ qua hoàn toàn Step 2–6.** Đi thẳng tới Step 7 dùng state in-memory này — ĐỪNG abort.
96
-
97
- ### Step 2 — Reconcile với file `.feature` hiện tại
98
-
99
- Mỗi file trace là `{UC-ID}-{platform}.tsv` (một sổ / UC × platform). Với mỗi row, đọc file `.feature` **của đúng platform đó** (`{specs_dir}/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}*.feature` — platform lấy từ tên file TSV) và lấy `@trace.sc_version` **hiện tại** cho SC đó.
100
- Nếu version SC trong `.feature` khác `spec_ver` của `.tsv` → cập nhật `spec_ver` trong memory (sẽ ghi lại).
101
-
102
- Cũng phát hiện SC có trong `.feature` (platform đó) nhưng thiếu trong `.tsv` → thêm row mới với `status: UNTRACKED`. *(sc_id trùng số giữa các platform là 2 scenario khác nhau → mỗi sổ platform giữ tập SC riêng, không dedupe chéo platform.)*
103
-
104
- ### Step 2b — Reverse audit (bắt tag mồ côi)
105
-
106
- *Step 2 đi chiều **spec → code** (mỗi row TSV, SC đó implement tới đâu). Step này đi **chiều ngược** — bắt lớp lỗi mà Step 2 cấu trúc không thể thấy: code trỏ vào một scenario **không còn tồn tại**. Xảy ra khi gen lại BDD làm một SC biến mất (gộp / đổi số / xoá) trong khi code implement nó vẫn nằm đó, vẫn được caller gọi.*
107
-
108
- **Quét (gộp vào cùng lượt quét code của Step 5b — không thêm pass mới):** dưới `{code_base_package}` (CLAUDE.md §2) + `{paths.src_dir}`, thu mọi `@trace.implements={UC-ID}-SC{N}`; trong thư mục test thu mọi `@trace.verifies={UC-ID}-SC{N}`.
109
-
110
- Với mỗi tag, hỏi: `SC{N}` đó có tồn tại trong `.feature` của đúng platform không?
111
-
112
- | Điều kiện | Cờ | Ý nghĩa |
113
- |---|---|---|
114
- | SC không có trong `.feature`, **và** row TSV còn (đã mang `status = ORPHANED` do `/generate-bdd` giữ lại) | `ORPHANED` 🔴 | Đã được ghi nhận — đang chờ người quyết định |
115
- | SC không có trong `.feature`, **và** không có row TSV nào | `TRACE_ORPHAN` 🔴 | Nợ cũ: row bị xoá bởi version trước, hoặc tag ghi sai UC/SC id ngay từ đầu. **Không có chỗ nào khác bắt được cái này.** |
116
- | SC có trong `.feature` | *(sạch)* | |
117
-
118
- **Với `TRACE_ORPHAN`:** đừng tự tạo row TSV (chưa biết nó nên là scenario nào) và **đừng** sửa/xoá code. Chỉ report kèm đúng hai đường ra ở §Output.
119
-
120
- Không tìm thấy tag mồ côi nào → bỏ qua im lặng.
121
-
122
- ### Step 3 — Tính `status` theo từng scenario
123
-
124
- Áp dụng quy tắc theo thứ tự ưu tiên (first-match-wins):
125
-
126
- | Rule | Status | Điều kiện |
127
- |------|--------|-----------|
128
- | 0 | `ORPHANED` | SC của row này **không còn trong `.feature`** (Step 2b) AND `implemented_by != —` — code trỏ vào scenario đã bị xoá |
129
- | 1 | `UNTRACKED` | `implemented_by == —` (chưa sinh code) |
130
- | 2 | `DRIFT` | `implemented_by != —` AND `spec_ver != gen_ver` (spec đã đổi sau lần codegen — code cũ, **ưu tiên regen trước khi test**) |
131
- | 3 | `GAP` | `implemented_by != —` AND (`test_count == —` OR `test_count == 0`) |
132
- | 4 | `OK` | tất cả: `spec_ver == gen_ver`, `implemented_by != —`, `test_count > 0` |
133
-
134
- > **Vì sao ORPHANED là Rule 0 (xét TRƯỚC mọi rule khác):** 4 rule kia đều giả định scenario **còn tồn tại** — chúng trả lời "spec này implement tới đâu". `ORPHANED` trả lời câu ngược: "code này còn spec nào bảo lãnh không". Nếu để rule khác thắng, mỗi giá trị đều **route người dùng sang một lệnh vô nghĩa**: `GAP` → `/dev-gen-test` sinh test cho scenario không tồn tại · `DRIFT` → `/generate-code` cố sinh lại từ SC đã bị xoá · `OK` → coi là sạch và cho tạo PR. Row cũng KHÔNG được xoá — xoá đi thì code thành vô hình (chính là bug gốc).
135
-
136
- > **Vì sao DRIFT xét trước GAP:** một scenario đã có code, chưa test, **và** spec vừa drift phải hiện `DRIFT` (không phải `GAP`) — vì `generate-code` xử `GAP` = "skip codegen, chạy /dev-gen-test" còn `DRIFT` = "regenerate". Nếu GAP thắng, code lỗi thời bị bỏ qua và test lại sinh trên code cũ. UNTRACKED vẫn phải là Rule 1 để scenario chưa code (gen_ver `—`) không lọt vào DRIFT.
137
-
138
- ### Step 4 — PRD version drift check
139
-
140
- Với mỗi UC, so:
141
- - PRD `| **Version** |` hiện tại từ `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md`
142
- - `prd_version` lưu trong `.tsv` (version tại thời điểm sinh BDD)
143
- - `@trace.prd_version` trong các file code implement UC đó
144
-
145
- Nếu layer nào sau version PRD hiện tại → trích các changelog entry kể từ version đó, rồi **lọc theo phạm vi ảnh hưởng** (dưới đây) để quyết `PRD_DRIFT` 🟠 hay `PRD_STALE_REF` ⓘ.
146
-
147
- #### Lọc theo phạm vi changelog — chống báo động oan
148
-
149
- *PRD là tài liệu **cấp feature** phủ nhiều UC, nhưng version của nó là **một scalar**. Nên thêm UC7 — không đụng một chữ nào của UC1–UC6 — vẫn làm cả 6 UC cũ lệch version. So version thuần thì cả 6 ăn cờ đỏ oan.*
150
-
151
- Đọc các row `# Change Log` của PRD **từ version của layer cũ nhất tới hiện tại**, trích tập UC/AC/BR được nêu. *(`/refine-prd` Phase 3 và `/extend-prd` **bắt buộc** ghi thông tin này vào mỗi row — chính vì mục đích này. `/generate-bdd` Version Check đã dùng nó từ trước; ở đây chỉ là đọc cùng một dữ liệu.)*
152
-
153
- | Điều kiện | Cờ | Hành động |
154
- |---|---|---|
155
- | UC này **có** trong tập bị ảnh hưởng | `PRD_DRIFT` 🟠 | Cần regen thật — theo bảng `drifted_layers` bên dưới |
156
- | UC này **không** có trong tập, **và** mọi row changelog trong khoảng đều nêu rõ scope | `PRD_STALE_REF` ⓘ | Nội dung không đổi, chỉ con trỏ version cũ. **KHÔNG** route regen — dùng `--realign-prd-version` |
157
- | **Bất kỳ** row nào trong khoảng mơ hồ (không nêu UC/AC/BR) | `PRD_DRIFT` 🟠 cho **MỌI** UC | Không suy đoán được thì quét rộng |
158
-
159
- > **Hàng thứ ba là lưới an toàn — hỏng theo hướng an toàn.** Changelog viết ẩu thì ta mất tính năng *lọc*, KHÔNG mất tính năng *cảnh báo*. Đồng bộ với `generate-bdd` Version Check: *"changelog row không nêu rõ UC/AC/BR (mơ hồ) → khuyến nghị F (gen lại toàn bộ)"*.
160
- >
161
- > **Vì sao cần bước lọc này:** đây là G1 lộn ngược. G1 làm cờ **im lặng**; so-version-thuần làm cờ **ồn tới mức vô nghĩa** — sau vài lần thêm feature, `PRD_DRIFT` sáng thường trực, người đọc học cách bỏ qua, rồi lần lệch THẬT cũng bị bỏ qua cùng. Kết cục giống hệt nhau: không ai còn tin cờ. Và nó tệ dần theo thời gian — PRD càng nhiều UC, càng nhiều lần bump, nhiễu càng lớn, tức là đánh mạnh nhất vào chính những feature trưởng thành nhất.
162
- > Framework **đã giải đúng bài này ở cấp scenario**: `sc_version` chỉ bump khi thân scenario thực sự đổi, với lý do ghi thẳng — *"bump vô cớ sẽ tạo DRIFT giả, làm cờ mất giá trị"*. Đây là bản tương ứng ở cấp PRD.
163
-
164
- **Ghi rõ layer nào lệch** (`drifted_layers` trong JSON — `"tsv"` và/hoặc `"code"`). Đây là thứ quyết định người dùng phải chạy **một** lệnh hay **hai**:
165
-
166
- | `drifted_layers` | Nghĩa | Hành động |
167
- |---|---|---|
168
- | `["tsv"]` | BDD chưa gen lại từ PRD mới; code vẫn khớp cột TSV | `/generate-bdd {prd-file}` là **đủ** |
169
- | `["tsv","code"]` | Cả BDD lẫn code đều cũ | `/generate-bdd` **rồi** `/generate-code {UC-ID}` |
170
- | `["code"]` | TSV đã cập nhật nhưng code chưa sinh lại | `/generate-code {UC-ID}` |
171
-
172
- *Không ghi `drifted_layers` thì hai ca đầu trông hệt nhau — người dùng hoặc chạy thiếu (cờ không sạch) hoặc chạy thừa (sinh lại code không cần thiết).*
173
-
174
- ### Step 5 — Tech-doc revision drift check
175
-
176
- Mỗi PRD có **một** tech-doc gộp `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md` với một `@trace.revision` chung. So revision đó vs hai cột đã lưu:
177
-
178
- - **Backend drift:** `@trace.revision` của doc vs `tech_doc_revision` trong `.tsv`.
179
- - **FE integration drift:** `@trace.revision` của doc vs `fe_tech_doc_revision` trong `.tsv` (row FE `--phase=integration`, theo từng platform; §4.5.4).
180
-
181
- Skip cột nào chưa có revision đã lưu (`—`), hoặc cả UC chưa có tech-doc.
182
-
183
- #### Lọc theo phạm vi — ĐỐI XỨNG với Step 4
184
-
185
- *Tech-doc có **đúng cùng hình dạng** với PRD: một doc **GỘP cấp PRD**, một `@trace.revision` chung cho nhiều UC. Chế độ **APPEND** (`generate-tech-docs` Bước 1) thêm UC mới vào doc đã có → revision bump → **mọi UC cũ lệch**, dù phần của chúng không đổi một dòng.*
186
-
187
- Đọc **§10 UC Coverage** và **Changelog** của tech-doc, trích tập UC mà row changelog trong khoảng revision đó nêu:
188
-
189
- | Điều kiện | Cờ |
190
- |---|---|
191
- | UC này **có** trong tập bị ảnh hưởng | `TECHDOC_DRIFT` / `FE_TECHDOC_DRIFT` 🟠 |
192
- | UC này **không** có, changelog nêu rõ scope | `TECHDOC_STALE_REF` ⓘ — dùng `--realign-techdoc-revision` |
193
- | Row changelog mơ hồ | 🟠 cho **mọi** UC (lưới an toàn) |
194
-
195
- ### Step 5e — Realign mode *(chỉ chạy khi có flag)*
196
-
197
- *Đường ra rẻ cho hai cờ ⓘ ở Step 4/5. Không có nó thì cờ `PRD_STALE_REF`/`TECHDOC_STALE_REF` **không bao giờ sạch được**: `/generate-bdd` cập nhật được cột TSV, nhưng tag trong code thì chỉ `/generate-code` ghi — mà nó thấy row `OK` là skip (`generate-code` §Read Trace State). Vòng lặp đóng, và lối ra duy nhất là ép sinh lại code cho hàng loạt UC không hề thay đổi.*
198
-
199
- Parse `$ARGUMENTS`:
200
-
201
- | Flag | Làm gì |
202
- |---|---|
203
- | `--realign-prd-version {UC-ID}` | Cập nhật cột `prd_version` của TSV **và** tag `@trace.prd_version` trong các file code của UC đó → version PRD hiện tại |
204
- | `--realign-techdoc-revision {UC-ID}` | Tương tự với `tech_doc_revision`/`fe_tech_doc_revision` và tag `@trace.tech_doc_revision` → `@trace.revision` hiện tại |
205
-
206
- **Ba rào an toàn — bắt buộc, đây là lệnh SỬA CODE:**
207
-
208
- 1. **Từ chối chạy** nếu UC đó có bất kỳ SC nào đang `DRIFT` hoặc `ORPHANED`, hoặc nếu Step 4/5 xếp nó là 🟠 (không phải ⓘ). Khi đó nội dung **có** đổi thật — dán nhãn lại là **che lỗi**. In:
209
- ```
210
- ❌ Từ chối realign {UC-ID}: UC này đang {PRD_DRIFT | có SC DRIFT | ORPHANED}.
211
- Realign chỉ dành cho ⓘ STALE_REF (nội dung KHÔNG đổi, chỉ con trỏ version cũ).
212
- Ở đây nội dung có đổi thật → /generate-bdd rồi /generate-code {UC-ID}.
213
- ```
214
- 2. **Chỉ sửa dòng bắt đầu bằng `@trace.`** — không đụng một dòng logic nào. **Guard sau-ghi:** đọc lại file, diff với bản trước; nếu có bất kỳ dòng nào **khác** ngoài các dòng `@trace.*` đã định → **khôi phục file** và dừng.
215
- 3. **In chính xác** file + dòng đã sửa vào report — realign im lặng là realign không kiểm chứng được.
216
-
217
- Không đụng `dev_selftest`/`qc_status` (luật G28 không áp: **không có logic nào đổi** — đó chính là tiền đề của realign).
218
-
219
- ### Step 5c — BDD version drift check
220
-
221
- *Đối xứng với Step 4 (PRD drift). Trước đây tầng BDD là tầng DUY NHẤT không có cờ drift — dù `/generate-code` vẫn ghi `@trace.bdd_version` vào code và JSON report vẫn lưu nó. Dữ liệu có, chỉ thiếu phép so.*
222
-
223
- **Chiều BDD → code.** Với mỗi UC × platform, so:
224
- - `@trace.bdd_version` **hiện tại** của `.feature` (`bdd/{platform}/{UC-ID}*.feature`)
225
- - `@trace.bdd_version` trong các file code implement UC đó
226
-
227
- Code mang version cũ hơn → gắn cờ `BDD_DRIFT`. Kèm theo, liệt kê các SC của UC đó đang `DRIFT` (từ Step 3) để chỉ đúng chỗ cần regen — `bdd_version` nói "file đã đổi", `sc_version` nói "đổi ở SC nào".
228
-
229
- > **Bổ trợ, không thay thế `sc_version`:** `sc_version` bắt thay đổi trong **thân scenario**. `bdd_version` bắt thay đổi ở **cấp file** mà `sc_version` không thấy: `Background`, `@trace.dataset`, khối BUSINESS DEFINITION, Popup/Modal Lifecycle, Display Logic Matrix, Coverage Matrix. Code sinh ra phụ thuộc cả hai.
230
-
231
- **File code KHÔNG có tag `@trace.bdd_version`** (code sinh trước khi tag này bắt buộc) → không kết luận drift được. Đếm và in **một dòng** tổng hợp:
232
- ```
233
- ⚠️ {n} file thiếu tag @trace.bdd_version → drift detection mù ở các file này.
234
- Bổ sung tag khi sửa file lần tới (/review-code lăng kính Traceability sẽ bắt).
235
- ```
236
-
237
- **Chiều BDD → tech-doc** *(chỉ report, cổng chặn nằm ở `/review-tech-docs`)*: đọc map `@trace.bdd_versions` của tech-doc gộp; platform nào có `.feature` **mới hơn** entry trong map → gắn cờ `TECHDOC_STALE_VS_BDD`. Đây là ca nguy hiểm hơn drift-về-code: `/generate-code` DS3 thấy tech-doc `approved` sẽ lấy shape §4 **nguyên văn** làm contract "đã chốt", nên contract dựng từ BDD cũ sẽ lan thẳng vào code.
238
-
239
- ### Step 5d — Design-spec drift check *(chỉ FE/App)*
240
-
241
- *Bỏ qua hoàn toàn với `system`/backend — không có design-spec.*
242
-
243
- *Đối xứng Step 5c. Design-spec là artifact upstream **cuối cùng** được đưa vào trace: nó điều khiển cả BDD FE/App (Screen States + AC-UI, xem `generate-bdd` §Design Spec — Gate & Load) lẫn code FE (màn hình, component inventory, link Figma frame), nhưng trước đây không có cột, không có tag, không có cờ. Nó **có** tự bảo vệ một chiều — `/generate-design-spec` reset `Status: draft` khi PRD đổi — nhưng chiều ngược lại (designer sửa design-spec SAU KHI BDD/code đã sinh) thì không gì bắt được.*
244
-
245
- Đọc `| **Version** |` **hiện tại** từ Metadata design-spec tại `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{platform}-{slug}.md` *(`app-ios`/`app-android` không có bản riêng → fallback bản `-app-`)*.
246
-
247
- **Chiều design-spec → BDD.** So với cột `design_spec_version` của TSV:
248
- - Cột **cũ hơn** → `DESIGNSPEC_STALE_VS_BDD` 🟠. BDD FE/App dựng từ design-spec cũ → có thể thiếu Screen State / AC-UI vừa thêm. Route: `/generate-bdd {prd-file}`.
249
-
250
- **Chiều design-spec → code.** So với tag `@trace.design_spec_version` trong các file code FE implement UC đó:
251
- - Tag **cũ hơn** → `DESIGNSPEC_DRIFT` 🟠. Route: `/generate-code {feature-file}`.
252
-
253
- **Không kết luận khi thiếu đầu so:**
254
- - Cột `design_spec_version` = `—` (TSV cũ, hoặc BDD sinh khi chưa có design-spec) → skip chiều BDD.
255
- - File code FE **không có** tag `@trace.design_spec_version` (sinh trước khi tag này tồn tại) → skip chiều code, và đếm gộp **một dòng** — y hệt cách Step 5c xử `@trace.bdd_version` thiếu:
256
- ```
257
- ⚠️ {n} file FE thiếu tag @trace.design_spec_version → drift detection mù ở các file này.
258
- Bổ sung khi sửa file lần tới (/review-code lăng kính Traceability sẽ bắt).
259
- ```
260
- - Không tìm thấy file design-spec → skip im lặng (feature có thể chưa cần design-spec; `/generate-bdd` đã cảnh báo mềm ở chỗ của nó).
261
-
262
- ### Step 5b — Seam & Stub Audit (mồ côi khi ghép luồng)
263
-
264
- *Bắt lỗi "gen từng BDD thì đúng, ghép cả luồng thì hỏng": chỗ giả lập còn rỗng trong khi hàng thật đã tồn tại ở nơi khác — luồng chạy vào no-op / hàm thật không ai gọi. Build vẫn xanh, test từng-UC vẫn xanh, nên không cổng nào khác bắt được. Hai loại: `seam` (port cross-UC chưa nối) và `stub` (method trắng nội-feature chưa lấp).*
265
-
266
- **Nguồn (dùng cái nào có, hợp nhất):**
267
- 1. Sổ chung `{trace_dir}/{domain}/{prd-slug}/_seams.tsv` — do `/generate-code` ghi (cột `kind` phân biệt `seam`/`stub`).
268
- 2. Quét code dưới `{code_base_package}` (từ CLAUDE.md §2 đã nạp) — bắt cả chỗ sinh **trước khi** có sổ:
269
- - **seam:** class mang `@trace.seam_pending` HOẶC tên khớp `*Stub*Adapter`.
270
- - **stub:** method mang `@trace.stub` (thân còn placeholder — `throw UnsupportedOperationException` / TODO / rỗng).
271
-
272
- **Audit A — Seam (port cross-UC).** Với mỗi seam:
273
- - Tìm **hàng thật**: class KHÁC (không `*Stub*`/`*Mock*`) implement cùng port/interface dưới `{code_base_package}`.
274
- - Tìm **binding hiện tại**: stub có còn được tham chiếu như adapter đang dùng không (được inject / `@Primary` / đăng ký trong config) — hàng thật thì KHÔNG có đường vào?
275
-
276
- | Điều kiện | Cờ | Ý nghĩa |
277
- |---|---|---|
278
- | Hàng thật CHƯA tồn tại | `SEAM_PENDING` | Bình thường — owner UC chưa gen. Chỉ nhắc. |
279
- | Hàng thật ĐÃ tồn tại **và** stub vẫn là binding đang dùng | `SEAM_UNWIRED` 🔴 | **Lỗi thật** — hàng thật mồ côi, luồng chạy vào stub rỗng. |
280
- | Binding đã trỏ hàng thật (stub chỉ còn cho test) | *(sạch)* | Đã nối xong. |
281
-
282
- **Audit B — Stub (method trắng nội-feature).** Với mỗi method còn tag `@trace.stub`:
283
- - Đọc `@trace.stub_owner` (UC lẽ ra phải lấp) + `@trace.stub_for` (trách nhiệm).
284
- - **Owner đã gen chưa?** = có bất kỳ `@trace.implements={stub_owner}-*` nào trong codebase không.
285
- - **Có hàng thật song song không?** = method KHÁC mang `@trace.implements` với thân thật cùng trách nhiệm `stub_for` (dấu hiệu BDD owner đã đẻ hàm song song thay vì lấp).
286
-
287
- | Điều kiện | Cờ | Ý nghĩa |
288
- |---|---|---|
289
- | `stub_owner` chưa gen **và** không có hàng song song | `STUB_PENDING` | Bình thường — owner BDD chưa chạy. Chỉ nhắc. |
290
- | `stub_owner` ĐÃ gen (hoặc có method song song cùng `stub_for`) mà method vẫn còn `@trace.stub` rỗng | `STUB_UNRESOLVED` 🔴 | **Lỗi thật** — hàm trắng mồ côi (caller chạy vào rỗng) và/hoặc hàm thật mồ côi (không ai gọi). Fill-before-create đã trượt. |
291
- | Không còn method nào mang `@trace.stub` cho trách nhiệm đó | *(sạch)* | Đã lấp xong. |
292
-
293
- - **Cập nhật sổ `_seams.tsv`** (nếu tồn tại). **Khớp dòng theo khoá `(kind, name, consumer_uc)`** — `name` là tên port (seam) hoặc trách nhiệm (stub). *Không khớp theo `artifact`: class/method stub có thể được đổi tên hoặc di chuyển giữa hai lần chạy, lúc đó ta sẽ append dòng mới thay vì cập nhật dòng cũ và sổ đẻ ra bản ghi ma.* Cập nhật `status` + `last_updated`; giữ nguyên `owner_uc`/`binding` (do `/generate-code` sở hữu). Theo `kind`:
294
- - `seam`: `PENDING`→`READY` khi hàng thật xuất hiện mà chưa nối; `→RESOLVED` khi binding đã trỏ hàng thật.
295
- - `stub`: `PENDING`→`READY` khi phát hiện `STUB_UNRESOLVED`; `→RESOLVED` khi method đã được lấp (hết `@trace.stub`).
296
- `READY` = đồng nghĩa cờ 🔴 tương ứng (`SEAM_UNWIRED` / `STUB_UNRESOLVED`).
297
-
298
- Không tìm thấy seam/stub nào → bỏ qua im lặng.
299
-
300
- ### Step 6 — Ghi status lại vào TSV
301
-
302
- *Bỏ qua step này nếu không có file TSV nào (đã xử lý bởi path no-TSV của Step 1).*
303
-
304
- Với mỗi file `.tsv` đã xử lý: ghi `spec_ver`, `status`, `last_updated` đã cập nhật lại disk.
305
- Đồng thời **đồng bộ `uc_status` ← `@trace.status`** của file `.feature` tương ứng (header `.feature` là nguồn-sự-thật về duyệt BDD — người đặt `approved` sau khi review sạch, giống PO đặt PRD Metadata `Status`). Nhờ vậy `approved_ucs` trên dashboard phản ánh đúng thay vì luôn = 0.
306
- Và **đồng bộ `prd_status` ← `| **Status** |`** của PRD tương ứng (`{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md`) — đối xứng với `uc_status`: PRD Metadata là nguồn-sự-thật về duyệt PRD. Không có bước này thì `prd_status` là **write-once** (chỉ `/generate-bdd` ghi một lần) và sẽ giữ `approved` vĩnh viễn sau khi `/refine-prd` hay `/review-context --fix` reset PRD về `draft`. *(Step 4 đã đọc file PRD này rồi — không phát sinh I/O.)*
307
- **Đừng** sửa `dev_selftest`/`dev_selftest_at` (do `/dev-run-test` sở hữu) hay `qc_status`/`qc_run_at`/`qc_owner`/`qc_blocked_by` (do `/qc-run-test` + `/report-bug` sở hữu); lệnh này chỉ đọc chúng cho report.
308
-
309
- ### Step 7 — Tính aggregate cho dashboard
310
-
311
- ```
312
- total_prds = count distinct PRD files in {paths.specs_dir}/{domain}/*/*.md (file .md ở gốc mỗi feature folder = PRD)
313
- approved_prds = PRDs with | Status | approved
314
- total_ucs = count distinct UC-IDs across all .tsv files (strip the -{platform} suffix from the filename)
315
- approved_ucs = UCs with uc_status == approved
316
- draft_ucs = UCs with uc_status == draft
317
- total_scs = rows across all .tsv files WHERE status != ORPHANED
318
- # (a UC's SCs are counted per platform — no cross-platform dedupe by sc_id)
319
- # ORPHANED bị LOẠI khỏi mẫu số: nó không còn là scope nữa (scenario đã bị xoá
320
- # khỏi .feature). Tính vào mẫu số sẽ bóp méo coverage theo hướng xấu đi vì một
321
- # thứ không ai cần implement. Nó được đếm riêng ở orphaned_count + cờ 🔴.
322
- code_coverage = rows where implemented_by != — / total_scs
323
- test_coverage = rows where test_count > 0 / total_scs
324
- drift_count = rows where status == DRIFT
325
- untracked_count = rows where status == UNTRACKED
326
- gap_count = rows where status == GAP
327
- fe_on_mock = rows where fe_phase == ui # FE đã có UI nhưng CÒN DÙNG MOCK — chưa wire API thật
328
- fe_integrated = rows where fe_phase == integrated # FE đã wire adapter thật theo tech-doc §4.5.4
329
- # fe_phase trả lời câu của PM: "màn nào demo được nhưng chưa nối backend?". Row `ui` là
330
- # công việc CHƯA XONG dù status có thể đã là OK (có code + có test trên mock).
331
- orphaned_count = rows where status == ORPHANED # code còn, scenario đã bị xoá khỏi .feature (Step 2b/Rule 0)
332
- trace_orphan_count = số tag @trace.implements/@trace.verifies trỏ vào SC không tồn tại VÀ không có row TSV (Step 2b)
333
- prd_drift_count = số UC bị cờ PRD_DRIFT (lệch version VÀ changelog nêu UC này — Step 4)
334
- prd_stale_ref_count = số UC bị cờ PRD_STALE_REF (lệch version nhưng changelog KHÔNG nêu UC này —
335
- nội dung không đổi, chỉ con trỏ cũ). ⓘ không phải lỗi; sạch bằng --realign-prd-version
336
- techdoc_stale_ref_count = số UC bị cờ TECHDOC_STALE_REF (đối xứng, Step 5)
337
- bdd_drift_count = số UC×platform bị cờ BDD_DRIFT (code mang @trace.bdd_version cũ hơn .feature — Step 5c)
338
- techdoc_drift_count = số UC bị cờ TECHDOC_DRIFT (code sinh từ tech_doc_revision cũ hơn @trace.revision — Step 5)
339
- fe_techdoc_drift_count = số UC×platform bị cờ FE_TECHDOC_DRIFT (FE wire theo fe_tech_doc_revision cũ — Step 5)
340
- techdoc_stale_vs_bdd_count = số platform mà tech-doc dựng từ bdd_version cũ hơn .feature hiện tại (Step 5c)
341
- designspec_drift_count = số UC×platform FE bị cờ DESIGNSPEC_DRIFT (code FE mang design_spec_version cũ hơn — Step 5d)
342
- designspec_stale_vs_bdd_count = số UC×platform FE mà BDD dựng từ design-spec cũ hơn bản hiện tại (Step 5d)
343
- by_service = map {service → {total_scs, coded_scs, tested_scs, drift_count}} — gom theo cột `service` (cột 23)
344
- # Trả lời câu số MỘT của dự án nhiều đội: "đội nào còn bao nhiêu việc".
345
- # Trước khi có cột 23, trace gộp (spec_source) KHÔNG mang thông tin sở hữu ở
346
- # cấp row nên câu này không trả lời được. Bỏ qua map này ở single-service.
347
- by_platform = map {platform → {total_scs, coded_scs, tested_scs, drift_count}} — gom theo
348
- platform (lấy từ TÊN FILE sổ `{UC-ID}-{platform}.tsv`, cùng nguồn với field
349
- `platform` của mỗi scenario ở Step 8)
350
- # CHỈ tạo ô cho platform THỰC SỰ có scenario — dự án chỉ có `web` thì chỉ một ô.
351
- # Trả lời "web xong bao nhiêu %, system xong bao nhiêu %" — câu thường ngày khi
352
- # làm FE và BE song song. Trước đó KHÔNG trả lời được từ `summary`: `by_service`
353
- # là bảng chia nhóm DUY NHẤT, mà cột `service` là `—` ở mọi row của dự án
354
- # single-service ⇒ nó gộp tất cả vào MỘT ô, và platform hoàn toàn vô hình.
355
- # Đây là hình dạng của G33: dữ liệu có ở cấp row (G48 vừa thêm `platform` vào
356
- # từng scenario) nhưng KHÔNG có ô tổng ⇒ dashboard chỉ đọc `summary` thì mù.
357
- # Bắt dashboard tự duyệt prds[].ucs[].scenarios[] mà cộng lại chính là cái bẫy
358
- # G33 đã chỉ ra: người viết dashboard đọc `summary`, thấy đủ, rồi tưởng xong.
359
- # KHÔNG thay `by_service` — hai TRỤC khác nhau, cùng hữu ích ở umbrella nhiều đội.
360
- seam_unwired_count = số seam bị cờ SEAM_UNWIRED (hàng thật đã có nhưng consumer còn wire vào stub — Step 5b)
361
- seam_pending_count = số seam bị cờ SEAM_PENDING (owner UC chưa gen — ⓘ chưa phải lỗi; PM dùng để xếp thứ tự gen)
362
- stub_unresolved_count = số stub bị cờ STUB_UNRESOLVED (method còn trắng dù owner đã gen / có hàm song song — Step 5b)
363
- stub_pending_count = số stub bị cờ STUB_PENDING (owner BDD chưa gen — ⓘ chưa phải lỗi)
364
- # LUẬT (rules/workflow.md §Trace Contract): MỌI giá trị trong vocabularies.audit_flags phải có
365
- # một counter {flag_lowercase}_count ở đây VÀ trong summary của JSON. bin/self-check.js R7 ép
366
- # điều này — thiếu counter = cờ không quan sát được ở tầng tổng hợp, dashboard không thấy.
367
- dev_selftest_passing = rows where dev_selftest == pass
368
- dev_selftest_failing = rows where dev_selftest == fail
369
- dev_selftest_not_run = rows where dev_selftest in (not_run, —)
370
- # NOTE: dev_selftest is the DEV self-check signal (did the dev run their own smoke tests),
371
- # NOT official coverage — keep it labeled as such on the dashboard.
372
- qc_passing = rows where qc_status == pass
373
- qc_failing = rows where qc_status == fail
374
- qc_skipped = rows where qc_status == skip
375
- qc_not_run = rows where qc_status in (not_run, —)
376
- # qc_status is the OFFICIAL QC automation result (set by /qc-run-test),
377
- # shown alongside — never merged with — dev_selftest.
378
- waiting_dev = rows where qc_owner == dev # PM view: QC-found, waiting on dev to fix
379
- waiting_po = rows where qc_owner == po # PM view: blocked, waiting on PO to confirm/clarify
380
- # qc_owner + qc_blocked_by trả lời "case nào đang chờ ai" — surface as a "Waiting on" column.
381
- tech_docs_count = count .md files in {paths.tech_docs_dir}/{domain}/*/tech-docs/
382
- ```
383
-
384
- ### Step 7b — Hàng đợi yêu cầu đổi PRD còn treo
385
-
386
- *Không phải trạng thái trace — nhưng đây là hàng đợi DUY NHẤT trong framework không có lệnh nào quét lại nó, nên nó cần một chỗ để không chìm. Chọn lệnh này vì nó được chạy thường xuyên nhất.*
387
-
388
- Quét `{paths.prd_change_requests_dir}/*.md` (mặc định `{spec_source}/feedback/prd-change-requests/`; **không** quét `archived/`). Thư mục không tồn tại hoặc rỗng → bỏ qua **im lặng**, không in gì.
389
-
390
- Với mỗi file, đọc metadata: `UC / Ticket`, `Status`, và tiêu đề. Chỉ giữ `Status: Open` (bỏ qua `incorporated` / `rejected`).
391
-
392
- Tính `days_waiting` = số ngày từ ngày file được tạo tới hôm nay. Nguồn ngày, theo thứ tự ưu tiên: (1) field ngày trong metadata nếu có · (2) `git -C {REPO} log --diff-filter=A --format=%ad --date=short -1 -- {file}` · (3) không lấy được → để `—`, đừng đoán.
393
-
394
- Lưu danh sách này cho §Output. **Không** ghi nó vào `trace-report.json` — nó không phải trạng thái trace, và JSON là contract với panel VS Code.
395
-
396
- > **Vì sao cần bước này:** ba hàng đợi feedback thì hai cái đã có người quét lại mỗi lần chạy — `/fix-bug` đọc `bug-reports/`, `/generate-bdd` quét `bdd-proposals/`. Riêng `prd-change-requests/` không có ai. Chỗ duy nhất nó từng xuất hiện là `/sync` Step 1d, mà Step 1d chỉ hiện những gì về **trong đúng lần pull đó** (`{old_sha}..{new_sha}`) — bỏ lỡ một lần là mất khỏi màn hình vĩnh viễn. Đây là loại yêu cầu **không cờ trace nào bắt được**: nó nói về hành vi chưa có AC nào phủ, nên theo mọi thước đo coverage thì nó không tồn tại.
397
-
398
- ### Step 8 — Ghi JSON report
399
-
400
- Ghi `{paths.trace_dir}/trace-report.json` (ghi đè nếu tồn tại). File này là source of truth duy nhất cho web dashboard — nó chứa snapshot đầy đủ tại thời điểm `/validate-traces` chạy lần cuối.
401
-
402
- Schema:
403
-
404
- ```json
405
- {
406
- "generated_at": "<ISO-8601 timestamp>",
407
- "domain": "<domain argument, or 'all' if no filter>",
408
- "summary": {
409
- "total_prds": 0,
410
- "approved_prds": 0,
411
- "total_ucs": 0,
412
- "approved_ucs": 0,
413
- "draft_ucs": 0,
414
- "total_scs": 0,
415
- "coded_scs": 0,
416
- "tested_scs": 0,
417
- "code_coverage_pct": 0,
418
- "test_coverage_pct": 0,
419
- "drift_count": 0,
420
- "gap_count": 0,
421
- "untracked_count": 0,
422
- "fe_on_mock": 0,
423
- "fe_integrated": 0,
424
- "orphaned_count": 0,
425
- "trace_orphan_count": 0,
426
- "prd_drift_count": 0,
427
- "prd_stale_ref_count": 0,
428
- "bdd_drift_count": 0,
429
- "techdoc_drift_count": 0,
430
- "techdoc_stale_ref_count": 0,
431
- "fe_techdoc_drift_count": 0,
432
- "techdoc_stale_vs_bdd_count": 0,
433
- "designspec_drift_count": 0,
434
- "designspec_stale_vs_bdd_count": 0,
435
- "seam_unwired_count": 0,
436
- "seam_pending_count": 0,
437
- "stub_unresolved_count": 0,
438
- "stub_pending_count": 0,
439
- "dev_selftest_passing": 0,
440
- "dev_selftest_failing": 0,
441
- "dev_selftest_not_run": 0,
442
- "qc_passing": 0,
443
- "qc_failing": 0,
444
- "qc_skipped": 0,
445
- "qc_not_run": 0,
446
- "waiting_dev": 0,
447
- "waiting_po": 0,
448
- "tech_docs_count": 0,
449
- "by_service": {
450
- "<service path, e.g. user-service>": {
451
- "total_scs": 0, "coded_scs": 0, "tested_scs": 0, "drift_count": 0
452
- }
453
- },
454
- "by_platform": {
455
- "<web | app | system — CHỈ platform thực sự có scenario>": {
456
- "total_scs": 0, "coded_scs": 0, "tested_scs": 0, "drift_count": 0
457
- }
458
- }
459
- },
460
- "prds": [
461
- {
462
- "prd_id": "<e.g. PAY>",
463
- "prd_status": "approved | draft | other",
464
- "total_scs": 0,
465
- "coded_scs": 0,
466
- "tested_scs": 0,
467
- "drift_count": 0,
468
- "gap_count": 0,
469
- "untracked_count": 0,
470
- "ucs": [
471
- {
472
- "uc_id": "<e.g. PAY-UC01>",
473
- "uc_status": "approved | draft | other",
474
- "scenarios": [
475
- {
476
- "sc_id": "<e.g. PAY-UC01-SC1>",
477
- "platform": "web | app | system",
478
- "sc_title": "<title>",
479
- "spec_ver": "<current version from .feature>",
480
- "gen_ver": "<version at codegen time>",
481
- "implemented_by": "<ClassName.method or null>",
482
- "test_count": 0,
483
- "test_classes": ["<TestClass1>", "<TestClass2>"],
484
- "dev_selftest": "pass | fail | not_run",
485
- "dev_selftest_at": "<YYYY-MM-DD or null>",
486
- "qc_status": "pass | fail | skip | not_run",
487
- "qc_run_at": "<YYYY-MM-DD or null>",
488
- "qc_owner": "dev | po | null",
489
- "qc_blocked_by": "<BUG-id / GAP-id or null>",
490
- "prd_version": "<prd version when BDD was generated>",
491
- "bdd_version": "<bdd version when code was generated>",
492
- "tech_doc_revision": 0,
493
- "fe_tech_doc_revision": 0,
494
- "service": "<đội/submodule sở hữu — cột 23; null nếu '—'>",
495
- "design_spec_version": "<version design-spec lúc sinh BDD — cột 24; null nếu '—'>",
496
- "status": "OK | DRIFT | GAP | UNTRACKED",
497
- "orphaned": false,
498
- "last_updated": "<YYYY-MM-DD>"
499
- }
500
- ]
501
- }
502
- ]
503
- }
504
- ],
505
- "issues": {
506
- "drift": [
507
- {
508
- "sc_id": "<SC-ID>",
509
- "sc_title": "<title>",
510
- "spec_ver": "<current>",
511
- "gen_ver": "<at codegen>",
512
- "fix": "/generate-code <UC-ID>"
513
- }
514
- ],
515
- "gap": [
516
- {
517
- "sc_id": "<SC-ID>",
518
- "sc_title": "<title>",
519
- "implemented_by": "<method>",
520
- "fix": "/dev-gen-test <UC-ID>"
521
- }
522
- ],
523
- "untracked": [
524
- {
525
- "sc_id": "<SC-ID>",
526
- "sc_title": "<title>",
527
- "fix": "/generate-code <UC-ID>"
528
- }
529
- ],
530
- "prd_version_drift": [
531
- {
532
- "uc_id": "<UC-ID>",
533
- "current_prd_version": "<version in PRD file — mốc so sánh>",
534
- "tsv_prd_version": "<cột prd_version của TSV — version lúc sinh BDD>",
535
- "code_prd_version": "<tag @trace.prd_version trong code — version lúc sinh code>",
536
- "drifted_layers": ["tsv", "code"],
537
- "changelog_since": ["<v1.1: ...>", "<v1.2: ...>"],
538
- "in_changelog_scope": true,
539
- "fix": "chỉ [\"tsv\"] → /generate-bdd <prd-file> là đủ · có \"code\" → /generate-bdd rồi /generate-code <UC-ID>"
540
- }
541
- ],
542
- "prd_stale_ref": [
543
- {
544
- "uc_id": "<UC-ID>",
545
- "current_prd_version": "<version PRD file>",
546
- "tsv_prd_version": "<cột prd_version>",
547
- "code_prd_version": "<tag trong code>",
548
- "drifted_layers": ["code"],
549
- "changelog_since": ["<v2.0: thêm UC7 — không đụng UC1>"],
550
- "in_changelog_scope": false,
551
- "fix": "/validate-traces --realign-prd-version <UC-ID> (chỉ sửa dòng nhãn, KHÔNG đụng logic)"
552
- }
553
- ],
554
- "techdoc_stale_ref": [
555
- {
556
- "uc_id": "<UC-ID>",
557
- "current_revision": 0,
558
- "code_revision": 0,
559
- "in_changelog_scope": false,
560
- "fix": "/validate-traces --realign-techdoc-revision <UC-ID>"
561
- }
562
- ],
563
- "bdd_drift": [
564
- {
565
- "uc_id": "<UC-ID>",
566
- "platform": "web | app | system",
567
- "code_bdd_version": "<@trace.bdd_version trong code>",
568
- "current_bdd_version": "<@trace.bdd_version của .feature>",
569
- "drifted_scs": ["<SC đang DRIFT của UC này>"],
570
- "fix": "/generate-code <feature-file>"
571
- }
572
- ],
573
- "techdoc_stale_vs_bdd": [
574
- {
575
- "uc_id": "<UC-ID>",
576
- "platform": "web | app | system",
577
- "techdoc_bdd_version": "<entry trong map @trace.bdd_version của tech-doc>",
578
- "current_bdd_version": "<@trace.bdd_version của .feature>",
579
- "fix": "/generate-tech-docs <feature-file> then /review-tech-docs"
580
- }
581
- ],
582
- "designspec_drift": [
583
- {
584
- "uc_id": "<UC-ID>",
585
- "platform": "web | app",
586
- "code_design_spec_version": "<@trace.design_spec_version trong code FE>",
587
- "current_design_spec_version": "<| **Version** | của design-spec>",
588
- "fix": "/generate-code <feature-file>"
589
- }
590
- ],
591
- "designspec_stale_vs_bdd": [
592
- {
593
- "uc_id": "<UC-ID>",
594
- "platform": "web | app",
595
- "bdd_design_spec_version": "<cột design_spec_version của TSV>",
596
- "current_design_spec_version": "<| **Version** | của design-spec>",
597
- "fix": "/generate-bdd <prd-file> — BDD có thể thiếu Screen State / AC-UI vừa thêm"
598
- }
599
- ],
600
- "orphaned": [
601
- {
602
- "sc_id": "<SC-ID đã bị xoá khỏi .feature>",
603
- "platform": "web | app | system",
604
- "implemented_by": "<ClassName.method còn tồn tại>",
605
- "test_classes": ["<test còn trỏ vào SC này>"],
606
- "fix": "xoá code + test, HOẶC đưa scenario trở lại .feature"
607
- }
608
- ],
609
- "trace_orphan": [
610
- {
611
- "tag": "@trace.implements | @trace.verifies",
612
- "sc_id": "<SC-ID không tồn tại>",
613
- "file": "<file mang tag>",
614
- "fix": "sửa sc_id cho đúng SC hiện có, HOẶC xoá code/test nếu không còn cần"
615
- }
616
- ],
617
- "techdoc_drift": [
618
- {
619
- "uc_id": "<UC-ID>",
620
- "code_revision": 0,
621
- "current_revision": 0,
622
- "fix": "changelog KHÔNG nêu UC này → /validate-traces --realign-techdoc-revision <UC-ID> (rẻ, không đụng logic) · changelog CÓ nêu → /generate-code <UC-ID> --force"
623
- }
624
- ],
625
- "fe_techdoc_drift": [
626
- {
627
- "uc_id": "<UC-ID>",
628
- "platform": "web | app",
629
- "code_revision": 0,
630
- "current_revision": 0,
631
- "fix": "changelog KHÔNG nêu UC này → /validate-traces --realign-techdoc-revision <UC-ID> · CÓ nêu → /generate-code <UC-ID> --phase=integration --force"
632
- }
633
- ],
634
- "seam_unwired": [
635
- {
636
- "port": "<PortName>",
637
- "consumer_uc": "<UC còn gọi stub>",
638
- "owner_uc": "<UC sở hữu hàng thật>",
639
- "stub_class": "<StubClass>",
640
- "real_class": "<RealClass>",
641
- "fix": "Trỏ binding của <consumer_uc> sang <RealClass> (xoá/thay stub), build lại"
642
- }
643
- ],
644
- "stub_unresolved": [
645
- {
646
- "artifact": "<ClassName#method>",
647
- "stub_for": "<trách nhiệm>",
648
- "consumer_uc": "<UC để trắng>",
649
- "owner_uc": "<UC lẽ ra phải lấp>",
650
- "parallel_impl": "<ClassName#method hàm song song, hoặc null>",
651
- "fix": "/generate-code <owner_uc> — lấp logic vào <ClassName#method> tại chỗ (Fill-before-create), xoá hàm song song nếu có, build lại"
652
- }
653
- ]
654
- }
655
- }
656
- ```
657
-
658
- **Rules:**
659
- - **`by_platform` là bắt buộc** (nếu có ít nhất một scenario). Cùng hình dạng `by_service`, khoá **động** — một ô cho mỗi platform tìm thấy, không phải một ô cố định cho mỗi giá trị vocabulary. Thêm platform thứ tư vào vocabulary thì nó tự có ô, không cần sửa gì ở đây.
660
- > Đây là lý do `by_platform` **không cần** một rule `self-check` riêng: khác cờ audit (mỗi cờ cần một counter mang tên riêng, nên R7 phải canh từng cái), ở đây không có gì để lệch.
661
- - **`platform` (bắt buộc, mỗi scenario):** lấy từ **tên file sổ** `{UC-ID}-{platform}.tsv` — Step 2 đã đọc nó để tìm đúng `.feature`. Giá trị: `web` | `app` | `system`.
662
- > **Vì sao bắt buộc (G48):** `sc_id` **một mình không định danh được** một scenario. Chính Step 2 phát biểu điều đó: *"sc_id trùng số giữa các platform là 2 scenario khác nhau"*. Sổ TSV giải quyết bằng tên file; JSON thì làm phẳng mọi platform vào chung một cây `scenarios[]`, nên thiếu field này thì `AUTH-UC1-SC1` của web và của app **không phân biệt được** — panel hiện trùng lặp hoặc đè nhau, và không ai trả lời được *"SC1 của app xong chưa"*.
663
- > Bất đối xứng cũ: `issues.orphaned[]` và `issues.fe_techdoc_drift[]` **đã** mang `platform`; chỉ cây dữ liệu chính là không.
664
- - `implemented_by`: dùng `null` (không phải `"—"`) trong JSON khi không có giá trị
665
- - `test_count`: dùng integer `0` (không phải `"—"`) khi không có test
666
- - `test_classes`: dùng `[]` (không phải `"—"`) khi không có test class
667
- - `tech_doc_revision` / `fe_tech_doc_revision`: dùng integer; `0` nếu chưa sinh
668
- - `code_coverage_pct` / `test_coverage_pct`: làm tròn về integer gần nhất (0–100)
669
- - **`status` trong JSON CỐ TÌNH chỉ có 4 giá trị** `OK`/`DRIFT`/`GAP`/`UNTRACKED` — KHÔNG ghi `ORPHANED` vào field này. VS Code extension "Spec Driven Docs Tools" (sống **ngoài** repo này) switch trên `status`; thêm giá trị thứ 5 sẽ rơi vào nhánh không khớp và có thể làm row mất khỏi panel.
670
- Row `ORPHANED` xuất ra JSON là: `"status": "DRIFT"` + `"orphaned": true`. Panel chưa hỗ trợ vẫn hiện nó như `DRIFT` — đủ đúng về nghĩa ("code không khớp spec, cần xử lý") và **không im lặng**; panel có đọc `orphaned` thì hiện nhãn riêng. Chi tiết đầy đủ luôn có ở `orphaned[]` và ở report terminal.
671
- **TSV giữ nguyên chữ `ORPHANED`** trong cột `status` — TSV là nguồn-sự-thật, JSON chỉ là bản xuất cho panel.
672
- - `orphaned` (boolean): `true` chỉ khi cột `status` của TSV là `ORPHANED`; mọi row khác ghi `false` (đừng bỏ trống — panel đọc field vắng dễ ra `undefined`).
673
- - Luôn ghi vào `{paths.trace_dir}/trace-report.json` bất kể domain filter — nếu có domain filter, chỉ gồm các PRD đó trong `prds[]` nhưng ghi domain vào field `domain`
674
- - **TSV `"—"` mapping**: khi đọc file TSV, map giá trị dash sang kiểu JSON: `implemented_by: "—"` → `null`; `test_count: "—"` → `0`; `test_classes: "—"` → `[]`; `tech_doc_revision: "—"` → `0`; `fe_tech_doc_revision: "—"` → `0`; `dev_selftest: "—"` → `"not_run"`; `dev_selftest_at: "—"` → `null`; `qc_status: "—"` → `"not_run"`; `qc_run_at: "—"` → `null`; `qc_owner: "—"` → `null`; `qc_blocked_by: "—"` → `null`; `service: "—"` → `null`; `design_spec_version: "—"` → `null`
675
- - **Backward-compat:** TSV cũ có thể thiếu cột mới hơn trong header — coi cột vắng nào là giá trị rỗng của nó (**đừng báo lỗi, đừng bỏ qua cả file**): `qc_owner`/`qc_blocked_by` (pre-19-col) → `null`; `fe_tech_doc_revision` (pre-22-col) → `0`; `service`/`design_spec_version` (pre-24-col) → `null`. Lần `/generate-bdd` gen lại tiếp theo nâng header lên layout **24 cột** hiện tại.
676
- > **Đọc theo TÊN CỘT ở header row, KHÔNG theo vị trí.** Header là dòng đầu mỗi `.tsv` — parse nó rồi tra theo tên. Đếm vị trí sẽ vỡ ở đúng file cũ mà luật này sinh ra để đỡ. Header thiếu hoàn toàn (file hỏng) → mới báo lỗi cho file đó và đi tiếp, không abort cả lệnh.
677
- > **Cột `service` = `null` không bằng "không có đội".** Nó nghĩa là *chưa biết* (TSV cũ hơn cột 23). Gom vào một nhóm `"(chưa xác định)"` trong `by_service` thay vì bỏ khỏi thống kê — bỏ đi thì tổng của `by_service` nhỏ hơn `total_scs` mà không ai giải thích được vì sao.
678
-
679
- ### Step 8b — Living Docs Sync *(chỉ umbrella mode)*
680
-
681
- *Bỏ qua step này ở single-service mode.*
682
-
683
- **Với `spec_source` được set,** các trace TSV authoritative đã sống ở **một** chỗ —
684
- `{spec_source}/.trace/` (committed trong spec repo). **Không có merge theo service**:
685
- mỗi scenario row mang service sở hữu ở **cột `service`** (cột 23, do `/generate-bdd` ghi từ
686
- `@trace.service`). Step này chỉ (re)generate report và làm mới panel local.
687
-
688
- 1. **Ghi report** vào `{living_docs_dir}/trace-report.json` (`mkdir -p` trước) — dựng
689
- trực tiếp từ `{spec_source}/.trace/*.tsv`, với field `"service"` mỗi scenario row và
690
- các summary aggregate. *(Umbrella legacy không-`spec_source` vẫn merge mọi `trace-report.json`
691
- theo service thành một document, namespace theo service.)*
692
-
693
- 2. **Mirror tới panel location** `{panel_mirror}` (`./.trace-mirror` ở gốc workspace hiện tại)
694
- để dev mở *repo này* thấy data ngay: copy
695
- `{living_docs_dir}/trace-report.json` (+ các file `{UC-ID}-{platform}.tsv`) → `{panel_mirror}/`.
696
- **Skip nếu `{paths.trace_dir}` đã nằm trong workspace hiện tại** (dev đang đứng trong spec repo —
697
- panel đọc thẳng ở đó). **KHÔNG** copy `trace-history.jsonl` sang mirror (xem Step 8c).
698
-
699
- 3. **In sync summary:**
700
- ```
701
- Living Docs → {living_docs_dir}/trace-report.json ({total} scenarios across {S} services)
702
- Trace (authoritative) → {spec_source}/.trace/ (committed in spec repo)
703
- Panel mirror → {panel_mirror}/trace-report.json (current workspace)
704
- ```
705
-
706
- > **Ranh giới git — tuyệt đối, không có ngoại lệ:**
707
- >
708
- > | Đường dẫn | Vai trò | Git |
709
- > |---|---|---|
710
- > | `{paths.trace_dir}/*.tsv` + `trace-history.jsonl` | **AUTHORITATIVE**, không regenerate được | **PHẢI commit** |
711
- > | `{living_docs_dir}/` (`.living-docs/`) | report sinh ra | gitignore |
712
- > | `{panel_mirror}/` (`.trace-mirror/`) | bản sao tiện cho panel | gitignore |
713
- >
714
- > Hai cái dưới được `/validate-traces` hoặc `/sync` dựng lại bất cứ lúc nào. Cái trên thì không —
715
- > mất là mất vĩnh viễn. Từ v0.4.3 mirror đổi tên thành `.trace-mirror` chính vì lý do này:
716
- > khi cả hai cùng tên `.trace`, một luật gitignore theo tên có thể xoá sổ gốc mà không ai biết.
717
-
718
- ### Step 8c — Ghi nhật ký lịch sử *(mọi mode)*
719
-
720
- *`trace-report.json` bị **ghi đè** mỗi lần chạy (Step 8), và cột `last_updated` của TSV chỉ là một ngày bị 8 lệnh cùng ghi đè. Nên framework đo được **trạng thái** rất tốt nhưng không đo được **tốc độ** — không trả lời được "từ bao giờ", "đang lên hay xuống", "case này hỏng đi hỏng lại mấy lần". Step này thêm chiều thời gian với chi phí gần bằng 0.*
721
-
722
- **Append** một dòng JSON (một bản ghi trọn vẹn trên một dòng) vào `{paths.trace_dir}/trace-history.jsonl`. Tạo file nếu chưa có.
723
-
724
- **Chỉ ghi DELTA, không chép lại snapshot** — snapshot đầy đủ đã ở `trace-report.json`:
725
-
726
- ```json
727
- {"at":"<ISO-8601>","domain":"<domain hoặc all>",
728
- "summary":{ …nguyên khối summary của Step 7… },
729
- "changed":[{"sc_id":"PAY-UC1-SC2","platform":"web","from":"OK","to":"DRIFT"},
730
- {"sc_id":"PAY-UC1-SC7","platform":"web","from":null,"to":"UNTRACKED"}],
731
- "flags_opened":["SEAM_UNWIRED:ScoreAccumulationPort"],
732
- "flags_closed":["STUB_UNRESOLVED:SegmentService#calculateSegment"]}
733
- ```
734
-
735
- **Cách tính `changed` / `flags_opened` / `flags_closed`:** đọc **dòng cuối cùng** của chính file này (đọc ngược từ cuối — không parse cả file) và so với kết quả lần này. `from: null` = row mới xuất hiện. Nếu file chưa tồn tại → đây là baseline: ghi `summary`, để `changed`/`flags_*` là `[]`.
736
-
737
- **Rotate:** file vượt **2000 dòng** → đổi tên thành `trace-history.{YYYY-MM}.jsonl` rồi bắt đầu file mới. Đừng xoá.
738
-
739
- **Năm ràng buộc — đây là phần dễ làm sai:**
740
-
741
- | Ràng buộc | Vì sao |
742
- |---|---|
743
- | Ghi **CHỈ** vào `{paths.trace_dir}` (nơi authoritative). **KHÔNG** copy sang `{panel_mirror}` hay `{living_docs_dir}` | Nó là dữ liệu tích luỹ, không phải thứ regenerate được. Nhân bản nó ra chỗ sinh-ra là tạo hai lịch sử lệch nhau. |
744
- | Dòng vừa append **PHẢI kết thúc bằng newline** — file không bao giờ được kết thúc giữa dòng | File này là append-only và được merge bằng `merge=union` (xem `{paths.trace_dir}/.gitattributes`). Thiếu newline cuối thì lần append sau — hoặc một lần union merge — **nối hai bản ghi JSON thành một dòng**, và dòng đó không parse được. `--lint-trace` T8 bắt, nhưng đây là ca phòng được bằng một ký tự. |
745
- | File này **PHẢI được commit** cùng TSV | Nó là **dữ liệu**, không phải mirror. Regenerate lại không được — mất là mất vĩnh viễn. ⚠️ Đừng để nó dính vào luật gitignore của `.living-docs/` hay panel mirror; hai cái đó là bản sinh ra, cái này thì không. |
746
- | **Không đụng** TSV và `trace-report.json` | TSV là bảng **trạng thái** — giữ nó phẳng. Lịch sử là file riêng, format riêng, vòng đời riêng. `trace-report.json` là contract với panel VS Code. |
747
- | **Không lệnh nào được ra quyết định dựa trên file này** | Nó để **quan sát**, không phải để gác cổng. Một cái cổng phụ thuộc file có thể bị xoá là cổng dở. Cổng chặn PR vẫn chỉ là 4 cờ 🔴. |
748
-
749
- Ghi thất bại (không có quyền, đĩa đầy) → **cảnh báo mềm một dòng rồi đi tiếp**. Nhật ký hỏng không được làm hỏng lệnh audit.
750
-
751
- ## Output
752
-
753
- {{include:steps/report-footer.md}}
754
-
755
- ```
756
- /validate-traces — {domain}
757
-
758
- 📄 {paths.trace_dir}/trace-report.json ← updated
759
-
760
- ┌─────────────────────────────────────────────────────────────────────────────────────┐
761
- │ PRDs Use Cases Scenarios Code Cov. Test Cov. Drift Untracked Gap │
762
- │ {N} {N} {N} {N}% {N}% {N} {N} {N} │
763
- │ {A} appr {A} appr {X}/{T} SCs {X}/{T} SCs │
764
- └─────────────────────────────────────────────────────────────────────────────────────┘
765
- {in dòng GATE nếu BẤT KỲ cờ 🔴 nào > 0 (seam_unwired · stub_unresolved · orphaned · trace_orphan) — ngược lại bỏ cả khối}
766
- 🔴 GATE — có MỒ CÔI: {seam_unwired_count} SEAM_UNWIRED · {stub_unresolved_count} STUB_UNRESOLVED
767
- · {orphaned_count} ORPHANED · {trace_orphan_count} TRACE_ORPHAN
768
- Build xanh, test từng-UC xanh, coverage đẹp — nhưng luồng ghép chạy vào no-op,
769
- hoặc code đang trỏ vào scenario đã bị xoá. KHÔNG coi là pass tới khi CẢ BỐN = 0.
770
- {in dòng ⓘ dưới đây chỉ khi drift_count + bdd_drift_count > 0 — để hai loại cờ đứng cạnh nhau thay vì ở hai đầu report}
771
- ⓘ Ngoài cổng: {drift_count} DRIFT · {bdd_drift_count} BDD_DRIFT — "code CHƯA theo kịp spec".
772
- KHÔNG chặn PR (khác 4 cờ trên), nhưng cũng chưa xong.
773
-
774
- {khối 📈 CHỈ in khi trace-history.jsonl đã có ≥1 dòng trước lần chạy này (Step 8c) — lần chạy
775
- đầu tiên là baseline, không có gì để so, bỏ cả khối. Dấu +/− lấy theo hướng thực tế.}
776
- 📈 So lần chạy trước ({ngày dòng cuối}): code {+2}% · test {−1}% · DRIFT {+3} · UNTRACKED {−5}
777
- Đèn mới bật: {SEAM_UNWIRED × 1} · Đèn đã tắt: {STUB_UNRESOLVED × 2}
778
- {n} scenario đổi trạng thái — chi tiết: {paths.trace_dir}/trace-history.jsonl
779
-
780
- | UC-ID | SC | Title (truncated) | Spec | Gen | Code | Tests | Status |
781
- |-------------|------|------------------------------|-------|-------|----------------------|----------------|----------|
782
- | {UC}-UC1 | SC1 | {title...} | v1.0 | v1.0 | ✅ {Controller.fn} | ✅ 10 tests | OK |
783
- | {UC}-UC1 | SC2 | {title...} | v1.1 | v1.0 | ✅ {Controller.fn} | ✅ 3 tests | DRIFT |
784
- | {UC}-UC1 | SC6 | {title...} | v1.0 | — | — | — | UNTRACKED|
785
- | {UC}-UC2 | SC1 | {title...} | v1.0 | v1.0 | ✅ {Controller.fn} | — | GAP |
786
- | {UC}-UC2 | SC7 | {title...} ⚠ đã xoá khỏi spec| — | v1.0 | ✅ {Controller.fn} | ✅ 2 tests | ORPHANED |
787
-
788
- Drift Detail:
789
- {UC}-UC1-SC2 — spec v1.1 nhưng code sinh từ v1.0
790
- → Chạy lại: /generate-code {UC-ID}
791
-
792
- BDD Version Drift (file .feature đổi ở cấp file — Background/dataset/business definition):
793
- {UC}-UC1 (web) — code sinh từ BDD v1.4, .feature giờ v1.6 [SC đang DRIFT: SC2, SC5]
794
- → /generate-code {feature-file}
795
- ⚠️ {n} file code thiếu tag @trace.bdd_version → drift detection mù ở các file này
796
-
797
- Tech-doc lỗi thời so với BDD:
798
- {UC}-UC3 (system) — tech-doc dựng từ BDD v1.5, .feature giờ v2.0
799
- ⚠️ Nguy hiểm hơn drift-về-code: DS3 của /generate-code coi §4 approved là contract
800
- "đã chốt" và lấy shape NGUYÊN VĂN → contract từ BDD cũ lan thẳng vào code.
801
- → /generate-tech-docs {feature-file} → /review-tech-docs (cổng T-BDD)
802
-
803
- Design-spec Drift (chỉ FE/App — designer sửa thiết kế SAU KHI BDD/code đã sinh):
804
- {UC}-UC1 (web) — code dựng từ design-spec v1.2, design-spec giờ v1.5
805
- → /generate-code {feature-file}
806
- {UC}-UC4 (app) — BDD dựng từ design-spec v2.0, design-spec giờ v2.3
807
- ⚠️ BDD có thể THIẾU Screen State / AC-UI vừa thêm — không phải chỉ lỗi thời nhãn.
808
- → /generate-bdd {prd-file}
809
- ⚠️ {n} file FE thiếu tag @trace.design_spec_version → drift detection mù ở các file này
810
-
811
- {khối by_service CHỈ in ở umbrella mode (có section `services`) — bỏ ở single-service}
812
- Theo đội (cột `service`):
813
- user-service 12/15 SC có code · 10 test · 2 DRIFT
814
- web-app 8/8 SC có code · 8 test · 0 DRIFT
815
- (chưa xác định) 3/3 SC có code · 3 test · 0 DRIFT ← TSV cũ hơn cột 23, chạy /generate-bdd để điền
816
-
817
- FE còn dùng mock (fe_phase = ui — có UI + test nhưng CHƯA nối API thật):
818
- {UC}-UC1 (web) — {n} SC ở fe_phase=ui
819
- → /generate-code {feature-file} --phase=integration (hoặc để trống --phase cho fe_full)
820
- ⚠️ Các SC này có thể đang hiện OK: có code, có test — nhưng test chạy trên mock.
821
- Đừng coi là xong tính năng.
822
-
823
- Orphaned (scenario đã bị xoá khỏi .feature nhưng code còn):
824
- {UC}-UC2-SC7 (web) — "{sc_title}"
825
- Code : {ControllerClass}.{method}
826
- Test : {TestClass} (2 tests)
827
- Không tự hết — chọn MỘT:
828
- (a) code không còn cần → xoá method + test, rồi xoá row khỏi .tsv
829
- (b) SC bị xoá do nhầm → đưa scenario trở lại .feature → row về DRIFT/OK bình thường
830
-
831
- Trace orphan (tag trỏ vào SC không tồn tại, KHÔNG có row .tsv nào):
832
- {file}:{line} — @trace.implements={UC}-UC1-SC9 nhưng .feature chỉ có tới SC5
833
- → Sửa sc_id cho đúng SC hiện có, HOẶC xoá code/test nếu không còn cần
834
- (Không lệnh nào khác bắt được cái này — row .tsv đã bị xoá bởi version cũ,
835
- hoặc tag ghi sai id ngay từ đầu.)
836
-
837
- PRD Version Drift (changelog CÓ nêu UC này — nội dung đổi thật):
838
- {UC}-UC2 — code ở PRD v1.0, PRD giờ ở v1.2 [lệch: tsv, code]
839
- Thay đổi kể từ v1.0:
840
- v1.1: {changelog entry}
841
- v1.2: {changelog entry}
842
- → /generate-bdd {prd-file} then /generate-code {UC-ID}
843
-
844
- {khối ⓘ dưới CHỈ in khi prd_stale_ref_count > 0}
845
- ⓘ PRD_STALE_REF — {n} UC mang con trỏ PRD cũ nhưng changelog KHÔNG nêu chúng:
846
- {UC}-UC1, {UC}-UC3, {UC}-UC4 — PRD v1.4 → v2.0 vì "thêm UC7", không đụng các UC này
847
- Nội dung KHÔNG đổi → không cần sinh lại code. Chỉ là nhãn version cũ.
848
- → /validate-traces --realign-prd-version {UC-ID} (chỉ sửa dòng @trace.*, KHÔNG đụng logic)
849
- ⚠️ Đây KHÔNG phải lỗi. Nó tồn tại vì version PRD là MỘT số cho cả tài liệu nhiều UC —
850
- thêm một UC làm mọi UC cũ lệch số. Trước khi có bộ lọc này, cả {n} UC đều ăn cờ đỏ oan,
851
- và làm theo hướng dẫn cũng không tắt được (generate-code skip row đang OK).
852
-
853
- Tech-Doc Revision Drift (changelog CÓ nêu UC này):
854
- {UC}-UC3 — code sinh từ tech-doc revision 2, giờ ở revision 4
855
- → /generate-code {UC-ID} --force
856
-
857
- {khối ⓘ dưới CHỈ in khi techdoc_stale_ref_count > 0}
858
- ⓘ TECHDOC_STALE_REF — {n} UC mang revision tech-doc cũ nhưng changelog KHÔNG nêu chúng:
859
- {UC}-UC5, {UC}-UC6 — revision 2 → 4 vì UC8 được APPEND vào doc gộp
860
- → /validate-traces --realign-techdoc-revision {UC-ID}
861
-
862
- Seam & Stub Audit (mồ côi khi ghép luồng):
863
- 🔴 SEAM_UNWIRED — {port}: {consumer_uc} còn gọi {stub_class} rỗng,
864
- hàng thật {real_class} ({owner_uc}) chưa được nối → luồng ghép chạy vào no-op
865
- → Trỏ binding {consumer_uc} sang {real_class}, xoá/thay stub, build lại
866
- ⓘ SEAM_PENDING — {port}: {consumer_uc} đang dùng stub, owner {owner_uc} chưa gen (chưa phải lỗi)
867
- 🔴 STUB_UNRESOLVED — {ClassName#method} ({stub_for}): {consumer_uc} để trắng, owner {owner_uc} đã gen
868
- {parallel_impl → "đẻ hàm song song " + parallel_impl | ""}→ hàm trắng mồ côi / hàm thật không ai gọi
869
- → /generate-code {owner_uc} lấp logic vào {ClassName#method} tại chỗ, xoá hàm song song, build lại
870
- ⓘ STUB_PENDING — {ClassName#method} ({stub_for}): owner {owner_uc} chưa gen (chưa phải lỗi)
871
-
872
- {khối dưới CHỈ in khi Step 7b tìm thấy ≥1 request Status: Open — else bỏ cả khối}
873
- 📥 Yêu cầu đổi PRD đang chờ ({n} — chưa ai xử lý):
874
- {UC-ID} — "{title}" chờ {days_waiting} ngày
875
- {UC-ID} — "{title}" chờ {days_waiting} ngày
876
- Đây KHÔNG phải coverage gap: nó là requirement chưa có AC nào phủ, nên KHÔNG cờ
877
- trace nào bắt được — theo mọi thước đo coverage thì nó không tồn tại. Chỉ hết khi
878
- PO đưa vào PRD.
879
- → PO đọc request, đặt Status: accepted, rồi /extend-prd {prd-file}
880
- (nó tự nhặt request, chốt AC/BR, đánh số nối tiếp, bump version + changelog,
881
- và đóng dấu incorporated + archived/ — không phải làm tay bước nào).
882
-
883
- Recommendations:
884
- - /generate-code {UC-ID} cho scenario DRIFT và UNTRACKED
885
- - /dev-gen-test {UC-ID} cho GAP (thiếu test)
886
- - /generate-bdd {prd-file} cho PRD_DRIFT 🟠 (changelog CÓ nêu UC này)
887
- - /validate-traces --realign-prd-version {UC-ID} cho PRD_STALE_REF ⓘ
888
- - /validate-traces --realign-techdoc-revision {UC-ID} cho TECHDOC_STALE_REF ⓘ
889
- ↳ Hai cái này chỉ sửa dòng @trace.*, KHÔNG đụng logic. Đừng /generate-code cho
890
- chúng — version bump không đụng UC này, sinh lại code là rủi ro không đáng.
891
- - /generate-code {feature-file} cho BDD_DRIFT (code sinh từ .feature cũ hơn)
892
- - /generate-code {feature-file} cho DESIGNSPEC_DRIFT · /generate-bdd cho DESIGNSPEC_STALE_VS_BDD
893
- - /generate-tech-docs + /review-tech-docs cho tech-doc lỗi thời so với BDD
894
- - Nối binding thủ công cho mỗi SEAM_UNWIRED 🔴 (hàng thật đã có, còn kẹt stub)
895
- - /generate-code {owner_uc} cho mỗi STUB_UNRESOLVED 🔴 (lấp method trắng tại chỗ + xoá hàm song song)
896
- - Quyết định thủ công cho mỗi ORPHANED / TRACE_ORPHAN 🔴 — xoá code+test, hoặc đưa
897
- scenario trở lại .feature, hoặc sửa sc_id của tag.
898
- KHÔNG có lệnh tự xử: cần người xác nhận behavior còn cần hay không.
899
-
900
- ⚠️ CỔNG TẠO PR = 4 cờ 🔴 đều = 0 (SEAM_UNWIRED · STUB_UNRESOLVED · ORPHANED · TRACE_ORPHAN).
901
- Đây là cổng "code đang HỎNG" — luồng ghép chạy vào hàm rỗng, hoặc code trỏ vào
902
- scenario đã bị xoá. Bốn cái này build xanh và test xanh vẫn không phát hiện được.
903
-
904
- Cổng này KHÔNG bao gồm DRIFT · BDD_DRIFT · PRD_DRIFT · TECHDOC_DRIFT — đó là
905
- "code CHƯA theo kịp spec", một loại nợ khác: nó không làm hỏng luồng đang chạy.
906
- {dòng dưới CHỈ in khi (drift_count + bdd_drift_count + prd_drift + techdoc_drift) > 0}
907
- Hiện có {n} scenario/UC đang ở trạng thái đó — không chặn PR, nhưng xử trước khi
908
- coi tính năng là xong. "Hết cờ 🔴" ≠ "sạch".
909
-
910
- 📜 Lịch sử → {paths.trace_dir}/trace-history.jsonl (+1 dòng — {n} lần chạy đã ghi)
911
- Đây là DỮ LIỆU, không phải mirror: regenerate lại không được, mất là mất vĩnh viễn.
912
- PHẢI commit cùng TSV.
913
-
914
- [Chỉ umbrella mode]
915
- Living Docs canonical → {living_docs_dir}/ (specs module — shared, gitignored)
916
- Panel mirror → {panel_mirror}/trace-report.json (.trace-mirror/, gitignored)
917
- Tip: chạy /validate-traces (hoặc /sync) sau mỗi phiên codegen để làm mới panel.
918
- ✅ Commit : {paths.trace_dir}/ (*.tsv + trace-history.jsonl — authoritative)
919
- 🚫 Gitignore : .living-docs/ và .trace-mirror/ (sinh ra, dựng lại được)
920
- ```