@educa-corp/sdd-framework 0.5.0 → 0.6.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 (115) hide show
  1. package/bin/build.js +113 -19
  2. package/bin/gate-trace.js +464 -0
  3. package/bin/index.js +418 -146
  4. package/bin/lint-trace.js +602 -0
  5. package/bin/self-check.js +376 -1
  6. package/bin/trace-schema.json +252 -2
  7. package/commands/debug.md +123 -511
  8. package/commands/debug.tmpl +3 -0
  9. package/commands/define-product.md +86 -510
  10. package/commands/dev-gen-test.md +86 -510
  11. package/commands/dev-run-test.md +86 -510
  12. package/commands/dev-smoke-test.md +86 -510
  13. package/commands/extend-prd.md +89 -510
  14. package/commands/extend-prd.tmpl +3 -0
  15. package/commands/fix-bug.md +118 -509
  16. package/commands/generate-architecture.md +94 -515
  17. package/commands/generate-architecture.tmpl +3 -0
  18. package/commands/generate-bdd.md +85 -509
  19. package/commands/generate-code.md +86 -510
  20. package/commands/generate-design-spec.md +86 -510
  21. package/commands/generate-prd.md +89 -510
  22. package/commands/generate-prd.tmpl +3 -0
  23. package/commands/generate-spec-manifest.md +86 -510
  24. package/commands/generate-tech-docs.md +86 -510
  25. package/commands/learn.md +172 -496
  26. package/commands/learn.tmpl +70 -3
  27. package/commands/map-testids.md +86 -510
  28. package/commands/propose-scenario.md +86 -510
  29. package/commands/qc-analyze.md +86 -510
  30. package/commands/qc-design-test.md +86 -510
  31. package/commands/qc-plan.md +86 -510
  32. package/commands/qc-report.md +86 -510
  33. package/commands/qc-review.md +86 -510
  34. package/commands/qc-run-test.md +86 -510
  35. package/commands/refine-prd.md +99 -520
  36. package/commands/refine-prd.tmpl +3 -0
  37. package/commands/report-bug.md +86 -510
  38. package/commands/review-code.md +123 -511
  39. package/commands/review-code.tmpl +3 -0
  40. package/commands/review-context.md +93 -514
  41. package/commands/review-context.tmpl +3 -0
  42. package/commands/review-tech-docs.md +90 -511
  43. package/commands/review-tech-docs.tmpl +3 -0
  44. package/commands/setup-ai-first.md +166 -138
  45. package/commands/setup-ai-first.tmpl +72 -0
  46. package/commands/sync.md +50 -106
  47. package/commands/sync.tmpl +48 -3
  48. package/commands/update-framework.md +16 -103
  49. package/commands/update-framework.tmpl +14 -0
  50. package/commands/validate-traces.md +153 -511
  51. package/commands/validate-traces.tmpl +67 -1
  52. package/core/FRAMEWORK_VERSION +1 -1
  53. package/core/README.md +20 -0
  54. package/core/commands/debug.md +123 -511
  55. package/core/commands/define-product.md +86 -510
  56. package/core/commands/dev-gen-test.md +86 -510
  57. package/core/commands/dev-run-test.md +86 -510
  58. package/core/commands/dev-smoke-test.md +86 -510
  59. package/core/commands/extend-prd.md +89 -510
  60. package/core/commands/fix-bug.md +118 -509
  61. package/core/commands/generate-architecture.md +94 -515
  62. package/core/commands/generate-bdd.md +85 -509
  63. package/core/commands/generate-code.md +86 -510
  64. package/core/commands/generate-design-spec.md +86 -510
  65. package/core/commands/generate-prd.md +89 -510
  66. package/core/commands/generate-spec-manifest.md +86 -510
  67. package/core/commands/generate-tech-docs.md +86 -510
  68. package/core/commands/learn.md +172 -496
  69. package/core/commands/map-testids.md +86 -510
  70. package/core/commands/propose-scenario.md +86 -510
  71. package/core/commands/qc-analyze.md +86 -510
  72. package/core/commands/qc-design-test.md +86 -510
  73. package/core/commands/qc-plan.md +86 -510
  74. package/core/commands/qc-report.md +86 -510
  75. package/core/commands/qc-review.md +86 -510
  76. package/core/commands/qc-run-test.md +86 -510
  77. package/core/commands/refine-prd.md +99 -520
  78. package/core/commands/report-bug.md +86 -510
  79. package/core/commands/review-code.md +123 -511
  80. package/core/commands/review-context.md +93 -514
  81. package/core/commands/review-tech-docs.md +90 -511
  82. package/core/commands/setup-ai-first.md +166 -138
  83. package/core/commands/sync.md +50 -106
  84. package/core/commands/update-framework.md +16 -103
  85. package/core/commands/validate-traces.md +153 -511
  86. package/core/hooks/data-guard.js +174 -83
  87. package/core/hooks/settings.json +2 -1
  88. package/core/rules/workflow.md +30 -4
  89. package/core/steps/capture-lesson.md +34 -1
  90. package/core/steps/context-loader.md +24 -3
  91. package/core/steps/gate.md +92 -35
  92. package/core/steps/report-footer.md +23 -0
  93. package/core/templates/README.md +24 -1
  94. package/core/templates/ci/trace-gate.yml +146 -0
  95. package/core/templates/hooks/pre-push +61 -0
  96. package/docs/02-concepts/architecture.md +25 -6
  97. package/docs/02-concepts/traceability.md +57 -0
  98. package/docs/03-guides/architect.md +63 -0
  99. package/docs/04-reference/commands.md +1 -1
  100. package/docs/04-reference/model-selection.md +32 -19
  101. package/docs/explain/21-validate-traces.md +2 -1
  102. package/docs/explain/27-learn.md +5 -3
  103. package/hooks/data-guard.js +174 -83
  104. package/hooks/settings.json +2 -1
  105. package/package.json +5 -2
  106. package/rules/workflow.md +30 -4
  107. package/steps/capture-lesson.md +34 -1
  108. package/steps/context-loader.md +24 -3
  109. package/steps/gate.md +92 -35
  110. package/steps/report-footer.md +23 -0
  111. package/templates/README.md +24 -1
  112. package/templates/ci/trace-gate.yml +146 -0
  113. package/templates/hooks/pre-push +61 -0
  114. package/scripts/init.sh +0 -49
  115. package/scripts/upgrade.sh +0 -94
