@edupia-tutor/spec-driven-docs 0.14.0 → 0.14.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commands/debug.md +435 -435
- package/commands/debug.tmpl +111 -111
- package/commands/define-product.md +330 -327
- package/commands/define-product.tmpl +50 -47
- package/commands/dev-gen-test.md +364 -364
- package/commands/dev-gen-test.tmpl +63 -63
- package/commands/dev-run-test.md +375 -375
- package/commands/dev-run-test.tmpl +74 -74
- package/commands/dev-smoke-test.md +340 -340
- package/commands/dev-smoke-test.tmpl +60 -60
- package/commands/fix-bug.md +402 -402
- package/commands/fix-bug.tmpl +78 -78
- package/commands/generate-bdd.md +512 -512
- package/commands/generate-bdd.tmpl +211 -211
- package/commands/generate-code.md +480 -482
- package/commands/generate-code.tmpl +179 -181
- package/commands/generate-design-spec.md +495 -495
- package/commands/generate-design-spec.tmpl +219 -219
- package/commands/generate-prd.md +445 -396
- package/commands/generate-prd.tmpl +45 -198
- package/commands/generate-spec-manifest.md +337 -337
- package/commands/generate-spec-manifest.tmpl +57 -57
- package/commands/generate-tech-docs.md +364 -364
- package/commands/generate-tech-docs.tmpl +84 -84
- package/commands/learn.md +346 -346
- package/commands/learn.tmpl +22 -22
- package/commands/map-testids.md +321 -321
- package/commands/map-testids.tmpl +41 -41
- package/commands/propose-scenario.md +334 -334
- package/commands/propose-scenario.tmpl +54 -54
- package/commands/qc-analyze.md +322 -323
- package/commands/qc-analyze.tmpl +42 -43
- package/commands/qc-design-test.md +303 -303
- package/commands/qc-design-test.tmpl +23 -23
- package/commands/qc-plan.md +296 -296
- package/commands/qc-plan.tmpl +16 -16
- package/commands/qc-report.md +301 -301
- package/commands/qc-report.tmpl +21 -21
- package/commands/qc-review.md +297 -297
- package/commands/qc-review.tmpl +17 -17
- package/commands/qc-run-test.md +336 -336
- package/commands/qc-run-test.tmpl +35 -35
- package/commands/refine-prd.md +426 -428
- package/commands/refine-prd.tmpl +61 -61
- package/commands/report-bug.md +350 -350
- package/commands/report-bug.tmpl +70 -70
- package/commands/review-code.md +363 -363
- package/commands/review-code.tmpl +39 -39
- package/commands/review-context.md +577 -579
- package/commands/review-context.tmpl +212 -212
- package/commands/review-tech-docs.md +426 -426
- package/commands/review-tech-docs.tmpl +146 -146
- package/commands/setup-ai-first.md +237 -237
- package/commands/setup-ai-first.tmpl +131 -131
- 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 +379 -379
- package/commands/validate-traces.tmpl +99 -99
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +435 -435
- package/core/commands/define-product.md +330 -327
- package/core/commands/dev-gen-test.md +364 -364
- package/core/commands/dev-run-test.md +375 -375
- package/core/commands/dev-smoke-test.md +340 -340
- package/core/commands/fix-bug.md +402 -402
- package/core/commands/generate-bdd.md +512 -512
- package/core/commands/generate-code.md +480 -482
- package/core/commands/generate-design-spec.md +495 -495
- package/core/commands/generate-prd.md +445 -396
- package/core/commands/generate-spec-manifest.md +337 -337
- package/core/commands/generate-tech-docs.md +364 -364
- package/core/commands/learn.md +346 -346
- package/core/commands/map-testids.md +321 -321
- package/core/commands/propose-scenario.md +334 -334
- package/core/commands/qc-analyze.md +322 -323
- package/core/commands/qc-design-test.md +303 -303
- package/core/commands/qc-plan.md +296 -296
- package/core/commands/qc-report.md +301 -301
- package/core/commands/qc-review.md +297 -297
- package/core/commands/qc-run-test.md +336 -336
- package/core/commands/refine-prd.md +426 -428
- package/core/commands/report-bug.md +350 -350
- package/core/commands/review-code.md +363 -363
- package/core/commands/review-context.md +577 -579
- package/core/commands/review-tech-docs.md +426 -426
- package/core/commands/setup-ai-first.md +237 -237
- package/core/commands/sync.md +145 -145
- package/core/commands/update-framework.md +88 -88
- package/core/commands/validate-traces.md +379 -379
- package/core/skills/code/SKILL.md +388 -388
- package/core/skills/debug/SKILL.md +390 -390
- package/core/skills/design-spec/SKILL.md +316 -316
- package/core/skills/discovery/SKILL.md +7 -547
- package/core/skills/prd/SKILL.md +298 -394
- package/core/skills/setup-ai-first/SKILL.md +79 -79
- package/core/skills/spec/SKILL.md +176 -176
- package/core/skills/test/SKILL.md +602 -602
- package/core/steps/capture-lesson.md +44 -44
- package/core/steps/context-loader.md +174 -174
- 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 +106 -231
- package/core/templates/product-definition.template.md +101 -88
- package/docs/04-operations/publishing.md +20 -3
- package/package.json +1 -1
- package/skills/code/SKILL.md +388 -388
- package/skills/code/SKILL.tmpl +56 -56
- package/skills/debug/SKILL.md +390 -390
- package/skills/debug/SKILL.tmpl +60 -60
- package/skills/design-spec/SKILL.md +316 -316
- package/skills/design-spec/SKILL.tmpl +36 -36
- 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 +79 -79
- package/skills/setup-ai-first/SKILL.tmpl +27 -27
- package/skills/spec/SKILL.md +176 -176
- package/skills/spec/SKILL.tmpl +18 -18
- package/skills/test/SKILL.md +602 -602
- package/skills/test/SKILL.tmpl +44 -44
- package/steps/capture-lesson.md +44 -44
- package/steps/context-loader.md +174 -174
- 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 +106 -231
- package/templates/product-definition.template.md +101 -88
|
@@ -1,149 +1,149 @@
|
|
|
1
1
|
# /review-tech-docs — Review Technical Design Document
|
|
2
2
|
|
|
3
|
-
**READ-ONLY
|
|
4
|
-
**
|
|
3
|
+
**Chế độ phân tích READ-ONLY — ghi file findings, KHÔNG sửa target.**
|
|
4
|
+
**Dùng `--resume` để áp dụng các finding được chấp nhận.**
|
|
5
5
|
|
|
6
6
|
## Gate
|
|
7
|
-
# Gate —
|
|
7
|
+
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
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ó.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
14
14
|
|
|
15
|
-
1.
|
|
16
|
-
2.
|
|
17
|
-
- **
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
3.
|
|
15
|
+
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
16
|
+
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
17
|
+
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
18
|
+
- Đặt target file = `payload.target_file`
|
|
19
|
+
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
20
|
+
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
21
|
+
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
22
|
+
- Đi thẳng tới phần logic riêng của lệnh.
|
|
23
|
+
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## Bước 0-B — Kiểm tra Model
|
|
26
26
|
|
|
27
|
-
*
|
|
27
|
+
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
28
28
|
|
|
29
|
-
|
|
30
|
-
|
|
29
|
+
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.
|
|
30
|
+
Dùng model nhỏ hơn sẽ rủi ro: bỏ sót edge case, phân tích spec thiếu sót, vi phạm kiến trúc.
|
|
31
31
|
|
|
32
|
-
|
|
32
|
+
Hiển thị và chờ phản hồi:
|
|
33
33
|
|
|
34
34
|
```
|
|
35
35
|
⚙️ MODEL CHECK
|
|
36
36
|
──────────────────────────────────────────────────────────────────
|
|
37
|
-
Recommended : claude-opus-4 (
|
|
38
|
-
Why needed :
|
|
39
|
-
|
|
37
|
+
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
38
|
+
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
39
|
+
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
40
40
|
|
|
41
|
-
|
|
42
|
-
• Settings → Model →
|
|
43
|
-
•
|
|
41
|
+
Cách đổi trong Claude Code:
|
|
42
|
+
• Settings → Model → chọn "claude-opus"
|
|
43
|
+
• hoặc: /model → chọn claude-opus
|
|
44
44
|
|
|
45
|
-
|
|
46
|
-
Y —
|
|
47
|
-
S —
|
|
45
|
+
Đang chạy claude-opus?
|
|
46
|
+
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
47
|
+
S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
|
|
48
48
|
──────────────────────────────────────────────────────────────────
|
|
49
49
|
```
|
|
50
50
|
|
|
51
|
-
- "Y" →
|
|
52
|
-
- "S" →
|
|
53
|
-
- "N"
|
|
51
|
+
- "Y" → tiếp tục sang Bước 1.
|
|
52
|
+
- "S" → tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
|
|
53
|
+
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang claude-opus rồi chạy lại lệnh này."
|
|
54
54
|
|
|
55
|
-
##
|
|
55
|
+
## Bước 1 — Xác định Target File
|
|
56
56
|
|
|
57
|
-
1.
|
|
58
|
-
2.
|
|
59
|
-
- **BDD
|
|
60
|
-
- **PRD
|
|
61
|
-
- **tech-docs
|
|
62
|
-
- **design-spec
|
|
57
|
+
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.
|
|
58
|
+
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/`):
|
|
59
|
+
- **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 đó.
|
|
60
|
+
- **Lệnh PRD** (target là `prd.md`): `{specs_dir}/{domain}/*/prd.md` (khớp feature folder có id tương ứng), nếu không thì `{specs_dir}/*/*/prd.md`.
|
|
61
|
+
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
62
|
+
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
63
63
|
|
|
64
|
-
|
|
65
|
-
3.
|
|
66
|
-
-
|
|
67
|
-
-
|
|
68
|
-
-
|
|
64
|
+
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.
|
|
65
|
+
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
66
|
+
- Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/prd.md` cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
|
|
67
|
+
- 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)"
|
|
68
|
+
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
69
69
|
|
|
70
|
-
##
|
|
70
|
+
## Bước 2 — Chạy Context Loader
|
|
71
71
|
|
|
72
|
-
|
|
73
|
-
|
|
72
|
+
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`.
|
|
73
|
+
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.
|
|
74
74
|
|
|
75
|
-
##
|
|
75
|
+
## Bước 3 — CHECKPOINT
|
|
76
76
|
|
|
77
|
-
|
|
77
|
+
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:
|
|
78
78
|
|
|
79
79
|
```
|
|
80
80
|
CHECKPOINT
|
|
81
81
|
-----------
|
|
82
82
|
Target : {resolved file path}
|
|
83
|
-
Project : {project.name
|
|
83
|
+
Project : {project.name từ project-context.yaml}
|
|
84
84
|
Tech stack : {language} / {framework}
|
|
85
|
-
Module : {module
|
|
86
|
-
Domains : {
|
|
85
|
+
Module : {module nếu có, else "not configured"}
|
|
86
|
+
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
87
87
|
|
|
88
|
-
|
|
88
|
+
Tiếp tục? (Y/N)
|
|
89
89
|
```
|
|
90
90
|
|
|
91
|
-
|
|
92
|
-
- "Y" →
|
|
93
|
-
- "N" →
|
|
91
|
+
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
92
|
+
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
93
|
+
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
94
94
|
|
|
95
95
|
|
|
96
|
-
*
|
|
97
|
-
|
|
96
|
+
*Lưu ý: Với lệnh này, target ở Bước 1 là một file tech-design `.md` trong `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/`.
|
|
97
|
+
Nếu `$ARGUMENTS` chứa `--resume` → bỏ qua sang Resume Mode bên dưới.*
|
|
98
98
|
|
|
99
99
|
## Context
|
|
100
|
-
# Context Loader —
|
|
100
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
101
101
|
|
|
102
|
-
|
|
102
|
+
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.
|
|
103
103
|
|
|
104
|
-
**
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
104
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
105
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
106
|
+
- 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.
|
|
107
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
108
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
109
|
+
- 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.
|
|
110
110
|
|
|
111
111
|
---
|
|
112
112
|
|
|
113
|
-
##
|
|
113
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
116
116
|
|
|
117
117
|
**Tech Stack:**
|
|
118
|
-
- `tech_stack.language` →
|
|
119
|
-
- `tech_stack.framework` →
|
|
120
|
-
- `tech_stack.build_tool` → build tool (
|
|
121
|
-
- `tech_stack.test_framework` → test framework (
|
|
122
|
-
- `tech_stack.database` → database (
|
|
123
|
-
- `tech_stack.module` →
|
|
118
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
119
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
120
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
121
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
122
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
123
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
124
124
|
|
|
125
125
|
**Conventions:**
|
|
126
|
-
- `conventions.build_command` →
|
|
127
|
-
- `conventions.test_command` →
|
|
128
|
-
- `conventions.service_run` →
|
|
129
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
126
|
+
- `conventions.build_command` → cách compile/build
|
|
127
|
+
- `conventions.test_command` → cách chạy test
|
|
128
|
+
- `conventions.service_run` → cách khởi động service
|
|
129
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
130
130
|
|
|
131
131
|
**Domains:**
|
|
132
|
-
- `domains` →
|
|
133
|
-
|
|
134
|
-
**Paths (
|
|
135
|
-
- `paths.specs_dir` → spec
|
|
136
|
-
- `paths.refinement_dir` → findings/review
|
|
137
|
-
- `paths.qc_dir` → QC automation
|
|
138
|
-
- `paths.qc_skills_dir` →
|
|
139
|
-
- `paths.product_definitions_dir` → product
|
|
140
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
141
|
-
- `paths.business_dictionary` → path
|
|
142
|
-
- `paths.core_entities` → path
|
|
143
|
-
- `paths.tech_docs_dir` →
|
|
144
|
-
- `paths.trace_dir` →
|
|
145
|
-
|
|
146
|
-
|
|
132
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
133
|
+
|
|
134
|
+
**Paths (nếu có):**
|
|
135
|
+
- `paths.specs_dir` → gốc của spec artifact — PRD, BDD, tech-docs, design-spec. Cấu trúc: `{specs_dir}/{domain}/{prd-slug}/{prd.md | bdd/ | tech-docs/ | design-spec/}`
|
|
136
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
137
|
+
- `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}/`)
|
|
138
|
+
- `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 đè)
|
|
139
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
140
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
141
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
142
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
143
|
+
- `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/`)
|
|
144
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
145
|
+
|
|
146
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
147
147
|
- `specs_dir` = `specs`
|
|
148
148
|
- `refinement_dir` = `.agent/review`
|
|
149
149
|
- `qc_dir` = `docs`
|
|
@@ -155,184 +155,184 @@ If `paths` section is absent, use these defaults:
|
|
|
155
155
|
- `tech_docs_dir` = `specs`
|
|
156
156
|
- `trace_dir` = `.trace`
|
|
157
157
|
|
|
158
|
-
|
|
158
|
+
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.
|
|
159
159
|
|
|
160
|
-
**
|
|
160
|
+
**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ụ:
|
|
161
161
|
- `specs/payment/create-invoice/prd.md` → `prd_slug = create-invoice`
|
|
162
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
163
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
164
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
162
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
163
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
164
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
165
165
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
166
166
|
|
|
167
|
-
|
|
167
|
+
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ừ đó.
|
|
168
168
|
|
|
169
|
-
|
|
169
|
+
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.
|
|
170
170
|
|
|
171
171
|
---
|
|
172
172
|
|
|
173
|
-
##
|
|
173
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
174
174
|
|
|
175
|
-
*
|
|
175
|
+
*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.*
|
|
176
176
|
|
|
177
|
-
|
|
177
|
+
Nếu có section `services`:
|
|
178
178
|
|
|
179
|
-
**1.
|
|
180
|
-
-
|
|
181
|
-
-
|
|
182
|
-
*(
|
|
183
|
-
-
|
|
179
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
180
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
181
|
+
- 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.
|
|
182
|
+
*(vd: `specs/user/create-account/prd.md` **và** `specs/user/create-account/bdd/system/UC1.feature` đều → domain = `user`, prd_slug = `create-account`)*
|
|
183
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
184
184
|
|
|
185
|
-
**2. Route
|
|
186
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
187
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
188
|
-
-
|
|
189
|
-
-
|
|
190
|
-
-
|
|
185
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
186
|
+
- 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.
|
|
187
|
+
- 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.
|
|
188
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
189
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
190
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
191
191
|
|
|
192
|
-
**3. Fallback** —
|
|
193
|
-
-
|
|
194
|
-
-
|
|
192
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
193
|
+
- Giữ path mặc định từ Bước 1
|
|
194
|
+
- Đặt `active_service = unresolved`
|
|
195
195
|
|
|
196
|
-
**4.
|
|
197
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
198
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
196
|
+
**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:`:
|
|
197
|
+
- 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`.)*
|
|
198
|
+
- 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.)*
|
|
199
199
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
200
200
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
201
201
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
202
202
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
203
203
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
204
204
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
205
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
205
|
+
- 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`.)*
|
|
206
206
|
|
|
207
|
-
> **
|
|
207
|
+
> **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.
|
|
208
208
|
|
|
209
209
|
---
|
|
210
210
|
|
|
211
|
-
##
|
|
211
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
212
212
|
|
|
213
|
-
*
|
|
213
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
214
214
|
|
|
215
|
-
|
|
215
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
216
216
|
|
|
217
|
-
**1.
|
|
217
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
218
218
|
- `{active_service}/.agent/project-context.yaml`
|
|
219
219
|
- `{active_service}/project-context.yaml`
|
|
220
220
|
|
|
221
|
-
**2.
|
|
221
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
222
222
|
|
|
223
|
-
|
|
|
223
|
+
| Biến | Nguồn |
|
|
224
224
|
|----------|--------|
|
|
225
|
-
| `conventions.test_command` |
|
|
226
|
-
| `conventions.build_command` |
|
|
227
|
-
| `paths.trace_dir` | **
|
|
228
|
-
| `paths.specs_dir` | **
|
|
225
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
226
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
227
|
+
| `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`). |
|
|
228
|
+
| `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. |
|
|
229
229
|
|
|
230
|
-
**3.
|
|
231
|
-
-
|
|
232
|
-
- **
|
|
230
|
+
**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:
|
|
231
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
232
|
+
- **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/`).
|
|
233
233
|
|
|
234
|
-
**4.
|
|
234
|
+
**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).
|
|
235
235
|
|
|
236
236
|
---
|
|
237
237
|
|
|
238
|
-
##
|
|
238
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
239
239
|
|
|
240
|
-
|
|
241
|
-
Merge framework
|
|
242
|
-
|
|
240
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
241
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
242
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
243
243
|
|
|
244
244
|
---
|
|
245
245
|
|
|
246
|
-
##
|
|
246
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
247
247
|
|
|
248
|
-
|
|
248
|
+
*Đâ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.*
|
|
249
249
|
|
|
250
|
-
CLAUDE.md
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
250
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
251
|
+
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
|
|
252
|
+
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
|
|
253
|
+
service phải thắng khi sinh code.
|
|
254
254
|
|
|
255
|
-
**
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
255
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
256
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
257
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
258
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
259
259
|
|
|
260
|
-
**
|
|
261
|
-
*
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
Overlay
|
|
265
|
-
coding standards,
|
|
266
|
-
(
|
|
260
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
261
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
262
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
263
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
264
|
+
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,
|
|
265
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
266
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
267
267
|
|
|
268
|
-
|
|
268
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
269
269
|
|
|
270
|
-
- **§1 Project Overview** →
|
|
271
|
-
- **§2 Architecture** → layer
|
|
272
|
-
- **§3 Coding Standards** →
|
|
273
|
-
- **§5 Error Handling** → exception
|
|
274
|
-
- **§7 Git Conventions** →
|
|
270
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
271
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
272
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
273
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
274
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
275
275
|
|
|
276
|
-
**
|
|
277
|
-
-
|
|
278
|
-
-
|
|
279
|
-
-
|
|
280
|
-
-
|
|
276
|
+
**Quy tắc phân giải:**
|
|
277
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
278
|
+
- 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}`.
|
|
279
|
+
- 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).
|
|
280
|
+
- 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.
|
|
281
281
|
|
|
282
282
|
---
|
|
283
283
|
|
|
284
|
-
##
|
|
284
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
285
285
|
|
|
286
|
-
|
|
286
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
287
287
|
|
|
288
|
-
|
|
288
|
+
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.
|
|
289
289
|
|
|
290
|
-
|
|
290
|
+
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*`.
|
|
291
291
|
|
|
292
292
|
---
|
|
293
293
|
|
|
294
|
-
##
|
|
294
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
295
295
|
|
|
296
|
-
|
|
296
|
+
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).
|
|
297
297
|
|
|
298
|
-
|
|
299
|
-
- **Canonical Terms** →
|
|
300
|
-
- **Banned Terms** →
|
|
301
|
-
- **Status / Enum Registry** →
|
|
298
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
299
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
300
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
301
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
302
302
|
|
|
303
|
-
|
|
304
|
-
-
|
|
305
|
-
-
|
|
303
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
304
|
+
- 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
|
|
305
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
306
306
|
|
|
307
|
-
|
|
307
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
308
308
|
|
|
309
309
|
---
|
|
310
310
|
|
|
311
|
-
##
|
|
311
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
312
312
|
|
|
313
|
-
|
|
314
|
-
|
|
313
|
+
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).
|
|
314
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
315
315
|
|
|
316
|
-
|
|
317
|
-
- **Entity catalog** →
|
|
318
|
-
- **Field name registry** →
|
|
319
|
-
- **Relationship map** →
|
|
316
|
+
Nếu tồn tại, đọc và lưu:
|
|
317
|
+
- **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ệ
|
|
318
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
319
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
320
320
|
|
|
321
|
-
**
|
|
322
|
-
-
|
|
323
|
-
-
|
|
324
|
-
-
|
|
321
|
+
**Cách dùng catalog này:**
|
|
322
|
+
- 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
|
|
323
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
324
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
325
325
|
|
|
326
|
-
|
|
326
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
327
327
|
|
|
328
328
|
---
|
|
329
329
|
|
|
330
|
-
##
|
|
330
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
331
331
|
|
|
332
|
-
|
|
332
|
+
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:
|
|
333
333
|
|
|
334
334
|
```
|
|
335
|
-
active_module = tech_stack.module (
|
|
335
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
336
336
|
```
|
|
337
337
|
|
|
338
338
|
| `platform_type` | Modules |
|
|
@@ -341,239 +341,239 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
341
341
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
342
342
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
343
343
|
|
|
344
|
-
|
|
344
|
+
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.
|
|
345
345
|
|
|
346
|
-
|
|
346
|
+
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).
|
|
347
347
|
|
|
348
348
|
---
|
|
349
349
|
|
|
350
|
-
##
|
|
350
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
351
351
|
|
|
352
|
-
*
|
|
353
|
-
|
|
352
|
+
*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`
|
|
353
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
354
354
|
|
|
355
|
-
|
|
356
|
-
-
|
|
357
|
-
- Else
|
|
358
|
-
-
|
|
355
|
+
Phân giải path file lessons:
|
|
356
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
357
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
358
|
+
- Ở 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`
|
|
359
359
|
|
|
360
|
-
|
|
361
|
-
-
|
|
362
|
-
-
|
|
363
|
-
-
|
|
360
|
+
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:
|
|
361
|
+
- 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).
|
|
362
|
+
- 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).
|
|
363
|
+
- 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.
|
|
364
364
|
|
|
365
|
-
|
|
365
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
366
366
|
|
|
367
367
|
---
|
|
368
368
|
|
|
369
|
-
##
|
|
369
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
370
370
|
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
(recency
|
|
371
|
+
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.
|
|
372
|
+
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
|
|
373
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
374
374
|
|
|
375
|
-
|
|
375
|
+
Xuất đúng khối này:
|
|
376
376
|
```
|
|
377
377
|
[CTX LOADED]
|
|
378
378
|
Stack : {language} / {framework} / {database}
|
|
379
379
|
Platform : {active_module} ({platform_type})
|
|
380
|
-
Layers : {
|
|
381
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
380
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
381
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
382
382
|
Ticket : {ticket_prefix}-
|
|
383
383
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
384
384
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
385
|
-
Lessons : {loaded — N guardrails |
|
|
385
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
386
386
|
Service : {active_service} ({active_service_module}) | single-service
|
|
387
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
388
|
-
Status : {FULL | PARTIAL —
|
|
387
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
388
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
389
389
|
```
|
|
390
390
|
|
|
391
|
-
|
|
391
|
+
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.
|
|
392
392
|
|
|
393
393
|
---
|
|
394
394
|
|
|
395
|
-
##
|
|
395
|
+
## Hoàn tất nạp Context
|
|
396
396
|
|
|
397
|
-
|
|
398
|
-
-
|
|
399
|
-
-
|
|
400
|
-
- Coding standards
|
|
401
|
-
-
|
|
402
|
-
-
|
|
403
|
-
- Entity catalog (field
|
|
404
|
-
-
|
|
397
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
398
|
+
- Định danh dự án, tech stack, convention module
|
|
399
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
400
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
401
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
402
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
403
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
404
|
+
- Toàn bộ path đã cấu hình
|
|
405
405
|
|
|
406
|
-
|
|
406
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
407
407
|
|
|
408
408
|
|
|
409
409
|
---
|
|
410
410
|
|
|
411
|
-
##
|
|
411
|
+
## Nạp tài liệu Review
|
|
412
412
|
|
|
413
|
-
|
|
413
|
+
Sau khi nạp context nền, đọc các thứ sau theo thứ tự:
|
|
414
414
|
|
|
415
|
-
1. **
|
|
415
|
+
1. **Tech-doc target** — đọc đầy đủ. Trích từ header:
|
|
416
416
|
- `@trace.id` → UC-ID
|
|
417
417
|
- `@trace.domain` → domain
|
|
418
|
-
- `@trace.prd` →
|
|
419
|
-
- `@trace.status` →
|
|
418
|
+
- `@trace.prd` → ticket ID của PRD nguồn
|
|
419
|
+
- `@trace.status` → status hiện tại (draft / in-review / approved)
|
|
420
420
|
|
|
421
|
-
2. **
|
|
421
|
+
2. **File feature nguồn** — nạp `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{UC-ID}*.feature` nếu tồn tại.
|
|
422
422
|
|
|
423
|
-
3. **
|
|
424
|
-
`{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/`
|
|
423
|
+
3. **Các tech-doc khác cùng domain** — liệt kê và nạp mọi file `.md` trong
|
|
424
|
+
`{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/` trừ target. Dùng để check conflict (T4).
|
|
425
425
|
|
|
426
|
-
4. **
|
|
426
|
+
4. **Tham chiếu kiến trúc** — xác nhận lại CLAUDE.md §2: thứ tự layer, quy tắc kiến trúc.
|
|
427
427
|
|
|
428
|
-
5. **Core entities** —
|
|
428
|
+
5. **Core entities** — đã nạp trong context (Bước 6 của context-loader).
|
|
429
429
|
|
|
430
|
-
|
|
430
|
+
Suy ra tên file findings:
|
|
431
431
|
`{paths.refinement_dir}/{uc-id}-tech-review-findings.yaml`
|
|
432
432
|
|
|
433
433
|
---
|
|
434
434
|
|
|
435
435
|
## Review Dimensions
|
|
436
436
|
|
|
437
|
-
### T1 — Architecture Alignment *(
|
|
437
|
+
### T1 — Architecture Alignment *(luôn CRITICAL nếu vi phạm)*
|
|
438
438
|
|
|
439
|
-
|
|
439
|
+
Đối chiếu design đề xuất với quy tắc CLAUDE.md §2:
|
|
440
440
|
|
|
441
|
-
|
|
|
441
|
+
| Loại vi phạm | Severity |
|
|
442
442
|
|----------------|----------|
|
|
443
|
-
| Controller
|
|
444
|
-
| Business logic
|
|
445
|
-
|
|
|
446
|
-
|
|
|
447
|
-
|
|
|
448
|
-
|
|
|
449
|
-
|
|
450
|
-
|
|
443
|
+
| Controller gọi Repository trực tiếp (skip layer) | Critical |
|
|
444
|
+
| Business logic trong Controller hoặc DTO | Critical |
|
|
445
|
+
| Pattern bị cấm từ §3 | Critical |
|
|
446
|
+
| Phụ thuộc đi ngược upstream (Service → Controller DTO) | Critical |
|
|
447
|
+
| Annotation transaction sai layer | Major |
|
|
448
|
+
| Thiếu tách lớp (không có Facade khi kiến trúc yêu cầu) | Major |
|
|
449
|
+
|
|
450
|
+
Với mỗi finding:
|
|
451
451
|
```
|
|
452
|
-
Component: {class
|
|
452
|
+
Component: {tên class hoặc method}
|
|
453
453
|
Violates: "{rule text}" (CLAUDE.md §2)
|
|
454
|
-
Fix: {
|
|
454
|
+
Fix: {layer/component nào nên sở hữu cái này}
|
|
455
455
|
```
|
|
456
|
-
→ **
|
|
456
|
+
→ **Không auto-fix.** Người phải quyết định fix cấu trúc. Bắt buộc note trong Review Board.
|
|
457
457
|
|
|
458
458
|
### T2 — Entity Consistency
|
|
459
459
|
|
|
460
|
-
|
|
460
|
+
Dùng catalog core-entities đã nạp:
|
|
461
461
|
|
|
462
|
-
|
|
|
462
|
+
| Vấn đề | Severity | Auto-fixable? |
|
|
463
463
|
|-------|----------|---------------|
|
|
464
|
-
| Entity
|
|
465
|
-
|
|
|
466
|
-
|
|
|
467
|
-
|
|
|
464
|
+
| Entity được nhắc nhưng không có trong core-entities.md | Major | No — người confirm là DTO hay domain entity |
|
|
465
|
+
| Tên field khác core-entities.md | Major | Yes — đổi về canonical |
|
|
466
|
+
| Quan hệ được mô tả khác đi | Major | No — người quyết định |
|
|
467
|
+
| Entity mới được đưa ra nhưng chưa có trong core-entities.md | Minor | No — thêm vào core-entities trước |
|
|
468
468
|
|
|
469
469
|
### T3 — BDD Traceability
|
|
470
470
|
|
|
471
|
-
|
|
471
|
+
Đối chiếu với file `.feature` nguồn:
|
|
472
472
|
|
|
473
|
-
|
|
|
473
|
+
| Vấn đề | Severity | Auto-fixable? |
|
|
474
474
|
|-------|----------|---------------|
|
|
475
|
-
| Tech-doc
|
|
476
|
-
| Tech-doc
|
|
477
|
-
| UC
|
|
475
|
+
| Tech-doc đề xuất behavior không có trong scenario BDD nào | Major | No — tạo scenario trước |
|
|
476
|
+
| Tech-doc mâu thuẫn một scenario BDD | Critical | No — giải quyết conflict trước |
|
|
477
|
+
| Scenario UC không có design decision tương ứng | Minor | Yes — thêm design note còn thiếu |
|
|
478
478
|
|
|
479
479
|
### T4 — Domain Conflict Check
|
|
480
480
|
|
|
481
|
-
|
|
481
|
+
So với các tech-doc khác trong `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/`:
|
|
482
482
|
|
|
483
|
-
|
|
|
483
|
+
| Vấn đề | Severity | Auto-fixable? |
|
|
484
484
|
|-------|----------|---------------|
|
|
485
|
-
|
|
|
486
|
-
|
|
|
487
|
-
|
|
|
488
|
-
|
|
|
485
|
+
| Cùng endpoint định nghĩa với request/response khác | Critical | No — người giải quyết |
|
|
486
|
+
| Cùng service method với behavior khác | Critical | No — người giải quyết |
|
|
487
|
+
| Status transition của entity khác nhau giữa các doc | Critical | No — người giải quyết |
|
|
488
|
+
| Trách nhiệm chồng lấn (cả hai doc nhận sở hữu cùng logic) | Major | No — người giải quyết |
|
|
489
489
|
|
|
490
490
|
### T5 — Internal Consistency
|
|
491
491
|
|
|
492
|
-
|
|
492
|
+
Trong nội bộ tech-doc:
|
|
493
493
|
|
|
494
494
|
| Check | Severity | Auto-fixable? |
|
|
495
495
|
|-------|----------|---------------|
|
|
496
|
-
| Sequence diagram
|
|
497
|
-
| API spec return type
|
|
498
|
-
| Section
|
|
499
|
-
| Assumption
|
|
496
|
+
| Sequence diagram thể hiện flow khác phần mô tả viết | Major | No |
|
|
497
|
+
| API spec return type khác code sketch | Major | Yes — căn chỉnh cái này theo cái kia |
|
|
498
|
+
| Section tham chiếu một component/concept không bao giờ được định nghĩa sau đó | Minor | Yes — thêm định nghĩa |
|
|
499
|
+
| Assumption được nêu nhưng không design nào xử lý nó | Minor | Yes — thêm note hoặc bỏ assumption |
|
|
500
500
|
|
|
501
501
|
### T6 — Structural Completeness
|
|
502
502
|
|
|
503
|
-
|
|
503
|
+
Kiểm tra tất cả section chuẩn có mặt và không rỗng:
|
|
504
504
|
|
|
505
505
|
| Section | Missing severity |
|
|
506
506
|
|---------|-----------------|
|
|
507
507
|
| Header (`@trace.id`, `@trace.prd`, `@trace.domain`, `@trace.status`) | Major |
|
|
508
508
|
| Overview / Context | Major |
|
|
509
|
-
| Architecture Decision
|
|
510
|
-
| Component Diagram
|
|
511
|
-
| Sequence Diagram
|
|
512
|
-
| API Contract (
|
|
513
|
-
| Data Model Changes (
|
|
509
|
+
| Architecture Decision kèm lý do | Major |
|
|
510
|
+
| Component Diagram hoặc Layer Description | Major |
|
|
511
|
+
| Sequence Diagram hoặc Flow Steps | Major |
|
|
512
|
+
| API Contract (nếu hướng HTTP) | Major |
|
|
513
|
+
| Data Model Changes (nếu entity đổi) | Major |
|
|
514
514
|
| Error Handling Strategy | Major |
|
|
515
515
|
| Open Questions / Assumptions | Minor |
|
|
516
516
|
|
|
517
|
-
→
|
|
517
|
+
→ Mọi finding section-thiếu T6 đều **auto-fixable**: AI thêm skeleton section kèm prompt.
|
|
518
518
|
|
|
519
519
|
### T7 — Cross-Team API Contract Review
|
|
520
520
|
|
|
521
|
-
*
|
|
522
|
-
*1.
|
|
523
|
-
*2.
|
|
521
|
+
*Chỉ áp dụng khi TẤT CẢ điều sau đúng:*
|
|
522
|
+
*1. BDD nguồn có `@trace.platform: system`.*
|
|
523
|
+
*2. Header tech-doc KHÔNG có `@trace.api_source: existing`.*
|
|
524
524
|
|
|
525
|
-
*
|
|
525
|
+
*Nếu `@trace.api_source: existing` → **skip T7 hoàn toàn**. Contract đã được PO xác định trong PRD — không có API design mới để đồng thuận.*
|
|
526
526
|
|
|
527
|
-
|
|
527
|
+
Dimension này đảm bảo team FE, App, và BE đều đồng thuận API contract trước khi bắt đầu implement.
|
|
528
528
|
|
|
529
|
-
**Step 1 — Check sign-off
|
|
529
|
+
**Step 1 — Check status sign-off trong header tech-doc:**
|
|
530
530
|
|
|
531
|
-
|
|
531
|
+
Đọc block `@trace.sign_off` trong header tech doc. Nếu vắng → thêm như một finding (auto-fixable: thêm skeleton).
|
|
532
532
|
|
|
533
533
|
```yaml
|
|
534
534
|
# @trace.sign_off:
|
|
535
|
-
# be_team: pending # author — set
|
|
536
|
-
# fe_team: pending # FE/Web —
|
|
537
|
-
# app_team: pending # App —
|
|
538
|
-
# sa: pending # SA/Tech Lead —
|
|
535
|
+
# be_team: pending # author — set "done" khi BE hài lòng với design
|
|
536
|
+
# fe_team: pending # FE/Web — phải confirm contract khớp expectation của web BDD
|
|
537
|
+
# app_team: pending # App — phải confirm contract khớp expectation của app BDD (nếu áp dụng)
|
|
538
|
+
# sa: pending # SA/Tech Lead — approval cuối
|
|
539
539
|
```
|
|
540
540
|
|
|
541
541
|
**Step 2 — Contract vs BDD cross-check:**
|
|
542
542
|
|
|
543
|
-
|
|
543
|
+
Nạp web và app BDD cho TICKET-ID này (từ `{paths.specs_dir}/{domain}/{prd-slug}/bdd/web/` và `{paths.specs_dir}/{domain}/{prd-slug}/bdd/app/` trong spec submodule hoặc spec repo).
|
|
544
544
|
|
|
545
|
-
|
|
545
|
+
Với mỗi platform BDD, kiểm tra API contract của tech doc có thoả các mệnh đề `Then` của BDD không:
|
|
546
546
|
|
|
547
547
|
| Check | Severity |
|
|
548
548
|
|---|---|
|
|
549
|
-
|
|
|
550
|
-
|
|
|
551
|
-
|
|
|
552
|
-
|
|
|
549
|
+
| Field response trong API contract không phủ những gì web BDD `Then` mong | Critical |
|
|
550
|
+
| Field response trong API contract không phủ những gì app BDD `Then` mong | Critical |
|
|
551
|
+
| Shape error response không khớp những gì các platform BDD mong | Major |
|
|
552
|
+
| Annotation `@system.resolution` của System BDD mâu thuẫn với design API contract | Critical |
|
|
553
553
|
|
|
554
|
-
**Step 3 —
|
|
554
|
+
**Step 3 — Report sign-off pending:**
|
|
555
555
|
|
|
556
|
-
|
|
556
|
+
Sau review, liệt kê các sign-off còn `pending`:
|
|
557
557
|
|
|
558
558
|
```
|
|
559
|
-
⏳
|
|
560
|
-
fe_team — FE/Web
|
|
561
|
-
app_team — App
|
|
562
|
-
sa — SA/Tech Lead
|
|
559
|
+
⏳ Sign-off pending trước khi tech docs được approve:
|
|
560
|
+
fe_team — team FE/Web phải confirm API contract khớp expectation web BDD
|
|
561
|
+
app_team — team App phải confirm API contract khớp expectation app BDD
|
|
562
|
+
sa — SA/Tech Lead approval cuối
|
|
563
563
|
|
|
564
|
-
|
|
565
|
-
Tech docs
|
|
564
|
+
Khi thu đủ sign-off → cập nhật @trace.sign_off trong header tech doc, rồi chạy lại /review-tech-docs.
|
|
565
|
+
Tech docs không thể set "approved" khi còn bất kỳ sign-off bắt buộc nào pending.
|
|
566
566
|
```
|
|
567
567
|
|
|
568
568
|
**Approval gate:**
|
|
569
|
-
-
|
|
570
|
-
-
|
|
569
|
+
- Nếu `be_team: done` VÀ `fe_team: done` VÀ `app_team: done` (hoặc N/A) VÀ `sa: done` → tech docs có thể set `approved`
|
|
570
|
+
- Ngược lại → `@trace.status` giữ `in-review` — `generate-code` bị chặn
|
|
571
571
|
|
|
572
572
|
---
|
|
573
573
|
|
|
574
|
-
##
|
|
574
|
+
## Ghi File Findings
|
|
575
575
|
|
|
576
|
-
|
|
576
|
+
Sau khi chạy hết các check, ghi findings vào `{paths.refinement_dir}/{uc-id}-tech-review-findings.yaml`:
|
|
577
577
|
|
|
578
578
|
```yaml
|
|
579
579
|
source_file: "{absolute path to tech-doc}"
|
|
@@ -582,25 +582,25 @@ domain: "{domain}"
|
|
|
582
582
|
generated_at: "{ISO datetime}"
|
|
583
583
|
review_type: "tech-design"
|
|
584
584
|
status: "pending_review"
|
|
585
|
-
is_system_bdd: {true | false} # true
|
|
585
|
+
is_system_bdd: {true | false} # true nếu BDD nguồn có @trace.platform: system
|
|
586
586
|
|
|
587
|
-
sign_off: #
|
|
588
|
-
be_team: pending #
|
|
587
|
+
sign_off: # chỉ có khi is_system_bdd: true
|
|
588
|
+
be_team: pending # đọc từ @trace.sign_off trong header tech-doc
|
|
589
589
|
fe_team: pending
|
|
590
|
-
app_team: pending # "n/a"
|
|
590
|
+
app_team: pending # "n/a" nếu dự án không có platform app
|
|
591
591
|
sa: pending
|
|
592
|
-
sign_off_gate: blocked # blocked | ready — "ready"
|
|
592
|
+
sign_off_gate: blocked # blocked | ready — "ready" chỉ khi tất cả bắt buộc là "done"
|
|
593
593
|
|
|
594
594
|
findings:
|
|
595
595
|
- id: "F001"
|
|
596
596
|
check_id: "T1" # T1–T7
|
|
597
597
|
severity: "critical" # critical | major | minor
|
|
598
|
-
section: "{section heading
|
|
599
|
-
uc_id: "{UC-ID}" #
|
|
600
|
-
quote: "{
|
|
601
|
-
finding: "{
|
|
602
|
-
suggestion: "{
|
|
603
|
-
auto_fixable: false # true = AI
|
|
598
|
+
section: "{section heading hoặc tên component nơi tìm thấy lỗi}"
|
|
599
|
+
uc_id: "{UC-ID}" # giống uc_id top-level (UC mà tech-doc này thiết kế)
|
|
600
|
+
quote: "{trích đoạn nguyên văn copy CHÍNH XÁC từ tech-doc tại vị trí lỗi, ≤120 ký tự}"
|
|
601
|
+
finding: "{mô tả rõ ràng vi phạm hoặc gap}"
|
|
602
|
+
suggestion: "{bản fix cụ thể — AI áp dụng khi --resume nếu được chấp nhận}"
|
|
603
|
+
auto_fixable: false # true = AI áp dụng được; false = người phải ghi quyết định trong note
|
|
604
604
|
status: "pending" # pending | accepted | modified | rejected | deferred
|
|
605
605
|
|
|
606
606
|
summary:
|
|
@@ -612,45 +612,45 @@ summary:
|
|
|
612
612
|
sign_off_gate: "{blocked — pending: fe_team, app_team, sa | ready}"
|
|
613
613
|
```
|
|
614
614
|
|
|
615
|
-
> **
|
|
616
|
-
>
|
|
617
|
-
>
|
|
618
|
-
>
|
|
615
|
+
> **Field định vị (`quote` + `uc_id`) — bắt buộc cho source-jump của Review Board.**
|
|
616
|
+
> Với mỗi finding, copy một đoạn `quote` **nguyên văn** thẳng từ tech-doc tại đúng chỗ
|
|
617
|
+
> 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.
|
|
618
|
+
> Field này cho phép reviewer click một finding trong Review Board và nhảy tới đúng vị trí nguồn.
|
|
619
619
|
|
|
620
620
|
## Report
|
|
621
621
|
|
|
622
|
-
# Report Footer —
|
|
622
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
623
623
|
|
|
624
|
-
|
|
624
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
625
625
|
|
|
626
626
|
## Status Badge
|
|
627
627
|
|
|
628
|
-
|
|
629
|
-
- `✅ Complete` —
|
|
630
|
-
- `❌ Failed` —
|
|
631
|
-
- `⚠️ Warnings` —
|
|
628
|
+
Chọn một theo kết quả:
|
|
629
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
630
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
631
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
632
632
|
|
|
633
633
|
## Output Artifacts
|
|
634
634
|
|
|
635
|
-
|
|
635
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
636
636
|
```
|
|
637
637
|
Output Artifacts:
|
|
638
|
-
{created|updated} {file-path} ({
|
|
639
|
-
{created|updated} {file-path} ({
|
|
638
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
639
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
640
640
|
```
|
|
641
641
|
|
|
642
|
-
|
|
642
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
643
643
|
|
|
644
644
|
## Pipeline Position
|
|
645
645
|
|
|
646
|
-
|
|
647
|
-
|
|
646
|
+
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`,
|
|
647
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
648
648
|
|
|
649
649
|
```
|
|
650
650
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
651
651
|
```
|
|
652
652
|
|
|
653
|
-
|
|
653
|
+
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:
|
|
654
654
|
|
|
655
655
|
| Phase | Commands |
|
|
656
656
|
|-------|----------|
|
|
@@ -664,130 +664,130 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
664
664
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
665
665
|
| Trace Audit | `/validate-traces` |
|
|
666
666
|
|
|
667
|
-
|
|
667
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
668
668
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
669
669
|
|
|
670
|
-
**
|
|
671
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
672
|
-
**
|
|
670
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
671
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
672
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
673
673
|
|
|
674
|
-
##
|
|
674
|
+
## Gợi ý lệnh tiếp theo
|
|
675
675
|
|
|
676
|
-
|
|
676
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
677
677
|
|
|
678
|
-
|
|
|
678
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
679
679
|
|-------------------------|-----------------------------------------------|
|
|
680
|
-
| /setup-ai-first | `/define-product`
|
|
680
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
681
681
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
682
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
683
|
-
| /refine-prd |
|
|
684
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
685
|
-
| /generate-design-spec | Designer review →
|
|
686
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
687
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
688
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
682
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
683
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
684
|
+
| /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 |
|
|
685
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
686
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
687
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
688
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
689
689
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
690
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
691
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
692
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
693
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
694
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
690
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
691
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
692
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
693
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
694
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
695
695
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
696
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
697
|
-
| /generate-code |
|
|
696
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
697
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
698
698
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
699
699
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
700
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
701
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
702
|
-
| /dev-smoke-test |
|
|
703
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
704
|
-
| /fix-bug |
|
|
705
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
706
|
-
| /report-bug |
|
|
707
|
-
| /propose-scenario |
|
|
708
|
-
| /learn |
|
|
709
|
-
| /sync | `/validate-traces`
|
|
710
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
711
|
-
|
|
712
|
-
|
|
700
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
701
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
702
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
703
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
704
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
705
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
706
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
707
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
708
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
709
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
710
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
711
|
+
|
|
712
|
+
Định dạng footer như sau:
|
|
713
713
|
```
|
|
714
714
|
---
|
|
715
715
|
Status : {badge}
|
|
716
|
-
{Output Artifacts
|
|
716
|
+
{khối Output Artifacts}
|
|
717
717
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
718
|
-
(review
|
|
719
|
-
Next : {
|
|
718
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
719
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
720
720
|
```
|
|
721
|
-
*(
|
|
721
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
722
722
|
|
|
723
723
|
|
|
724
724
|
```
|
|
725
|
-
/review-tech-docs
|
|
725
|
+
/review-tech-docs Hoàn tất — {target file}
|
|
726
726
|
UC: {UC-ID} | Domain: {domain}
|
|
727
727
|
Findings: {total} | 🔴 Critical: {N} | 🟡 Major: {N} | 🟢 Minor: {N}
|
|
728
728
|
Auto-fixable: {N} | Needs human decision: {N}
|
|
729
729
|
|
|
730
|
-
Sign-off gate (system BDD
|
|
730
|
+
Sign-off gate (chỉ system BDD):
|
|
731
731
|
be_team : {done | pending}
|
|
732
732
|
fe_team : {done | pending} ← {name / "needs sign-off" }
|
|
733
733
|
app_team : {done | pending | n/a}
|
|
734
734
|
sa : {done | pending}
|
|
735
735
|
Gate : {🔒 BLOCKED — pending: fe_team, sa | ✅ READY}
|
|
736
736
|
|
|
737
|
-
|
|
738
|
-
Next:
|
|
739
|
-
|
|
740
|
-
|
|
737
|
+
File findings: {paths.refinement_dir}/{uc-id}-tech-review-findings.yaml
|
|
738
|
+
Next: Mở trong Review Board → Accept/Modify/Reject từng finding
|
|
739
|
+
Rồi chạy: /review-tech-docs --resume {tech-design-file}
|
|
740
|
+
Sau khi thu đủ sign-off → cập nhật @trace.sign_off trong tech doc, chạy lại review
|
|
741
741
|
```
|
|
742
742
|
|
|
743
743
|
---
|
|
744
744
|
|
|
745
|
-
## Resume Mode —
|
|
745
|
+
## Resume Mode — Áp dụng các Finding được chấp nhận
|
|
746
746
|
|
|
747
|
-
*
|
|
748
|
-
*
|
|
747
|
+
*Kích hoạt khi `$ARGUMENTS` chứa `--resume`.*
|
|
748
|
+
*Ví dụ: `/review-tech-docs --resume {paths.tech_docs_dir}/payment/{prd-slug}/tech-docs/PAY-UC1-tech-design.md`*
|
|
749
749
|
|
|
750
|
-
### Phase 1 —
|
|
750
|
+
### Phase 1 — Đọc các finding được chấp nhận
|
|
751
751
|
|
|
752
|
-
1.
|
|
753
|
-
2.
|
|
754
|
-
3.
|
|
752
|
+
1. Suy ra file findings từ target: `{paths.refinement_dir}/{uc-id}-tech-review-findings.yaml`
|
|
753
|
+
2. Đọc file. Gom các finding có `status: "accepted"` hoặc `status: "modified"`.
|
|
754
|
+
3. Nếu không có → báo "No accepted findings. File unchanged." và dừng.
|
|
755
755
|
|
|
756
|
-
### Phase 2 —
|
|
756
|
+
### Phase 2 — Áp dụng fix
|
|
757
757
|
|
|
758
|
-
|
|
758
|
+
Áp dụng theo thứ tự: critical → major → minor.
|
|
759
759
|
|
|
760
|
-
| check_id |
|
|
760
|
+
| check_id | Làm gì |
|
|
761
761
|
|----------|-----------|
|
|
762
|
-
| T1 (Architecture) |
|
|
763
|
-
| T2 (
|
|
764
|
-
| T3 (
|
|
765
|
-
| T5 (Internal inconsistency) |
|
|
766
|
-
| T6 (
|
|
762
|
+
| T1 (Architecture) | Áp dụng fix cấu trúc từ note finding — chuyển logic về đúng layer, cập nhật mô tả component |
|
|
763
|
+
| T2 (Tên field) | Đổi field về tên canonical từ core-entities.md xuyên suốt tài liệu |
|
|
764
|
+
| T3 (Thiếu design note) | Thêm design decision note cho scenario chưa phủ |
|
|
765
|
+
| T5 (Internal inconsistency) | Căn chỉnh các section mâu thuẫn theo quyết định nêu trong note |
|
|
766
|
+
| T6 (Thiếu section) | Thêm skeleton section với prompt placeholder cho tech lead điền |
|
|
767
767
|
|
|
768
|
-
**T1, T2, T4
|
|
769
|
-
|
|
768
|
+
**Finding T1, T2, T4 có `auto_fixable: false`:** cần một resolution do người viết trong
|
|
769
|
+
note "Modify" của Review Board. Áp dụng đúng những gì note nói. Đừng bịa fix.
|
|
770
770
|
|
|
771
|
-
### Phase 3 —
|
|
771
|
+
### Phase 3 — Cập nhật header + TSV + Report
|
|
772
772
|
|
|
773
|
-
|
|
774
|
-
1.
|
|
775
|
-
2.
|
|
776
|
-
-
|
|
777
|
-
-
|
|
778
|
-
3.
|
|
773
|
+
Sửa file tech-doc trực tiếp:
|
|
774
|
+
1. Tìm `@trace.revision:` trong header — tăng giá trị integer lên 1.
|
|
775
|
+
2. Tìm `@trace.status:` trong header:
|
|
776
|
+
- Nếu sign_off_gate = `ready` (tất cả sign-off done) → set `approved`
|
|
777
|
+
- Ngược lại → set `in-review` (chặn `/generate-code`)
|
|
778
|
+
3. Nếu block `@trace.sign_off` vắng và đây là tech doc system BDD → thêm nó với tất cả giá trị `pending`.
|
|
779
779
|
|
|
780
|
-
|
|
780
|
+
Ghi cả hai thay đổi vào file.
|
|
781
781
|
|
|
782
|
-
|
|
783
|
-
- **BE contract** (`{UC-ID}-tech-design.md`) → set `tech_doc_revision`
|
|
784
|
-
- **FE tech-design** (`{UC-ID}-tech-design-{platform}.md`) → set `fe_tech_doc_revision`
|
|
785
|
-
- Set `last_updated`
|
|
782
|
+
Rồi cập nhật `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` — chọn cột theo tech-doc nào được review (đọc tên file):
|
|
783
|
+
- **BE contract** (`{UC-ID}-tech-design.md`) → set `tech_doc_revision` thành integer `@trace.revision` mới cho mọi row của UC này.
|
|
784
|
+
- **FE tech-design** (`{UC-ID}-tech-design-{platform}.md`) → set `fe_tech_doc_revision` thay vì cái kia, cho các row của UC này trên platform đó (giữ nguyên `tech_doc_revision`).
|
|
785
|
+
- Set `last_updated` thành ngày hôm nay (`YYYY-MM-DD`) cho mọi row của UC này.
|
|
786
786
|
|
|
787
|
-
|
|
787
|
+
In report sau khi hoàn tất mọi lần ghi file.
|
|
788
788
|
|
|
789
789
|
```
|
|
790
|
-
/review-tech-docs --resume
|
|
790
|
+
/review-tech-docs --resume Đã áp dụng — {target file}
|
|
791
791
|
UC: {UC-ID}
|
|
792
792
|
|
|
793
793
|
Applied : {N} findings ({critical} critical, {major} major, {minor} minor)
|
|
@@ -800,12 +800,12 @@ Changes:
|
|
|
800
800
|
Revision : {old} → {new}
|
|
801
801
|
Status : {approved | in-review}
|
|
802
802
|
|
|
803
|
-
Sign-off : {✅
|
|
804
|
-
| 🔒 Pending: fe_team, sa — status set
|
|
805
|
-
|
|
803
|
+
Sign-off : {✅ Tất cả done — status set approved
|
|
804
|
+
| 🔒 Pending: fe_team, sa — status set in-review
|
|
805
|
+
Cập nhật @trace.sign_off trong tech doc khi mỗi team confirm, rồi chạy lại /review-tech-docs}
|
|
806
806
|
|
|
807
|
-
|
|
808
|
-
Next: {/generate-code {feature-file} ←
|
|
809
|
-
|
|
|
810
|
-
→
|
|
807
|
+
Chạy lại /review-tech-docs {file} để xác nhận 0 finding critical còn lại.
|
|
808
|
+
Next: {/generate-code {feature-file} ← chỉ khi status = approved
|
|
809
|
+
| Thu các sign-off pending → cập nhật @trace.sign_off → chạy lại /review-tech-docs}
|
|
810
|
+
→ nếu tech-doc sống trong spec repo dùng chung: commit + push lên spec submodule để FE/App `/sync` contract đã cập nhật
|
|
811
811
|
```
|