@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/qc-report.md
CHANGED
|
@@ -6,148 +6,148 @@ ported_from: ai-automation-qc-base
|
|
|
6
6
|
|
|
7
7
|
# /qc-report — QC Test Report & Evidence
|
|
8
8
|
|
|
9
|
-
> Stage 6 (
|
|
9
|
+
> Stage 6 (cuối) của QC automation pipeline native (qc-analyze → qc-plan → qc-design-test → qc-review → qc-run-test → qc-report). Port từ bước report của qa-runner team QC.
|
|
10
10
|
|
|
11
11
|
## Gate
|
|
12
|
-
# Gate —
|
|
12
|
+
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
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ó.
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
19
19
|
|
|
20
|
-
1.
|
|
21
|
-
2.
|
|
22
|
-
- **
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
-
|
|
27
|
-
-
|
|
28
|
-
3.
|
|
20
|
+
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
21
|
+
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
22
|
+
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
23
|
+
- Đặt target file = `payload.target_file`
|
|
24
|
+
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
25
|
+
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
26
|
+
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
27
|
+
- Đi thẳng tới phần logic riêng của lệnh.
|
|
28
|
+
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).
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Bước 0-B — Kiểm tra Model
|
|
31
31
|
|
|
32
|
-
*
|
|
32
|
+
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
34
|
+
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.
|
|
35
|
+
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.
|
|
36
36
|
|
|
37
|
-
|
|
37
|
+
Hiển thị và chờ phản hồi:
|
|
38
38
|
|
|
39
39
|
```
|
|
40
40
|
⚙️ MODEL CHECK
|
|
41
41
|
──────────────────────────────────────────────────────────────────
|
|
42
|
-
Recommended : claude-opus-4 (
|
|
43
|
-
Why needed :
|
|
44
|
-
|
|
42
|
+
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
43
|
+
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
44
|
+
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
• Settings → Model →
|
|
48
|
-
•
|
|
46
|
+
Cách đổi trong Claude Code:
|
|
47
|
+
• Settings → Model → chọn "claude-opus"
|
|
48
|
+
• hoặc: /model → chọn claude-opus
|
|
49
49
|
|
|
50
|
-
|
|
51
|
-
Y —
|
|
52
|
-
S —
|
|
50
|
+
Đang chạy claude-opus?
|
|
51
|
+
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
52
|
+
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)
|
|
53
53
|
──────────────────────────────────────────────────────────────────
|
|
54
54
|
```
|
|
55
55
|
|
|
56
|
-
- "Y" →
|
|
57
|
-
- "S" →
|
|
58
|
-
- "N"
|
|
56
|
+
- "Y" → tiếp tục sang Bước 1.
|
|
57
|
+
- "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).
|
|
58
|
+
- "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."
|
|
59
59
|
|
|
60
|
-
##
|
|
60
|
+
## Bước 1 — Xác định Target File
|
|
61
61
|
|
|
62
|
-
1.
|
|
63
|
-
2.
|
|
64
|
-
- **BDD
|
|
65
|
-
- **PRD
|
|
66
|
-
- **tech-docs
|
|
67
|
-
- **design-spec
|
|
62
|
+
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.
|
|
63
|
+
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/`):
|
|
64
|
+
- **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 đó.
|
|
65
|
+
- **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.)*
|
|
66
|
+
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
67
|
+
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
3.
|
|
71
|
-
-
|
|
72
|
-
-
|
|
73
|
-
-
|
|
69
|
+
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.
|
|
70
|
+
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
71
|
+
- 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).
|
|
72
|
+
- 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)"
|
|
73
|
+
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
74
74
|
|
|
75
|
-
##
|
|
75
|
+
## Bước 2 — Chạy Context Loader
|
|
76
76
|
|
|
77
|
-
|
|
78
|
-
|
|
77
|
+
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`.
|
|
78
|
+
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.
|
|
79
79
|
|
|
80
|
-
##
|
|
80
|
+
## Bước 3 — CHECKPOINT
|
|
81
81
|
|
|
82
|
-
|
|
82
|
+
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:
|
|
83
83
|
|
|
84
84
|
```
|
|
85
85
|
CHECKPOINT
|
|
86
86
|
-----------
|
|
87
87
|
Target : {resolved file path}
|
|
88
|
-
Project : {project.name
|
|
88
|
+
Project : {project.name từ project-context.yaml}
|
|
89
89
|
Tech stack : {language} / {framework}
|
|
90
|
-
Module : {module
|
|
91
|
-
Domains : {
|
|
90
|
+
Module : {module nếu có, else "not configured"}
|
|
91
|
+
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
92
92
|
|
|
93
|
-
|
|
93
|
+
Tiếp tục? (Y/N)
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
|
|
97
|
-
- "Y" →
|
|
98
|
-
- "N" →
|
|
96
|
+
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
97
|
+
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
98
|
+
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
99
99
|
|
|
100
100
|
|
|
101
|
-
*
|
|
101
|
+
*Lưu ý: Với lệnh này, target ở Bước 1 là một UC-ID. Sinh report từ lần chạy `/qc-run-test` gần nhất. Dùng module **qc-playwright** (pytest-html + Playwright Trace — không Allure, không dashboard viết tay).*
|
|
102
102
|
|
|
103
103
|
## Context
|
|
104
|
-
# Context Loader —
|
|
104
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
105
105
|
|
|
106
|
-
|
|
106
|
+
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.
|
|
107
107
|
|
|
108
|
-
**
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
108
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
109
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
110
|
+
- 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.
|
|
111
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
112
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
113
|
+
- 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.
|
|
114
114
|
|
|
115
115
|
---
|
|
116
116
|
|
|
117
|
-
##
|
|
117
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
120
120
|
|
|
121
121
|
**Tech Stack:**
|
|
122
|
-
- `tech_stack.language` →
|
|
123
|
-
- `tech_stack.framework` →
|
|
124
|
-
- `tech_stack.build_tool` → build tool (
|
|
125
|
-
- `tech_stack.test_framework` → test framework (
|
|
126
|
-
- `tech_stack.database` → database (
|
|
127
|
-
- `tech_stack.module` →
|
|
122
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
123
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
124
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
125
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
126
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
127
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
128
128
|
|
|
129
129
|
**Conventions:**
|
|
130
|
-
- `conventions.build_command` →
|
|
131
|
-
- `conventions.test_command` →
|
|
132
|
-
- `conventions.service_run` →
|
|
133
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
130
|
+
- `conventions.build_command` → cách compile/build
|
|
131
|
+
- `conventions.test_command` → cách chạy test
|
|
132
|
+
- `conventions.service_run` → cách khởi động service
|
|
133
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
134
134
|
|
|
135
135
|
**Domains:**
|
|
136
|
-
- `domains` →
|
|
137
|
-
|
|
138
|
-
**Paths (
|
|
139
|
-
- `paths.specs_dir` → spec
|
|
140
|
-
- `paths.refinement_dir` → findings/review
|
|
141
|
-
- `paths.qc_dir` → QC automation
|
|
142
|
-
- `paths.qc_skills_dir` →
|
|
143
|
-
- `paths.product_definitions_dir` → product
|
|
144
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
145
|
-
- `paths.business_dictionary` → path
|
|
146
|
-
- `paths.core_entities` → path
|
|
147
|
-
- `paths.tech_docs_dir` →
|
|
148
|
-
- `paths.trace_dir` →
|
|
149
|
-
|
|
150
|
-
|
|
136
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
137
|
+
|
|
138
|
+
**Paths (nếu có):**
|
|
139
|
+
- `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)
|
|
140
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
141
|
+
- `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}/`)
|
|
142
|
+
- `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 đè)
|
|
143
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
144
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
145
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
146
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
147
|
+
- `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/`)
|
|
148
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
149
|
+
|
|
150
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
151
151
|
- `specs_dir` = `specs`
|
|
152
152
|
- `refinement_dir` = `.agent/review`
|
|
153
153
|
- `qc_dir` = `docs`
|
|
@@ -159,184 +159,184 @@ If `paths` section is absent, use these defaults:
|
|
|
159
159
|
- `tech_docs_dir` = `specs`
|
|
160
160
|
- `trace_dir` = `.trace`
|
|
161
161
|
|
|
162
|
-
|
|
162
|
+
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.
|
|
163
163
|
|
|
164
|
-
**
|
|
165
|
-
- `specs/payment/create-invoice/
|
|
166
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
167
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
168
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
164
|
+
**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ụ:
|
|
165
|
+
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
166
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
167
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
168
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
169
169
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
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ừ đó.
|
|
172
172
|
|
|
173
|
-
|
|
173
|
+
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.
|
|
174
174
|
|
|
175
175
|
---
|
|
176
176
|
|
|
177
|
-
##
|
|
177
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
178
178
|
|
|
179
|
-
*
|
|
179
|
+
*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.*
|
|
180
180
|
|
|
181
|
-
|
|
181
|
+
Nếu có section `services`:
|
|
182
182
|
|
|
183
|
-
**1.
|
|
184
|
-
-
|
|
185
|
-
-
|
|
186
|
-
*(
|
|
187
|
-
-
|
|
183
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
184
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
185
|
+
- 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.
|
|
186
|
+
*(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`)*
|
|
187
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
188
188
|
|
|
189
|
-
**2. Route
|
|
190
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
191
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
192
|
-
-
|
|
193
|
-
-
|
|
194
|
-
-
|
|
189
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
190
|
+
- 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.
|
|
191
|
+
- 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.
|
|
192
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
193
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
194
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
195
195
|
|
|
196
|
-
**3. Fallback** —
|
|
197
|
-
-
|
|
198
|
-
-
|
|
196
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
197
|
+
- Giữ path mặc định từ Bước 1
|
|
198
|
+
- Đặt `active_service = unresolved`
|
|
199
199
|
|
|
200
|
-
**4.
|
|
201
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
202
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
200
|
+
**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:`:
|
|
201
|
+
- 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`.)*
|
|
202
|
+
- 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.)*
|
|
203
203
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
204
204
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
205
205
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
206
206
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
207
207
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
208
208
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
209
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
209
|
+
- 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`.)*
|
|
210
210
|
|
|
211
|
-
> **
|
|
211
|
+
> **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.
|
|
212
212
|
|
|
213
213
|
---
|
|
214
214
|
|
|
215
|
-
##
|
|
215
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
216
216
|
|
|
217
|
-
*
|
|
217
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
218
218
|
|
|
219
|
-
|
|
219
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
220
220
|
|
|
221
|
-
**1.
|
|
221
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
222
222
|
- `{active_service}/.agent/project-context.yaml`
|
|
223
223
|
- `{active_service}/project-context.yaml`
|
|
224
224
|
|
|
225
|
-
**2.
|
|
225
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
226
226
|
|
|
227
|
-
|
|
|
227
|
+
| Biến | Nguồn |
|
|
228
228
|
|----------|--------|
|
|
229
|
-
| `conventions.test_command` |
|
|
230
|
-
| `conventions.build_command` |
|
|
231
|
-
| `paths.trace_dir` | **
|
|
232
|
-
| `paths.specs_dir` | **
|
|
229
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
230
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
231
|
+
| `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`). |
|
|
232
|
+
| `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. |
|
|
233
233
|
|
|
234
|
-
**3.
|
|
235
|
-
-
|
|
236
|
-
- **
|
|
234
|
+
**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:
|
|
235
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
236
|
+
- **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/`).
|
|
237
237
|
|
|
238
|
-
**4.
|
|
238
|
+
**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).
|
|
239
239
|
|
|
240
240
|
---
|
|
241
241
|
|
|
242
|
-
##
|
|
242
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
243
243
|
|
|
244
|
-
|
|
245
|
-
Merge framework
|
|
246
|
-
|
|
244
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
245
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
246
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
247
247
|
|
|
248
248
|
---
|
|
249
249
|
|
|
250
|
-
##
|
|
250
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
251
251
|
|
|
252
|
-
|
|
252
|
+
*Đâ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.*
|
|
253
253
|
|
|
254
|
-
CLAUDE.md
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
254
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
255
|
+
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
|
|
256
|
+
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
|
|
257
|
+
service phải thắng khi sinh code.
|
|
258
258
|
|
|
259
|
-
**
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
259
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
260
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
261
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
262
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
263
263
|
|
|
264
|
-
**
|
|
265
|
-
*
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
Overlay
|
|
269
|
-
coding standards,
|
|
270
|
-
(
|
|
264
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
265
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
266
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
267
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
268
|
+
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,
|
|
269
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
270
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
271
271
|
|
|
272
|
-
|
|
272
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
273
273
|
|
|
274
|
-
- **§1 Project Overview** →
|
|
275
|
-
- **§2 Architecture** → layer
|
|
276
|
-
- **§3 Coding Standards** →
|
|
277
|
-
- **§5 Error Handling** → exception
|
|
278
|
-
- **§7 Git Conventions** →
|
|
274
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
275
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
276
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
277
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
278
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
279
279
|
|
|
280
|
-
**
|
|
281
|
-
-
|
|
282
|
-
-
|
|
283
|
-
-
|
|
284
|
-
-
|
|
280
|
+
**Quy tắc phân giải:**
|
|
281
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
282
|
+
- 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}`.
|
|
283
|
+
- 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).
|
|
284
|
+
- 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.
|
|
285
285
|
|
|
286
286
|
---
|
|
287
287
|
|
|
288
|
-
##
|
|
288
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
289
289
|
|
|
290
|
-
|
|
290
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
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.
|
|
293
293
|
|
|
294
|
-
|
|
294
|
+
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*`.
|
|
295
295
|
|
|
296
296
|
---
|
|
297
297
|
|
|
298
|
-
##
|
|
298
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
299
299
|
|
|
300
|
-
|
|
300
|
+
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).
|
|
301
301
|
|
|
302
|
-
|
|
303
|
-
- **Canonical Terms** →
|
|
304
|
-
- **Banned Terms** →
|
|
305
|
-
- **Status / Enum Registry** →
|
|
302
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
303
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
304
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
305
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
306
306
|
|
|
307
|
-
|
|
308
|
-
-
|
|
309
|
-
-
|
|
307
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
308
|
+
- 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
|
|
309
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
310
310
|
|
|
311
|
-
|
|
311
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
312
312
|
|
|
313
313
|
---
|
|
314
314
|
|
|
315
|
-
##
|
|
315
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
316
316
|
|
|
317
|
-
|
|
318
|
-
|
|
317
|
+
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).
|
|
318
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
319
319
|
|
|
320
|
-
|
|
321
|
-
- **Entity catalog** →
|
|
322
|
-
- **Field name registry** →
|
|
323
|
-
- **Relationship map** →
|
|
320
|
+
Nếu tồn tại, đọc và lưu:
|
|
321
|
+
- **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ệ
|
|
322
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
323
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
324
324
|
|
|
325
|
-
**
|
|
326
|
-
-
|
|
327
|
-
-
|
|
328
|
-
-
|
|
325
|
+
**Cách dùng catalog này:**
|
|
326
|
+
- 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
|
|
327
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
328
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
329
329
|
|
|
330
|
-
|
|
330
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
331
331
|
|
|
332
332
|
---
|
|
333
333
|
|
|
334
|
-
##
|
|
334
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
335
335
|
|
|
336
|
-
|
|
336
|
+
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:
|
|
337
337
|
|
|
338
338
|
```
|
|
339
|
-
active_module = tech_stack.module (
|
|
339
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
340
340
|
```
|
|
341
341
|
|
|
342
342
|
| `platform_type` | Modules |
|
|
@@ -345,131 +345,131 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
345
345
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
346
346
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
347
347
|
|
|
348
|
-
|
|
348
|
+
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.
|
|
349
349
|
|
|
350
|
-
|
|
350
|
+
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).
|
|
351
351
|
|
|
352
352
|
---
|
|
353
353
|
|
|
354
|
-
##
|
|
354
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
355
355
|
|
|
356
|
-
*
|
|
357
|
-
|
|
356
|
+
*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`
|
|
357
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
358
358
|
|
|
359
|
-
|
|
360
|
-
-
|
|
361
|
-
- Else
|
|
362
|
-
-
|
|
359
|
+
Phân giải path file lessons:
|
|
360
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
361
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
362
|
+
- Ở 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`
|
|
363
363
|
|
|
364
|
-
|
|
365
|
-
-
|
|
366
|
-
-
|
|
367
|
-
-
|
|
364
|
+
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:
|
|
365
|
+
- 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).
|
|
366
|
+
- 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).
|
|
367
|
+
- 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.
|
|
368
368
|
|
|
369
|
-
|
|
369
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
370
370
|
|
|
371
371
|
---
|
|
372
372
|
|
|
373
|
-
##
|
|
373
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
374
374
|
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
(recency
|
|
375
|
+
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.
|
|
376
|
+
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
|
|
377
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
378
378
|
|
|
379
|
-
|
|
379
|
+
Xuất đúng khối này:
|
|
380
380
|
```
|
|
381
381
|
[CTX LOADED]
|
|
382
382
|
Stack : {language} / {framework} / {database}
|
|
383
383
|
Platform : {active_module} ({platform_type})
|
|
384
|
-
Layers : {
|
|
385
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
384
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
385
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
386
386
|
Ticket : {ticket_prefix}-
|
|
387
387
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
388
388
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
389
|
-
Lessons : {loaded — N guardrails |
|
|
389
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
390
390
|
Service : {active_service} ({active_service_module}) | single-service
|
|
391
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
392
|
-
Status : {FULL | PARTIAL —
|
|
391
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
392
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
393
393
|
```
|
|
394
394
|
|
|
395
|
-
|
|
395
|
+
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.
|
|
396
396
|
|
|
397
397
|
---
|
|
398
398
|
|
|
399
|
-
##
|
|
399
|
+
## Hoàn tất nạp Context
|
|
400
400
|
|
|
401
|
-
|
|
402
|
-
-
|
|
403
|
-
-
|
|
404
|
-
- Coding standards
|
|
405
|
-
-
|
|
406
|
-
-
|
|
407
|
-
- Entity catalog (field
|
|
408
|
-
-
|
|
401
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
402
|
+
- Định danh dự án, tech stack, convention module
|
|
403
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
404
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
405
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
406
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
407
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
408
|
+
- Toàn bộ path đã cấu hình
|
|
409
409
|
|
|
410
|
-
|
|
410
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
411
411
|
|
|
412
412
|
|
|
413
413
|
---
|
|
414
414
|
|
|
415
415
|
## Role
|
|
416
416
|
|
|
417
|
-
|
|
417
|
+
Bạn là stage **QC Report** — biến lần chạy gần nhất thành report + evidence chia sẻ được.
|
|
418
418
|
|
|
419
419
|
## Skill (`{paths.qc_skills_dir}/qa-runner/report/`)
|
|
420
420
|
|
|
421
|
-
- `report.md` —
|
|
422
|
-
--self-contained-html`) + Playwright Trace (`test-results/<nodeid>/trace.zip`,
|
|
423
|
-
`python3 -m playwright show-trace <file>`),
|
|
421
|
+
- `report.md` — tự đủ: pytest-html (`--html=reports/<feature>/report.html
|
|
422
|
+
--self-contained-html`) + Playwright Trace (`test-results/<nodeid>/trace.zip`, xem qua
|
|
423
|
+
`python3 -m playwright show-trace <file>`), kèm screenshot/evidence đính trên FAIL/SKIP.
|
|
424
424
|
|
|
425
425
|
## Procedure
|
|
426
426
|
|
|
427
|
-
1.
|
|
428
|
-
2.
|
|
429
|
-
FAIL/SKIP
|
|
430
|
-
3.
|
|
431
|
-
|
|
432
|
-
4. **
|
|
433
|
-
(
|
|
434
|
-
`/report-bug {UC-ID} {one-line expected-vs-actual}`
|
|
435
|
-
`/report-bug`
|
|
436
|
-
fake-pass
|
|
437
|
-
|
|
427
|
+
1. Định vị artifact của lần chạy gần nhất cho `{UC-ID}` (report pytest-html + trace).
|
|
428
|
+
2. Sinh/làm mới `reports/<feature>/report.html` (self-contained) và đảm bảo mỗi
|
|
429
|
+
FAIL/SKIP có trace + screenshot đính kèm.
|
|
430
|
+
3. Tóm tắt TOTAL / PASS / FAIL / SKIP; với mỗi FAIL gồm lệnh `show-trace` và
|
|
431
|
+
phân loại là script-bug hay product-gap.
|
|
432
|
+
4. **Bàn giao product-gap về spec (có nhắc).** Với mỗi FAIL phân loại **product-gap**
|
|
433
|
+
(defect thật, impl ≠ spec — không phải script-bug), in một
|
|
434
|
+
`/report-bug {UC-ID} {one-line expected-vs-actual}` sẵn-chạy để QC file nó vào spec repo dùng chung.
|
|
435
|
+
BUG_FLOW của `/report-bug` rồi định tuyến root cause (Code / BDD / PRD / Design / Env). Không bao giờ
|
|
436
|
+
fake-pass một product-gap — nó giữ FAIL trong `qc_status` cho tới khi fix + chạy lại. **script-bug
|
|
437
|
+
KHÔNG được file** (QC fix script và chạy lại). Liệt kê các lệnh; đừng tự tạo report.
|
|
438
438
|
|
|
439
439
|
## Report
|
|
440
440
|
|
|
441
|
-
# Report Footer —
|
|
441
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
442
442
|
|
|
443
|
-
|
|
443
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
444
444
|
|
|
445
445
|
## Status Badge
|
|
446
446
|
|
|
447
|
-
|
|
448
|
-
- `✅ Complete` —
|
|
449
|
-
- `❌ Failed` —
|
|
450
|
-
- `⚠️ Warnings` —
|
|
447
|
+
Chọn một theo kết quả:
|
|
448
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
449
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
450
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
451
451
|
|
|
452
452
|
## Output Artifacts
|
|
453
453
|
|
|
454
|
-
|
|
454
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
455
455
|
```
|
|
456
456
|
Output Artifacts:
|
|
457
|
-
{created|updated} {file-path} ({
|
|
458
|
-
{created|updated} {file-path} ({
|
|
457
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
458
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
459
459
|
```
|
|
460
460
|
|
|
461
|
-
|
|
461
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
462
462
|
|
|
463
463
|
## Pipeline Position
|
|
464
464
|
|
|
465
|
-
|
|
466
|
-
|
|
465
|
+
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`,
|
|
466
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
467
467
|
|
|
468
468
|
```
|
|
469
469
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
470
470
|
```
|
|
471
471
|
|
|
472
|
-
|
|
472
|
+
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:
|
|
473
473
|
|
|
474
474
|
| Phase | Commands |
|
|
475
475
|
|-------|----------|
|
|
@@ -483,72 +483,72 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
483
483
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
484
484
|
| Trace Audit | `/validate-traces` |
|
|
485
485
|
|
|
486
|
-
|
|
486
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
487
487
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
488
488
|
|
|
489
|
-
**
|
|
490
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
491
|
-
**
|
|
489
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
490
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
491
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
492
492
|
|
|
493
|
-
##
|
|
493
|
+
## Gợi ý lệnh tiếp theo
|
|
494
494
|
|
|
495
|
-
|
|
495
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
496
496
|
|
|
497
|
-
|
|
|
497
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
498
498
|
|-------------------------|-----------------------------------------------|
|
|
499
|
-
| /setup-ai-first | `/define-product`
|
|
499
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
500
500
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
501
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
502
|
-
| /refine-prd |
|
|
503
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
504
|
-
| /generate-design-spec | Designer review →
|
|
505
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
506
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
507
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
501
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
502
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
503
|
+
| /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 |
|
|
504
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
505
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
506
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
507
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
508
508
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
509
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
510
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
511
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
512
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
513
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
509
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
510
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
511
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
512
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
513
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
514
514
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
515
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
516
|
-
| /generate-code |
|
|
515
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
516
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
517
517
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
518
518
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
519
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
520
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
521
|
-
| /dev-smoke-test |
|
|
522
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
523
|
-
| /fix-bug |
|
|
524
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
525
|
-
| /report-bug |
|
|
526
|
-
| /propose-scenario |
|
|
527
|
-
| /learn |
|
|
528
|
-
| /sync | `/validate-traces`
|
|
529
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
530
|
-
|
|
531
|
-
|
|
519
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
520
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
521
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
522
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
523
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
524
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
525
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
526
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
527
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
528
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
529
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
530
|
+
|
|
531
|
+
Định dạng footer như sau:
|
|
532
532
|
```
|
|
533
533
|
---
|
|
534
534
|
Status : {badge}
|
|
535
|
-
{Output Artifacts
|
|
535
|
+
{khối Output Artifacts}
|
|
536
536
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
537
|
-
(review
|
|
538
|
-
Next : {
|
|
537
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
538
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
539
539
|
```
|
|
540
|
-
*(
|
|
540
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
541
541
|
|
|
542
542
|
|
|
543
543
|
```
|
|
544
|
-
/qc-report
|
|
544
|
+
/qc-report Hoàn tất — {UC-ID}
|
|
545
545
|
Report: reports/<feature>/report.html (TOTAL {N} · PASS {p} · FAIL {f} · SKIP {s})
|
|
546
546
|
Trace : test-results/<nodeid>/trace.zip (python3 -m playwright show-trace <file>)
|
|
547
547
|
|
|
548
|
-
Product-
|
|
548
|
+
Product-gap cần file ({g}): ← chạy các lệnh này để PO/Dev thấy trên /sync (script-bug bị loại)
|
|
549
549
|
/report-bug {UC-ID} {gap 1 — expected vs actual}
|
|
550
550
|
/report-bug {UC-ID} {gap 2 …}
|
|
551
|
-
(
|
|
551
|
+
(không có → skip)
|
|
552
552
|
|
|
553
|
-
Next: /validate-traces {UC-ID} ←
|
|
553
|
+
Next: /validate-traces {UC-ID} ← làm mới Living Docs (qc_status), rồi tạo PR
|
|
554
554
|
```
|