@@ -22,35 +22,31 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
22
22
  - Đi thẳng tới phần logic riêng của lệnh.
23
23
  3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
24
24
 
25
- ## Bước 0-B — Kiểm tra Model
25
+ ## Bước 0-B — Ghi nhận Model *(KHÔNG chặn)*
26
26
 
27
- *Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
27
+ *Bỏ qua nếu `_agent_mode: true` (sub-agent — orchestrator đã ghi nhận rồi).*
28
28
 
29
- Các lệnh sinh nội dung review phức tạp đòi hỏi khả năng suy luận mạnh.
30
- Dùng model nhỏ hơn sẽ rủi ro: bỏ sót edge case, phân tích spec thiếu sót, vi phạm kiến trúc.
29
+ Ghi lại **model bạn agent đang chạy lệnh này thực sự đang dùng**, rồi mang nó vào
30
+ dòng `Model:` của report cuối (xem `report-footer`). Nếu bạn biết mình **không** phải một
31
+ model Opus, gắn thêm cảnh báo ngay ở dòng đó.
31
32
 
32
- Hiển thị chờ phản hồi:
33
+ **KHÔNG hỏi người dùng. KHÔNG chờ. KHÔNG dừng.**
33
34
 
34
- ```
35
- ⚙️ MODEL CHECK
36
- ──────────────────────────────────────────────────────────────────
37
- Recommended : model Opus mới nhất
38
- Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
39
- suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
40
-
41
- Cách đổi trong Claude Code:
42
- /model chọn model Opus
43
- • hoặc: Settings → Model
44
-
45
- Đang chạy một model Opus?
46
- Y — đúng → tiếp tục
47
- S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
48
- ──────────────────────────────────────────────────────────────────
49
- ```
35
+ > **Vì sao bước này từng là prompt chặn, và vì sao bỏ (GAPS-v3 G41):** bản cũ hiện khối
36
+ > `⚙️ MODEL CHECK` rồi chờ `Y/S/N`. Ba vấn đề cùng chỉ một hướng:
37
+ > **(1)** nó hỏi người dùng thứ mà **agent đã biết chính xác**;
38
+ > **(2)** câu trả lời **không kiểm chứng được** — gõ `Y` xong vẫn đang chạy Haiku thì không
39
+ > phát hiện;
40
+ > **(3)** **cả `Y` lẫn `S` đều đi tiếp** cách duy nhất để nó dừng là tự nguyện gõ `N`.
41
+ > Tức nó **không chặn được ai**, mà tốn một lần chặn ở **mọi** lệnh. Một feature đi hết
42
+ > pipeline dùng 20 lệnh; 30/32 lệnh chạy gate. Hai mươi lần bấm cho một tín hiệu tự-khai
43
+ > không kiểm chứng được — và chính cái giá đó làm mòn CHECKPOINT ở Bước 3, cổng có giá trị thật.
44
+ >
45
+ > Khai báo trong report **mạnh hơn** hỏi: đúng nguồn (agent, không phải người), và nằm
46
+ > **cạnh kết quả** để cân nhắc, thay vì nằm trước khi có kết quả để bấm cho xong.
50
47
 
51
- - "Y" tiếp tục sang Bước 1.
52
- - "S" tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
53
- - "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang một model Opus (`/model`) rồi chạy lại lệnh này."
48
+ **Vẫn khuyến nghị Opus:** phân tích spec, review kiến trúc và sinh code đòi hỏi suy luận sâu;
49
+ model nhỏ hơn dễ bỏ sót edge case vi phạm kiến trúc. Đổi: `/model` chọn Opus.
54
50
 
55
51
  ## Bước 1 — Xác định Target File
56
52
 
