@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
package/commands/refine-prd.md
CHANGED
|
@@ -1,145 +1,145 @@
|
|
|
1
|
-
# /refine-prd —
|
|
1
|
+
# /refine-prd — Phân tích PRD qua 4 lăng kính review
|
|
2
2
|
|
|
3
3
|
## Gate
|
|
4
|
-
# Gate —
|
|
4
|
+
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
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ó.
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
11
11
|
|
|
12
|
-
1.
|
|
13
|
-
2.
|
|
14
|
-
- **
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
3.
|
|
12
|
+
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
13
|
+
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
14
|
+
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
15
|
+
- Đặt target file = `payload.target_file`
|
|
16
|
+
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
|
+
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
|
+
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
|
+
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).
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Bước 0-B — Kiểm tra Model
|
|
23
23
|
|
|
24
|
-
*
|
|
24
|
+
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
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.
|
|
27
|
+
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.
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Hiển thị và chờ phản hồi:
|
|
30
30
|
|
|
31
31
|
```
|
|
32
32
|
⚙️ MODEL CHECK
|
|
33
33
|
──────────────────────────────────────────────────────────────────
|
|
34
|
-
Recommended : claude-opus-4 (
|
|
35
|
-
Why needed :
|
|
36
|
-
|
|
34
|
+
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
35
|
+
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
36
|
+
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
37
37
|
|
|
38
|
-
|
|
39
|
-
• Settings → Model →
|
|
40
|
-
•
|
|
38
|
+
Cách đổi trong Claude Code:
|
|
39
|
+
• Settings → Model → chọn "claude-opus"
|
|
40
|
+
• hoặc: /model → chọn claude-opus
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
Y —
|
|
44
|
-
S —
|
|
42
|
+
Đang chạy claude-opus?
|
|
43
|
+
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
44
|
+
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)
|
|
45
45
|
──────────────────────────────────────────────────────────────────
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
- "Y" →
|
|
49
|
-
- "S" →
|
|
50
|
-
- "N"
|
|
48
|
+
- "Y" → tiếp tục sang Bước 1.
|
|
49
|
+
- "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).
|
|
50
|
+
- "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."
|
|
51
51
|
|
|
52
|
-
##
|
|
52
|
+
## Bước 1 — Xác định Target File
|
|
53
53
|
|
|
54
|
-
1.
|
|
55
|
-
2.
|
|
56
|
-
- **BDD
|
|
57
|
-
- **PRD
|
|
58
|
-
- **tech-docs
|
|
59
|
-
- **design-spec
|
|
54
|
+
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.
|
|
55
|
+
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/`):
|
|
56
|
+
- **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 đó.
|
|
57
|
+
- **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.)*
|
|
58
|
+
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
59
|
+
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
60
60
|
|
|
61
|
-
|
|
62
|
-
3.
|
|
63
|
-
-
|
|
64
|
-
-
|
|
65
|
-
-
|
|
61
|
+
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.
|
|
62
|
+
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
63
|
+
- 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).
|
|
64
|
+
- 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)"
|
|
65
|
+
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
66
66
|
|
|
67
|
-
##
|
|
67
|
+
## Bước 2 — Chạy Context Loader
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
69
|
+
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`.
|
|
70
|
+
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.
|
|
71
71
|
|
|
72
|
-
##
|
|
72
|
+
## Bước 3 — CHECKPOINT
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
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:
|
|
75
75
|
|
|
76
76
|
```
|
|
77
77
|
CHECKPOINT
|
|
78
78
|
-----------
|
|
79
79
|
Target : {resolved file path}
|
|
80
|
-
Project : {project.name
|
|
80
|
+
Project : {project.name từ project-context.yaml}
|
|
81
81
|
Tech stack : {language} / {framework}
|
|
82
|
-
Module : {module
|
|
83
|
-
Domains : {
|
|
82
|
+
Module : {module nếu có, else "not configured"}
|
|
83
|
+
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
Tiếp tục? (Y/N)
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
|
|
89
|
-
- "Y" →
|
|
90
|
-
- "N" →
|
|
88
|
+
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
89
|
+
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
90
|
+
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
91
91
|
|
|
92
92
|
|
|
93
|
-
*
|
|
93
|
+
*Lưu ý: Với lệnh này, target file ở Bước 1 là một file PRD (`{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder) dưới `{paths.specs_dir}/{domain}/{prd-slug}/`. Đọc toàn bộ PRD sau khi phân giải file.*
|
|
94
94
|
|
|
95
95
|
## Context
|
|
96
|
-
# Context Loader —
|
|
96
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
97
97
|
|
|
98
|
-
|
|
98
|
+
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.
|
|
99
99
|
|
|
100
|
-
**
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
100
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
101
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
102
|
+
- 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.
|
|
103
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
104
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
105
|
+
- 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.
|
|
106
106
|
|
|
107
107
|
---
|
|
108
108
|
|
|
109
|
-
##
|
|
109
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
112
112
|
|
|
113
113
|
**Tech Stack:**
|
|
114
|
-
- `tech_stack.language` →
|
|
115
|
-
- `tech_stack.framework` →
|
|
116
|
-
- `tech_stack.build_tool` → build tool (
|
|
117
|
-
- `tech_stack.test_framework` → test framework (
|
|
118
|
-
- `tech_stack.database` → database (
|
|
119
|
-
- `tech_stack.module` →
|
|
114
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
115
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
116
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
117
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
118
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
119
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
120
120
|
|
|
121
121
|
**Conventions:**
|
|
122
|
-
- `conventions.build_command` →
|
|
123
|
-
- `conventions.test_command` →
|
|
124
|
-
- `conventions.service_run` →
|
|
125
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
122
|
+
- `conventions.build_command` → cách compile/build
|
|
123
|
+
- `conventions.test_command` → cách chạy test
|
|
124
|
+
- `conventions.service_run` → cách khởi động service
|
|
125
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
126
126
|
|
|
127
127
|
**Domains:**
|
|
128
|
-
- `domains` →
|
|
129
|
-
|
|
130
|
-
**Paths (
|
|
131
|
-
- `paths.specs_dir` → spec
|
|
132
|
-
- `paths.refinement_dir` → findings/review
|
|
133
|
-
- `paths.qc_dir` → QC automation
|
|
134
|
-
- `paths.qc_skills_dir` →
|
|
135
|
-
- `paths.product_definitions_dir` → product
|
|
136
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
137
|
-
- `paths.business_dictionary` → path
|
|
138
|
-
- `paths.core_entities` → path
|
|
139
|
-
- `paths.tech_docs_dir` →
|
|
140
|
-
- `paths.trace_dir` →
|
|
141
|
-
|
|
142
|
-
|
|
128
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
129
|
+
|
|
130
|
+
**Paths (nếu có):**
|
|
131
|
+
- `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)
|
|
132
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
133
|
+
- `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}/`)
|
|
134
|
+
- `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 đè)
|
|
135
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
136
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
137
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
138
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
139
|
+
- `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/`)
|
|
140
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
141
|
+
|
|
142
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
143
143
|
- `specs_dir` = `specs`
|
|
144
144
|
- `refinement_dir` = `.agent/review`
|
|
145
145
|
- `qc_dir` = `docs`
|
|
@@ -151,184 +151,184 @@ If `paths` section is absent, use these defaults:
|
|
|
151
151
|
- `tech_docs_dir` = `specs`
|
|
152
152
|
- `trace_dir` = `.trace`
|
|
153
153
|
|
|
154
|
-
|
|
154
|
+
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.
|
|
155
155
|
|
|
156
|
-
**
|
|
157
|
-
- `specs/payment/create-invoice/
|
|
158
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
159
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
160
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
156
|
+
**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ụ:
|
|
157
|
+
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
158
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
159
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
160
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
161
161
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
162
162
|
|
|
163
|
-
|
|
163
|
+
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ừ đó.
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
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.
|
|
166
166
|
|
|
167
167
|
---
|
|
168
168
|
|
|
169
|
-
##
|
|
169
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
170
170
|
|
|
171
|
-
*
|
|
171
|
+
*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.*
|
|
172
172
|
|
|
173
|
-
|
|
173
|
+
Nếu có section `services`:
|
|
174
174
|
|
|
175
|
-
**1.
|
|
176
|
-
-
|
|
177
|
-
-
|
|
178
|
-
*(
|
|
179
|
-
-
|
|
175
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
176
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
177
|
+
- 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.
|
|
178
|
+
*(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`)*
|
|
179
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
180
180
|
|
|
181
|
-
**2. Route
|
|
182
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
183
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
184
|
-
-
|
|
185
|
-
-
|
|
186
|
-
-
|
|
181
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
182
|
+
- 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.
|
|
183
|
+
- 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.
|
|
184
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
185
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
186
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
187
187
|
|
|
188
|
-
**3. Fallback** —
|
|
189
|
-
-
|
|
190
|
-
-
|
|
188
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
189
|
+
- Giữ path mặc định từ Bước 1
|
|
190
|
+
- Đặt `active_service = unresolved`
|
|
191
191
|
|
|
192
|
-
**4.
|
|
193
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
194
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
192
|
+
**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:`:
|
|
193
|
+
- 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`.)*
|
|
194
|
+
- 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.)*
|
|
195
195
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
196
196
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
197
197
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
198
198
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
199
199
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
200
200
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
201
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
201
|
+
- 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`.)*
|
|
202
202
|
|
|
203
|
-
> **
|
|
203
|
+
> **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.
|
|
204
204
|
|
|
205
205
|
---
|
|
206
206
|
|
|
207
|
-
##
|
|
207
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
208
208
|
|
|
209
|
-
*
|
|
209
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
210
210
|
|
|
211
|
-
|
|
211
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
212
212
|
|
|
213
|
-
**1.
|
|
213
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
214
214
|
- `{active_service}/.agent/project-context.yaml`
|
|
215
215
|
- `{active_service}/project-context.yaml`
|
|
216
216
|
|
|
217
|
-
**2.
|
|
217
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
218
218
|
|
|
219
|
-
|
|
|
219
|
+
| Biến | Nguồn |
|
|
220
220
|
|----------|--------|
|
|
221
|
-
| `conventions.test_command` |
|
|
222
|
-
| `conventions.build_command` |
|
|
223
|
-
| `paths.trace_dir` | **
|
|
224
|
-
| `paths.specs_dir` | **
|
|
221
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
222
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
223
|
+
| `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`). |
|
|
224
|
+
| `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. |
|
|
225
225
|
|
|
226
|
-
**3.
|
|
227
|
-
-
|
|
228
|
-
- **
|
|
226
|
+
**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:
|
|
227
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
228
|
+
- **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/`).
|
|
229
229
|
|
|
230
|
-
**4.
|
|
230
|
+
**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).
|
|
231
231
|
|
|
232
232
|
---
|
|
233
233
|
|
|
234
|
-
##
|
|
234
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
235
235
|
|
|
236
|
-
|
|
237
|
-
Merge framework
|
|
238
|
-
|
|
236
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
237
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
238
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
239
239
|
|
|
240
240
|
---
|
|
241
241
|
|
|
242
|
-
##
|
|
242
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
243
243
|
|
|
244
|
-
|
|
244
|
+
*Đâ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.*
|
|
245
245
|
|
|
246
|
-
CLAUDE.md
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
246
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
247
|
+
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
|
|
248
|
+
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
|
|
249
|
+
service phải thắng khi sinh code.
|
|
250
250
|
|
|
251
|
-
**
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
251
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
252
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
253
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
254
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
255
255
|
|
|
256
|
-
**
|
|
257
|
-
*
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
Overlay
|
|
261
|
-
coding standards,
|
|
262
|
-
(
|
|
256
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
257
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
258
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
259
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
260
|
+
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,
|
|
261
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
262
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
263
263
|
|
|
264
|
-
|
|
264
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
265
265
|
|
|
266
|
-
- **§1 Project Overview** →
|
|
267
|
-
- **§2 Architecture** → layer
|
|
268
|
-
- **§3 Coding Standards** →
|
|
269
|
-
- **§5 Error Handling** → exception
|
|
270
|
-
- **§7 Git Conventions** →
|
|
266
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
267
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
268
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
269
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
270
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
271
271
|
|
|
272
|
-
**
|
|
273
|
-
-
|
|
274
|
-
-
|
|
275
|
-
-
|
|
276
|
-
-
|
|
272
|
+
**Quy tắc phân giải:**
|
|
273
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
274
|
+
- 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}`.
|
|
275
|
+
- 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).
|
|
276
|
+
- 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.
|
|
277
277
|
|
|
278
278
|
---
|
|
279
279
|
|
|
280
|
-
##
|
|
280
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
281
281
|
|
|
282
|
-
|
|
282
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
283
283
|
|
|
284
|
-
|
|
284
|
+
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.
|
|
285
285
|
|
|
286
|
-
|
|
286
|
+
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*`.
|
|
287
287
|
|
|
288
288
|
---
|
|
289
289
|
|
|
290
|
-
##
|
|
290
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
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).
|
|
293
293
|
|
|
294
|
-
|
|
295
|
-
- **Canonical Terms** →
|
|
296
|
-
- **Banned Terms** →
|
|
297
|
-
- **Status / Enum Registry** →
|
|
294
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
295
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
296
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
297
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
298
298
|
|
|
299
|
-
|
|
300
|
-
-
|
|
301
|
-
-
|
|
299
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
300
|
+
- 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
|
|
301
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
304
304
|
|
|
305
305
|
---
|
|
306
306
|
|
|
307
|
-
##
|
|
307
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
308
308
|
|
|
309
|
-
|
|
310
|
-
|
|
309
|
+
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).
|
|
310
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
311
311
|
|
|
312
|
-
|
|
313
|
-
- **Entity catalog** →
|
|
314
|
-
- **Field name registry** →
|
|
315
|
-
- **Relationship map** →
|
|
312
|
+
Nếu tồn tại, đọc và lưu:
|
|
313
|
+
- **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ệ
|
|
314
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
315
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
316
316
|
|
|
317
|
-
**
|
|
318
|
-
-
|
|
319
|
-
-
|
|
320
|
-
-
|
|
317
|
+
**Cách dùng catalog này:**
|
|
318
|
+
- 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
|
|
319
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
320
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
321
321
|
|
|
322
|
-
|
|
322
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
323
323
|
|
|
324
324
|
---
|
|
325
325
|
|
|
326
|
-
##
|
|
326
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
327
327
|
|
|
328
|
-
|
|
328
|
+
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:
|
|
329
329
|
|
|
330
330
|
```
|
|
331
|
-
active_module = tech_stack.module (
|
|
331
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
332
332
|
```
|
|
333
333
|
|
|
334
334
|
| `platform_type` | Modules |
|
|
@@ -337,138 +337,138 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
337
337
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
338
338
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
339
339
|
|
|
340
|
-
|
|
340
|
+
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.
|
|
341
341
|
|
|
342
|
-
|
|
342
|
+
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).
|
|
343
343
|
|
|
344
344
|
---
|
|
345
345
|
|
|
346
|
-
##
|
|
346
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
347
347
|
|
|
348
|
-
*
|
|
349
|
-
|
|
348
|
+
*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`
|
|
349
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
350
350
|
|
|
351
|
-
|
|
352
|
-
-
|
|
353
|
-
- Else
|
|
354
|
-
-
|
|
351
|
+
Phân giải path file lessons:
|
|
352
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
353
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
354
|
+
- Ở 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`
|
|
355
355
|
|
|
356
|
-
|
|
357
|
-
-
|
|
358
|
-
-
|
|
359
|
-
-
|
|
356
|
+
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:
|
|
357
|
+
- 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).
|
|
358
|
+
- 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).
|
|
359
|
+
- 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.
|
|
360
360
|
|
|
361
|
-
|
|
361
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
362
362
|
|
|
363
363
|
---
|
|
364
364
|
|
|
365
|
-
##
|
|
365
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
366
366
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
(recency
|
|
367
|
+
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.
|
|
368
|
+
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
|
|
369
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
370
370
|
|
|
371
|
-
|
|
371
|
+
Xuất đúng khối này:
|
|
372
372
|
```
|
|
373
373
|
[CTX LOADED]
|
|
374
374
|
Stack : {language} / {framework} / {database}
|
|
375
375
|
Platform : {active_module} ({platform_type})
|
|
376
|
-
Layers : {
|
|
377
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
376
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
377
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
378
378
|
Ticket : {ticket_prefix}-
|
|
379
379
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
380
380
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
381
|
-
Lessons : {loaded — N guardrails |
|
|
381
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
382
382
|
Service : {active_service} ({active_service_module}) | single-service
|
|
383
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
384
|
-
Status : {FULL | PARTIAL —
|
|
383
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
384
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
385
385
|
```
|
|
386
386
|
|
|
387
|
-
|
|
387
|
+
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.
|
|
388
388
|
|
|
389
389
|
---
|
|
390
390
|
|
|
391
|
-
##
|
|
391
|
+
## Hoàn tất nạp Context
|
|
392
392
|
|
|
393
|
-
|
|
394
|
-
-
|
|
395
|
-
-
|
|
396
|
-
- Coding standards
|
|
397
|
-
-
|
|
398
|
-
-
|
|
399
|
-
- Entity catalog (field
|
|
400
|
-
-
|
|
393
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
394
|
+
- Định danh dự án, tech stack, convention module
|
|
395
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
396
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
397
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
398
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
399
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
400
|
+
- Toàn bộ path đã cấu hình
|
|
401
401
|
|
|
402
|
-
|
|
402
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
403
403
|
|
|
404
404
|
|
|
405
405
|
---
|
|
406
406
|
|
|
407
|
-
## Review
|
|
408
|
-
#
|
|
407
|
+
## Quy trình Review
|
|
408
|
+
# Review Fan-Out toàn diện + Hội tụ về độ đầy đủ
|
|
409
409
|
|
|
410
|
-
**
|
|
411
|
-
|
|
412
|
-
(
|
|
413
|
-
fan out
|
|
414
|
-
|
|
410
|
+
**Vì sao có cái này:** Một lượt review đơn không bao giờ liệt kê hết mọi vấn đề cùng lúc — model
|
|
411
|
+
dừng ở mức "đủ" findings, nên mỗi vòng review sau lại lòi ra vấn đề *mới*
|
|
412
|
+
(đập chuột chũi). Quy trình này ép review **hội tụ trong một lần chạy lệnh**:
|
|
413
|
+
fan out song song theo các chiều review, rồi lặp một critic độ-đầy-đủ cho tới khi một
|
|
414
|
+
vòng không sinh thêm gì mới, *trước khi* ghi file findings.
|
|
415
415
|
|
|
416
|
-
|
|
417
|
-
- **DIMENSIONS** —
|
|
418
|
-
(`/refine-prd` →
|
|
419
|
-
- **FINDINGS SCHEMA** —
|
|
416
|
+
Lệnh gọi cung cấp hai thứ:
|
|
417
|
+
- **DIMENSIONS** — danh sách các chiều review để fan out
|
|
418
|
+
(`/refine-prd` → 4 lăng kính; `/review-context` → các P-check hoặc B-check).
|
|
419
|
+
- **FINDINGS SCHEMA** — dạng YAML mà mỗi finding phải theo (định nghĩa trong lệnh).
|
|
420
420
|
|
|
421
|
-
> **
|
|
422
|
-
>
|
|
423
|
-
> sub-agent.
|
|
421
|
+
> **Bỏ qua ở chế độ sub-agent:** Nếu Gate Bước 0 đã set `_agent_mode: true`, toàn bộ
|
|
422
|
+
> quy trình này bị **bỏ qua** — orchestrator đã chạy sẵn một dimension/UC cho mỗi
|
|
423
|
+
> sub-agent. Chạy các check của lệnh trực tiếp trên section đã giới hạn và trả về findings.
|
|
424
424
|
|
|
425
425
|
---
|
|
426
426
|
|
|
427
|
-
## Phase 1 —
|
|
427
|
+
## Phase 1 — Quét dimension song song
|
|
428
428
|
|
|
429
|
-
**
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
429
|
+
**Bao nhiêu sub-agent:** *số lượng* agent không phải là đòn bẩy độ đầy đủ — bề rộng được
|
|
430
|
+
cố định bởi taxonomy DIMENSION (thêm agent vào cùng một dimension chỉ tìm lại cùng vấn đề),
|
|
431
|
+
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2. Chọn **độ mịn fan-out**
|
|
432
|
+
theo kích thước target, tái dùng ngưỡng của `steps/spawn-agent.md`:
|
|
433
433
|
|
|
434
|
-
|
|
|
434
|
+
| Kích thước target | Độ mịn | Số agent |
|
|
435
435
|
|-------------|-------------|-------------|
|
|
436
|
-
| ≤ 3
|
|
437
|
-
| > 3
|
|
436
|
+
| ≤ 3 UC **và** ≤ 300 dòng | một agent cho mỗi DIMENSION trên cả file | = số dimension |
|
|
437
|
+
| > 3 UC **hoặc** > 300 dòng | một agent cho mỗi **DIMENSION × phạm vi UC** (các UC + một phạm vi PRD-global), gom batch để vừa giới hạn agent | `dimensions × (UCs + 1)`, có cap (xem dưới) |
|
|
438
438
|
|
|
439
|
-
|
|
440
|
-
|
|
439
|
+
Độ mịn lớn hơn giữ context của mỗi sub-agent nhỏ và quét nó vét cạn trên một
|
|
440
|
+
UC duy nhất — chính là điều ngăn bỏ sót trên các PRD lớn.
|
|
441
441
|
|
|
442
|
-
> **
|
|
443
|
-
>
|
|
444
|
-
> problem statement, terminology, glossary, changelog)
|
|
445
|
-
> fan out
|
|
446
|
-
> `uc_id: ""`)
|
|
447
|
-
> (
|
|
442
|
+
> **Các section global (không thuộc UC) — bắt buộc ở chế độ `DIMENSION × UC`.** Mỗi agent per-UC chỉ
|
|
443
|
+
> thấy một UC, nên các section toàn-PRD không thuộc UC nào (scope, success metric,
|
|
444
|
+
> problem statement, terminology, glossary, changelog) sẽ không được quét. Khi nào
|
|
445
|
+
> fan out theo UC, cũng phải thêm một phạm vi **"PRD-global"** (các section không thuộc UC, finding nhận
|
|
446
|
+
> `uc_id: ""`) bên cạnh danh sách UC. Nên số agent tự nhiên là `dimensions × (UCs + 1)`.
|
|
447
|
+
> (Không cần ở chế độ whole-file — ở đó mỗi agent đã thấy các section global rồi.)
|
|
448
448
|
|
|
449
|
-
### Agent cap — batch
|
|
449
|
+
### Agent cap — gom batch các UC khi fan-out quá rộng
|
|
450
450
|
|
|
451
|
-
`dimensions × (UCs + 1)`
|
|
452
|
-
|
|
451
|
+
`dimensions × (UCs + 1)` có thể bùng nổ trên PRD lớn (vd 6 check × (8 UC + 1) = 54
|
|
452
|
+
agent). Giới hạn mỗi wave ở **`AGENT_CAP = 12`** agent và gom batch các phạm vi UC cho vừa:
|
|
453
453
|
|
|
454
|
-
1.
|
|
455
|
-
2.
|
|
456
|
-
-
|
|
457
|
-
- Else
|
|
458
|
-
(
|
|
459
|
-
|
|
460
|
-
3.
|
|
454
|
+
1. Dựng danh sách phạm vi = `[UC1, UC2, …, UCn, PRD-global]` (độ dài `UCs + 1`).
|
|
455
|
+
2. Tính số-phạm-vi-mỗi-bucket: `groups = max(1, floor(AGENT_CAP / dimensions))`.
|
|
456
|
+
- Nếu `groups ≥ UCs + 1` → không cần batch, chạy một agent cho mỗi `DIMENSION × scope`.
|
|
457
|
+
- Else chia danh sách phạm vi thành `groups` bucket liền kề kích thước xấp xỉ bằng nhau
|
|
458
|
+
(giữ `PRD-global` ở bucket riêng nếu vừa; nếu không thì gắn vào bucket cuối).
|
|
459
|
+
Mỗi agent khi đó xử lý **một DIMENSION trên một bucket UC**.
|
|
460
|
+
3. Kích thước wave kết quả = `dimensions × groups ≤ AGENT_CAP`.
|
|
461
461
|
|
|
462
|
-
|
|
463
|
-
file,
|
|
464
|
-
|
|
462
|
+
Một agent đã batch review nhiều UC cùng lúc — vẫn giới hạn chặt hơn nhiều so với cả
|
|
463
|
+
file, nên độ phủ vẫn cao. `AGENT_CAP` là núm chỉnh duy nhất; tăng nếu host cho phép
|
|
464
|
+
concurrency nhiều hơn, giảm để tiết kiệm token. Chế độ whole-file (≤ 3 UC) không bao giờ chạm cap.
|
|
465
465
|
|
|
466
|
-
Spawn
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
dimension
|
|
466
|
+
Spawn các sub-agent đã chọn bằng Agent tool (gửi trong một message duy nhất để chúng
|
|
467
|
+
chạy đồng thời). Mỗi sub-agent nhận một **context window mới** và quét phạm vi của nó
|
|
468
|
+
chỉ qua **một** dimension duy nhất — độ phủ sâu hơn một session phải tung hứng mọi
|
|
469
|
+
dimension cùng lúc (tránh lost-in-the-middle).
|
|
470
470
|
|
|
471
|
-
|
|
471
|
+
Template prompt cho sub-agent (điền vào các ngoặc):
|
|
472
472
|
|
|
473
473
|
```
|
|
474
474
|
You are a {DIMENSION_NAME} reviewer. Read the full target file at {target_file}.
|
|
@@ -484,20 +484,20 @@ Return a JSON array of findings, each:
|
|
|
484
484
|
Return [] if this dimension is clean. Return ONLY the JSON array.
|
|
485
485
|
```
|
|
486
486
|
|
|
487
|
-
|
|
487
|
+
Gom mảng findings của mọi sub-agent vào một danh sách hợp nhất `ALL_FINDINGS`.
|
|
488
488
|
|
|
489
489
|
---
|
|
490
490
|
|
|
491
|
-
## Phase 2 —
|
|
491
|
+
## Phase 2 — Vòng lặp hội tụ critic độ-đầy-đủ
|
|
492
492
|
|
|
493
|
-
|
|
494
|
-
|
|
493
|
+
Đây là bước chống đập-chuột-chũi. Lặp cho tới khi **hai vòng liên tiếp thêm 0 finding
|
|
494
|
+
mới**, hoặc tới cap cứng **3 vòng**, cái nào đến trước:
|
|
495
495
|
|
|
496
|
-
1. Spawn
|
|
497
|
-
-
|
|
498
|
-
-
|
|
499
|
-
-
|
|
500
|
-
Prompt
|
|
496
|
+
1. Spawn một sub-agent **completeness-critic** bằng Agent tool. Cho nó:
|
|
497
|
+
- toàn bộ target file (`{target_file}`),
|
|
498
|
+
- danh sách `ALL_FINDINGS` hiện tại (để nó biết những gì đã được ghi nhận),
|
|
499
|
+
- cùng context gọn đó.
|
|
500
|
+
Prompt nó:
|
|
501
501
|
```
|
|
502
502
|
Here is a document and a list of issues already found. Read the WHOLE document.
|
|
503
503
|
List ONLY real, additional issues NOT already in the list — gaps, ambiguities,
|
|
@@ -506,73 +506,71 @@ findings**, or a hard cap of **3 rounds**, whichever comes first:
|
|
|
506
506
|
Do NOT repeat anything already listed. Return the same finding JSON shape, or [] if
|
|
507
507
|
nothing new.
|
|
508
508
|
```
|
|
509
|
-
2.
|
|
510
|
-
3.
|
|
511
|
-
4.
|
|
509
|
+
2. Thêm bất kỳ finding thực sự mới (chưa có trong `ALL_FINDINGS`) vào danh sách.
|
|
510
|
+
3. Nếu vòng này trả 0 finding mới → tăng bộ đếm dry-round; ngược lại reset về 0.
|
|
511
|
+
4. Dừng khi bộ đếm dry-round đạt 2, hoặc sau tổng cộng 3 vòng.
|
|
512
512
|
|
|
513
|
-
|
|
513
|
+
Ghi lại `convergence_rounds` (số vòng critic đã chạy) cho report.
|
|
514
514
|
|
|
515
515
|
---
|
|
516
516
|
|
|
517
|
-
## Phase 3 — Dedup,
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
1. **
|
|
524
|
-
`section` + `uc_id`
|
|
525
|
-
|
|
526
|
-
2. **
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
In the command's final report, add one line:
|
|
517
|
+
## Phase 3 — Dedup, giải quyết xung đột, merge
|
|
518
|
+
|
|
519
|
+
Các sub-agent chạy **mù với nhau** (độc lập = độ phủ đa dạng). Chúng không bao giờ
|
|
520
|
+
trao đổi hay điều hoà giữa chúng — mọi xử lý trùng/xung đột diễn ra **ở đây trong
|
|
521
|
+
orchestrator**, nơi thấy toàn bộ tập findings.
|
|
522
|
+
|
|
523
|
+
1. **Khử trùng lặp** `ALL_FINDINGS`: hai finding là trùng nếu cùng nhắm tới cùng
|
|
524
|
+
`section` + `uc_id` và mô tả cùng một vấn đề gốc. Giữ cái có `suggestion`
|
|
525
|
+
phong phú hơn; nếu khác nhau về severity, giữ severity **cao hơn**.
|
|
526
|
+
2. **Giải quyết xung đột** — nhóm các finding còn lại theo `section` + `uc_id` và kiểm tra
|
|
527
|
+
mâu thuẫn (hai finding có `suggestion` không thể cùng áp dụng, hoặc đề xuất sửa ngược nhau cho cùng một chỗ):
|
|
528
|
+
- Nếu hai đề xuất có thể **merge** thành một bản sửa mạch lạc → merge thành một finding duy nhất.
|
|
529
|
+
- Nếu chúng **loại trừ lẫn nhau** → phát ra **một** finding nêu cả hai phương án
|
|
530
|
+
và set `auto_fixable: false` với `status: "needs_discussion"` (PRD) /
|
|
531
|
+
`status: "pending"` (review) để con người chọn — không bao giờ âm thầm bỏ một bên.
|
|
532
|
+
- Nếu một finding bị **vô hiệu** bởi finding khác (vd một finding cấu trúc nói một section
|
|
533
|
+
bị thiếu, nhưng một finding khác trích dẫn nội dung từ chính section đó) → bỏ cái không hợp lệ.
|
|
534
|
+
3. **Sắp xếp** theo severity (critical → major → minor), rồi theo thứ tự `section` trong file.
|
|
535
|
+
4. **Gán ID ổn định** `F001, F002, …` theo thứ tự đã sắp đó.
|
|
536
|
+
5. Map `dimension` của mỗi finding vào field schema của lệnh
|
|
537
|
+
(`lens` cho `/refine-prd`; `check_id` cho `/review-context`).
|
|
538
|
+
6. Ghi **một** file findings duy nhất theo FINDINGS SCHEMA mà lệnh định nghĩa.
|
|
539
|
+
|
|
540
|
+
Trong report cuối của lệnh, thêm một dòng:
|
|
543
541
|
```
|
|
544
|
-
Convergence: {convergence_rounds} critic
|
|
542
|
+
Convergence: {convergence_rounds} vòng critic — file findings đã đầy đủ; chạy lại sẽ lòi ra 0 vấn đề mới.
|
|
545
543
|
```
|
|
546
544
|
|
|
547
545
|
|
|
548
546
|
---
|
|
549
547
|
|
|
550
|
-
##
|
|
548
|
+
## Phân tích — 4 lăng kính (fan out cả bốn, rồi hội tụ)
|
|
551
549
|
|
|
552
|
-
|
|
550
|
+
Chạy review qua **Quy trình Review** ở trên (`steps/review-fanout.md`).
|
|
553
551
|
|
|
554
|
-
**DIMENSIONS** =
|
|
555
|
-
|
|
552
|
+
**DIMENSIONS** = 4 lăng kính dưới đây — fan out một sub-agent cho mỗi lăng kính, mỗi cái quét
|
|
553
|
+
toàn bộ PRD qua đúng lăng kính của nó:
|
|
556
554
|
|
|
557
|
-
- **QA
|
|
558
|
-
- **DEV
|
|
559
|
-
- **SA
|
|
560
|
-
- **PO
|
|
555
|
+
- **Lăng kính QA**: AC có testable không? Edge case đã nêu? Điều kiện biên đã định nghĩa?
|
|
556
|
+
- **Lăng kính DEV**: Input/output API rõ chưa? Business rule có mơ hồ không? Cross-service deps mô tả đủ chưa? Có rủi ro kỹ thuật nào?
|
|
557
|
+
- **Lăng kính SA**: Khớp kiến trúc hiện tại? Hệ luỵ security/auth? Mô hình dữ liệu rõ chưa?
|
|
558
|
+
- **Lăng kính PO**: Scope đã khoanh vùng? Priority rõ chưa? Success metric đã định nghĩa? Rủi ro scope creep?
|
|
561
559
|
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
560
|
+
Vòng lặp completeness-critic (Phase 2) là cái đảm bảo file findings đầy đủ trong một lần chạy
|
|
561
|
+
— chạy lại `/refine-prd` sẽ lòi ra **0 finding mới**. Map mỗi dimension vào field `lens`
|
|
562
|
+
của schema dưới đây.
|
|
565
563
|
|
|
566
|
-
## Output
|
|
564
|
+
## File Output
|
|
567
565
|
|
|
568
|
-
|
|
569
|
-
- PRD
|
|
570
|
-
-
|
|
566
|
+
Suy ra tên file output từ PRD slug:
|
|
567
|
+
- File PRD: `{paths.specs_dir}/payment/create-invoice/PAY01-create-invoice.md` → output: `{paths.refinement_dir}/create-invoice-findings.yaml`
|
|
568
|
+
- Quy tắc: lấy tên folder cha của PRD (prd-slug), thêm hậu tố `-findings.yaml`
|
|
571
569
|
|
|
572
|
-
|
|
570
|
+
Ghi `{paths.refinement_dir}/{prd-slug}-findings.yaml`:
|
|
573
571
|
|
|
574
572
|
```yaml
|
|
575
|
-
prd_source: "{paths.specs_dir}/{domain}/{prd-slug}/prd.md"
|
|
573
|
+
prd_source: "{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md"
|
|
576
574
|
generated_at: "{ISO datetime}"
|
|
577
575
|
status: "pending_review"
|
|
578
576
|
|
|
@@ -580,12 +578,12 @@ findings:
|
|
|
580
578
|
- id: "F001"
|
|
581
579
|
lens: "QA" # QA | DEV | SA | PO
|
|
582
580
|
severity: "major" # critical | major | minor
|
|
583
|
-
section: "§
|
|
584
|
-
uc_id: "{TICKET-ID}-UC{N}" # UC
|
|
585
|
-
quote: "{
|
|
586
|
-
finding: "{
|
|
587
|
-
suggestion: "{
|
|
588
|
-
auto_fixable: false # true = AI
|
|
581
|
+
section: "§2. Acceptance Criteria" # nhãn heading/section dạng người đọc
|
|
582
|
+
uc_id: "{TICKET-ID}-UC{N}" # UC mà finding thuộc về; "" nếu PRD-global (scope, metrics, problem statement)
|
|
583
|
+
quote: "{trích đoạn nguyên văn copy CHÍNH XÁC từ PRD tại vị trí lỗi, ≤120 ký tự}"
|
|
584
|
+
finding: "{mô tả gap hoặc vấn đề}"
|
|
585
|
+
suggestion: "{đề xuất cải thiện cụ thể, hành động được}"
|
|
586
|
+
auto_fixable: false # true = AI áp dụng khi --resume; false = người phải ghi quyết định trong note
|
|
589
587
|
status: "pending" # pending | accepted | rejected | needs_discussion
|
|
590
588
|
|
|
591
589
|
summary:
|
|
@@ -595,46 +593,46 @@ summary:
|
|
|
595
593
|
recommendation: "APPROVED_WITH_MINOR_CHANGES | NEEDS_REVISION | BLOCKED"
|
|
596
594
|
```
|
|
597
595
|
|
|
598
|
-
> **
|
|
599
|
-
>
|
|
600
|
-
>
|
|
601
|
-
> `uc_id`
|
|
602
|
-
> finding
|
|
596
|
+
> **Field định vị (`quote` + `uc_id`) — bắt buộc cho source-jump của Review Board.**
|
|
597
|
+
> Với mỗi finding, copy một đoạn `quote` **nguyên văn** thẳng từ PRD tại đúng chỗ
|
|
598
|
+
> lỗi xảy ra — KHÔNG diễn giải lại; nó được so khớp với tài liệu để định vị dòng. Đặt
|
|
599
|
+
> `uc_id` là Use Case sở hữu (hoặc `""` cho finding PRD-global). Hai field này cho phép reviewer click một
|
|
600
|
+
> finding trong Review Board và nhảy thẳng tới đúng vị trí trong PRD nguồn.
|
|
603
601
|
|
|
604
602
|
## Report
|
|
605
603
|
|
|
606
|
-
# Report Footer —
|
|
604
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
607
605
|
|
|
608
|
-
|
|
606
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
609
607
|
|
|
610
608
|
## Status Badge
|
|
611
609
|
|
|
612
|
-
|
|
613
|
-
- `✅ Complete` —
|
|
614
|
-
- `❌ Failed` —
|
|
615
|
-
- `⚠️ Warnings` —
|
|
610
|
+
Chọn một theo kết quả:
|
|
611
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
612
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
613
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
616
614
|
|
|
617
615
|
## Output Artifacts
|
|
618
616
|
|
|
619
|
-
|
|
617
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
620
618
|
```
|
|
621
619
|
Output Artifacts:
|
|
622
|
-
{created|updated} {file-path} ({
|
|
623
|
-
{created|updated} {file-path} ({
|
|
620
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
621
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
624
622
|
```
|
|
625
623
|
|
|
626
|
-
|
|
624
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
627
625
|
|
|
628
626
|
## Pipeline Position
|
|
629
627
|
|
|
630
|
-
|
|
631
|
-
|
|
628
|
+
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`,
|
|
629
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
632
630
|
|
|
633
631
|
```
|
|
634
632
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
635
633
|
```
|
|
636
634
|
|
|
637
|
-
|
|
635
|
+
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:
|
|
638
636
|
|
|
639
637
|
| Phase | Commands |
|
|
640
638
|
|-------|----------|
|
|
@@ -648,125 +646,125 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
648
646
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
649
647
|
| Trace Audit | `/validate-traces` |
|
|
650
648
|
|
|
651
|
-
|
|
649
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
652
650
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
653
651
|
|
|
654
|
-
**
|
|
655
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
656
|
-
**
|
|
652
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
653
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
654
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
657
655
|
|
|
658
|
-
##
|
|
656
|
+
## Gợi ý lệnh tiếp theo
|
|
659
657
|
|
|
660
|
-
|
|
658
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
661
659
|
|
|
662
|
-
|
|
|
660
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
663
661
|
|-------------------------|-----------------------------------------------|
|
|
664
|
-
| /setup-ai-first | `/define-product`
|
|
662
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
665
663
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
666
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
667
|
-
| /refine-prd |
|
|
668
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
669
|
-
| /generate-design-spec | Designer review →
|
|
670
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
671
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
672
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
664
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
665
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
666
|
+
| /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 |
|
|
667
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
668
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
669
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
670
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
673
671
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
674
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
675
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
676
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
677
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
678
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
672
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
673
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
674
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
675
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
676
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
679
677
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
680
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
681
|
-
| /generate-code |
|
|
678
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
679
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
682
680
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
683
681
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
684
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
685
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
686
|
-
| /dev-smoke-test |
|
|
687
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
688
|
-
| /fix-bug |
|
|
689
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
690
|
-
| /report-bug |
|
|
691
|
-
| /propose-scenario |
|
|
692
|
-
| /learn |
|
|
693
|
-
| /sync | `/validate-traces`
|
|
694
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
695
|
-
|
|
696
|
-
|
|
682
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
683
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
684
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
685
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
686
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
687
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
688
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
689
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
690
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
691
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
692
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
693
|
+
|
|
694
|
+
Định dạng footer như sau:
|
|
697
695
|
```
|
|
698
696
|
---
|
|
699
697
|
Status : {badge}
|
|
700
|
-
{Output Artifacts
|
|
698
|
+
{khối Output Artifacts}
|
|
701
699
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
702
|
-
(review
|
|
703
|
-
Next : {
|
|
700
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
701
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
704
702
|
```
|
|
705
|
-
*(
|
|
703
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
706
704
|
|
|
707
705
|
|
|
708
706
|
```
|
|
709
|
-
/refine-prd
|
|
707
|
+
/refine-prd Hoàn tất — {PRD name}
|
|
710
708
|
Findings: {total} | 🔴 Critical: {N} | 🟡 Major: {N} | 🟢 Minor: {N}
|
|
711
709
|
Review: {paths.refinement_dir}/{prd-slug}-findings.yaml
|
|
712
|
-
Next:
|
|
713
|
-
→ /review-context {prd-file} ←
|
|
710
|
+
Next: Mở trong Review Board (chuột phải vào file) → Cập nhật PRD
|
|
711
|
+
→ /review-context {prd-file} ← kiểm tra chất lượng PRD trước khi sinh BDD
|
|
714
712
|
→ /generate-bdd {prd-file}
|
|
715
713
|
```
|
|
716
714
|
|
|
717
715
|
---
|
|
718
716
|
|
|
719
|
-
## Resume Mode —
|
|
717
|
+
## Resume Mode — Áp dụng Findings & Bump Version
|
|
720
718
|
|
|
721
|
-
*
|
|
719
|
+
*Kích hoạt khi `$ARGUMENTS` chứa `--resume` (gọi bởi nút "Apply to PRD" của Review Board).*
|
|
722
720
|
|
|
723
|
-
### Phase 1 —
|
|
721
|
+
### Phase 1 — Đọc các finding được chấp nhận
|
|
724
722
|
|
|
725
|
-
1.
|
|
726
|
-
2.
|
|
727
|
-
3.
|
|
723
|
+
1. Đọc `{paths.refinement_dir}/{prd-slug}-findings.yaml`.
|
|
724
|
+
2. Gom tất cả finding có `status: "accepted"` hoặc `status: "modified"`.
|
|
725
|
+
3. Nếu không có finding nào được chấp nhận → báo "No accepted findings. PRD unchanged." và dừng.
|
|
728
726
|
|
|
729
|
-
### Phase 2 —
|
|
727
|
+
### Phase 2 — Áp dụng thay đổi vào PRD
|
|
730
728
|
|
|
731
|
-
|
|
732
|
-
-
|
|
733
|
-
-
|
|
734
|
-
-
|
|
729
|
+
Với mỗi finding được chấp nhận, theo thứ tự severity (critical → major → minor):
|
|
730
|
+
- Đi tới section PRD được chỉ định bởi `finding.section`.
|
|
731
|
+
- Áp dụng `finding.suggestion`. Với finding `status: "modified"`, người đã sửa sẵn `finding.suggestion` trong Review Board — giá trị đã sửa đó CHÍNH LÀ bản fix cần áp dụng.
|
|
732
|
+
- Không thay đổi bất kỳ section nào không được tham chiếu bởi một finding được chấp nhận.
|
|
735
733
|
|
|
736
|
-
### Phase 2.5 —
|
|
734
|
+
### Phase 2.5 — Cập nhật file findings
|
|
737
735
|
|
|
738
|
-
|
|
739
|
-
-
|
|
736
|
+
Với mỗi finding đã áp dụng (status là `accepted` hoặc `modified`):
|
|
737
|
+
- Đặt `status: "applied"` trong `{paths.refinement_dir}/{prd-slug}-findings.yaml`.
|
|
740
738
|
|
|
741
|
-
|
|
739
|
+
Cập nhật `summary.status: "applied"` trong file findings.
|
|
742
740
|
|
|
743
|
-
### Phase 3 — Bump version &
|
|
741
|
+
### Phase 3 — Bump version & ghi entry changelog
|
|
744
742
|
|
|
745
|
-
1.
|
|
746
|
-
2.
|
|
747
|
-
- **major** (X.0 →
|
|
748
|
-
- **minor** (x.Y → x.Y+1):
|
|
749
|
-
3.
|
|
750
|
-
4.
|
|
743
|
+
1. Đọc giá trị `| **Version** |` hiện tại từ bảng metadata của PRD.
|
|
744
|
+
2. Xác định loại bump từ tập finding được chấp nhận:
|
|
745
|
+
- **major** (X.0 → X+1.0 kế tiếp): thêm/xoá Use Case, tái cấu trúc scope, thay đổi BR breaking.
|
|
746
|
+
- **minor** (x.Y → x.Y+1): làm rõ, thêm edge case, tinh chỉnh wording AC/BR.
|
|
747
|
+
3. Tính chuỗi version mới.
|
|
748
|
+
4. Cập nhật metadata PRD:
|
|
751
749
|
- `| **Version** | {new_version} |`
|
|
752
750
|
- `| **Updated** | {today YYYY-MM-DD} |`
|
|
753
|
-
- `| **Status** | draft |` ← reset
|
|
754
|
-
5.
|
|
751
|
+
- `| **Status** | draft |` ← reset về draft, phải được duyệt lại
|
|
752
|
+
5. Thêm một row mới lên đầu `## Changelog` ở cuối PRD:
|
|
755
753
|
```
|
|
756
|
-
| {new_version} | {today} | {
|
|
754
|
+
| {new_version} | {today} | {tóm tắt súc tích mọi thay đổi đã áp dụng} |
|
|
757
755
|
```
|
|
758
756
|
|
|
759
757
|
### Phase 4 — Report
|
|
760
758
|
|
|
761
759
|
```
|
|
762
|
-
/refine-prd
|
|
760
|
+
/refine-prd Đã áp dụng — {PRD name}
|
|
763
761
|
Version : {old_version} → {new_version}
|
|
764
762
|
Applied : {N} findings ({critical} critical, {major} major, {minor} minor)
|
|
765
763
|
Changes :
|
|
766
764
|
- {change 1}
|
|
767
765
|
- {change 2}
|
|
768
766
|
|
|
769
|
-
⚠️ BDD
|
|
770
|
-
/review-context {prd-file} ←
|
|
767
|
+
⚠️ BDD có thể đã lỗi thời. Chạy:
|
|
768
|
+
/review-context {prd-file} ← kiểm tra chất lượng PRD trước
|
|
771
769
|
→ /generate-bdd {prd-file}
|
|
772
770
|
```
|