@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/debug.md
CHANGED
|
@@ -1,148 +1,148 @@
|
|
|
1
|
-
# /debug —
|
|
1
|
+
# /debug — Phân tích Debug nhanh
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
3
|
+
Dùng cho: lỗi IDE, test fail, hành vi lạ, hoặc "tại sao code này làm X?"
|
|
4
|
+
Khác `/fix-bug`: chỉ phân tích, không full workflow, không cần ticket.
|
|
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à 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.)*
|
|
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/*/*/*.md` — file PRD ở gốc mỗi feature folder — 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
|
-
*
|
|
96
|
+
*Lưu ý: Với lệnh này, target ở Bước 1 là input người dùng cung cấp (stack trace, output test fail, file path + mô tả, hoặc câu hỏi code). Không cần tìm file — đi thẳng sang context loading.*
|
|
97
97
|
|
|
98
98
|
## Context
|
|
99
|
-
# Context Loader —
|
|
99
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
100
100
|
|
|
101
|
-
|
|
101
|
+
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.
|
|
102
102
|
|
|
103
|
-
**
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
103
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
104
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
105
|
+
- 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.
|
|
106
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
107
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
108
|
+
- 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.
|
|
109
109
|
|
|
110
110
|
---
|
|
111
111
|
|
|
112
|
-
##
|
|
112
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
113
113
|
|
|
114
|
-
|
|
114
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
115
115
|
|
|
116
116
|
**Tech Stack:**
|
|
117
|
-
- `tech_stack.language` →
|
|
118
|
-
- `tech_stack.framework` →
|
|
119
|
-
- `tech_stack.build_tool` → build tool (
|
|
120
|
-
- `tech_stack.test_framework` → test framework (
|
|
121
|
-
- `tech_stack.database` → database (
|
|
122
|
-
- `tech_stack.module` →
|
|
117
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
118
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
119
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
120
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
121
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
122
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
123
123
|
|
|
124
124
|
**Conventions:**
|
|
125
|
-
- `conventions.build_command` →
|
|
126
|
-
- `conventions.test_command` →
|
|
127
|
-
- `conventions.service_run` →
|
|
128
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
125
|
+
- `conventions.build_command` → cách compile/build
|
|
126
|
+
- `conventions.test_command` → cách chạy test
|
|
127
|
+
- `conventions.service_run` → cách khởi động service
|
|
128
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
129
129
|
|
|
130
130
|
**Domains:**
|
|
131
|
-
- `domains` →
|
|
132
|
-
|
|
133
|
-
**Paths (
|
|
134
|
-
- `paths.specs_dir` → spec
|
|
135
|
-
- `paths.refinement_dir` → findings/review
|
|
136
|
-
- `paths.qc_dir` → QC automation
|
|
137
|
-
- `paths.qc_skills_dir` →
|
|
138
|
-
- `paths.product_definitions_dir` → product
|
|
139
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
140
|
-
- `paths.business_dictionary` → path
|
|
141
|
-
- `paths.core_entities` → path
|
|
142
|
-
- `paths.tech_docs_dir` →
|
|
143
|
-
- `paths.trace_dir` →
|
|
144
|
-
|
|
145
|
-
|
|
131
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
132
|
+
|
|
133
|
+
**Paths (nếu có):**
|
|
134
|
+
- `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)
|
|
135
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
136
|
+
- `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}/`)
|
|
137
|
+
- `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 đè)
|
|
138
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
139
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
140
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
141
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
142
|
+
- `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/`)
|
|
143
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
144
|
+
|
|
145
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
146
146
|
- `specs_dir` = `specs`
|
|
147
147
|
- `refinement_dir` = `.agent/review`
|
|
148
148
|
- `qc_dir` = `docs`
|
|
@@ -154,184 +154,184 @@ If `paths` section is absent, use these defaults:
|
|
|
154
154
|
- `tech_docs_dir` = `specs`
|
|
155
155
|
- `trace_dir` = `.trace`
|
|
156
156
|
|
|
157
|
-
|
|
157
|
+
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.
|
|
158
158
|
|
|
159
|
-
**
|
|
160
|
-
- `specs/payment/create-invoice/
|
|
161
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
162
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
163
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
159
|
+
**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ụ:
|
|
160
|
+
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
161
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
162
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
163
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
164
164
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
165
165
|
|
|
166
|
-
|
|
166
|
+
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ừ đó.
|
|
167
167
|
|
|
168
|
-
|
|
168
|
+
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.
|
|
169
169
|
|
|
170
170
|
---
|
|
171
171
|
|
|
172
|
-
##
|
|
172
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
173
173
|
|
|
174
|
-
*
|
|
174
|
+
*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.*
|
|
175
175
|
|
|
176
|
-
|
|
176
|
+
Nếu có section `services`:
|
|
177
177
|
|
|
178
|
-
**1.
|
|
179
|
-
-
|
|
180
|
-
-
|
|
181
|
-
*(
|
|
182
|
-
-
|
|
178
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
179
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
180
|
+
- 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.
|
|
181
|
+
*(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`)*
|
|
182
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
183
183
|
|
|
184
|
-
**2. Route
|
|
185
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
186
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
187
|
-
-
|
|
188
|
-
-
|
|
189
|
-
-
|
|
184
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
185
|
+
- 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.
|
|
186
|
+
- 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.
|
|
187
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
188
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
189
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
190
190
|
|
|
191
|
-
**3. Fallback** —
|
|
192
|
-
-
|
|
193
|
-
-
|
|
191
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
192
|
+
- Giữ path mặc định từ Bước 1
|
|
193
|
+
- Đặt `active_service = unresolved`
|
|
194
194
|
|
|
195
|
-
**4.
|
|
196
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
197
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
195
|
+
**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:`:
|
|
196
|
+
- 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`.)*
|
|
197
|
+
- 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.)*
|
|
198
198
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
199
199
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
200
200
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
201
201
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
202
202
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
203
203
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
204
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
204
|
+
- 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`.)*
|
|
205
205
|
|
|
206
|
-
> **
|
|
206
|
+
> **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.
|
|
207
207
|
|
|
208
208
|
---
|
|
209
209
|
|
|
210
|
-
##
|
|
210
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
211
211
|
|
|
212
|
-
*
|
|
212
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
213
213
|
|
|
214
|
-
|
|
214
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
215
215
|
|
|
216
|
-
**1.
|
|
216
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
217
217
|
- `{active_service}/.agent/project-context.yaml`
|
|
218
218
|
- `{active_service}/project-context.yaml`
|
|
219
219
|
|
|
220
|
-
**2.
|
|
220
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
221
221
|
|
|
222
|
-
|
|
|
222
|
+
| Biến | Nguồn |
|
|
223
223
|
|----------|--------|
|
|
224
|
-
| `conventions.test_command` |
|
|
225
|
-
| `conventions.build_command` |
|
|
226
|
-
| `paths.trace_dir` | **
|
|
227
|
-
| `paths.specs_dir` | **
|
|
224
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
225
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
226
|
+
| `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`). |
|
|
227
|
+
| `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. |
|
|
228
228
|
|
|
229
|
-
**3.
|
|
230
|
-
-
|
|
231
|
-
- **
|
|
229
|
+
**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:
|
|
230
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
231
|
+
- **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/`).
|
|
232
232
|
|
|
233
|
-
**4.
|
|
233
|
+
**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).
|
|
234
234
|
|
|
235
235
|
---
|
|
236
236
|
|
|
237
|
-
##
|
|
237
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
238
238
|
|
|
239
|
-
|
|
240
|
-
Merge framework
|
|
241
|
-
|
|
239
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
240
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
241
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
242
242
|
|
|
243
243
|
---
|
|
244
244
|
|
|
245
|
-
##
|
|
245
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
246
246
|
|
|
247
|
-
|
|
247
|
+
*Đâ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.*
|
|
248
248
|
|
|
249
|
-
CLAUDE.md
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
249
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
250
|
+
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
|
|
251
|
+
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
|
|
252
|
+
service phải thắng khi sinh code.
|
|
253
253
|
|
|
254
|
-
**
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
254
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
255
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
256
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
257
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
258
258
|
|
|
259
|
-
**
|
|
260
|
-
*
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
Overlay
|
|
264
|
-
coding standards,
|
|
265
|
-
(
|
|
259
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
260
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
261
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
262
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
263
|
+
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,
|
|
264
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
265
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
266
266
|
|
|
267
|
-
|
|
267
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
268
268
|
|
|
269
|
-
- **§1 Project Overview** →
|
|
270
|
-
- **§2 Architecture** → layer
|
|
271
|
-
- **§3 Coding Standards** →
|
|
272
|
-
- **§5 Error Handling** → exception
|
|
273
|
-
- **§7 Git Conventions** →
|
|
269
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
270
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
271
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
272
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
273
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
274
274
|
|
|
275
|
-
**
|
|
276
|
-
-
|
|
277
|
-
-
|
|
278
|
-
-
|
|
279
|
-
-
|
|
275
|
+
**Quy tắc phân giải:**
|
|
276
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
277
|
+
- 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}`.
|
|
278
|
+
- 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).
|
|
279
|
+
- 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.
|
|
280
280
|
|
|
281
281
|
---
|
|
282
282
|
|
|
283
|
-
##
|
|
283
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
284
284
|
|
|
285
|
-
|
|
285
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
286
286
|
|
|
287
|
-
|
|
287
|
+
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.
|
|
288
288
|
|
|
289
|
-
|
|
289
|
+
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*`.
|
|
290
290
|
|
|
291
291
|
---
|
|
292
292
|
|
|
293
|
-
##
|
|
293
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
294
294
|
|
|
295
|
-
|
|
295
|
+
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).
|
|
296
296
|
|
|
297
|
-
|
|
298
|
-
- **Canonical Terms** →
|
|
299
|
-
- **Banned Terms** →
|
|
300
|
-
- **Status / Enum Registry** →
|
|
297
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
298
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
299
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
300
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
301
301
|
|
|
302
|
-
|
|
303
|
-
-
|
|
304
|
-
-
|
|
302
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
303
|
+
- 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
|
|
304
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
305
305
|
|
|
306
|
-
|
|
306
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
307
307
|
|
|
308
308
|
---
|
|
309
309
|
|
|
310
|
-
##
|
|
310
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
311
311
|
|
|
312
|
-
|
|
313
|
-
|
|
312
|
+
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).
|
|
313
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
314
314
|
|
|
315
|
-
|
|
316
|
-
- **Entity catalog** →
|
|
317
|
-
- **Field name registry** →
|
|
318
|
-
- **Relationship map** →
|
|
315
|
+
Nếu tồn tại, đọc và lưu:
|
|
316
|
+
- **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ệ
|
|
317
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
318
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
319
319
|
|
|
320
|
-
**
|
|
321
|
-
-
|
|
322
|
-
-
|
|
323
|
-
-
|
|
320
|
+
**Cách dùng catalog này:**
|
|
321
|
+
- 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
|
|
322
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
323
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
324
324
|
|
|
325
|
-
|
|
325
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
326
326
|
|
|
327
327
|
---
|
|
328
328
|
|
|
329
|
-
##
|
|
329
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
330
330
|
|
|
331
|
-
|
|
331
|
+
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:
|
|
332
332
|
|
|
333
333
|
```
|
|
334
|
-
active_module = tech_stack.module (
|
|
334
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
335
335
|
```
|
|
336
336
|
|
|
337
337
|
| `platform_type` | Modules |
|
|
@@ -340,261 +340,261 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
340
340
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
341
341
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
342
342
|
|
|
343
|
-
|
|
343
|
+
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.
|
|
344
344
|
|
|
345
|
-
|
|
345
|
+
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).
|
|
346
346
|
|
|
347
347
|
---
|
|
348
348
|
|
|
349
|
-
##
|
|
349
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
350
350
|
|
|
351
|
-
*
|
|
352
|
-
|
|
351
|
+
*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`
|
|
352
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
353
353
|
|
|
354
|
-
|
|
355
|
-
-
|
|
356
|
-
- Else
|
|
357
|
-
-
|
|
354
|
+
Phân giải path file lessons:
|
|
355
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
356
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
357
|
+
- Ở 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`
|
|
358
358
|
|
|
359
|
-
|
|
360
|
-
-
|
|
361
|
-
-
|
|
362
|
-
-
|
|
359
|
+
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:
|
|
360
|
+
- 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).
|
|
361
|
+
- 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).
|
|
362
|
+
- 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.
|
|
363
363
|
|
|
364
|
-
|
|
364
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
365
365
|
|
|
366
366
|
---
|
|
367
367
|
|
|
368
|
-
##
|
|
368
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
369
369
|
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
(recency
|
|
370
|
+
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.
|
|
371
|
+
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
|
|
372
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
373
373
|
|
|
374
|
-
|
|
374
|
+
Xuất đúng khối này:
|
|
375
375
|
```
|
|
376
376
|
[CTX LOADED]
|
|
377
377
|
Stack : {language} / {framework} / {database}
|
|
378
378
|
Platform : {active_module} ({platform_type})
|
|
379
|
-
Layers : {
|
|
380
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
379
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
380
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
381
381
|
Ticket : {ticket_prefix}-
|
|
382
382
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
383
383
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
384
|
-
Lessons : {loaded — N guardrails |
|
|
384
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
385
385
|
Service : {active_service} ({active_service_module}) | single-service
|
|
386
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
387
|
-
Status : {FULL | PARTIAL —
|
|
386
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
387
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
388
388
|
```
|
|
389
389
|
|
|
390
|
-
|
|
390
|
+
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.
|
|
391
391
|
|
|
392
392
|
---
|
|
393
393
|
|
|
394
|
-
##
|
|
394
|
+
## Hoàn tất nạp Context
|
|
395
395
|
|
|
396
|
-
|
|
397
|
-
-
|
|
398
|
-
-
|
|
399
|
-
- Coding standards
|
|
400
|
-
-
|
|
401
|
-
-
|
|
402
|
-
- Entity catalog (field
|
|
403
|
-
-
|
|
396
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
397
|
+
- Định danh dự án, tech stack, convention module
|
|
398
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
399
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
400
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
401
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
402
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
403
|
+
- Toàn bộ path đã cấu hình
|
|
404
404
|
|
|
405
|
-
|
|
405
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
406
406
|
|
|
407
407
|
|
|
408
408
|
---
|
|
409
409
|
|
|
410
|
-
## Step 1 —
|
|
410
|
+
## Step 1 — Phân loại loại debug
|
|
411
411
|
|
|
412
|
-
|
|
412
|
+
Sau khi nạp context, hiện prompt này và chờ user chọn:
|
|
413
413
|
|
|
414
414
|
```
|
|
415
415
|
DEBUG SESSION
|
|
416
416
|
──────────────────────────────────────────────────────────────
|
|
417
|
-
|
|
417
|
+
Tình huống của bạn?
|
|
418
418
|
|
|
419
|
-
1
|
|
420
|
-
2
|
|
421
|
-
3
|
|
422
|
-
4
|
|
419
|
+
1 Tôi đã có stack trace / error log → dán nó
|
|
420
|
+
2 Tôi cần reproduce lỗi trước → chỉ tôi lệnh run
|
|
421
|
+
3 Một test đang fail → tôi sẽ chạy test, rồi dán output
|
|
422
|
+
4 Câu hỏi về code (không cần runtime) → hỏi luôn
|
|
423
423
|
──────────────────────────────────────────────────────────────
|
|
424
|
-
|
|
424
|
+
Nhập 1 / 2 / 3 / 4:
|
|
425
425
|
```
|
|
426
426
|
|
|
427
|
-
|
|
427
|
+
Chờ user chọn, rồi theo path tương ứng bên dưới.
|
|
428
428
|
|
|
429
429
|
---
|
|
430
430
|
|
|
431
|
-
### Path 1 —
|
|
431
|
+
### Path 1 — Đã có error output
|
|
432
432
|
|
|
433
|
-
|
|
433
|
+
Hỏi:
|
|
434
434
|
```
|
|
435
|
-
|
|
435
|
+
Dán stack trace / error log của bạn bên dưới:
|
|
436
436
|
```
|
|
437
437
|
|
|
438
|
-
|
|
438
|
+
Chờ input, rồi sang [Stack Trace Analysis](#stack-trace-analysis).
|
|
439
439
|
|
|
440
440
|
---
|
|
441
441
|
|
|
442
|
-
### Path 2 —
|
|
442
|
+
### Path 2 — Cần reproduce trước
|
|
443
443
|
|
|
444
|
-
|
|
444
|
+
Hiện lệnh run từ `conventions.service_run` trong `project-context.yaml`:
|
|
445
445
|
|
|
446
446
|
```
|
|
447
|
-
|
|
447
|
+
Khởi động service trước:
|
|
448
448
|
|
|
449
449
|
{conventions.service_run}
|
|
450
450
|
|
|
451
|
-
(
|
|
451
|
+
(Nếu dùng Docker: `docker compose up -d`, rồi verify với `docker compose ps`)
|
|
452
452
|
|
|
453
|
-
|
|
454
|
-
1. Trigger
|
|
455
|
-
2. Copy
|
|
456
|
-
3.
|
|
453
|
+
Khi service đang chạy:
|
|
454
|
+
1. Trigger hành vi gây lỗi
|
|
455
|
+
2. Copy full stack trace hoặc error log
|
|
456
|
+
3. Dán vào đây
|
|
457
457
|
|
|
458
|
-
|
|
458
|
+
Đang chờ error output của bạn...
|
|
459
459
|
```
|
|
460
460
|
|
|
461
|
-
|
|
461
|
+
Chờ user dán lỗi, rồi sang [Stack Trace Analysis](#stack-trace-analysis).
|
|
462
462
|
|
|
463
|
-
|
|
463
|
+
Nếu `conventions.service_run` chưa set → hiện:
|
|
464
464
|
```
|
|
465
|
-
⚠️ service_run
|
|
466
|
-
|
|
465
|
+
⚠️ service_run chưa được cấu hình trong .agent/project-context.yaml.
|
|
466
|
+
Thêm nó để lệnh này hiện đúng lệnh khởi động:
|
|
467
467
|
|
|
468
468
|
conventions:
|
|
469
469
|
service_run: "mvn spring-boot:run" # or: npm run dev / go run . / etc.
|
|
470
470
|
```
|
|
471
|
-
|
|
471
|
+
Rồi nhờ user khởi động service thủ công và dán lỗi khi sẵn sàng.
|
|
472
472
|
|
|
473
473
|
---
|
|
474
474
|
|
|
475
|
-
### Path 3 — Test
|
|
475
|
+
### Path 3 — Test đang fail
|
|
476
476
|
|
|
477
|
-
|
|
477
|
+
Hiện lệnh test từ `conventions.test_command` trong `project-context.yaml`:
|
|
478
478
|
|
|
479
479
|
```
|
|
480
|
-
|
|
480
|
+
Chạy test của bạn trước:
|
|
481
481
|
|
|
482
482
|
{conventions.test_command}
|
|
483
483
|
|
|
484
|
-
|
|
484
|
+
Khi chạy xong, dán full output test fail vào đây.
|
|
485
485
|
|
|
486
|
-
|
|
486
|
+
Đang chờ...
|
|
487
487
|
```
|
|
488
488
|
|
|
489
|
-
|
|
489
|
+
Chờ user dán output fail, rồi sang [Test Failure Analysis](#test-failure-analysis).
|
|
490
490
|
|
|
491
|
-
|
|
491
|
+
Nếu `conventions.test_command` chưa set → hiện:
|
|
492
492
|
```
|
|
493
|
-
⚠️ test_command
|
|
494
|
-
|
|
493
|
+
⚠️ test_command chưa được cấu hình trong .agent/project-context.yaml.
|
|
494
|
+
Thêm nó để lệnh này hiện đúng lệnh test:
|
|
495
495
|
|
|
496
496
|
conventions:
|
|
497
497
|
test_command: "mvn test" # or: npm test / go test ./... / etc.
|
|
498
498
|
```
|
|
499
|
-
|
|
499
|
+
Rồi nhờ user chạy test thủ công và dán output khi sẵn sàng.
|
|
500
500
|
|
|
501
501
|
---
|
|
502
502
|
|
|
503
|
-
### Path 4 —
|
|
503
|
+
### Path 4 — Câu hỏi code
|
|
504
504
|
|
|
505
|
-
|
|
505
|
+
Hỏi:
|
|
506
506
|
```
|
|
507
|
-
|
|
507
|
+
Mô tả câu hỏi của bạn hoặc dán code snippet bạn đang hỏi:
|
|
508
508
|
```
|
|
509
509
|
|
|
510
|
-
|
|
510
|
+
Chờ input, rồi trả lời trực tiếp dùng project context đã nạp (quy tắc kiến trúc, thứ tự layer, coding standards từ CLAUDE.md).
|
|
511
511
|
|
|
512
512
|
---
|
|
513
513
|
|
|
514
514
|
## Stack Trace Analysis
|
|
515
515
|
|
|
516
|
-
|
|
516
|
+
Đọc từ **dưới lên** — `Caused by:` là root cause thật:
|
|
517
517
|
```
|
|
518
|
-
Caused by: {RealException} ←
|
|
518
|
+
Caused by: {RealException} ← bắt đầu ở đây
|
|
519
519
|
at {class}.{method}({file}:{line})
|
|
520
520
|
```
|
|
521
521
|
|
|
522
522
|
## Common Error Patterns
|
|
523
523
|
|
|
524
|
-
|
|
524
|
+
Dùng `active_module` từ context để chọn bảng liên quan.
|
|
525
525
|
|
|
526
|
-
###
|
|
526
|
+
### Nếu `platform_type = backend`
|
|
527
527
|
|
|
528
528
|
#### java-spring / golang / dotnet / php-laravel
|
|
529
529
|
|
|
530
|
-
| Error |
|
|
530
|
+
| Error | Nguyên nhân khả nghi | Hướng fix |
|
|
531
531
|
|-------|-------------|---------------|
|
|
532
|
-
| NullPointerException |
|
|
533
|
-
| ClassCastException |
|
|
534
|
-
| OutOfMemoryError |
|
|
535
|
-
| StackOverflowError |
|
|
536
|
-
| Connection refused | Dependency
|
|
537
|
-
| 401 Unauthorized | Token
|
|
538
|
-
| 403 Forbidden |
|
|
539
|
-
| DB constraint violation |
|
|
540
|
-
| Serialization error | Circular reference |
|
|
541
|
-
| Test assertion mismatch |
|
|
532
|
+
| NullPointerException | Truy cập object null; Optional chưa xử lý | Kiểm tra Optional.orElseThrow, null guard |
|
|
533
|
+
| ClassCastException | Giả định sai kiểu | Kiểm tra type ở assignment/return |
|
|
534
|
+
| OutOfMemoryError | Load quá nhiều data | Thêm pagination |
|
|
535
|
+
| StackOverflowError | Đệ quy vô hạn | Tìm recursive call không có base case |
|
|
536
|
+
| Connection refused | Dependency chưa chạy | Kiểm tra config URL / khởi động service |
|
|
537
|
+
| 401 Unauthorized | Token hết hạn, sai config | Verify token, kiểm tra auth config |
|
|
538
|
+
| 403 Forbidden | Sai role | Kiểm tra auth annotation |
|
|
539
|
+
| DB constraint violation | Trùng key, null trong NOT NULL | Kiểm tra data và constraint |
|
|
540
|
+
| Serialization error | Circular reference | Kiểm tra config DTO/mapper |
|
|
541
|
+
| Test assertion mismatch | Sai mock hoặc sai expected | Đọc lại setup mock |
|
|
542
542
|
|
|
543
543
|
#### context-engineering (AI/LLM pipelines)
|
|
544
544
|
|
|
545
|
-
| Error |
|
|
545
|
+
| Error | Nguyên nhân khả nghi | Hướng fix |
|
|
546
546
|
|-------|-------------|---------------|
|
|
547
|
-
| `APIError` / `RateLimitError` |
|
|
548
|
-
| `TokenLimitError` / `context_length_exceeded` |
|
|
549
|
-
| `AuthenticationError` | API key
|
|
550
|
-
| Response validation / schema mismatch | LLM
|
|
551
|
-
| `JSONDecodeError`
|
|
552
|
-
|
|
|
553
|
-
|
|
|
547
|
+
| `APIError` / `RateLimitError` | Vượt quota LLM hoặc service down | Kiểm tra API key, rate limit; thêm exponential backoff |
|
|
548
|
+
| `TokenLimitError` / `context_length_exceeded` | Prompt input quá dài | Truncate/chunk input; review kích thước prompt template |
|
|
549
|
+
| `AuthenticationError` | API key không hợp lệ hoặc hết hạn | Kiểm tra env var; rotate key |
|
|
550
|
+
| Response validation / schema mismatch | Output LLM không khớp format kỳ vọng | Thêm output parser; retry với prompt chặt hơn |
|
|
551
|
+
| `JSONDecodeError` trên output LLM | Model trả về text non-JSON | Thêm post-processing trích JSON hoặc system prompt chặt hơn |
|
|
552
|
+
| Test treo / chậm | LLM thật bị gọi trong test thay vì mock | Verify `patch('...')` được áp; thêm timeout guard |
|
|
553
|
+
| Kết quả flaky giữa các lần chạy | Response LLM non-deterministic | Dùng mock cố định trong test; check temperature = 0 cho determinism |
|
|
554
554
|
|
|
555
|
-
###
|
|
555
|
+
### Nếu `platform_type = web-frontend`
|
|
556
556
|
|
|
557
|
-
| Error |
|
|
557
|
+
| Error | Nguyên nhân khả nghi | Hướng fix |
|
|
558
558
|
|-------|-------------|---------------|
|
|
559
|
-
| `Cannot read properties of undefined` | Data
|
|
560
|
-
| `useEffect` infinite loop | Dependency array
|
|
561
|
-
| `Cannot update state on unmounted component` | Async
|
|
562
|
-
| CORS error | API
|
|
563
|
-
| 401 Unauthorized | Token
|
|
564
|
-
| White screen / no output |
|
|
565
|
-
| Type error (Zod / TypeScript) |
|
|
566
|
-
| `act(...)` warning
|
|
567
|
-
| Module not found |
|
|
568
|
-
|
|
569
|
-
###
|
|
559
|
+
| `Cannot read properties of undefined` | Data chưa load | Thêm loading guard / optional chaining `?.` |
|
|
560
|
+
| `useEffect` infinite loop | Dependency array sai | Review deps, dùng stable ref / `useCallback` |
|
|
561
|
+
| `Cannot update state on unmounted component` | Async resolve sau unmount | Cancel trong cleanup / dùng AbortController |
|
|
562
|
+
| CORS error | API chưa cấu hình | Kiểm tra CORS config backend hoặc dev proxy |
|
|
563
|
+
| 401 Unauthorized | Token hết hạn hoặc thiếu | Refresh token / kiểm tra header Authorization |
|
|
564
|
+
| White screen / no output | Render error chưa xử lý | Kiểm tra console browser, thêm ErrorBoundary |
|
|
565
|
+
| Type error (Zod / TypeScript) | Shape response API mismatch | So response thực tế vs type definition |
|
|
566
|
+
| `act(...)` warning trong test | Async state update | Bọc trong `act(async () => {...})` |
|
|
567
|
+
| Module not found | Sai import path | Kiểm tra relative path / tsconfig alias |
|
|
568
|
+
|
|
569
|
+
### Nếu `platform_type = mobile`
|
|
570
570
|
|
|
571
571
|
#### Flutter
|
|
572
|
-
| Error |
|
|
572
|
+
| Error | Nguyên nhân khả nghi | Hướng fix |
|
|
573
573
|
|-------|-------------|---------------|
|
|
574
|
-
| `Null check operator on null value` | Nullable
|
|
575
|
-
| `pumpAndSettle timed out` | Async
|
|
576
|
-
| `setState called after dispose` | Async
|
|
577
|
-
| `RenderFlex overflow` | Widget
|
|
578
|
-
| BLoC state
|
|
579
|
-
| `MissingPluginException` | Native plugin
|
|
574
|
+
| `Null check operator on null value` | Nullable chưa guard | Thêm `?` hoặc null check trước `!` |
|
|
575
|
+
| `pumpAndSettle timed out` | Async chưa hoàn thành trong test | Dùng `pump(Duration(...))` |
|
|
576
|
+
| `setState called after dispose` | Async tiếp tục sau khi widget bị bỏ | Cancel trong `dispose()` |
|
|
577
|
+
| `RenderFlex overflow` | Widget quá rộng so với màn | Bọc `Flexible`, `Expanded`, hoặc `SingleChildScrollView` |
|
|
578
|
+
| BLoC state không update | Event chưa dispatch | Verify `bloc.add(Event())` được gọi |
|
|
579
|
+
| `MissingPluginException` | Native plugin chưa link | Chạy `flutter clean && flutter pub get` |
|
|
580
580
|
|
|
581
581
|
#### React Native
|
|
582
|
-
| Error |
|
|
582
|
+
| Error | Nguyên nhân khả nghi | Hướng fix |
|
|
583
583
|
|-------|-------------|---------------|
|
|
584
|
-
| `undefined is not an object` |
|
|
584
|
+
| `undefined is not an object` | Truy cập prop null | Thêm null check / optional chaining |
|
|
585
585
|
| Metro bundler error | Cache stale | `npx react-native start --reset-cache` |
|
|
586
|
-
| `VirtualizedLists nested` | FlatList
|
|
587
|
-
| Navigation `undefined` | `useNavigation`
|
|
588
|
-
| `act(...)` warning | Async state update
|
|
586
|
+
| `VirtualizedLists nested` | FlatList trong ScrollView | Dùng `nestedScrollEnabled` hoặc tái cấu trúc |
|
|
587
|
+
| Navigation `undefined` | `useNavigation` ngoài navigator | Bọc component trong đúng navigator |
|
|
588
|
+
| `act(...)` warning | Async state update trong test | Bọc trong `act(async () => {...})` |
|
|
589
589
|
|
|
590
590
|
#### iOS / Android
|
|
591
|
-
| Error |
|
|
591
|
+
| Error | Nguyên nhân khả nghi | Hướng fix |
|
|
592
592
|
|-------|-------------|---------------|
|
|
593
|
-
| `SIGABRT` / `EXC_BAD_ACCESS` (iOS) | Nil dereference |
|
|
594
|
-
| `IllegalStateException` (Android) |
|
|
595
|
-
| `NetworkOnMainThreadException` | Network call
|
|
596
|
-
| Build
|
|
597
|
-
| `Hilt injection failed` |
|
|
593
|
+
| `SIGABRT` / `EXC_BAD_ACCESS` (iOS) | Nil dereference | Thêm optional binding `if let` / `guard let` |
|
|
594
|
+
| `IllegalStateException` (Android) | Vi phạm lifecycle | Kiểm tra fragment/activity còn attached không |
|
|
595
|
+
| `NetworkOnMainThreadException` | Network call trên UI thread | Chuyển sang coroutine / background thread |
|
|
596
|
+
| Build fail sau pod install | Pod cache stale | `pod deintegrate && pod install` |
|
|
597
|
+
| `Hilt injection failed` | Thiếu `@AndroidEntryPoint` | Thêm annotation vào Activity/Fragment |
|
|
598
598
|
|
|
599
599
|
## Test Failure Analysis
|
|
600
600
|
|
|
@@ -603,44 +603,44 @@ Expected: {value}
|
|
|
603
603
|
Actual : {value}
|
|
604
604
|
at {test}.{method}(line {N})
|
|
605
605
|
```
|
|
606
|
-
1.
|
|
606
|
+
1. Gap là gì? 2. Mock setup đúng chưa? 3. Assertion có đúng logic không?
|
|
607
607
|
|
|
608
608
|
---
|
|
609
609
|
|
|
610
610
|
## Output
|
|
611
611
|
|
|
612
|
-
# Report Footer —
|
|
612
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
613
613
|
|
|
614
|
-
|
|
614
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
615
615
|
|
|
616
616
|
## Status Badge
|
|
617
617
|
|
|
618
|
-
|
|
619
|
-
- `✅ Complete` —
|
|
620
|
-
- `❌ Failed` —
|
|
621
|
-
- `⚠️ Warnings` —
|
|
618
|
+
Chọn một theo kết quả:
|
|
619
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
620
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
621
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
622
622
|
|
|
623
623
|
## Output Artifacts
|
|
624
624
|
|
|
625
|
-
|
|
625
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
626
626
|
```
|
|
627
627
|
Output Artifacts:
|
|
628
|
-
{created|updated} {file-path} ({
|
|
629
|
-
{created|updated} {file-path} ({
|
|
628
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
629
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
630
630
|
```
|
|
631
631
|
|
|
632
|
-
|
|
632
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
633
633
|
|
|
634
634
|
## Pipeline Position
|
|
635
635
|
|
|
636
|
-
|
|
637
|
-
|
|
636
|
+
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`,
|
|
637
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
638
638
|
|
|
639
639
|
```
|
|
640
640
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
641
641
|
```
|
|
642
642
|
|
|
643
|
-
|
|
643
|
+
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:
|
|
644
644
|
|
|
645
645
|
| Phase | Commands |
|
|
646
646
|
|-------|----------|
|
|
@@ -654,61 +654,61 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
654
654
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
655
655
|
| Trace Audit | `/validate-traces` |
|
|
656
656
|
|
|
657
|
-
|
|
657
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
658
658
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
659
659
|
|
|
660
|
-
**
|
|
661
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
662
|
-
**
|
|
660
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
661
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
662
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
663
663
|
|
|
664
|
-
##
|
|
664
|
+
## Gợi ý lệnh tiếp theo
|
|
665
665
|
|
|
666
|
-
|
|
666
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
667
667
|
|
|
668
|
-
|
|
|
668
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
669
669
|
|-------------------------|-----------------------------------------------|
|
|
670
|
-
| /setup-ai-first | `/define-product`
|
|
670
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
671
671
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
672
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
673
|
-
| /refine-prd |
|
|
674
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
675
|
-
| /generate-design-spec | Designer review →
|
|
676
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
677
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
678
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
672
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
673
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
674
|
+
| /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 |
|
|
675
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
676
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
677
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
678
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
679
679
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
680
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
681
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
682
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
683
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
684
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
680
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
681
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
682
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
683
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
684
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
685
685
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
686
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
687
|
-
| /generate-code |
|
|
686
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
687
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
688
688
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
689
689
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
690
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
691
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
692
|
-
| /dev-smoke-test |
|
|
693
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
694
|
-
| /fix-bug |
|
|
695
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
696
|
-
| /report-bug |
|
|
697
|
-
| /propose-scenario |
|
|
698
|
-
| /learn |
|
|
699
|
-
| /sync | `/validate-traces`
|
|
700
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
701
|
-
|
|
702
|
-
|
|
690
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
691
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
692
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
693
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
694
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
695
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
696
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
697
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
698
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
699
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
700
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
701
|
+
|
|
702
|
+
Định dạng footer như sau:
|
|
703
703
|
```
|
|
704
704
|
---
|
|
705
705
|
Status : {badge}
|
|
706
|
-
{Output Artifacts
|
|
706
|
+
{khối Output Artifacts}
|
|
707
707
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
708
|
-
(review
|
|
709
|
-
Next : {
|
|
708
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
709
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
710
710
|
```
|
|
711
|
-
*(
|
|
711
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
712
712
|
|
|
713
713
|
|
|
714
714
|
```
|
|
@@ -718,104 +718,104 @@ Next : {suggested command with example arguments}
|
|
|
718
718
|
{description}
|
|
719
719
|
|
|
720
720
|
## Root Cause
|
|
721
|
-
{
|
|
721
|
+
{giải thích kỹ thuật}
|
|
722
722
|
|
|
723
723
|
## Location
|
|
724
724
|
File: {path} | Line: {N} | Layer: {Controller/Service/Repository/Test}
|
|
725
725
|
|
|
726
726
|
## Suggested Fix
|
|
727
|
-
{
|
|
727
|
+
{thay đổi code cụ thể}
|
|
728
728
|
|
|
729
729
|
## Related Rule
|
|
730
|
-
|
|
730
|
+
Xem CLAUDE.md §{section}
|
|
731
731
|
|
|
732
732
|
## Next Step
|
|
733
|
-
-
|
|
734
|
-
-
|
|
733
|
+
- Để fix hoàn toàn → /fix-bug {TICKET_ID}
|
|
734
|
+
- Chỉ cần phân tích → xong
|
|
735
735
|
```
|
|
736
736
|
|
|
737
737
|
---
|
|
738
738
|
|
|
739
|
-
##
|
|
739
|
+
## Đề xuất ghi Lesson (tuỳ chọn)
|
|
740
740
|
|
|
741
|
-
|
|
742
|
-
(
|
|
741
|
+
Nếu root cause là một **lỗi AI gây ra khi sinh code và có thể lặp lại**
|
|
742
|
+
(không phải vấn đề env/config hay nguyên nhân bên ngoài), hỏi:
|
|
743
743
|
|
|
744
744
|
```
|
|
745
|
-
|
|
745
|
+
Cái này trông như một lỗi AI lặp lại. Ghi nó thành project lesson? (Y/N)
|
|
746
746
|
```
|
|
747
747
|
|
|
748
|
-
|
|
749
|
-
(
|
|
748
|
+
Nếu `Y` → chạy quy trình capture bên dưới với `source=/debug`, một `category` phù hợp
|
|
749
|
+
(thường `code-gen`), và `scope` = domain hoặc file glob bị ảnh hưởng.
|
|
750
750
|
|
|
751
|
-
# Capture Lesson —
|
|
751
|
+
# Capture Lesson — Ghi lại lỗi lặp lại thành một Guardrail
|
|
752
752
|
|
|
753
|
-
|
|
754
|
-
|
|
753
|
+
Quy trình tái sử dụng để lưu một "lesson" nhằm tránh AI lặp lại lỗi trong dự án này.
|
|
754
|
+
Dùng bởi `/learn` (thủ công) và được đề xuất bởi `/review-code`, `/fix-bug`, `/debug` (tự động).
|
|
755
755
|
|
|
756
|
-
> **
|
|
757
|
-
>
|
|
758
|
-
>
|
|
756
|
+
> **Bộ nhớ dự án, không phải huấn luyện model.** Một lesson là văn bản thuần được inject vào context ở
|
|
757
|
+
> đầu mỗi lệnh (context-loader Bước 6.7). Về mặt chức năng, điều này chặn việc lặp lại — AI thấy
|
|
758
|
+
> guardrail trước khi sinh nội dung. Không có trọng số model nào thay đổi.
|
|
759
759
|
|
|
760
|
-
## L1 —
|
|
760
|
+
## L1 — Phân giải file lessons
|
|
761
761
|
|
|
762
|
-
|
|
763
|
-
1. `paths.lessons_file`
|
|
764
|
-
2.
|
|
765
|
-
3.
|
|
762
|
+
Phân giải `lessons_path` theo thứ tự sau:
|
|
763
|
+
1. `paths.lessons_file` từ context đã nạp (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
764
|
+
2. Mặc định `specs/domain-knowledge/lessons-learned.md` (single-service)
|
|
765
|
+
3. Ở chế độ umbrella/service (khi `service_root` được set) mặc định `{service_root}/.agent/project-lessons.md`
|
|
766
766
|
|
|
767
|
-
## L2 —
|
|
767
|
+
## L2 — Dựng lesson
|
|
768
768
|
|
|
769
|
-
|
|
770
|
-
(
|
|
769
|
+
Thu thập các field sau — từ `$ARGUMENTS` (cho `/learn`) hoặc từ findings của lệnh gọi
|
|
770
|
+
(cho `/review-code`, `/fix-bug`, `/debug`):
|
|
771
771
|
|
|
772
|
-
| Field |
|
|
772
|
+
| Field | Ý nghĩa |
|
|
773
773
|
|-------|---------|
|
|
774
|
-
| `category` |
|
|
775
|
-
| `title` |
|
|
776
|
-
| `mistake` |
|
|
777
|
-
| `rule` |
|
|
778
|
-
| `scope` |
|
|
779
|
-
| `source` |
|
|
774
|
+
| `category` | một trong: `code-gen` \| `bdd` \| `tech-docs` \| `tests` \| `prd` \| `general` |
|
|
775
|
+
| `title` | cụm từ ngắn đặt tên cho lỗi |
|
|
776
|
+
| `mistake` | cụ thể, AI đã làm sai điều gì |
|
|
777
|
+
| `rule` | câu sửa mệnh lệnh — "Luôn …" / "Không bao giờ …" — testable, không mơ hồ |
|
|
778
|
+
| `scope` | phạm vi áp dụng: một domain, một file glob (vd `*Controller.*`), hoặc `all` |
|
|
779
|
+
| `source` | cách ghi nhận: `/learn` \| `/review-code {UC-ID}` \| `/fix-bug {TICKET}` \| `/debug` |
|
|
780
780
|
|
|
781
|
-
|
|
781
|
+
Nếu `rule` mơ hồ (vd "cẩn thận"), viết lại thành chỉ dẫn cụ thể, kiểm tra được trước khi lưu.
|
|
782
782
|
|
|
783
|
-
## L3 —
|
|
783
|
+
## L3 — Khử trùng lặp
|
|
784
784
|
|
|
785
|
-
|
|
786
|
-
- **
|
|
785
|
+
Đọc các lesson hiện có trong `lessons_path`. Nếu đã có một lesson cùng lỗi:
|
|
786
|
+
- **Tinh chỉnh** entry đó (siết chặt Rule, mở rộng/thu hẹp Scope, cập nhật Date, thêm Source mới) — KHÔNG thêm bản trùng.
|
|
787
787
|
|
|
788
|
-
|
|
788
|
+
Nếu không, gán id kế tiếp `L-{NNN}` = (số lớn nhất hiện có + 1), pad 0 đủ 3 chữ số.
|
|
789
789
|
|
|
790
|
-
## L4 —
|
|
790
|
+
## L4 — Ghi
|
|
791
791
|
|
|
792
|
-
|
|
792
|
+
Nếu `lessons_path` chưa tồn tại, tạo file với header sau trước:
|
|
793
793
|
|
|
794
794
|
```markdown
|
|
795
795
|
# Project Lessons — Learned Guardrails
|
|
796
796
|
|
|
797
|
-
>
|
|
798
|
-
>
|
|
799
|
-
>
|
|
800
|
-
> Commit
|
|
797
|
+
> Các lỗi AI KHÔNG được lặp lại trong dự án này. Được nạp bởi context-loader ở đầu
|
|
798
|
+
> mỗi lệnh và coi như ràng buộc cứng (cùng mức ưu tiên với coding standards trong CLAUDE.md).
|
|
799
|
+
> Thêm bằng /learn, hoặc chấp nhận prompt trong /review-code, /fix-bug, /debug.
|
|
800
|
+
> Commit file này để cả team dùng chung guardrail.
|
|
801
801
|
|
|
802
|
-
| Category |
|
|
802
|
+
| Category | Áp dụng cho |
|
|
803
803
|
|----------|-----------|
|
|
804
|
-
| code-gen | /generate-code
|
|
805
|
-
| bdd | /generate-bdd
|
|
806
|
-
| tech-docs | /generate-tech-docs
|
|
807
|
-
| tests | /dev-gen-test
|
|
808
|
-
| prd | /generate-prd, /refine-prd
|
|
809
|
-
| general |
|
|
804
|
+
| code-gen | output của /generate-code |
|
|
805
|
+
| bdd | output của /generate-bdd |
|
|
806
|
+
| tech-docs | output của /generate-tech-docs |
|
|
807
|
+
| tests | output của /dev-gen-test |
|
|
808
|
+
| prd | output của /generate-prd, /refine-prd |
|
|
809
|
+
| general | mọi lệnh |
|
|
810
810
|
|
|
811
811
|
---
|
|
812
812
|
```
|
|
813
813
|
|
|
814
|
-
|
|
814
|
+
Chèn lesson mới ngay dưới dấu phân cách `---` (**mới nhất lên đầu**), theo đúng dạng:
|
|
815
815
|
|
|
816
816
|
```markdown
|
|
817
817
|
### L-{NNN} — [{category}] {title}
|
|
818
|
-
- **Date**: {
|
|
818
|
+
- **Date**: {hôm nay YYYY-MM-DD}
|
|
819
819
|
- **Scope**: {scope}
|
|
820
820
|
- **Mistake**: {mistake}
|
|
821
821
|
- **Rule**: {rule}
|
|
@@ -823,8 +823,8 @@ Insert the new lesson directly under the `---` separator (**newest first**), in
|
|
|
823
823
|
|
|
824
824
|
```
|
|
825
825
|
|
|
826
|
-
## L5 —
|
|
826
|
+
## L5 — Xác nhận
|
|
827
827
|
|
|
828
|
-
|
|
829
|
-
|
|
828
|
+
In: `📝 Đã ghi lesson {id} → {lessons_path} ([{category}] {title})`
|
|
829
|
+
Rồi nhắc: `Commit {lessons_path} để cả team dùng chung guardrail này.`
|
|
830
830
|
|