@@ -80,23 +76,84 @@ Lưu toàn bộ context đã nạp vào bộ nhớ để dùng xuyên suốt phi
80
76
 
81
77
  ## Bước 3 — CHECKPOINT
82
78
 
83
- Sau khi hoàn thành Bước 1 và 2, hiển thị bản tóm tắt và chờ xác nhận:
79
+ *Bỏ qua nếu `_agent_mode: true`.*
80
+
81
+ ### 3a — Lệnh này có phải chặn không?
82
+
83
+ | Mức | Lệnh nào | `--yes` bỏ qua được? |
84
+ |---|---|:---:|
85
+ | **Không chặn** | Lệnh read-only: `/review-code` · `/validate-traces` · `/debug` · `/review-context` · `/review-tech-docs` | — (vốn không có) |
86
+ | **Chặn thường** | Mọi lệnh sinh/sửa artifact | ✅ |
87
+ | **Chặn CỨNG** | Ghi đè file đã tồn tại · `--resume` áp findings · migrate · prune | ❌ **không bao giờ** |
88
+
89
+ `--yes` trong `$ARGUMENTS` → bỏ qua CHECKPOINT mức *chặn thường*. (Bước 1 đã tách mọi token
90
+ `--` khỏi phần resolve target, nên cờ này không ảnh hưởng việc tìm file.) Mở đường chạy
91
+ headless: `claude -p "/generate-code UC1 --yes"`.
92
+
93
+ > **KHÔNG tự suy mức từ bảng này.** Mỗi lệnh **tự khai** mức của nó ở một dòng `*Checkpoint: …*`
94
+ > ngay dưới `## Gate` của chính nó — đọc dòng đó, đừng suy diễn. Bảng trên chỉ giải thích ba mức
95
+ > **nghĩa là gì**.
96
+ > Nguồn máy đọc: `bin/trace-schema.json` → `gate.checkpoint_levels`; `self-check` **R11** fail
97
+ > build nếu nhãn trong file lệnh lệch với schema, hoặc nếu một lệnh `hard`/`none` thiếu nhãn.
98
+ > *(Lệnh không có dòng nào = mức **chặn thường**, mặc định.)*
99
+
100
+ > **Mức *không chặn* là thực thi đúng miễn trừ mà `rules/workflow.md` đã cấp từ trước** —
101
+ > trước G41 file đó viết *"read-only commands may skip CHECKPOINT"* còn gate thì luôn đòi.
102
+ > Hai file cùng được nạp vào mọi lệnh mà nói ngược nhau; agent theo cái nào là tuỳ lúc.
103
+
104
+ ### 3b — In gì
105
+
106
+ **KHÔNG lặp lại những gì `[CTX LOADED]` vừa in.** Recap của context-loader (Bước 7) đã hiện
107
+ Stack · Platform · Layers · CLAUDE.md · Dict · Entities · Lessons · Service · Status ngay phía
108
+ trên. CHECKPOINT chỉ thêm **một** thông tin mới là `Target`.
109
+
110
+ **Mọi thứ sạch** — recap báo `Status: FULL`, không cờ nào bật → in đúng hai dòng:
84
111
 
85
112
  ```
86
- CHECKPOINT
87
- -----------
88
- Target : {resolved file path}
89
- Project : {project.name từ project-context.yaml}
90
- Tech stack : {language} / {framework}
91
- Module : {module nếu có, else "not configured"}
92
- Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
113
+ CHECKPOINT — Target: {resolved file path}
114
+ Tiếp tục? (Y/N)
115
+ ```
93
116
 
117
+ **Có bất thường** → thêm một dòng cho **mỗi** trạng thái, nặng nhất lên đầu:
118
+
119
+ ```
120
+ CHECKPOINT
121
+ 🔴 Service : unresolved — {lý do context-loader đã ghi}
122
+ ⚠️ CLAUDE.md: service overlay THIẾU — dùng root (code sinh ra có thể sai stack)
123
+ ⚠️ Target : resolve bằng wildcard — {n} file khớp, chọn {file}
124
+ ⚠️ Module : not configured — code sinh ra sẽ dùng default
125
+ Status : PARTIAL — thiếu: {danh sách}
126
+ Target : {resolved file path}
94
127
  Tiếp tục? (Y/N)
95
128
  ```
96
129
 
