@edupia-tutor/spec-driven-docs 0.14.0 → 0.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/index.js +12 -1
- package/commands/debug.md +436 -436
- package/commands/debug.tmpl +111 -111
- package/commands/define-product.md +350 -345
- package/commands/define-product.tmpl +69 -64
- package/commands/dev-gen-test.md +365 -365
- package/commands/dev-gen-test.tmpl +63 -63
- package/commands/dev-run-test.md +376 -376
- package/commands/dev-run-test.tmpl +74 -74
- package/commands/dev-smoke-test.md +341 -341
- package/commands/dev-smoke-test.tmpl +60 -60
- package/commands/fix-bug.md +403 -403
- package/commands/fix-bug.tmpl +78 -78
- package/commands/generate-bdd.md +513 -513
- package/commands/generate-bdd.tmpl +211 -211
- package/commands/generate-code.md +481 -483
- package/commands/generate-code.tmpl +179 -181
- package/commands/generate-design-spec.md +497 -497
- package/commands/generate-design-spec.tmpl +220 -220
- package/commands/generate-prd.md +452 -400
- package/commands/generate-prd.tmpl +50 -200
- package/commands/generate-spec-manifest.md +340 -340
- package/commands/generate-spec-manifest.tmpl +59 -59
- package/commands/generate-tech-docs.md +365 -365
- package/commands/generate-tech-docs.tmpl +84 -84
- package/commands/learn.md +347 -347
- package/commands/learn.tmpl +22 -22
- package/commands/map-testids.md +322 -322
- package/commands/map-testids.tmpl +41 -41
- package/commands/propose-scenario.md +335 -335
- package/commands/propose-scenario.tmpl +54 -54
- package/commands/qc-analyze.md +323 -324
- package/commands/qc-analyze.tmpl +42 -43
- package/commands/qc-design-test.md +304 -304
- package/commands/qc-design-test.tmpl +23 -23
- package/commands/qc-plan.md +297 -297
- package/commands/qc-plan.tmpl +16 -16
- package/commands/qc-report.md +302 -302
- package/commands/qc-report.tmpl +21 -21
- package/commands/qc-review.md +298 -298
- package/commands/qc-review.tmpl +17 -17
- package/commands/qc-run-test.md +337 -337
- package/commands/qc-run-test.tmpl +35 -35
- package/commands/refine-prd.md +428 -430
- package/commands/refine-prd.tmpl +62 -62
- package/commands/report-bug.md +351 -351
- package/commands/report-bug.tmpl +70 -70
- package/commands/review-code.md +364 -364
- package/commands/review-code.tmpl +39 -39
- package/commands/review-context.md +578 -580
- package/commands/review-context.tmpl +212 -212
- package/commands/review-tech-docs.md +427 -427
- package/commands/review-tech-docs.tmpl +146 -146
- package/commands/setup-ai-first.md +239 -239
- package/commands/setup-ai-first.tmpl +133 -133
- package/commands/sync.md +145 -145
- package/commands/sync.tmpl +93 -93
- package/commands/update-framework.md +88 -88
- package/commands/update-framework.tmpl +36 -36
- package/commands/validate-traces.md +381 -381
- package/commands/validate-traces.tmpl +100 -100
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +436 -436
- package/core/commands/define-product.md +350 -345
- package/core/commands/dev-gen-test.md +365 -365
- package/core/commands/dev-run-test.md +376 -376
- package/core/commands/dev-smoke-test.md +341 -341
- package/core/commands/fix-bug.md +403 -403
- package/core/commands/generate-bdd.md +513 -513
- package/core/commands/generate-code.md +481 -483
- package/core/commands/generate-design-spec.md +497 -497
- package/core/commands/generate-prd.md +452 -400
- package/core/commands/generate-spec-manifest.md +340 -340
- package/core/commands/generate-tech-docs.md +365 -365
- package/core/commands/learn.md +347 -347
- package/core/commands/map-testids.md +322 -322
- package/core/commands/propose-scenario.md +335 -335
- package/core/commands/qc-analyze.md +323 -324
- package/core/commands/qc-design-test.md +304 -304
- package/core/commands/qc-plan.md +297 -297
- package/core/commands/qc-report.md +302 -302
- package/core/commands/qc-review.md +298 -298
- package/core/commands/qc-run-test.md +337 -337
- package/core/commands/refine-prd.md +428 -430
- package/core/commands/report-bug.md +351 -351
- package/core/commands/review-code.md +364 -364
- package/core/commands/review-context.md +578 -580
- package/core/commands/review-tech-docs.md +427 -427
- package/core/commands/setup-ai-first.md +239 -239
- package/core/commands/sync.md +145 -145
- package/core/commands/update-framework.md +88 -88
- package/core/commands/validate-traces.md +381 -381
- package/core/skills/code/SKILL.md +389 -389
- package/core/skills/debug/SKILL.md +391 -391
- package/core/skills/design-spec/SKILL.md +318 -318
- package/core/skills/discovery/SKILL.md +7 -547
- package/core/skills/prd/SKILL.md +298 -394
- package/core/skills/setup-ai-first/SKILL.md +80 -80
- package/core/skills/spec/SKILL.md +178 -178
- package/core/skills/test/SKILL.md +604 -604
- package/core/steps/capture-lesson.md +44 -44
- package/core/steps/context-loader.md +175 -175
- package/core/steps/gate.md +54 -54
- package/core/steps/report-footer.md +52 -52
- package/core/steps/review-fanout.md +85 -87
- package/core/steps/spawn-agent.md +45 -45
- package/core/steps/trace-mirror.md +21 -21
- package/core/templates/architecture.template.md +37 -37
- package/core/templates/design-spec.template.md +77 -77
- package/core/templates/platform-guide.template.md +47 -47
- package/core/templates/prd.template.md +107 -232
- package/core/templates/product-definition.template.md +101 -88
- package/core/templates/project-context.yaml +2 -2
- package/docs/01-getting-started/core-concepts.md +1 -1
- package/docs/01-getting-started/quickstart.md +7 -7
- package/docs/02-guides/developer/bdd-and-trace.md +1 -1
- package/docs/02-guides/developer/scenarios.md +5 -5
- package/docs/02-guides/product-owner/handoff-checklist.md +1 -1
- package/docs/02-guides/product-owner/scenarios.md +23 -23
- package/docs/02-guides/tester/bug-reporting.md +2 -2
- package/docs/02-guides/tester/reading-specs.md +2 -2
- package/docs/02-guides/tester/scenarios.md +1 -1
- package/docs/02-guides/tester/spec-manifest.md +3 -3
- package/docs/02-guides/tester/workflow.md +1 -1
- package/docs/03-concepts/architecture.md +3 -3
- package/docs/03-concepts/pipeline.md +3 -3
- package/docs/04-operations/publishing.md +20 -3
- package/docs/04-operations/sync-and-update.md +5 -5
- package/docs/05-reference/command-cheatsheet.md +2 -2
- package/docs/05-reference/commands.md +8 -8
- package/package.json +1 -1
- package/scripts/migrate-specs.js +5 -3
- package/scripts/rename-prd-files.js +174 -0
- package/skills/code/SKILL.md +389 -389
- package/skills/code/SKILL.tmpl +56 -56
- package/skills/debug/SKILL.md +391 -391
- package/skills/debug/SKILL.tmpl +60 -60
- package/skills/design-spec/SKILL.md +318 -318
- package/skills/design-spec/SKILL.tmpl +37 -37
- package/skills/discovery/SKILL.md +7 -547
- package/skills/discovery/SKILL.tmpl +7 -140
- package/skills/prd/SKILL.md +298 -394
- package/skills/prd/SKILL.tmpl +40 -151
- package/skills/setup-ai-first/SKILL.md +80 -80
- package/skills/setup-ai-first/SKILL.tmpl +28 -28
- package/skills/spec/SKILL.md +178 -178
- package/skills/spec/SKILL.tmpl +20 -20
- package/skills/test/SKILL.md +604 -604
- package/skills/test/SKILL.tmpl +44 -44
- package/steps/capture-lesson.md +44 -44
- package/steps/context-loader.md +175 -175
- package/steps/gate.md +54 -54
- package/steps/report-footer.md +52 -52
- package/steps/review-fanout.md +85 -87
- package/steps/spawn-agent.md +45 -45
- package/steps/trace-mirror.md +21 -21
- package/templates/architecture.template.md +37 -37
- package/templates/design-spec.template.md +77 -77
- package/templates/platform-guide.template.md +47 -47
- package/templates/prd.template.md +107 -232
- package/templates/product-definition.template.md +101 -88
- package/templates/project-context.yaml +2 -2
|
@@ -1,147 +1,147 @@
|
|
|
1
1
|
# /validate-traces — Traceability Coverage Matrix
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Check read-only độ phủ giữa spec, code, và test — gồm cả PRD version drift.
|
|
4
4
|
|
|
5
5
|
## Gate
|
|
6
|
-
# Gate —
|
|
6
|
+
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Mọi lệnh PHẢI chạy gate này trước khi thực thi phần logic riêng của nó.
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
13
13
|
|
|
14
|
-
1.
|
|
15
|
-
2.
|
|
16
|
-
- **
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
3.
|
|
14
|
+
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
15
|
+
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
16
|
+
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
17
|
+
- Đặt target file = `payload.target_file`
|
|
18
|
+
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
19
|
+
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
20
|
+
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
21
|
+
- Đi thẳng tới phần logic riêng của lệnh.
|
|
22
|
+
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).
|
|
23
23
|
|
|
24
|
-
##
|
|
24
|
+
## Bước 0-B — Kiểm tra Model
|
|
25
25
|
|
|
26
|
-
*
|
|
26
|
+
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
28
|
+
Các lệnh sinh nội dung và review phức tạp đòi hỏi khả năng suy luận mạnh.
|
|
29
|
+
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.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
Hiển thị và chờ phản hồi:
|
|
32
32
|
|
|
33
33
|
```
|
|
34
34
|
⚙️ MODEL CHECK
|
|
35
35
|
──────────────────────────────────────────────────────────────────
|
|
36
|
-
Recommended : claude-opus-4 (
|
|
37
|
-
Why needed :
|
|
38
|
-
|
|
36
|
+
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
37
|
+
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
38
|
+
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
39
39
|
|
|
40
|
-
|
|
41
|
-
• Settings → Model →
|
|
42
|
-
•
|
|
40
|
+
Cách đổi trong Claude Code:
|
|
41
|
+
• Settings → Model → chọn "claude-opus"
|
|
42
|
+
• hoặc: /model → chọn claude-opus
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
Y —
|
|
46
|
-
S —
|
|
44
|
+
Đang chạy claude-opus?
|
|
45
|
+
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
46
|
+
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)
|
|
47
47
|
──────────────────────────────────────────────────────────────────
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
- "Y" →
|
|
51
|
-
- "S" →
|
|
52
|
-
- "N"
|
|
50
|
+
- "Y" → tiếp tục sang Bước 1.
|
|
51
|
+
- "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).
|
|
52
|
+
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang claude-opus rồi chạy lại lệnh này."
|
|
53
53
|
|
|
54
|
-
##
|
|
54
|
+
## Bước 1 — Xác định Target File
|
|
55
55
|
|
|
56
|
-
1.
|
|
57
|
-
2.
|
|
58
|
-
- **BDD
|
|
59
|
-
- **PRD
|
|
60
|
-
- **tech-docs
|
|
61
|
-
- **design-spec
|
|
56
|
+
1. Nếu `$ARGUMENTS` được cung cấp và trỏ tới một file tồn tại → dùng trực tiếp làm target.
|
|
57
|
+
2. Nếu `$ARGUMENTS` là một **UC-ID / ticket ID / tên rút gọn** (không có path) → phân giải thành file bằng cách glob theo bố cục feature-package. `{prd-slug}` lúc này **chưa biết**, nên dùng wildcard `*` cho segment đó, và `**` đệ quy dưới `bdd/` để phủ hết các thư mục con theo platform (`bdd/web/`, `bdd/app/`, `bdd/system/`):
|
|
58
|
+
- **Lệnh BDD** (target là `.feature`): `{specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` — hoặc `{specs_dir}/*/*/bdd/**/{UC-ID}*.feature` nếu domain cũng chưa biết. Nếu lệnh ngụ ý một platform/scope cụ thể (vd: system tech-doc cần BDD `system/`), ưu tiên kết quả trong thư mục con platform đó.
|
|
59
|
+
- **Lệnh PRD** (target là file PRD `{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder, cạnh `bdd/`): `{specs_dir}/{domain}/*/{TICKET-ID}*.md` nếu biết TICKET-ID; nếu không, `{specs_dir}/{domain}/*/*.md` (khớp feature folder có id tương ứng), hoặc `{specs_dir}/*/*/*.md` nếu domain cũng chưa biết. *(Glob `*/*.md` ở cấp gốc folder chỉ khớp PRD — tech-docs/design-spec `.md` nằm sâu hơn trong thư mục con.)*
|
|
60
|
+
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
61
|
+
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
62
62
|
|
|
63
|
-
|
|
64
|
-
3.
|
|
65
|
-
-
|
|
66
|
-
-
|
|
67
|
-
-
|
|
63
|
+
Khi một file khớp: đặt nó làm target **và** ghi lại `domain` + `prd_slug` từ path của nó (theo quy tắc trích xuất trong `context-loader.md` Bước 1 — `prd_slug` = segment đầu tiên sau `{specs_dir}/{domain}/`). Mọi path mà lệnh đọc/ghi về sau (BDD/tech-docs/design-spec/trace cùng cấp) đều dùng **`prd_slug` đã phân giải đó**, nên tất cả artifact nằm chung một feature package. Nếu nhiều file khớp (vd: nhiều platform), chọn theo platform/scope của lệnh hoặc liệt kê ra và hỏi.
|
|
64
|
+
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
65
|
+
- Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/*.md` — file PRD ở gốc mỗi feature folder — cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
|
|
66
|
+
- Hiển thị danh sách cho người dùng và hỏi: "Bạn muốn làm việc với file nào? (Nhập số thứ tự hoặc tên file)"
|
|
67
|
+
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
68
68
|
|
|
69
|
-
##
|
|
69
|
+
## Bước 2 — Chạy Context Loader
|
|
70
70
|
|
|
71
|
-
|
|
72
|
-
|
|
71
|
+
Nạp toàn bộ context của dự án bằng cách làm theo quy trình trong `steps/context-loader.md`.
|
|
72
|
+
Lưu toàn bộ context đã nạp vào bộ nhớ để dùng xuyên suốt phiên làm việc của lệnh.
|
|
73
73
|
|
|
74
|
-
##
|
|
74
|
+
## Bước 3 — CHECKPOINT
|
|
75
75
|
|
|
76
|
-
|
|
76
|
+
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:
|
|
77
77
|
|
|
78
78
|
```
|
|
79
79
|
CHECKPOINT
|
|
80
80
|
-----------
|
|
81
81
|
Target : {resolved file path}
|
|
82
|
-
Project : {project.name
|
|
82
|
+
Project : {project.name từ project-context.yaml}
|
|
83
83
|
Tech stack : {language} / {framework}
|
|
84
|
-
Module : {module
|
|
85
|
-
Domains : {
|
|
84
|
+
Module : {module nếu có, else "not configured"}
|
|
85
|
+
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
86
86
|
|
|
87
|
-
|
|
87
|
+
Tiếp tục? (Y/N)
|
|
88
88
|
```
|
|
89
89
|
|
|
90
|
-
|
|
91
|
-
- "Y" →
|
|
92
|
-
- "N" →
|
|
90
|
+
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
91
|
+
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
92
|
+
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
93
93
|
|
|
94
94
|
|
|
95
|
-
*
|
|
95
|
+
*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.*
|
|
96
96
|
|
|
97
97
|
## Context
|
|
98
|
-
# Context Loader —
|
|
98
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
99
99
|
|
|
100
|
-
|
|
100
|
+
Thực hiện các bước theo đúng thứ tự. Lưu mọi thứ vào bộ nhớ trong suốt phiên làm việc của lệnh.
|
|
101
101
|
|
|
102
|
-
**
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
102
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
103
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
104
|
+
- Bước 3 là CRITICAL — kiến trúc + coding standards, là các sự thật ưu tiên cao nhất khi sinh nội dung.
|
|
105
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
106
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
107
|
+
- Bước 7 là WORKING MEMORY RECAP — chốt các sự thật quan trọng lên đầu bộ nhớ làm việc.
|
|
108
108
|
|
|
109
109
|
---
|
|
110
110
|
|
|
111
|
-
##
|
|
111
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
114
114
|
|
|
115
115
|
**Tech Stack:**
|
|
116
|
-
- `tech_stack.language` →
|
|
117
|
-
- `tech_stack.framework` →
|
|
118
|
-
- `tech_stack.build_tool` → build tool (
|
|
119
|
-
- `tech_stack.test_framework` → test framework (
|
|
120
|
-
- `tech_stack.database` → database (
|
|
121
|
-
- `tech_stack.module` →
|
|
116
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
117
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
118
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
119
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
120
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
121
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
122
122
|
|
|
123
123
|
**Conventions:**
|
|
124
|
-
- `conventions.build_command` →
|
|
125
|
-
- `conventions.test_command` →
|
|
126
|
-
- `conventions.service_run` →
|
|
127
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
124
|
+
- `conventions.build_command` → cách compile/build
|
|
125
|
+
- `conventions.test_command` → cách chạy test
|
|
126
|
+
- `conventions.service_run` → cách khởi động service
|
|
127
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
128
128
|
|
|
129
129
|
**Domains:**
|
|
130
|
-
- `domains` →
|
|
131
|
-
|
|
132
|
-
**Paths (
|
|
133
|
-
- `paths.specs_dir` → spec
|
|
134
|
-
- `paths.refinement_dir` → findings/review
|
|
135
|
-
- `paths.qc_dir` → QC automation
|
|
136
|
-
- `paths.qc_skills_dir` →
|
|
137
|
-
- `paths.product_definitions_dir` → product
|
|
138
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
139
|
-
- `paths.business_dictionary` → path
|
|
140
|
-
- `paths.core_entities` → path
|
|
141
|
-
- `paths.tech_docs_dir` →
|
|
142
|
-
- `paths.trace_dir` →
|
|
143
|
-
|
|
144
|
-
|
|
130
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
131
|
+
|
|
132
|
+
**Paths (nếu có):**
|
|
133
|
+
- `paths.specs_dir` → gốc của spec artifact — PRD, BDD, tech-docs, design-spec. Cấu trúc: `{specs_dir}/{domain}/{prd-slug}/{ {TICKET-ID}-{prd-slug}.md | bdd/ | tech-docs/ | design-spec/}` (file PRD đặt tên `{TICKET-ID}-{prd-slug}.md`, là file `.md` duy nhất ở gốc feature folder)
|
|
134
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
135
|
+
- `paths.qc_dir` → gốc artifact QC automation (hiện ở top-level, mỗi UC một thư mục con: `{qc_dir}/{UC-ID}/`)
|
|
136
|
+
- `paths.qc_skills_dir` → nơi các lệnh qc-* nạp QC skill (mặc định bundled `.agent/skills/qc`; override sang repo/submodule riêng của team QC để bản nâng cấp framework không ghi đè)
|
|
137
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
138
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
139
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
140
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
141
|
+
- `paths.tech_docs_dir` → gốc tài liệu kỹ thuật (gộp với specs_dir trong bố cục feature-package — tech-docs nằm dưới `{specs_dir}/{domain}/{prd-slug}/tech-docs/`)
|
|
142
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
143
|
+
|
|
144
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
145
145
|
- `specs_dir` = `specs`
|
|
146
146
|
- `refinement_dir` = `.agent/review`
|
|
147
147
|
- `qc_dir` = `docs`
|
|
@@ -153,184 +153,184 @@ If `paths` section is absent, use these defaults:
|
|
|
153
153
|
- `tech_docs_dir` = `specs`
|
|
154
154
|
- `trace_dir` = `.trace`
|
|
155
155
|
|
|
156
|
-
|
|
156
|
+
Lưu ý: Trong bố cục feature-package, `specs_dir` là gốc thống nhất. Mọi loại spec artifact (PRD, BDD, tech-docs, design-spec) đều nằm dưới `{specs_dir}/{domain}/{prd-slug}/`. `prd-slug` là tên folder feature-package, không phải một biến config riêng.
|
|
157
157
|
|
|
158
|
-
**
|
|
159
|
-
- `specs/payment/create-invoice/
|
|
160
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
161
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
162
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
158
|
+
**Cách trích xuất `prd_slug` (đúng cho MỌI target file, bất kể độ sâu lồng nhau):** với một path target dạng `{specs_dir}/{domain}/{prd-slug}/...`, lấy **segment path đầu tiên sau `{specs_dir}/{domain}/`** — tức vị trí `{prd-slug}`. KHÔNG dùng folder cha trực tiếp của file, vì artifact BDD/tech-docs/design-spec lồng sâu hơn một hoặc hai cấp bên trong package. Ví dụ:
|
|
159
|
+
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
160
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
161
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
162
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
163
163
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
Mọi artifact cùng cấp của một feature (PRD, BDD của từng platform, tech-docs BE + FE, design-spec, và trace TSV) đều phân giải về **cùng một `prd_slug`** — nên một BDD **system** hay tech-doc **system/BE** được tổng hợp sẽ nằm chung package `{specs_dir}/{domain}/{prd-slug}/` với các artifact web/app mà nó được suy ra từ đó.
|
|
166
166
|
|
|
167
|
-
|
|
167
|
+
Nếu `tech_stack.module` được đặt, đồng thời nạp `.agent/modules/{module}/stack-profile.yaml` nếu file tồn tại.
|
|
168
168
|
|
|
169
169
|
---
|
|
170
170
|
|
|
171
|
-
##
|
|
171
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
172
172
|
|
|
173
|
-
*
|
|
173
|
+
*Bỏ qua hoàn toàn bước này nếu `setup.mode` không phải `"umbrella"` và không có section `services` trong project-context.yaml.*
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
Nếu có section `services`:
|
|
176
176
|
|
|
177
|
-
**1.
|
|
178
|
-
-
|
|
179
|
-
-
|
|
180
|
-
*(
|
|
181
|
-
-
|
|
177
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
178
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
179
|
+
- Trích xuất từ path target file: `domain` = segment đầu tiên sau base path `specs_dir`; `prd_slug` = segment kế tiếp (folder feature-package). Điều này đúng ở mọi độ sâu target — xem quy tắc trích xuất `prd_slug` ở Bước 1.
|
|
180
|
+
*(vd: `specs/user/create-account/USR01-create-account.md` **và** `specs/user/create-account/bdd/system/UC1.feature` đều → domain = `user`, prd_slug = `create-account`)*
|
|
181
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
182
182
|
|
|
183
|
-
**2. Route
|
|
184
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
185
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
186
|
-
-
|
|
187
|
-
-
|
|
188
|
-
-
|
|
183
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
184
|
+
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **chỉ khi `setup.spec_source` KHÔNG được đặt.** Khi `spec_source` ĐƯỢC đặt, MỌI BDD (web/app/**system**) là artifact dùng chung liên team → để bước 4 route sang spec repo; KHÔNG pin theo service ở đây.
|
|
185
|
+
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **chỉ khi `setup.spec_source` KHÔNG được đặt.** Khi `spec_source` ĐƯỢC đặt, tech-design (API contract) là artifact liên team và phải nằm trong spec repo dùng chung (xử lý ở bước 4), nên để bước 4 route `tech_docs_dir` — KHÔNG pin theo service ở đây.
|
|
186
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
187
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
188
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
189
189
|
|
|
190
|
-
**3. Fallback** —
|
|
191
|
-
-
|
|
192
|
-
-
|
|
190
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
191
|
+
- Giữ path mặc định từ Bước 1
|
|
192
|
+
- Đặt `active_service = unresolved`
|
|
193
193
|
|
|
194
|
-
**4.
|
|
195
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
196
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
194
|
+
**4. Tự động override theo spec source** — nếu `setup.spec_source` được đặt VÀ path tương ứng chưa được set tường minh trong `paths:`:
|
|
195
|
+
- Override `paths.specs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt.** Mọi spec artifact (PRD, BDD, tech-docs, design-spec) nằm dưới gốc spec thống nhất trong spec repo dùng chung theo bố cục feature-package: `{spec_source}/specs/{domain}/{prd-slug}/`. Mọi umbrella (FE/App/BE) đều đọc từ đây. *(`specs/` theo service chỉ khi không có `spec_source`.)*
|
|
196
|
+
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **luôn khi `spec_source` được đặt** (bước 2 không còn pin tech-docs theo service trong trường hợp này). Tech-docs nằm tại `{spec_source}/specs/{domain}/{prd-slug}/tech-docs/`. Tech-design CHÍNH LÀ API contract liên team: BE viết ở đây, FE/App đọc nó từ cùng spec submodule tại `/generate-code --phase=integration`. *(tech-docs theo service chỉ xảy ra khi không có `spec_source` — repo BE thuần đa-service không có spec module dùng chung.)*
|
|
197
197
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
198
198
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
199
199
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
200
200
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
201
201
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
202
202
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
203
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
203
|
+
- Override `paths.trace_dir` → `{spec_source}/.trace` — **luôn khi `spec_source` được đặt.** Trace TSV được gộp vào spec repo (một nơi authoritative duy nhất, không tách theo service) để PM/PO có một chỗ duy nhất quản lý trạng thái. Cấu trúc bên trong: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`. Các lệnh phía code (`/generate-code`, `/dev-run-test`, `/qc-run-test`) chạy từ `service_root` nhưng **ghi trace row của chúng vào `{spec_source}/.trace/{domain}/{prd-slug}/`** — giống như chúng đã push `feedback/` vào đó. *(`.trace` theo service chỉ khi không có `spec_source`.)*
|
|
204
204
|
|
|
205
|
-
> **
|
|
205
|
+
> **Vì sao đặt dưới `spec_source`:** PRD, BDD, tech-docs, design-spec, domain knowledge, feedback của tester, **và trạng thái coverage `.trace/`** đều là **artifact liên team** — chúng nằm trong **spec repo dùng chung** theo bố cục feature-package để mọi umbrella (FE/App/BE) và PM đọc từ một nguồn qua `/sync`. Trong bố cục feature-package, một folder `specs/{domain}/{prd-slug}/` gom tất cả loại artifact của một PRD, giúp spec repo tự đủ và dễ điều hướng theo feature. Service submodule chỉ chứa **code** (+ tooling build/test). `.trace/` và `feedback/` là khu vực **ghi** của dev/QC trong spec repo. Ở chế độ single-service (không có `spec_source`), mọi thứ mặc định dưới gốc repo — vẫn là một repo.
|
|
206
206
|
|
|
207
207
|
---
|
|
208
208
|
|
|
209
|
-
##
|
|
209
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
210
210
|
|
|
211
|
-
*
|
|
211
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
212
212
|
|
|
213
|
-
|
|
213
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
214
214
|
|
|
215
|
-
**1.
|
|
215
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
216
216
|
- `{active_service}/.agent/project-context.yaml`
|
|
217
217
|
- `{active_service}/project-context.yaml`
|
|
218
218
|
|
|
219
|
-
**2.
|
|
219
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
220
220
|
|
|
221
|
-
|
|
|
221
|
+
| Biến | Nguồn |
|
|
222
222
|
|----------|--------|
|
|
223
|
-
| `conventions.test_command` |
|
|
224
|
-
| `conventions.build_command` |
|
|
225
|
-
| `paths.trace_dir` | **
|
|
226
|
-
| `paths.specs_dir` | **
|
|
223
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
224
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
225
|
+
| `paths.trace_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/.trace`); bỏ qua mọi `trace_dir` cấp service.** Chỉ khi không có `spec_source`: `{active_service}/{service paths.trace_dir}` (mặc định `{active_service}/.trace`). |
|
|
226
|
+
| `paths.specs_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/specs`); bỏ qua mọi `specs_dir` cấp service** (mọi spec artifact đều liên team, không bao giờ theo service ở chế độ này). Chỉ khi không có `spec_source`: `{active_service}/{service paths.specs_dir}` nếu được set, else dùng override ở Bước 1.5. |
|
|
227
227
|
|
|
228
|
-
**3.
|
|
229
|
-
-
|
|
230
|
-
- **
|
|
228
|
+
**3. Lưu** `service_root = {active_service}` làm mốc thư mục làm việc cho mọi lệnh phía sau:
|
|
229
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
230
|
+
- **File source/test** được ghi tương đối với `service_root`; **trace TSV** được ghi vào `{paths.trace_dir}` (là spec repo khi `spec_source` được đặt — một thao tác ghi liên-repo, commit/push vào spec submodule giống như `feedback/`).
|
|
231
231
|
|
|
232
|
-
**4.
|
|
232
|
+
**4. Nếu không tìm thấy config của service** — giữ mặc định umbrella, vẫn set `service_root = {active_service}` (luôn cần mốc path kể cả khi không có config override).
|
|
233
233
|
|
|
234
234
|
---
|
|
235
235
|
|
|
236
|
-
##
|
|
236
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
237
237
|
|
|
238
|
-
|
|
239
|
-
Merge framework
|
|
240
|
-
|
|
238
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
239
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
240
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
241
241
|
|
|
242
242
|
---
|
|
243
243
|
|
|
244
|
-
##
|
|
244
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
245
245
|
|
|
246
|
-
|
|
246
|
+
*Đây là context ưu tiên cao nhất — nó định nghĩa CÁCH viết code và tài liệu cho dự án này.*
|
|
247
247
|
|
|
248
|
-
CLAUDE.md
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
248
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
249
|
+
riêng của service kết hợp đúng cách. Agent luôn đứng ở gốc umbrella, nhưng code triển khai nằm
|
|
250
|
+
trong một service submodule với stack, kiến trúc, và convention RIÊNG của nó — nên CLAUDE.md của
|
|
251
|
+
service phải thắng khi sinh code.
|
|
252
252
|
|
|
253
|
-
**
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
253
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
254
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
255
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
256
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
257
257
|
|
|
258
|
-
**
|
|
259
|
-
*
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
Overlay
|
|
263
|
-
coding standards,
|
|
264
|
-
(
|
|
258
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
259
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
260
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
261
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
262
|
+
Overlay nó lên trên Tầng 1: **khi có xung đột, giá trị của service THẮNG** cho kiến trúc,
|
|
263
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
264
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
265
265
|
|
|
266
|
-
|
|
266
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
267
267
|
|
|
268
|
-
- **§1 Project Overview** →
|
|
269
|
-
- **§2 Architecture** → layer
|
|
270
|
-
- **§3 Coding Standards** →
|
|
271
|
-
- **§5 Error Handling** → exception
|
|
272
|
-
- **§7 Git Conventions** →
|
|
268
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
269
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
270
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
271
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
272
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
273
273
|
|
|
274
|
-
**
|
|
275
|
-
-
|
|
276
|
-
-
|
|
277
|
-
-
|
|
278
|
-
-
|
|
274
|
+
**Quy tắc phân giải:**
|
|
275
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
276
|
+
- Nếu chỉ có service overlay (không có root CLAUDE.md) → dùng file service một mình; `claude_md_source = {service_root}`.
|
|
277
|
+
- Nếu `service_root` được set nhưng `{service_root}/CLAUDE.md` **thiếu** → fallback về root CLAUDE.md và gắn cờ ⚠️ trong recap Bước 7 (service không có định nghĩa kiến trúc/coding-standards — việc sinh code sẽ dùng mặc định umbrella, có thể sai stack).
|
|
278
|
+
- Nếu cả hai đều không tồn tại → ghi nhận CLAUDE.md thiếu và tiếp tục chỉ với dữ liệu từ project-context.yaml.
|
|
279
279
|
|
|
280
280
|
---
|
|
281
281
|
|
|
282
|
-
##
|
|
282
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
283
283
|
|
|
284
|
-
|
|
284
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
285
285
|
|
|
286
|
-
|
|
286
|
+
Lưu các pattern file nhạy cảm — bạn **tuyệt đối không** đọc, ghi, hiển thị, hay tham chiếu nội dung từ các file khớp những pattern đó trong suốt cả phiên.
|
|
287
287
|
|
|
288
|
-
|
|
288
|
+
Nếu cả hai file đều không tồn tại → áp dụng mặc định built-in: không bao giờ truy cập `.env*`, `*.key`, `*.pem`, `*secret*`, `*password*`, `*credential*`.
|
|
289
289
|
|
|
290
290
|
---
|
|
291
291
|
|
|
292
|
-
##
|
|
292
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
293
293
|
|
|
294
|
-
|
|
294
|
+
Kiểm tra file business dictionary có tồn tại không (dùng `paths.business_dictionary` đã phân giải ở Bước 1).
|
|
295
295
|
|
|
296
|
-
|
|
297
|
-
- **Canonical Terms** →
|
|
298
|
-
- **Banned Terms** →
|
|
299
|
-
- **Status / Enum Registry** →
|
|
296
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
297
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
298
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
299
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
300
300
|
|
|
301
|
-
|
|
302
|
-
-
|
|
303
|
-
-
|
|
301
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
302
|
+
- Khi sinh bất kỳ văn bản nào (PRD, BDD, comment code, tech docs), kiểm tra không có banned term nào xuất hiện
|
|
303
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
306
306
|
|
|
307
307
|
---
|
|
308
308
|
|
|
309
|
-
##
|
|
309
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
310
310
|
|
|
311
|
-
|
|
312
|
-
|
|
311
|
+
Kiểm tra file core entities có tồn tại tại `paths.core_entities` không (đã phân giải ở Bước 1).
|
|
312
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
313
313
|
|
|
314
|
-
|
|
315
|
-
- **Entity catalog** →
|
|
316
|
-
- **Field name registry** →
|
|
317
|
-
- **Relationship map** →
|
|
314
|
+
Nếu tồn tại, đọc và lưu:
|
|
315
|
+
- **Entity catalog** → với mỗi entity: tên, mục đích, service sở hữu, các field chính (tên + kiểu), business invariant, và quan hệ
|
|
316
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
317
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
318
318
|
|
|
319
|
-
**
|
|
320
|
-
-
|
|
321
|
-
-
|
|
322
|
-
-
|
|
319
|
+
**Cách dùng catalog này:**
|
|
320
|
+
- Khi sinh code: dùng tên field, kiểu, và quan hệ định nghĩa ở đây — KHÔNG suy đoán từ code có sẵn
|
|
321
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
322
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
323
323
|
|
|
324
|
-
|
|
324
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
325
325
|
|
|
326
326
|
---
|
|
327
327
|
|
|
328
|
-
##
|
|
328
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
329
329
|
|
|
330
|
-
|
|
330
|
+
Dùng `tech_stack.module` đã nạp ở Bước 1, suy ra và lưu hai biến để mọi lệnh phía sau dùng:
|
|
331
331
|
|
|
332
332
|
```
|
|
333
|
-
active_module = tech_stack.module (
|
|
333
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
334
334
|
```
|
|
335
335
|
|
|
336
336
|
| `platform_type` | Modules |
|
|
@@ -339,69 +339,69 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
339
339
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
340
340
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
341
341
|
|
|
342
|
-
|
|
342
|
+
Nếu `tech_stack.module` rỗng hoặc không nhận diện được → set `platform_type = "unknown"` và gắn cờ ⚠️ trong recap Bước 7.
|
|
343
343
|
|
|
344
|
-
|
|
344
|
+
Hai biến này (`active_module`, `platform_type`) là nguồn chuẩn cho mọi logic rẽ nhánh trong các lệnh cần hành vi riêng theo platform (dev-gen-test, debug, fix-bug, dev-smoke-test).
|
|
345
345
|
|
|
346
346
|
---
|
|
347
347
|
|
|
348
|
-
##
|
|
348
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
349
349
|
|
|
350
|
-
*
|
|
351
|
-
|
|
350
|
+
*Các lỗi tích luỹ mà AI không được lặp lại trong dự án này. Chúng được bổ sung dần qua `/learn`
|
|
351
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
352
352
|
|
|
353
|
-
|
|
354
|
-
-
|
|
355
|
-
- Else
|
|
356
|
-
-
|
|
353
|
+
Phân giải path file lessons:
|
|
354
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
355
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
356
|
+
- Ở chế độ umbrella/service (khi `service_root` được set), nếu `paths.lessons_file` chưa set, mặc định `{service_root}/.agent/project-lessons.md`
|
|
357
357
|
|
|
358
|
-
|
|
359
|
-
-
|
|
360
|
-
-
|
|
361
|
-
-
|
|
358
|
+
Nếu file tồn tại, đọc và lưu TẤT CẢ lesson làm **GUARDRAIL ĐANG HOẠT ĐỘNG** cho phiên:
|
|
359
|
+
- Coi **Rule** của mỗi lesson là ràng buộc cứng — cùng mức ưu tiên với coding standards trong CLAUDE.md (Bước 3).
|
|
360
|
+
- Trước khi sinh hoặc sửa bất kỳ artifact nào (PRD, BDD, tech-doc, code, test), đối chiếu output với mọi lesson có `category` khớp lệnh hiện tại VÀ `scope` khớp target (domain / file).
|
|
361
|
+
- Nếu output sinh ra vi phạm một lesson → sửa **trước khi** trình bày, và ghi rõ lesson nào (`L-NNN`) đã được áp dụng.
|
|
362
362
|
|
|
363
|
-
|
|
363
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
364
364
|
|
|
365
365
|
---
|
|
366
366
|
|
|
367
|
-
##
|
|
367
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
368
368
|
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
(recency
|
|
369
|
+
Sau khi nạp toàn bộ context, tổng hợp và xuất một khối tóm tắt gọn.
|
|
370
|
+
Recap này đảm bảo các sự thật quan trọng nhất được nêu ở CUỐI quá trình nạp context
|
|
371
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
372
372
|
|
|
373
|
-
|
|
373
|
+
Xuất đúng khối này:
|
|
374
374
|
```
|
|
375
375
|
[CTX LOADED]
|
|
376
376
|
Stack : {language} / {framework} / {database}
|
|
377
377
|
Platform : {active_module} ({platform_type})
|
|
378
|
-
Layers : {
|
|
379
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
378
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
379
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
380
380
|
Ticket : {ticket_prefix}-
|
|
381
381
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
382
382
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
383
|
-
Lessons : {loaded — N guardrails |
|
|
383
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
384
384
|
Service : {active_service} ({active_service_module}) | single-service
|
|
385
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
386
|
-
Status : {FULL | PARTIAL —
|
|
385
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
386
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
387
387
|
```
|
|
388
388
|
|
|
389
|
-
|
|
389
|
+
Nếu bất kỳ file CRITICAL nào thiếu (CLAUDE.md), gắn cờ rõ ràng để người dùng quyết định có tiếp tục hay không.
|
|
390
390
|
|
|
391
391
|
---
|
|
392
392
|
|
|
393
|
-
##
|
|
393
|
+
## Hoàn tất nạp Context
|
|
394
394
|
|
|
395
|
-
|
|
396
|
-
-
|
|
397
|
-
-
|
|
398
|
-
- Coding standards
|
|
399
|
-
-
|
|
400
|
-
-
|
|
401
|
-
- Entity catalog (field
|
|
402
|
-
-
|
|
395
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
396
|
+
- Định danh dự án, tech stack, convention module
|
|
397
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
398
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
399
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
400
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
401
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
402
|
+
- Toàn bộ path đã cấu hình
|
|
403
403
|
|
|
404
|
-
|
|
404
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
405
405
|
|
|
406
406
|
|
|
407
407
|
---
|
|
@@ -410,89 +410,89 @@ Proceed to the next step of the calling command.
|
|
|
410
410
|
|
|
411
411
|
### Step 0 — Umbrella Mode Detection
|
|
412
412
|
|
|
413
|
-
|
|
413
|
+
Kiểm tra mảng `services` có tồn tại trong `project-context.yaml` không.
|
|
414
414
|
|
|
415
|
-
**
|
|
416
|
-
-
|
|
417
|
-
- **
|
|
418
|
-
- **Else (
|
|
419
|
-
- Step 1
|
|
420
|
-
- **
|
|
421
|
-
-
|
|
422
|
-
*(
|
|
423
|
-
- Else (umbrella
|
|
424
|
-
- **
|
|
415
|
+
**Nếu `services` tồn tại (umbrella mode):**
|
|
416
|
+
- Phân giải trace dir:
|
|
417
|
+
- **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. Scenario mang service sở hữu qua field `@trace.service`, nên không cần tách theo service. Đây là trường hợp phổ biến.
|
|
418
|
+
- **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.
|
|
419
|
+
- Step 1 đọc TSV từ `all_trace_dirs`.
|
|
420
|
+
- **Phân giải Living Docs home (vị trí report sinh ra):**
|
|
421
|
+
- Nếu `setup.spec_source` được set → `living_docs_dir = {spec_source}/.living-docs`
|
|
422
|
+
*(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)*
|
|
423
|
+
- Else (umbrella không có spec repo riêng) → `living_docs_dir = .living-docs` ở umbrella root
|
|
424
|
+
- **Phân giải panel mirror:** `panel_mirror = ./.trace` ở **gốc workspace hiện tại** (nơi lệnh chạy). Panel VS Code đọc `.trace/trace-report.json` từ workspace đang mở — ghi report ở đây là cái làm view không rỗng khi dev mở một service submodule trực tiếp.
|
|
425
425
|
|
|
426
|
-
**
|
|
426
|
+
**Nếu không có key `services` (single-service mode):**
|
|
427
427
|
- Set `all_trace_dirs = [ {paths.trace_dir} ]`
|
|
428
|
-
-
|
|
428
|
+
- Không cần umbrella sync
|
|
429
429
|
|
|
430
430
|
---
|
|
431
431
|
|
|
432
|
-
### Step 1 —
|
|
432
|
+
### Step 1 — Nạp dữ liệu TSV
|
|
433
433
|
|
|
434
|
-
**Umbrella mode:**
|
|
434
|
+
**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.
|
|
435
435
|
|
|
436
|
-
**Single-service mode:**
|
|
436
|
+
**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).
|
|
437
437
|
|
|
438
|
-
|
|
438
|
+
Mỗi file cho trace state đã lưu của UC đó.
|
|
439
439
|
|
|
440
|
-
**
|
|
441
|
-
-
|
|
442
|
-
-
|
|
443
|
-
-
|
|
444
|
-
-
|
|
445
|
-
- **
|
|
440
|
+
**Nếu không tìm thấy file `.tsv` nào** trong bất kỳ trace dir nào:
|
|
441
|
+
- Quét tất cả file `{paths.specs_dir}/**/*.feature` trong domain target để dựng list in-memory mọi scenario.
|
|
442
|
+
- Coi mọi scenario là `UNTRACKED` (chưa sinh code).
|
|
443
|
+
- In: "⚠️ No trace files found. All {N} scenarios across {M} UCs are UNTRACKED."
|
|
444
|
+
- Đề xuất: "Run `/generate-bdd {prd-file}` to initialize trace state, or `/generate-code {feature-file}` to generate code."
|
|
445
|
+
- **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.
|
|
446
446
|
|
|
447
|
-
### Step 2 — Reconcile
|
|
447
|
+
### Step 2 — Reconcile với file `.feature` hiện tại
|
|
448
448
|
|
|
449
|
-
|
|
450
|
-
|
|
449
|
+
Với mỗi row `.tsv`, đọc file `.feature` tương ứng và lấy `@trace.sc_version` **hiện tại** cho SC đó.
|
|
450
|
+
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).
|
|
451
451
|
|
|
452
|
-
|
|
452
|
+
Cũng phát hiện SC có trong `.feature` nhưng thiếu trong `.tsv` → thêm row mới với `status: UNTRACKED`.
|
|
453
453
|
|
|
454
|
-
### Step 3 —
|
|
454
|
+
### Step 3 — Tính `status` theo từng scenario
|
|
455
455
|
|
|
456
|
-
|
|
456
|
+
Áp dụng quy tắc theo thứ tự ưu tiên:
|
|
457
457
|
|
|
458
|
-
| Rule | Status |
|
|
458
|
+
| Rule | Status | Điều kiện |
|
|
459
459
|
|------|--------|-----------|
|
|
460
|
-
| 1 | `UNTRACKED` | `implemented_by == —` (
|
|
460
|
+
| 1 | `UNTRACKED` | `implemented_by == —` (chưa sinh code) |
|
|
461
461
|
| 2 | `GAP` | `implemented_by != —` AND (`test_count == —` OR `test_count == 0`) |
|
|
462
|
-
| 3 | `DRIFT` | `spec_ver != gen_ver` (scenario
|
|
463
|
-
| 4 | `OK` |
|
|
462
|
+
| 3 | `DRIFT` | `spec_ver != gen_ver` (scenario cập nhật từ lần codegen trước) |
|
|
463
|
+
| 4 | `OK` | tất cả: `spec_ver == gen_ver`, `implemented_by != —`, `test_count > 0` |
|
|
464
464
|
|
|
465
465
|
### Step 4 — PRD version drift check
|
|
466
466
|
|
|
467
|
-
|
|
468
|
-
-
|
|
469
|
-
- `prd_version`
|
|
470
|
-
- `@trace.prd_version`
|
|
467
|
+
Với mỗi UC, so:
|
|
468
|
+
- PRD `| **Version** |` hiện tại từ `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md`
|
|
469
|
+
- `prd_version` lưu trong `.tsv` (version tại thời điểm sinh BDD)
|
|
470
|
+
- `@trace.prd_version` trong các file code implement UC đó
|
|
471
471
|
|
|
472
|
-
|
|
472
|
+
Nếu layer nào sau version PRD hiện tại → gắn cờ `PRD_DRIFT` và trích các changelog entry kể từ version đó.
|
|
473
473
|
|
|
474
474
|
### Step 5 — Tech-doc revision drift check
|
|
475
475
|
|
|
476
|
-
|
|
476
|
+
Với mỗi UC có tech-doc, so revision đã lưu vs doc hiện tại — cho **cả hai** loại tech-doc:
|
|
477
477
|
|
|
478
|
-
- **BE contract:** `@trace.revision`
|
|
479
|
-
Code
|
|
480
|
-
- **FE tech-design:** `@trace.revision`
|
|
481
|
-
FE
|
|
478
|
+
- **BE contract:** `@trace.revision` trong `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` vs `tech_doc_revision` trong `.tsv`.
|
|
479
|
+
Code sinh từ revision cũ hơn → gắn cờ `TECHDOC_DRIFT`.
|
|
480
|
+
- **FE tech-design:** `@trace.revision` trong `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md` vs `fe_tech_doc_revision` trong `.tsv` (theo từng row platform).
|
|
481
|
+
Code FE sinh từ revision cũ hơn → gắn cờ `FE_TECHDOC_DRIFT`.
|
|
482
482
|
|
|
483
|
-
Skip
|
|
483
|
+
Skip loại nào không có doc / không có revision đã lưu (`—`).
|
|
484
484
|
|
|
485
|
-
### Step 6 —
|
|
485
|
+
### Step 6 — Ghi status lại vào TSV
|
|
486
486
|
|
|
487
|
-
*
|
|
487
|
+
*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).*
|
|
488
488
|
|
|
489
|
-
|
|
490
|
-
|
|
489
|
+
Với mỗi file `.tsv` đã xử lý: ghi `spec_ver`, `status`, `last_updated` đã cập nhật lại disk.
|
|
490
|
+
**Đừ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.
|
|
491
491
|
|
|
492
|
-
### Step 7 —
|
|
492
|
+
### Step 7 — Tính aggregate cho dashboard
|
|
493
493
|
|
|
494
494
|
```
|
|
495
|
-
total_prds = count distinct PRD files in {paths.specs_dir}/{domain}
|
|
495
|
+
total_prds = count distinct PRD files in {paths.specs_dir}/{domain}/*/*.md (file .md ở gốc mỗi feature folder = PRD)
|
|
496
496
|
approved_prds = PRDs with | Status | approved
|
|
497
497
|
total_ucs = count distinct UC-IDs across all .tsv files
|
|
498
498
|
approved_ucs = UCs with uc_status == approved
|
|
@@ -516,13 +516,13 @@ qc_not_run = rows where qc_status in (not_run, —)
|
|
|
516
516
|
# shown alongside — never merged with — dev_selftest.
|
|
517
517
|
waiting_dev = rows where qc_owner == dev # PM view: QC-found, waiting on dev to fix
|
|
518
518
|
waiting_po = rows where qc_owner == po # PM view: blocked, waiting on PO to confirm/clarify
|
|
519
|
-
# qc_owner + qc_blocked_by
|
|
519
|
+
# qc_owner + qc_blocked_by trả lời "case nào đang chờ ai" — surface as a "Waiting on" column.
|
|
520
520
|
tech_docs_count = count .md files in {paths.tech_docs_dir}/{domain}/*/tech-docs/
|
|
521
521
|
```
|
|
522
522
|
|
|
523
|
-
### Step 8 —
|
|
523
|
+
### Step 8 — Ghi JSON report
|
|
524
524
|
|
|
525
|
-
|
|
525
|
+
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.
|
|
526
526
|
|
|
527
527
|
Schema:
|
|
528
528
|
|
|
@@ -652,80 +652,80 @@ Schema:
|
|
|
652
652
|
```
|
|
653
653
|
|
|
654
654
|
**Rules:**
|
|
655
|
-
- `implemented_by`:
|
|
656
|
-
- `test_count`:
|
|
657
|
-
- `test_classes`:
|
|
658
|
-
- `tech_doc_revision` / `fe_tech_doc_revision`:
|
|
659
|
-
- `code_coverage_pct` / `test_coverage_pct`:
|
|
660
|
-
-
|
|
661
|
-
- **TSV `"—"` mapping**:
|
|
662
|
-
- **Backward-compat:**
|
|
663
|
-
|
|
664
|
-
### Step 8b — Living Docs Sync *(umbrella mode
|
|
665
|
-
|
|
666
|
-
*
|
|
667
|
-
|
|
668
|
-
**
|
|
669
|
-
`{spec_source}/.trace/` (committed
|
|
670
|
-
|
|
671
|
-
(re)
|
|
672
|
-
|
|
673
|
-
1. **
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
2. **Mirror
|
|
679
|
-
|
|
680
|
-
`{living_docs_dir}/trace-report.json` (+
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
3. **
|
|
655
|
+
- `implemented_by`: dùng `null` (không phải `"—"`) trong JSON khi không có giá trị
|
|
656
|
+
- `test_count`: dùng integer `0` (không phải `"—"`) khi không có test
|
|
657
|
+
- `test_classes`: dùng `[]` (không phải `"—"`) khi không có test class
|
|
658
|
+
- `tech_doc_revision` / `fe_tech_doc_revision`: dùng integer; `0` nếu chưa sinh
|
|
659
|
+
- `code_coverage_pct` / `test_coverage_pct`: làm tròn về integer gần nhất (0–100)
|
|
660
|
+
- 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`
|
|
661
|
+
- **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`
|
|
662
|
+
- **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): `qc_owner`/`qc_blocked_by` (pre-19-col) → `null`; `fe_tech_doc_revision` (pre-22-col) → `0`. Lần `/generate-bdd` gen lại tiếp theo nâng header lên layout 22 cột hiện tại.
|
|
663
|
+
|
|
664
|
+
### Step 8b — Living Docs Sync *(chỉ umbrella mode)*
|
|
665
|
+
|
|
666
|
+
*Bỏ qua step này ở single-service mode.*
|
|
667
|
+
|
|
668
|
+
**Với `spec_source` được set,** các trace TSV authoritative đã sống ở **một** chỗ —
|
|
669
|
+
`{spec_source}/.trace/` (committed trong spec repo). **Không có merge theo service**:
|
|
670
|
+
mỗi scenario row mang service sở hữu qua `@trace.service`. Step này chỉ
|
|
671
|
+
(re)generate report và làm mới panel local.
|
|
672
|
+
|
|
673
|
+
1. **Ghi report** vào `{living_docs_dir}/trace-report.json` (`mkdir -p` trước) — dựng
|
|
674
|
+
trực tiếp từ `{spec_source}/.trace/*.tsv`, với field `"service"` mỗi scenario row và
|
|
675
|
+
các summary aggregate. *(Umbrella legacy không-`spec_source` vẫn merge mọi `trace-report.json`
|
|
676
|
+
theo service thành một document, namespace theo service.)*
|
|
677
|
+
|
|
678
|
+
2. **Mirror tới panel location** `{panel_mirror}` (`./.trace` ở gốc workspace hiện tại)
|
|
679
|
+
để dev mở *repo này* thấy data ngay: copy
|
|
680
|
+
`{living_docs_dir}/trace-report.json` (+ các file `{UC-ID}.tsv`) → `{panel_mirror}/`.
|
|
681
|
+
Nếu `panel_mirror` đã phân giải về `{spec_source}/.trace`, skip.
|
|
682
|
+
|
|
683
|
+
3. **In sync summary:**
|
|
684
684
|
```
|
|
685
685
|
Living Docs → {living_docs_dir}/trace-report.json ({total} scenarios across {S} services)
|
|
686
686
|
Trace (authoritative) → {spec_source}/.trace/ (committed in spec repo)
|
|
687
687
|
Panel mirror → {panel_mirror}/trace-report.json (current workspace)
|
|
688
688
|
```
|
|
689
689
|
|
|
690
|
-
> **
|
|
691
|
-
> spec repo —
|
|
692
|
-
> (`./.trace`
|
|
693
|
-
>
|
|
690
|
+
> **Lưu ý:** trace state committed, authoritative là `{spec_source}/.trace/*.tsv` (trong
|
|
691
|
+
> spec repo — một chỗ cho PM). Report (`.living-docs/`) và panel mirror
|
|
692
|
+
> (`./.trace` ở workspace không phải spec repo) là **sinh ra** — gitignore chúng;
|
|
693
|
+
> chúng được regenerate bởi `/validate-traces` hoặc `/sync`.
|
|
694
694
|
|
|
695
695
|
## Output
|
|
696
696
|
|
|
697
|
-
# Report Footer —
|
|
697
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
698
698
|
|
|
699
|
-
|
|
699
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
700
700
|
|
|
701
701
|
## Status Badge
|
|
702
702
|
|
|
703
|
-
|
|
704
|
-
- `✅ Complete` —
|
|
705
|
-
- `❌ Failed` —
|
|
706
|
-
- `⚠️ Warnings` —
|
|
703
|
+
Chọn một theo kết quả:
|
|
704
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
705
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
706
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
707
707
|
|
|
708
708
|
## Output Artifacts
|
|
709
709
|
|
|
710
|
-
|
|
710
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
711
711
|
```
|
|
712
712
|
Output Artifacts:
|
|
713
|
-
{created|updated} {file-path} ({
|
|
714
|
-
{created|updated} {file-path} ({
|
|
713
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
714
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
715
715
|
```
|
|
716
716
|
|
|
717
|
-
|
|
717
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
718
718
|
|
|
719
719
|
## Pipeline Position
|
|
720
720
|
|
|
721
|
-
|
|
722
|
-
|
|
721
|
+
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`,
|
|
722
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
723
723
|
|
|
724
724
|
```
|
|
725
725
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
726
726
|
```
|
|
727
727
|
|
|
728
|
-
|
|
728
|
+
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:
|
|
729
729
|
|
|
730
730
|
| Phase | Commands |
|
|
731
731
|
|-------|----------|
|
|
@@ -739,61 +739,61 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
739
739
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
740
740
|
| Trace Audit | `/validate-traces` |
|
|
741
741
|
|
|
742
|
-
|
|
742
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
743
743
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
744
744
|
|
|
745
|
-
**
|
|
746
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
747
|
-
**
|
|
745
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
746
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
747
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
748
748
|
|
|
749
|
-
##
|
|
749
|
+
## Gợi ý lệnh tiếp theo
|
|
750
750
|
|
|
751
|
-
|
|
751
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
752
752
|
|
|
753
|
-
|
|
|
753
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
754
754
|
|-------------------------|-----------------------------------------------|
|
|
755
|
-
| /setup-ai-first | `/define-product`
|
|
755
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
756
756
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
757
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
758
|
-
| /refine-prd |
|
|
759
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
760
|
-
| /generate-design-spec | Designer review →
|
|
761
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
762
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
763
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
757
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
758
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
759
|
+
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (rồi BDD sau khi sign-off); BE: `/generate-bdd {prd-file}` trực tiếp; sửa PRD nếu NEEDS_FIX |
|
|
760
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
761
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
762
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
763
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
764
764
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
765
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
766
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
767
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
768
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
769
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
765
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
766
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
767
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
768
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
769
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
770
770
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
771
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
772
|
-
| /generate-code |
|
|
771
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
772
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
773
773
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
774
774
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
775
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
776
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
777
|
-
| /dev-smoke-test |
|
|
778
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
779
|
-
| /fix-bug |
|
|
780
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
781
|
-
| /report-bug |
|
|
782
|
-
| /propose-scenario |
|
|
783
|
-
| /learn |
|
|
784
|
-
| /sync | `/validate-traces`
|
|
785
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
786
|
-
|
|
787
|
-
|
|
775
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
776
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
777
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
778
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
779
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
780
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
781
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
782
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
783
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
784
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
785
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
786
|
+
|
|
787
|
+
Định dạng footer như sau:
|
|
788
788
|
```
|
|
789
789
|
---
|
|
790
790
|
Status : {badge}
|
|
791
|
-
{Output Artifacts
|
|
791
|
+
{khối Output Artifacts}
|
|
792
792
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
793
|
-
(review
|
|
794
|
-
Next : {
|
|
793
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
794
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
795
795
|
```
|
|
796
|
-
*(
|
|
796
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
797
797
|
|
|
798
798
|
|
|
799
799
|
```
|
|
@@ -815,28 +815,28 @@ Next : {suggested command with example arguments}
|
|
|
815
815
|
| {UC}-UC2 | SC1 | {title...} | v1.0 | v1.0 | ✅ {Controller.fn} | — | GAP |
|
|
816
816
|
|
|
817
817
|
Drift Detail:
|
|
818
|
-
{UC}-UC1-SC2 — spec v1.1
|
|
819
|
-
→
|
|
818
|
+
{UC}-UC1-SC2 — spec v1.1 nhưng code sinh từ v1.0
|
|
819
|
+
→ Chạy lại: /generate-code {UC-ID}
|
|
820
820
|
|
|
821
821
|
PRD Version Drift:
|
|
822
|
-
{UC}-UC2 — code
|
|
823
|
-
|
|
822
|
+
{UC}-UC2 — code ở PRD v1.0, PRD giờ ở v1.2
|
|
823
|
+
Thay đổi kể từ v1.0:
|
|
824
824
|
v1.1: {changelog entry}
|
|
825
825
|
v1.2: {changelog entry}
|
|
826
826
|
→ /generate-bdd {prd-file} then /generate-code {UC-ID}
|
|
827
827
|
|
|
828
828
|
Tech-Doc Revision Drift:
|
|
829
|
-
{UC}-UC3 — code
|
|
830
|
-
→ Review tech-doc
|
|
829
|
+
{UC}-UC3 — code sinh từ tech-doc revision 2, giờ ở revision 4
|
|
830
|
+
→ Review thay đổi tech-doc rồi /generate-code {UC-ID}
|
|
831
831
|
|
|
832
832
|
Recommendations:
|
|
833
|
-
- /generate-code {UC-ID}
|
|
834
|
-
- /dev-gen-test {UC-ID}
|
|
835
|
-
- /generate-bdd {prd-file}
|
|
833
|
+
- /generate-code {UC-ID} cho scenario DRIFT và UNTRACKED
|
|
834
|
+
- /dev-gen-test {UC-ID} cho GAP (thiếu test)
|
|
835
|
+
- /generate-bdd {prd-file} cho PRD version drift
|
|
836
836
|
|
|
837
|
-
[
|
|
837
|
+
[Chỉ umbrella mode]
|
|
838
838
|
Living Docs canonical → {living_docs_dir}/ (specs module — shared, gitignored)
|
|
839
839
|
Panel mirror → {panel_mirror}/trace-report.json (current workspace)
|
|
840
|
-
Tip:
|
|
841
|
-
|
|
840
|
+
Tip: chạy /validate-traces (hoặc /sync) sau mỗi phiên codegen để làm mới panel.
|
|
841
|
+
Cả hai là mirror sinh ra — đừng commit (.living-docs/ + .trace/ trong .gitignore).
|
|
842
842
|
```
|