97
- Chờ người dùng trả lời ràng "Y" hoặc "N" rồi mới tiếp tục.
98
- - "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
99
- - "N" dừng lại hỏi người dùng muốn thay đổi gì.
130
+ ### 3c Cờ nào bật, cờ nào KHÔNG
131
+
132
+ Mỗi dòng ⚠️/🔴 phải ứng với một trạng thái **context-loader đã tính rồi** — không phát minh
133
+ điều kiện mới, chỉ mang thứ đang bị giấu lên chỗ người dùng phải quyết định:
134
+
135
+ | Bật cờ khi | Nguồn | Mức |
136
+ |---|---|:---:|
137
+ | `active_service = unresolved` | context-loader Bước 2b/2c/Fallback | 🔴 |
138
+ | `Status = MINIMAL` | recap Bước 7 | 🔴 |
139
+ | `Status = PARTIAL` | recap Bước 7 | ⚠️ |
140
+ | CLAUDE.md thiếu, hoặc service overlay thiếu | context-loader Bước 3 | ⚠️ |
141
+ | Target resolve qua wildcard, hoặc nhiều file khớp mà lệnh tự chọn | Bước 1 ở trên | ⚠️ |
142
+ | `module` không cấu hình | recap Bước 7 | ⚠️ |
143
+
144
+ **KHÔNG bật cờ cho:** `Lessons: chưa có` · `Dict: missing` · `Entities: missing`. Đó là
145
+ *"dự án chưa điền"*, không phải *"có gì đó sai"* — chúng ở lại trong recap.
146
+
147
+ > **Nguyên tắc một câu:** cờ dành cho thứ **framework không chắc chắn hoặc đã phải đoán**,
148
+ > không dành cho thứ **người dùng chưa làm**. Đẩy hết mọi thứ lên thì CHECKPOINT lại đầy như
149
+ > cũ, và ta quay về đúng chỗ xuất phát: một cổng luôn giống nhau thì bị lướt qua.
150
+
151
+ ### 3d — Chờ trả lời
152
+
153
+ - "Y" → tiếp tục sang các bước riêng của lệnh.
154
+ - "N" → dừng, hỏi người dùng muốn thay đổi gì.
155
+ - Có `--yes` và mức *chặn thường* → coi như "Y", **nhưng vẫn IN khối CHECKPOINT** nếu có cờ
156
+ 🔴/⚠️ (không chặn ≠ không báo — người đọc log sau này vẫn cần thấy).
100
157
 
101
158
 
102
159
  *Lưu ý: Với lệnh này — **bỏ qua Gate Step 1, 2, và 3** (chưa có file input và chưa có project context). Chỉ chạy Step 0-B (model check). Project root là **thư mục làm việc hiện tại**. Đi thẳng tới Precondition Check bên dưới.*
@@ -207,6 +264,34 @@ specs/{domain}/{prd-slug}/
207
264
  | **2 — Umbrella** | Chỉ `.trace/` + `.agent/review/` (ở umbrella root) | Mọi thứ khác — **toàn bộ spec sống trong spec submodule (`spec_source`)** dưới `specs/{domain}/{prd-slug}/`; service submodule chỉ chứa **code + `.trace/`** |
208
265
  | **3 — PO Spec repo** | `specs/product-definition/`, `specs/domain-knowledge/`, **`feedback/`**, `.agent/review/` (folder `specs/{domain}/{prd-slug}/` theo feature tạo on demand) | `.trace/` (theo service, sống cạnh code trong mỗi service submodule) |
209
266
 
267
+ ### Step 1b — Luật merge cho sổ trace *(mọi project_type có tạo `.trace/`)*
268
+
269
+ Ngay khi tạo `.trace/`, tạo luôn `.trace/.gitattributes`:
270
+
271
+ ```gitattributes
272
+ # Sổ trace — dữ liệu KHÔNG regenerate được. Hai luật, hai lý do khác nhau:
273
+ #
274
+ # merge=union — giữ row của CẢ HAI nhánh thay vì bắt người chọn một bên. Trùng sc_id sau
275
+ # union là ca ĐÚNG VÀ ĐƯỢC MONG ĐỢI: `--lint-trace` T4 bắt nó, rồi /validate-traces
276
+ # reconcile về một row. Mất row thì KHÔNG có gì bắt được. Đánh đổi có chủ ý — đừng "dọn".
277
+ # (union là driver built-in của git: không ai cần chạy git config gì thêm.)
278
+ #
279
+ # text eol=lf — BẮT BUỘC đi kèm union. Thiếu nó: một máy ghi CRLF → git thấy MỌI dòng đã
280
+ # đổi → union giữ cả hai bản → NHÂN ĐÔI CẢ FILE, gồm cả dòng header.
281
+ #
282
+ # KHÔNG thêm *.json — trace-report.json nằm cùng thư mục và union trên JSON tạo ra JSON
283
+ # không hợp lệ. Nó sinh lại được: conflict thì chạy lại /validate-traces.
284
+ *.tsv text eol=lf merge=union
285
+ *.jsonl text eol=lf merge=union
286
+ ```
287
+
288
+ **Vì sao làm ở đây, ngay lúc tạo thư mục:** sổ trace phải commit và được nhiều người ghi trên
289
+ nhiều nhánh song song. Không có luật này, lần merge song song đầu tiên sẽ conflict — và giải
290
+ conflict bằng "take mine" là **mất row của người kia, im lặng**. Đây là ca **chắc chắn xảy ra**
291
+ với team ≥3 người và không cần ai làm sai gì cả.
292
+
293
+ *Project đã cài từ trước → `/sync` Step 4c kiểm và tạo hộ.*
294
+
210
295
  ## Step 2 — Tạo CLAUDE.md
211
296
 
212
297
  *Bỏ qua hoàn toàn step này nếu `project_type = 2` (Umbrella) — umbrella không có một tech stack đơn.*
@@ -375,6 +460,50 @@ Hoặc: VS Code → `Ctrl+Shift+P` → **"Extensions: Install from Marketplace"*
375
460
  - 📋 **Review Board** — UI trực quan để review findings từ `/refine-prd`, `/review-context`, `/review-tech-docs`
376
461
  - 📊 **Living Documentation** — dashboard traceability dựa trên `.trace/*.tsv`
377
462
 
463
+ ## Step 6b — Cổng chặn bằng máy (Khuyến nghị mạnh)
464
+
465
+ *Skip nếu `project_type = 3` (PO Spec repo) — không có code thì không có PR cần chặn.*
466
+
467
+ Framework phát hiện được một lớp lỗi mà **build xanh + test từng-UC xanh KHÔNG thấy**: luồng
468
+ ghép chạy vào hàm rỗng (`SEAM_UNWIRED`, `STUB_UNRESOLVED`), hoặc code trỏ vào scenario đã bị
469
+ xoá (`ORPHANED`, `TRACE_ORPHAN`). Nhưng nếu việc phát hiện đó phụ thuộc vào **có người tự
470
+ nguyện chạy `/validate-traces` rồi đọc report bằng mắt**, thì sau sprint thứ ba không ai làm.
471
+
472
+ Hai file mẫu đã có sẵn. Hỏi user muốn cài cái nào:
473
+
474
+ ```
475
+ Cài cổng chặn bằng máy? (khuyến nghị cả hai)
476
+ 1. pre-push hook — chặn push khi sổ trace hỏng cấu trúc. Rẻ, 2 giây, offline được.
477
+ Bắt được marker conflict git trước khi nó vào nhánh chung.
478
+ 2. CI workflow — chặn PR khi có cờ 🔴. Cần GitHub Actions.
479
+ 3. Cả hai (khuyến nghị)
480
+ 4. Bỏ qua, cài sau
481
+ ```
482
+
483
+ **Chọn 1 hoặc 3** — copy hook rồi cấp quyền chạy:
484
+ ```bash
485
+ cp .agent/templates/hooks/pre-push .git/hooks/pre-push && chmod +x .git/hooks/pre-push
486
+ ```
487
+ *Nếu `trace_dir` của project không phải `.trace` (vd `../.trace` hay `{spec_source}/.trace`) →
488
+ mở file vừa copy và sửa biến `TRACE_DIR` ở đầu file cho khớp.*
489
+
490
+ **Chọn 2 hoặc 3** — copy workflow:
491
+ ```bash
492
+ mkdir -p .github/workflows && cp .agent/templates/ci/trace-gate.yml .github/workflows/
493
+ ```
494
+ *Rồi mở nó ra: sửa `src/**` ở job `require-fresh-audit` cho khớp layout project, và bỏ comment
495
+ `submodules: recursive` nếu spec/trace nằm trong submodule.*
496
+
497
+ > **Phải COPY RA khỏi `.agent/`** — `.agent/` bị ghi đè mỗi lần `/update-framework`, và
498
+ > `.git/hooks/` thì git không chạy từ chỗ khác. Copy ra rồi thì chúng là file của project.
499
+
500
+ Kiểm ngay sau khi cài (chưa có sổ trace thì cả hai thoát sạch, không phải lỗi):
501
+ ```bash
502
+ npx @educa-corp/sdd-framework --lint-trace
503
+ ```
504
+
505
+ Chi tiết + giới hạn của cổng → `docs/03-guides/architect.md` §Cắm vào CI.
506
+
378
507
  ## Step 7 — Verify
379
508
 
380
509
  Checklist tuỳ theo `project_type`:
@@ -410,109 +539,8 @@ Checklist tuỳ theo `project_type`:
410
539
 
411
540
  ## Output
412
541
 
413
- # Report Footer Định dạng output chuẩn cho mọi lệnh
414
-
415
- Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
416
-
417
- ## Status Badge
418
-
419
- Chọn một theo kết quả:
420
- - `✅ Complete` — mọi bước thành công, không có vấn đề
421
- - `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
422
- - `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
423
-
424
- ## Output Artifacts
425
-
426
- Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
427
- ```
428
- Output Artifacts:
429
- {created|updated} {file-path} ({mô tả ngắn})
430
- {created|updated} {file-path} ({mô tả ngắn})
431
- ```
432
-
433
- Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
434
-
435
- ## Pipeline Position
436
-
437
- In một sơ đồ pipeline một dòng, đánh dấu phase của lệnh HIỆN TẠI bằng `◀ bạn ở đây`,
438
- để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
439
-
440
- ```
441
- Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
442
- ```
443
-
444
- Tìm lệnh hiện tại trong bảng phase dưới đây và đánh dấu **phase của nó** trong sơ đồ trên:
445
-
446
- | Phase | Commands |
447
- |-------|----------|
448
- | Discovery | `/define-product` |
449
- | PRD | `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` (PRD) |
450
- | Design Spec | `/generate-design-spec` |
451
- | BDD | `/generate-bdd` · `/review-context` (BDD) |
452
- | Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
453
- | Code | `/generate-code` · `/review-code` |
454
- | Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
455
- | QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
456
- | Trace Audit | `/validate-traces` |
457
-
458
- Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
459
- `Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
460
-
461
- **Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
462
- `/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
463
- **bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
464
-
465
- ## Gợi ý lệnh tiếp theo
466
-
467
- Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
468
-
469
- | Lệnh hiện tại | Gợi ý lệnh tiếp theo |
470
- |-------------------------|-----------------------------------------------|
471
- | /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
472
- | /define-product | `/generate-prd {product-definition-file}` |
473
- | /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
474
- | /extend-prd | `/refine-prd {prd-file}` (soi phần vừa thêm) rồi `/review-context {prd-file}` → PO duyệt → `/generate-bdd` **chỉ cho UC MỚI**; UC cũ dùng `/validate-traces --realign-prd-version {UC-ID}` |
475
- | /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
476
- | /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
477
- | /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
478
- | /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
479
- | /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
480
- | /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
481
- | /qc-plan | `/qc-design-test {UC-ID}` |
482
- | /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
483
- | /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
484
- | /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
485
- | /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
486
- | /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
487
- | /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
488
- | /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
489
- | /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
490
- | /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
491
- | /dev-gen-test | `/dev-run-test {UC-ID}` |
492
- | /dev-run-test (passing) | `/review-code {UC-ID}` |
493
- | /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
494
- | /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
495
- | /dev-smoke-test | Tạo PR và link tới ticket |
496
- | /validate-traces | **Cờ 🔴 trước (chặn PR):** SEAM_UNWIRED → nối binding sang class thật, xoá/thay stub · STUB_UNRESOLVED → `/generate-code {owner_uc}` (lấp logic tại chỗ + xoá hàm song song) · ORPHANED/TRACE_ORPHAN → quyết định thủ công (xoá code+test, đưa scenario trở lại `.feature`, hoặc sửa `sc_id` của tag). **Rồi:** DRIFT/UNTRACKED → `/generate-code {UC-ID}` · BDD_DRIFT → `/generate-code {feature-file}` · tech-doc lỗi thời vs BDD → `/generate-tech-docs` → `/review-tech-docs` · PRD drift → `/generate-bdd {prd-file}` · GAP → `/dev-gen-test {UC-ID}`. **Chỉ tạo PR khi mọi cờ 🔴 = 0** |
497
- | /fix-bug | `/dev-run-test {UC-ID}` (dev_selftest vừa reset về not_run) → tạo PR; nếu fix một `{BUG-ID}` → QC chạy `/qc-run-test {UC-ID}` để verify + đóng bug |
498
- | /debug | `/fix-bug {ticket-id}` nếu cần sửa |
499
- | /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
500
- | /propose-scenario | **Case A** (thiếu scenario cho AC có sẵn) → báo PO/Dev review trong `feedback/bdd-proposals/`; `/generate-bdd` tự chèn khi `Status: accepted`. **Case B** (requirement mới) → `feedback/prd-change-requests/` — PO phải đưa vào PRD trước, KHÔNG tự vào BDD được; `/validate-traces` nhắc lại kèm số ngày chờ chừng nào `Status: Open` |
501
- | /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
502
- | /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
503
- | /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
504
-
505
- Định dạng footer như sau:
506
- ```
507
- ---
508
- Status : {badge}
509
- {khối Output Artifacts}
510
- Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
511
- (lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
512
- Next : {lệnh gợi ý kèm ví dụ tham số}
513
- ```
514
- *(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
515
-
542
+ **Đọc `.agent/steps/report-footer.md`** áp đúng khuôn footer trong đó (Status Badge ·
543
+ Output Artifacts · Next) cho report cuối, kèm khối bên dưới.
516
544
 
517
545
  ```
518
546
  /setup-ai-first Hoàn tất ✅
@@ -259,9 +259,13 @@ Với mỗi entry trong danh sách đó:
259
259
 
260
260
  ---
261
261
 
262
- ## Step 4 — Check `.gitignore`
262
+ ## Step 4 — Check luật git cho sổ trace
263
263
 
264
- *Bước này kiểm **hai chiều ngược nhau**, nhầm chiều là mất dữ liệu — đọc bảng trước:*
264
+ *Step 4a/4b kiểm **có được commit hay không** (hai chiều ngược nhau nhầm chiều là mất dữ liệu).
265
+ Step 4c kiểm **merge thế nào khi hai người cùng ghi**. Cả hai đều là đường mất sổ, và 4c không
266
+ cần ai làm sai gì cả — chỉ cần hai người làm việc cùng lúc.*
267
+
268
+ *Đọc bảng trước:*
265
269
 
266
270
  | Đường dẫn | Vai trò | Kỳ vọng |
267
271
  |---|---|---|
@@ -293,6 +297,45 @@ Phân giải `{paths.trace_dir}`; nếu nó nằm trong một git repo, chạy `
293
297
  ```
294
298
  > **Vì sao cần báo động này:** trước v0.4.3, mirror và sổ gốc **cùng tên `.trace`**. Khi dev mở thẳng spec repo làm workspace thì hai path bằng nhau — và Step 4 (bản cũ) gợi ý gitignore theo **tên**, không theo vai trò. Làm theo là mất sổ gốc, **im lặng**: máy vẫn chạy, dashboard vẫn có số; chỉ người thứ hai clone về mới phát hiện. Bản v0.4.3 đổi tên mirror thành `.trace-mirror` để cái bẫy biến mất, nhưng **dự án đã dính từ trước thì vẫn dính** — 4b là để tìm ra chúng.
295
299
 
300
+ **4c. Luật merge cho sổ trace.**
301
+
302
+ Sổ trace **phải commit** (4b) và **được nhiều người ghi trên nhiều nhánh song song**. Git cần biết
303
+ merge nó thế nào — mặc định thì không biết, và mặc định là đường mất row.
304
+
305
+ Kiểm `{paths.trace_dir}/.gitattributes` có tồn tại và có đủ hai dòng dưới. **Thiếu → tạo/bổ sung
306
+ ngay** (đây là hành động ghi duy nhất của Step 4; nó chỉ thêm file luật, không đụng dữ liệu):
307
+
308
+ ```gitattributes
309
+ # Sổ trace — dữ liệu KHÔNG regenerate được. Hai luật, hai lý do khác nhau:
310
+ #
311
+ # merge=union — giữ row của CẢ HAI nhánh thay vì bắt người chọn một bên. Trùng sc_id sau
312
+ # union là ca ĐÚNG VÀ ĐƯỢC MONG ĐỢI: `--lint-trace` T4 bắt nó, rồi /validate-traces
313
+ # reconcile về một row. Mất row thì KHÔNG có gì bắt được. Đánh đổi có chủ ý — đừng "dọn".
314
+ # (union là driver built-in của git: không ai cần chạy git config gì thêm.)
315
+ #
316
+ # text eol=lf — BẮT BUỘC đi kèm union, không phải cho đẹp. Thiếu nó: một máy ghi CRLF →
317
+ # git thấy MỌI dòng đã đổi → union giữ cả hai bản → NHÂN ĐÔI CẢ FILE, gồm cả dòng header.
318
+ # Team mixed Windows/macOS gặp ca này mà không ai làm gì sai.
319
+ *.tsv text eol=lf merge=union
320
+ *.jsonl text eol=lf merge=union
321
+ ```
322
+
323
+ > **Vì sao đặt `.gitattributes` BÊN TRONG `{paths.trace_dir}` thay vì gốc repo:** `trace_dir` là
324
+ > đường dẫn **cấu hình được** (`.trace/`, `../.trace`, `{spec_source}/.trace/`), nên một luật ở gốc
325
+ > repo phải nhắc lại đúng đường dẫn đó và sẽ lệch ngay khi ai đổi config. Đặt trong thư mục thì
326
+ > pattern là `*.tsv` thuần — không phụ thuộc `trace_dir` tên gì, nằm ở đâu, và **đi theo sổ** khi
327
+ > spec repo được mount vào một umbrella khác. Git đọc `.gitattributes` ở mọi cấp thư mục.
328
+
329
+ > **KHÔNG thêm `*.json`.** `trace-report.json` có thể nằm cùng thư mục và union trên JSON tạo ra
330
+ > **JSON không hợp lệ** — panel VS Code parse lỗi. Nó là file **sinh lại được**: conflict ở đó thì
331
+ > chạy lại `/validate-traces`, đừng merge tay.
332
+
333
+ In vào report:
334
+ ```
335
+ ✅ {paths.trace_dir}/.gitattributes (merge=union + eol=lf)
336
+ (hoặc: ✅ vừa tạo — sổ trace giờ merge được khi hai người cùng ghi)
337
+ ```
338
+
296
339
  ---
297
340
 
298
341
  ## Step 5 — Refresh Living Docs *(chỉ umbrella mode)*
@@ -333,109 +376,8 @@ Nếu `spec-manifest.yaml` tồn tại HOẶC `setup.spec_source` được cấu
333
376
 
334
377
  ## Output
335
378
 
336
- # Report Footer Định dạng output chuẩn cho mọi lệnh
337
-
338
- Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
339
-
340
- ## Status Badge
341
-
342
- Chọn một theo kết quả:
343
- - `✅ Complete` — mọi bước thành công, không có vấn đề
344
- - `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
345
- - `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
346
-
347
- ## Output Artifacts
348
-
349
- Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
350
- ```
351
- Output Artifacts:
352
- {created|updated} {file-path} ({mô tả ngắn})
353
- {created|updated} {file-path} ({mô tả ngắn})
354
- ```
355
-
356
- Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
357
-
358
- ## Pipeline Position
359
-
360
- In một sơ đồ pipeline một dòng, đánh dấu phase của lệnh HIỆN TẠI bằng `◀ bạn ở đây`,
361
- để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
362
-
363
- ```
364
- Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
365
- ```
366
-
367
- Tìm lệnh hiện tại trong bảng phase dưới đây và đánh dấu **phase của nó** trong sơ đồ trên:
368
-
369
- | Phase | Commands |
370
- |-------|----------|
371
- | Discovery | `/define-product` |
372
- | PRD | `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` (PRD) |
373
- | Design Spec | `/generate-design-spec` |
374
- | BDD | `/generate-bdd` · `/review-context` (BDD) |
375
- | Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
376
- | Code | `/generate-code` · `/review-code` |
377
- | Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
378
- | QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
379
- | Trace Audit | `/validate-traces` |
380
-
381
- Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
382
- `Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
383
-
384
- **Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
385
- `/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
386
- **bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
387
-
388
- ## Gợi ý lệnh tiếp theo
389
-
390
- Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
391
-
392
- | Lệnh hiện tại | Gợi ý lệnh tiếp theo |
393
- |-------------------------|-----------------------------------------------|
394
- | /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
395
- | /define-product | `/generate-prd {product-definition-file}` |
396
- | /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
397
- | /extend-prd | `/refine-prd {prd-file}` (soi phần vừa thêm) rồi `/review-context {prd-file}` → PO duyệt → `/generate-bdd` **chỉ cho UC MỚI**; UC cũ dùng `/validate-traces --realign-prd-version {UC-ID}` |
398
- | /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
399
- | /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
400
- | /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
401
- | /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
402
- | /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
403
- | /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
404
- | /qc-plan | `/qc-design-test {UC-ID}` |
405
- | /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
406
- | /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
407
- | /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
408
- | /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
409
- | /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
410
- | /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
411
- | /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
412
- | /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
413
- | /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
414
- | /dev-gen-test | `/dev-run-test {UC-ID}` |
415
- | /dev-run-test (passing) | `/review-code {UC-ID}` |
416
- | /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
417
- | /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
418
- | /dev-smoke-test | Tạo PR và link tới ticket |
419
- | /validate-traces | **Cờ 🔴 trước (chặn PR):** SEAM_UNWIRED → nối binding sang class thật, xoá/thay stub · STUB_UNRESOLVED → `/generate-code {owner_uc}` (lấp logic tại chỗ + xoá hàm song song) · ORPHANED/TRACE_ORPHAN → quyết định thủ công (xoá code+test, đưa scenario trở lại `.feature`, hoặc sửa `sc_id` của tag). **Rồi:** DRIFT/UNTRACKED → `/generate-code {UC-ID}` · BDD_DRIFT → `/generate-code {feature-file}` · tech-doc lỗi thời vs BDD → `/generate-tech-docs` → `/review-tech-docs` · PRD drift → `/generate-bdd {prd-file}` · GAP → `/dev-gen-test {UC-ID}`. **Chỉ tạo PR khi mọi cờ 🔴 = 0** |
420
- | /fix-bug | `/dev-run-test {UC-ID}` (dev_selftest vừa reset về not_run) → tạo PR; nếu fix một `{BUG-ID}` → QC chạy `/qc-run-test {UC-ID}` để verify + đóng bug |
421
- | /debug | `/fix-bug {ticket-id}` nếu cần sửa |
422
- | /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
423
- | /propose-scenario | **Case A** (thiếu scenario cho AC có sẵn) → báo PO/Dev review trong `feedback/bdd-proposals/`; `/generate-bdd` tự chèn khi `Status: accepted`. **Case B** (requirement mới) → `feedback/prd-change-requests/` — PO phải đưa vào PRD trước, KHÔNG tự vào BDD được; `/validate-traces` nhắc lại kèm số ngày chờ chừng nào `Status: Open` |
424
- | /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
425
- | /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
426
- | /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
427
-
428
- Định dạng footer như sau:
429
- ```
430
- ---
431
- Status : {badge}
432
- {khối Output Artifacts}
433
- Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
434
- (lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
435
- Next : {lệnh gợi ý kèm ví dụ tham số}
436
- ```
437
- *(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
438
-
379
+ **Đọc `.agent/steps/report-footer.md`** áp đúng khuôn footer trong đó (Status Badge ·
380
+ Output Artifacts · Next) cho report cuối, kèm khối bên dưới.
439
381
 
440
382
  ```
441
383
  /sync — {Setup | Update}
@@ -466,11 +408,13 @@ Service Configs
466
408
  ⚠️ payment-service — .agent/project-context.yaml missing
467
409
  → create it so /dev-run-test works correctly
468
410
 
469
- .gitignore
411
+ Luật git cho sổ trace
470
412
  ✅ .trace-mirror/ + .living-docs/ gitignored (mirror — sinh lại được)
471
413
  ✅ {paths.trace_dir}/ KHÔNG bị gitignore (sổ gốc — phải commit)
414
+ ✅ {paths.trace_dir}/.gitattributes (merge=union + eol=lf — hai người ghi song song)
472
415
  (hoặc: ⚠️ Thêm .trace-mirror/ vào .gitignore)
473
416
  (hoặc: 🔴 NGUY HIỂM — sổ gốc {paths.trace_dir} đang bị gitignore, xem Step 4b)
417
+ (hoặc: ✅ vừa tạo .gitattributes — trước đó merge song song sẽ conflict và mất row)
474
418
 
475
419
  Living Docs
476
420
  ✅ {panel_mirror}/ synced — {N} TSVs across {S} services