@edupia-tutor/spec-driven-docs 0.14.0 → 0.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/index.js +12 -1
- package/commands/debug.md +436 -436
- package/commands/debug.tmpl +111 -111
- package/commands/define-product.md +350 -345
- package/commands/define-product.tmpl +69 -64
- package/commands/dev-gen-test.md +365 -365
- package/commands/dev-gen-test.tmpl +63 -63
- package/commands/dev-run-test.md +376 -376
- package/commands/dev-run-test.tmpl +74 -74
- package/commands/dev-smoke-test.md +341 -341
- package/commands/dev-smoke-test.tmpl +60 -60
- package/commands/fix-bug.md +403 -403
- package/commands/fix-bug.tmpl +78 -78
- package/commands/generate-bdd.md +513 -513
- package/commands/generate-bdd.tmpl +211 -211
- package/commands/generate-code.md +481 -483
- package/commands/generate-code.tmpl +179 -181
- package/commands/generate-design-spec.md +497 -497
- package/commands/generate-design-spec.tmpl +220 -220
- package/commands/generate-prd.md +452 -400
- package/commands/generate-prd.tmpl +50 -200
- package/commands/generate-spec-manifest.md +340 -340
- package/commands/generate-spec-manifest.tmpl +59 -59
- package/commands/generate-tech-docs.md +365 -365
- package/commands/generate-tech-docs.tmpl +84 -84
- package/commands/learn.md +347 -347
- package/commands/learn.tmpl +22 -22
- package/commands/map-testids.md +322 -322
- package/commands/map-testids.tmpl +41 -41
- package/commands/propose-scenario.md +335 -335
- package/commands/propose-scenario.tmpl +54 -54
- package/commands/qc-analyze.md +323 -324
- package/commands/qc-analyze.tmpl +42 -43
- package/commands/qc-design-test.md +304 -304
- package/commands/qc-design-test.tmpl +23 -23
- package/commands/qc-plan.md +297 -297
- package/commands/qc-plan.tmpl +16 -16
- package/commands/qc-report.md +302 -302
- package/commands/qc-report.tmpl +21 -21
- package/commands/qc-review.md +298 -298
- package/commands/qc-review.tmpl +17 -17
- package/commands/qc-run-test.md +337 -337
- package/commands/qc-run-test.tmpl +35 -35
- package/commands/refine-prd.md +428 -430
- package/commands/refine-prd.tmpl +62 -62
- package/commands/report-bug.md +351 -351
- package/commands/report-bug.tmpl +70 -70
- package/commands/review-code.md +364 -364
- package/commands/review-code.tmpl +39 -39
- package/commands/review-context.md +578 -580
- package/commands/review-context.tmpl +212 -212
- package/commands/review-tech-docs.md +427 -427
- package/commands/review-tech-docs.tmpl +146 -146
- package/commands/setup-ai-first.md +239 -239
- package/commands/setup-ai-first.tmpl +133 -133
- package/commands/sync.md +145 -145
- package/commands/sync.tmpl +93 -93
- package/commands/update-framework.md +88 -88
- package/commands/update-framework.tmpl +36 -36
- package/commands/validate-traces.md +381 -381
- package/commands/validate-traces.tmpl +100 -100
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +436 -436
- package/core/commands/define-product.md +350 -345
- package/core/commands/dev-gen-test.md +365 -365
- package/core/commands/dev-run-test.md +376 -376
- package/core/commands/dev-smoke-test.md +341 -341
- package/core/commands/fix-bug.md +403 -403
- package/core/commands/generate-bdd.md +513 -513
- package/core/commands/generate-code.md +481 -483
- package/core/commands/generate-design-spec.md +497 -497
- package/core/commands/generate-prd.md +452 -400
- package/core/commands/generate-spec-manifest.md +340 -340
- package/core/commands/generate-tech-docs.md +365 -365
- package/core/commands/learn.md +347 -347
- package/core/commands/map-testids.md +322 -322
- package/core/commands/propose-scenario.md +335 -335
- package/core/commands/qc-analyze.md +323 -324
- package/core/commands/qc-design-test.md +304 -304
- package/core/commands/qc-plan.md +297 -297
- package/core/commands/qc-report.md +302 -302
- package/core/commands/qc-review.md +298 -298
- package/core/commands/qc-run-test.md +337 -337
- package/core/commands/refine-prd.md +428 -430
- package/core/commands/report-bug.md +351 -351
- package/core/commands/review-code.md +364 -364
- package/core/commands/review-context.md +578 -580
- package/core/commands/review-tech-docs.md +427 -427
- package/core/commands/setup-ai-first.md +239 -239
- package/core/commands/sync.md +145 -145
- package/core/commands/update-framework.md +88 -88
- package/core/commands/validate-traces.md +381 -381
- package/core/skills/code/SKILL.md +389 -389
- package/core/skills/debug/SKILL.md +391 -391
- package/core/skills/design-spec/SKILL.md +318 -318
- package/core/skills/discovery/SKILL.md +7 -547
- package/core/skills/prd/SKILL.md +298 -394
- package/core/skills/setup-ai-first/SKILL.md +80 -80
- package/core/skills/spec/SKILL.md +178 -178
- package/core/skills/test/SKILL.md +604 -604
- package/core/steps/capture-lesson.md +44 -44
- package/core/steps/context-loader.md +175 -175
- package/core/steps/gate.md +54 -54
- package/core/steps/report-footer.md +52 -52
- package/core/steps/review-fanout.md +85 -87
- package/core/steps/spawn-agent.md +45 -45
- package/core/steps/trace-mirror.md +21 -21
- package/core/templates/architecture.template.md +37 -37
- package/core/templates/design-spec.template.md +77 -77
- package/core/templates/platform-guide.template.md +47 -47
- package/core/templates/prd.template.md +107 -232
- package/core/templates/product-definition.template.md +101 -88
- package/core/templates/project-context.yaml +2 -2
- package/docs/01-getting-started/core-concepts.md +1 -1
- package/docs/01-getting-started/quickstart.md +7 -7
- package/docs/02-guides/developer/bdd-and-trace.md +1 -1
- package/docs/02-guides/developer/scenarios.md +5 -5
- package/docs/02-guides/product-owner/handoff-checklist.md +1 -1
- package/docs/02-guides/product-owner/scenarios.md +23 -23
- package/docs/02-guides/tester/bug-reporting.md +2 -2
- package/docs/02-guides/tester/reading-specs.md +2 -2
- package/docs/02-guides/tester/scenarios.md +1 -1
- package/docs/02-guides/tester/spec-manifest.md +3 -3
- package/docs/02-guides/tester/workflow.md +1 -1
- package/docs/03-concepts/architecture.md +3 -3
- package/docs/03-concepts/pipeline.md +3 -3
- package/docs/04-operations/publishing.md +20 -3
- package/docs/04-operations/sync-and-update.md +5 -5
- package/docs/05-reference/command-cheatsheet.md +2 -2
- package/docs/05-reference/commands.md +8 -8
- package/package.json +1 -1
- package/scripts/migrate-specs.js +5 -3
- package/scripts/rename-prd-files.js +174 -0
- package/skills/code/SKILL.md +389 -389
- package/skills/code/SKILL.tmpl +56 -56
- package/skills/debug/SKILL.md +391 -391
- package/skills/debug/SKILL.tmpl +60 -60
- package/skills/design-spec/SKILL.md +318 -318
- package/skills/design-spec/SKILL.tmpl +37 -37
- package/skills/discovery/SKILL.md +7 -547
- package/skills/discovery/SKILL.tmpl +7 -140
- package/skills/prd/SKILL.md +298 -394
- package/skills/prd/SKILL.tmpl +40 -151
- package/skills/setup-ai-first/SKILL.md +80 -80
- package/skills/setup-ai-first/SKILL.tmpl +28 -28
- package/skills/spec/SKILL.md +178 -178
- package/skills/spec/SKILL.tmpl +20 -20
- package/skills/test/SKILL.md +604 -604
- package/skills/test/SKILL.tmpl +44 -44
- package/steps/capture-lesson.md +44 -44
- package/steps/context-loader.md +175 -175
- package/steps/gate.md +54 -54
- package/steps/report-footer.md +52 -52
- package/steps/review-fanout.md +85 -87
- package/steps/spawn-agent.md +45 -45
- package/steps/trace-mirror.md +21 -21
- package/templates/architecture.template.md +37 -37
- package/templates/design-spec.template.md +77 -77
- package/templates/platform-guide.template.md +47 -47
- package/templates/prd.template.md +107 -232
- package/templates/product-definition.template.md +101 -88
- package/templates/project-context.yaml +2 -2
|
@@ -1,151 +1,151 @@
|
|
|
1
|
-
# /dev-run-test —
|
|
1
|
+
# /dev-run-test — Chạy Dev Self-Check Tests & Report kết quả
|
|
2
2
|
|
|
3
|
-
> **Scope — dev self-check (smoke),
|
|
4
|
-
>
|
|
5
|
-
>
|
|
6
|
-
>
|
|
7
|
-
> dev
|
|
3
|
+
> **Scope — dev self-check (smoke), không phải bộ test chính thức.** Chạy các test do
|
|
4
|
+
> `/dev-gen-test` sinh ra để dev xác nhận code mình chạy được trước khi review. Đây là một
|
|
5
|
+
> self-check của dev, **không** phải lần chạy test authoritative của QC/dev-team (flow riêng).
|
|
6
|
+
> Pass/fail được publish lên Living Docs như tín hiệu **dev self-test** — nó cho QC biết
|
|
7
|
+
> dev đã chạy check của họ; KHÔNG phải tuyên bố về độ phủ test chính thức.
|
|
8
8
|
|
|
9
9
|
## Gate
|
|
10
|
-
# Gate —
|
|
10
|
+
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
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ó.
|
|
13
13
|
|
|
14
|
-
##
|
|
14
|
+
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
15
15
|
|
|
16
|
-
|
|
16
|
+
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
17
17
|
|
|
18
|
-
1.
|
|
19
|
-
2.
|
|
20
|
-
- **
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
25
|
-
-
|
|
26
|
-
3.
|
|
18
|
+
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
19
|
+
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
20
|
+
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
21
|
+
- Đặt target file = `payload.target_file`
|
|
22
|
+
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
23
|
+
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
24
|
+
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
25
|
+
- Đi thẳng tới phần logic riêng của lệnh.
|
|
26
|
+
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).
|
|
27
27
|
|
|
28
|
-
##
|
|
28
|
+
## Bước 0-B — Kiểm tra Model
|
|
29
29
|
|
|
30
|
-
*
|
|
30
|
+
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
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.
|
|
33
|
+
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.
|
|
34
34
|
|
|
35
|
-
|
|
35
|
+
Hiển thị và chờ phản hồi:
|
|
36
36
|
|
|
37
37
|
```
|
|
38
38
|
⚙️ MODEL CHECK
|
|
39
39
|
──────────────────────────────────────────────────────────────────
|
|
40
|
-
Recommended : claude-opus-4 (
|
|
41
|
-
Why needed :
|
|
42
|
-
|
|
40
|
+
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
41
|
+
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
42
|
+
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
43
43
|
|
|
44
|
-
|
|
45
|
-
• Settings → Model →
|
|
46
|
-
•
|
|
44
|
+
Cách đổi trong Claude Code:
|
|
45
|
+
• Settings → Model → chọn "claude-opus"
|
|
46
|
+
• hoặc: /model → chọn claude-opus
|
|
47
47
|
|
|
48
|
-
|
|
49
|
-
Y —
|
|
50
|
-
S —
|
|
48
|
+
Đang chạy claude-opus?
|
|
49
|
+
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
50
|
+
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)
|
|
51
51
|
──────────────────────────────────────────────────────────────────
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
- "Y" →
|
|
55
|
-
- "S" →
|
|
56
|
-
- "N"
|
|
54
|
+
- "Y" → tiếp tục sang Bước 1.
|
|
55
|
+
- "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).
|
|
56
|
+
- "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."
|
|
57
57
|
|
|
58
|
-
##
|
|
58
|
+
## Bước 1 — Xác định Target File
|
|
59
59
|
|
|
60
|
-
1.
|
|
61
|
-
2.
|
|
62
|
-
- **BDD
|
|
63
|
-
- **PRD
|
|
64
|
-
- **tech-docs
|
|
65
|
-
- **design-spec
|
|
60
|
+
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.
|
|
61
|
+
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/`):
|
|
62
|
+
- **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 đó.
|
|
63
|
+
- **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.)*
|
|
64
|
+
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
65
|
+
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
66
66
|
|
|
67
|
-
|
|
68
|
-
3.
|
|
69
|
-
-
|
|
70
|
-
-
|
|
71
|
-
-
|
|
67
|
+
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.
|
|
68
|
+
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
69
|
+
- 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).
|
|
70
|
+
- 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)"
|
|
71
|
+
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
72
72
|
|
|
73
|
-
##
|
|
73
|
+
## Bước 2 — Chạy Context Loader
|
|
74
74
|
|
|
75
|
-
|
|
76
|
-
|
|
75
|
+
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`.
|
|
76
|
+
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.
|
|
77
77
|
|
|
78
|
-
##
|
|
78
|
+
## Bước 3 — CHECKPOINT
|
|
79
79
|
|
|
80
|
-
|
|
80
|
+
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:
|
|
81
81
|
|
|
82
82
|
```
|
|
83
83
|
CHECKPOINT
|
|
84
84
|
-----------
|
|
85
85
|
Target : {resolved file path}
|
|
86
|
-
Project : {project.name
|
|
86
|
+
Project : {project.name từ project-context.yaml}
|
|
87
87
|
Tech stack : {language} / {framework}
|
|
88
|
-
Module : {module
|
|
89
|
-
Domains : {
|
|
88
|
+
Module : {module nếu có, else "not configured"}
|
|
89
|
+
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
90
90
|
|
|
91
|
-
|
|
91
|
+
Tiếp tục? (Y/N)
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
|
|
95
|
-
- "Y" →
|
|
96
|
-
- "N" →
|
|
94
|
+
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
95
|
+
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
96
|
+
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
97
97
|
|
|
98
98
|
|
|
99
|
-
*
|
|
99
|
+
*Lưu ý: Với lệnh này, target ở Bước 1 là một UC-ID hoặc tên service. Context loading cung cấp `conventions.test_command` và `tech_stack.module`.*
|
|
100
100
|
|
|
101
101
|
## Context
|
|
102
|
-
# Context Loader —
|
|
102
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
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.
|
|
105
105
|
|
|
106
|
-
**
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
106
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
107
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
108
|
+
- 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.
|
|
109
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
110
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
111
|
+
- 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.
|
|
112
112
|
|
|
113
113
|
---
|
|
114
114
|
|
|
115
|
-
##
|
|
115
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
116
116
|
|
|
117
|
-
|
|
117
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
118
118
|
|
|
119
119
|
**Tech Stack:**
|
|
120
|
-
- `tech_stack.language` →
|
|
121
|
-
- `tech_stack.framework` →
|
|
122
|
-
- `tech_stack.build_tool` → build tool (
|
|
123
|
-
- `tech_stack.test_framework` → test framework (
|
|
124
|
-
- `tech_stack.database` → database (
|
|
125
|
-
- `tech_stack.module` →
|
|
120
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
121
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
122
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
123
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
124
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
125
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
126
126
|
|
|
127
127
|
**Conventions:**
|
|
128
|
-
- `conventions.build_command` →
|
|
129
|
-
- `conventions.test_command` →
|
|
130
|
-
- `conventions.service_run` →
|
|
131
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
128
|
+
- `conventions.build_command` → cách compile/build
|
|
129
|
+
- `conventions.test_command` → cách chạy test
|
|
130
|
+
- `conventions.service_run` → cách khởi động service
|
|
131
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
132
132
|
|
|
133
133
|
**Domains:**
|
|
134
|
-
- `domains` →
|
|
135
|
-
|
|
136
|
-
**Paths (
|
|
137
|
-
- `paths.specs_dir` → spec
|
|
138
|
-
- `paths.refinement_dir` → findings/review
|
|
139
|
-
- `paths.qc_dir` → QC automation
|
|
140
|
-
- `paths.qc_skills_dir` →
|
|
141
|
-
- `paths.product_definitions_dir` → product
|
|
142
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
143
|
-
- `paths.business_dictionary` → path
|
|
144
|
-
- `paths.core_entities` → path
|
|
145
|
-
- `paths.tech_docs_dir` →
|
|
146
|
-
- `paths.trace_dir` →
|
|
147
|
-
|
|
148
|
-
|
|
134
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
135
|
+
|
|
136
|
+
**Paths (nếu có):**
|
|
137
|
+
- `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)
|
|
138
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
139
|
+
- `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}/`)
|
|
140
|
+
- `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 đè)
|
|
141
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
142
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
143
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
144
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
145
|
+
- `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/`)
|
|
146
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
147
|
+
|
|
148
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
149
149
|
- `specs_dir` = `specs`
|
|
150
150
|
- `refinement_dir` = `.agent/review`
|
|
151
151
|
- `qc_dir` = `docs`
|
|
@@ -157,184 +157,184 @@ If `paths` section is absent, use these defaults:
|
|
|
157
157
|
- `tech_docs_dir` = `specs`
|
|
158
158
|
- `trace_dir` = `.trace`
|
|
159
159
|
|
|
160
|
-
|
|
160
|
+
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.
|
|
161
161
|
|
|
162
|
-
**
|
|
163
|
-
- `specs/payment/create-invoice/
|
|
164
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
165
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
166
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
162
|
+
**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ụ:
|
|
163
|
+
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
164
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
165
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
166
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
167
167
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
168
168
|
|
|
169
|
-
|
|
169
|
+
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ừ đó.
|
|
170
170
|
|
|
171
|
-
|
|
171
|
+
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.
|
|
172
172
|
|
|
173
173
|
---
|
|
174
174
|
|
|
175
|
-
##
|
|
175
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
176
176
|
|
|
177
|
-
*
|
|
177
|
+
*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.*
|
|
178
178
|
|
|
179
|
-
|
|
179
|
+
Nếu có section `services`:
|
|
180
180
|
|
|
181
|
-
**1.
|
|
182
|
-
-
|
|
183
|
-
-
|
|
184
|
-
*(
|
|
185
|
-
-
|
|
181
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
182
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
183
|
+
- 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.
|
|
184
|
+
*(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`)*
|
|
185
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
186
186
|
|
|
187
|
-
**2. Route
|
|
188
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
189
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
190
|
-
-
|
|
191
|
-
-
|
|
192
|
-
-
|
|
187
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
188
|
+
- 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.
|
|
189
|
+
- 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.
|
|
190
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
191
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
192
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
193
193
|
|
|
194
|
-
**3. Fallback** —
|
|
195
|
-
-
|
|
196
|
-
-
|
|
194
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
195
|
+
- Giữ path mặc định từ Bước 1
|
|
196
|
+
- Đặt `active_service = unresolved`
|
|
197
197
|
|
|
198
|
-
**4.
|
|
199
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
200
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
198
|
+
**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:`:
|
|
199
|
+
- 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`.)*
|
|
200
|
+
- 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.)*
|
|
201
201
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
202
202
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
203
203
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
204
204
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
205
205
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
206
206
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
207
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
207
|
+
- 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`.)*
|
|
208
208
|
|
|
209
|
-
> **
|
|
209
|
+
> **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.
|
|
210
210
|
|
|
211
211
|
---
|
|
212
212
|
|
|
213
|
-
##
|
|
213
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
214
214
|
|
|
215
|
-
*
|
|
215
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
216
216
|
|
|
217
|
-
|
|
217
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
218
218
|
|
|
219
|
-
**1.
|
|
219
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
220
220
|
- `{active_service}/.agent/project-context.yaml`
|
|
221
221
|
- `{active_service}/project-context.yaml`
|
|
222
222
|
|
|
223
|
-
**2.
|
|
223
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
224
224
|
|
|
225
|
-
|
|
|
225
|
+
| Biến | Nguồn |
|
|
226
226
|
|----------|--------|
|
|
227
|
-
| `conventions.test_command` |
|
|
228
|
-
| `conventions.build_command` |
|
|
229
|
-
| `paths.trace_dir` | **
|
|
230
|
-
| `paths.specs_dir` | **
|
|
227
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
228
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
229
|
+
| `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`). |
|
|
230
|
+
| `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. |
|
|
231
231
|
|
|
232
|
-
**3.
|
|
233
|
-
-
|
|
234
|
-
- **
|
|
232
|
+
**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:
|
|
233
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
234
|
+
- **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/`).
|
|
235
235
|
|
|
236
|
-
**4.
|
|
236
|
+
**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).
|
|
237
237
|
|
|
238
238
|
---
|
|
239
239
|
|
|
240
|
-
##
|
|
240
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
241
241
|
|
|
242
|
-
|
|
243
|
-
Merge framework
|
|
244
|
-
|
|
242
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
243
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
244
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
245
245
|
|
|
246
246
|
---
|
|
247
247
|
|
|
248
|
-
##
|
|
248
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
249
249
|
|
|
250
|
-
|
|
250
|
+
*Đâ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.*
|
|
251
251
|
|
|
252
|
-
CLAUDE.md
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
252
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
253
|
+
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
|
|
254
|
+
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
|
|
255
|
+
service phải thắng khi sinh code.
|
|
256
256
|
|
|
257
|
-
**
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
257
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
258
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
259
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
260
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
261
261
|
|
|
262
|
-
**
|
|
263
|
-
*
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
Overlay
|
|
267
|
-
coding standards,
|
|
268
|
-
(
|
|
262
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
263
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
264
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
265
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
266
|
+
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,
|
|
267
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
268
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
269
269
|
|
|
270
|
-
|
|
270
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
271
271
|
|
|
272
|
-
- **§1 Project Overview** →
|
|
273
|
-
- **§2 Architecture** → layer
|
|
274
|
-
- **§3 Coding Standards** →
|
|
275
|
-
- **§5 Error Handling** → exception
|
|
276
|
-
- **§7 Git Conventions** →
|
|
272
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
273
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
274
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
275
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
276
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
277
277
|
|
|
278
|
-
**
|
|
279
|
-
-
|
|
280
|
-
-
|
|
281
|
-
-
|
|
282
|
-
-
|
|
278
|
+
**Quy tắc phân giải:**
|
|
279
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
280
|
+
- 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}`.
|
|
281
|
+
- 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).
|
|
282
|
+
- 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.
|
|
283
283
|
|
|
284
284
|
---
|
|
285
285
|
|
|
286
|
-
##
|
|
286
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
287
287
|
|
|
288
|
-
|
|
288
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
289
289
|
|
|
290
|
-
|
|
290
|
+
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.
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
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*`.
|
|
293
293
|
|
|
294
294
|
---
|
|
295
295
|
|
|
296
|
-
##
|
|
296
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
297
297
|
|
|
298
|
-
|
|
298
|
+
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).
|
|
299
299
|
|
|
300
|
-
|
|
301
|
-
- **Canonical Terms** →
|
|
302
|
-
- **Banned Terms** →
|
|
303
|
-
- **Status / Enum Registry** →
|
|
300
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
301
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
302
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
303
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
304
304
|
|
|
305
|
-
|
|
306
|
-
-
|
|
307
|
-
-
|
|
305
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
306
|
+
- 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
|
|
307
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
308
308
|
|
|
309
|
-
|
|
309
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
310
310
|
|
|
311
311
|
---
|
|
312
312
|
|
|
313
|
-
##
|
|
313
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
314
314
|
|
|
315
|
-
|
|
316
|
-
|
|
315
|
+
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).
|
|
316
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
317
317
|
|
|
318
|
-
|
|
319
|
-
- **Entity catalog** →
|
|
320
|
-
- **Field name registry** →
|
|
321
|
-
- **Relationship map** →
|
|
318
|
+
Nếu tồn tại, đọc và lưu:
|
|
319
|
+
- **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ệ
|
|
320
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
321
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
322
322
|
|
|
323
|
-
**
|
|
324
|
-
-
|
|
325
|
-
-
|
|
326
|
-
-
|
|
323
|
+
**Cách dùng catalog này:**
|
|
324
|
+
- 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
|
|
325
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
326
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
327
327
|
|
|
328
|
-
|
|
328
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
329
329
|
|
|
330
330
|
---
|
|
331
331
|
|
|
332
|
-
##
|
|
332
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
333
333
|
|
|
334
|
-
|
|
334
|
+
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:
|
|
335
335
|
|
|
336
336
|
```
|
|
337
|
-
active_module = tech_stack.module (
|
|
337
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
338
338
|
```
|
|
339
339
|
|
|
340
340
|
| `platform_type` | Modules |
|
|
@@ -343,89 +343,89 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
343
343
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
344
344
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
345
345
|
|
|
346
|
-
|
|
346
|
+
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.
|
|
347
347
|
|
|
348
|
-
|
|
348
|
+
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).
|
|
349
349
|
|
|
350
350
|
---
|
|
351
351
|
|
|
352
|
-
##
|
|
352
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
353
353
|
|
|
354
|
-
*
|
|
355
|
-
|
|
354
|
+
*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`
|
|
355
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
356
356
|
|
|
357
|
-
|
|
358
|
-
-
|
|
359
|
-
- Else
|
|
360
|
-
-
|
|
357
|
+
Phân giải path file lessons:
|
|
358
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
359
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
360
|
+
- Ở 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`
|
|
361
361
|
|
|
362
|
-
|
|
363
|
-
-
|
|
364
|
-
-
|
|
365
|
-
-
|
|
362
|
+
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:
|
|
363
|
+
- 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).
|
|
364
|
+
- 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).
|
|
365
|
+
- 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.
|
|
366
366
|
|
|
367
|
-
|
|
367
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
368
368
|
|
|
369
369
|
---
|
|
370
370
|
|
|
371
|
-
##
|
|
371
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
372
372
|
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
(recency
|
|
373
|
+
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.
|
|
374
|
+
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
|
|
375
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
376
376
|
|
|
377
|
-
|
|
377
|
+
Xuất đúng khối này:
|
|
378
378
|
```
|
|
379
379
|
[CTX LOADED]
|
|
380
380
|
Stack : {language} / {framework} / {database}
|
|
381
381
|
Platform : {active_module} ({platform_type})
|
|
382
|
-
Layers : {
|
|
383
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
382
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
383
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
384
384
|
Ticket : {ticket_prefix}-
|
|
385
385
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
386
386
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
387
|
-
Lessons : {loaded — N guardrails |
|
|
387
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
388
388
|
Service : {active_service} ({active_service_module}) | single-service
|
|
389
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
390
|
-
Status : {FULL | PARTIAL —
|
|
389
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
390
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
391
391
|
```
|
|
392
392
|
|
|
393
|
-
|
|
393
|
+
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.
|
|
394
394
|
|
|
395
395
|
---
|
|
396
396
|
|
|
397
|
-
##
|
|
397
|
+
## Hoàn tất nạp Context
|
|
398
398
|
|
|
399
|
-
|
|
400
|
-
-
|
|
401
|
-
-
|
|
402
|
-
- Coding standards
|
|
403
|
-
-
|
|
404
|
-
-
|
|
405
|
-
- Entity catalog (field
|
|
406
|
-
-
|
|
399
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
400
|
+
- Định danh dự án, tech stack, convention module
|
|
401
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
402
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
403
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
404
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
405
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
406
|
+
- Toàn bộ path đã cấu hình
|
|
407
407
|
|
|
408
|
-
|
|
408
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
409
409
|
|
|
410
410
|
|
|
411
411
|
---
|
|
412
412
|
|
|
413
413
|
## Service Detection
|
|
414
414
|
|
|
415
|
-
|
|
416
|
-
|
|
415
|
+
Đọc `active_module` từ context (đã phân giải ở context-loader Bước 1).
|
|
416
|
+
Dùng nó để chọn đúng lệnh chạy và bảng phân tích lỗi bên dưới.
|
|
417
417
|
|
|
418
418
|
---
|
|
419
419
|
|
|
420
420
|
## Submodule Working Directory
|
|
421
421
|
|
|
422
|
-
*
|
|
422
|
+
*Bỏ qua section này nếu `service_root` chưa được set (single-service mode).*
|
|
423
423
|
|
|
424
|
-
|
|
424
|
+
Khi chạy ở **umbrella/submodule mode** (`service_root` được phân giải ở context-loader Bước 1.6):
|
|
425
425
|
|
|
426
|
-
-
|
|
427
|
-
- `conventions.test_command`
|
|
428
|
-
- Prefix
|
|
426
|
+
- Mọi lệnh trong section **Run** bên dưới phải thực thi từ trong `{service_root}/`
|
|
427
|
+
- `conventions.test_command` được nạp từ `{service_root}/.agent/project-context.yaml` — đã riêng theo service
|
|
428
|
+
- Prefix mọi lệnh shell bằng `cd {service_root} &&`:
|
|
429
429
|
|
|
430
430
|
```bash
|
|
431
431
|
cd {service_root}
|
|
@@ -438,13 +438,13 @@ npx vitest run src/... # web-frontend
|
|
|
438
438
|
flutter test test/{domain}/... # flutter
|
|
439
439
|
```
|
|
440
440
|
|
|
441
|
-
> **
|
|
441
|
+
> **Vì sao cd?** Session Claude Code mở ở umbrella root. Mỗi service submodule có build tool, test runner, và cây dependency riêng — test phải chạy từ trong thư mục service.
|
|
442
442
|
|
|
443
443
|
---
|
|
444
444
|
|
|
445
445
|
## Run
|
|
446
446
|
|
|
447
|
-
###
|
|
447
|
+
### Nếu `platform_type = backend`
|
|
448
448
|
|
|
449
449
|
```bash
|
|
450
450
|
# Run all tests for this UC
|
|
@@ -465,7 +465,7 @@ pytest tests/{domain}/{test_file}.py::{TestClass}::{test_method} -v
|
|
|
465
465
|
pytest tests/ --cov={source_dir} --cov-report=term-missing
|
|
466
466
|
```
|
|
467
467
|
|
|
468
|
-
###
|
|
468
|
+
### Nếu `platform_type = web-frontend`
|
|
469
469
|
|
|
470
470
|
```bash
|
|
471
471
|
# Run all tests
|
|
@@ -481,7 +481,7 @@ npx playwright test {UC-ID}
|
|
|
481
481
|
npx cypress run --spec "cypress/e2e/{UC-ID}*"
|
|
482
482
|
```
|
|
483
483
|
|
|
484
|
-
###
|
|
484
|
+
### Nếu `platform_type = mobile`
|
|
485
485
|
|
|
486
486
|
```bash
|
|
487
487
|
# Flutter:
|
|
@@ -499,7 +499,7 @@ xcodebuild test -scheme {Scheme} -destination 'platform=iOS Simulator,name=iPhon
|
|
|
499
499
|
./gradlew connectedAndroidTest # instrumented (device/emulator required)
|
|
500
500
|
```
|
|
501
501
|
|
|
502
|
-
> **
|
|
502
|
+
> **Lưu ý cho Android instrumented test:** cần một emulator đang chạy hoặc device kết nối trước khi chạy `connectedAndroidTest`. Khởi động qua Android Studio hoặc: `emulator -avd {AVD_NAME} &`
|
|
503
503
|
|
|
504
504
|
---
|
|
505
505
|
|
|
@@ -509,150 +509,150 @@ xcodebuild test -scheme {Scheme} -destination 'platform=iOS Simulator,name=iPhon
|
|
|
509
509
|
|
|
510
510
|
#### java-spring / golang / dotnet / php-laravel
|
|
511
511
|
|
|
512
|
-
| Error Pattern |
|
|
512
|
+
| Error Pattern | Nguyên nhân thường gặp | Suggested Fix |
|
|
513
513
|
|---|---|---|
|
|
514
|
-
| `NullPointerException` |
|
|
515
|
-
| `Bean not found` |
|
|
516
|
-
| `Expected 200, got 401` |
|
|
517
|
-
| `Expected 200, got 400` | Request body
|
|
518
|
-
| `Expected 200, got 403` |
|
|
519
|
-
| `LazyInitializationException` | Lazy collection
|
|
520
|
-
| `Mapper not found` | Code
|
|
521
|
-
| `DataIntegrityViolationException` |
|
|
522
|
-
| Assertion mismatch |
|
|
514
|
+
| `NullPointerException` | Thiếu setup mock | Kiểm tra `given(...)`/`coEvery`/`mockk` cho dependency null |
|
|
515
|
+
| `Bean not found` | Thiếu khai báo mock | Thêm `@MockBean` / inject mock |
|
|
516
|
+
| `Expected 200, got 401` | Thiếu setup auth | Thêm auth token/user vào test context |
|
|
517
|
+
| `Expected 200, got 400` | Request body fail validation | Kiểm tra field bắt buộc trong DTO |
|
|
518
|
+
| `Expected 200, got 403` | Sai role | Thêm đúng role cho test user |
|
|
519
|
+
| `LazyInitializationException` | Lazy collection ngoài transaction | Thêm `@Transactional` hoặc eager fetch |
|
|
520
|
+
| `Mapper not found` | Code chưa compile | Chạy build trước khi test |
|
|
521
|
+
| `DataIntegrityViolationException` | Trùng key trong DB setup | Dùng `@Transactional` + rollback, hoặc clean DB giữa các test |
|
|
522
|
+
| Assertion mismatch | Sai giá trị mock return | Đọc lại setup `given(...).willReturn(...)` |
|
|
523
523
|
|
|
524
524
|
#### context-engineering (AI/LLM pipelines)
|
|
525
525
|
|
|
526
|
-
| Error Pattern |
|
|
526
|
+
| Error Pattern | Nguyên nhân thường gặp | Suggested Fix |
|
|
527
527
|
|---|---|---|
|
|
528
|
-
| `AssertionError`
|
|
529
|
-
| `ValidationError`
|
|
530
|
-
| `ConnectionError` / `APIError` |
|
|
531
|
-
| `TimeoutError` | Test
|
|
532
|
-
|
|
|
528
|
+
| `AssertionError` trên output mock LLM | Giá trị mock return không khớp schema | Kiểm tra lại setup `mock_llm.return_value` / `mock_llm.complete.return_value` |
|
|
529
|
+
| `ValidationError` trên response | Cấu trúc output LLM không khớp schema kỳ vọng | Siết schema check hoặc thêm retry logic trong test |
|
|
530
|
+
| `ConnectionError` / `APIError` | LLM API thật bị gọi trong test | Đảm bảo mock `patch('...')` được áp dụng — không bao giờ gọi LLM thật trong unit test |
|
|
531
|
+
| `TimeoutError` | Test gọi LLM endpoint live | Thêm mock; kiểm tra test fixture |
|
|
532
|
+
| Kết quả flaky / non-deterministic | Response LLM thật dùng trong assertion | Thay bằng giá trị mock return tất định |
|
|
533
533
|
|
|
534
534
|
### Web frontend failure patterns
|
|
535
535
|
|
|
536
|
-
| Error Pattern |
|
|
536
|
+
| Error Pattern | Nguyên nhân thường gặp | Suggested Fix |
|
|
537
537
|
|---|---|---|
|
|
538
|
-
| `Unable to find role "..."` | Element
|
|
539
|
-
| `TestingLibraryElementError: Found multiple elements` | Selector
|
|
540
|
-
| `Network request not intercepted` |
|
|
541
|
-
| `act(...)` warning | State update
|
|
542
|
-
| `Cannot read properties of undefined` | Component
|
|
543
|
-
| Playwright timeout | Page
|
|
544
|
-
| `expect(page.locator(...)).toBeVisible`
|
|
538
|
+
| `Unable to find role "..."` | Element chưa render | Bọc trong `await waitFor(() => ...)` |
|
|
539
|
+
| `TestingLibraryElementError: Found multiple elements` | Selector quá rộng | Dùng `getByRole(..., { name: '...' })` để thu hẹp |
|
|
540
|
+
| `Network request not intercepted` | Thiếu MSW handler / `cy.intercept` | Thêm handler cho endpoint |
|
|
541
|
+
| `act(...)` warning | State update sau khi test kết thúc | Await async event / `await userEvent.click(...)` |
|
|
542
|
+
| `Cannot read properties of undefined` | Component render trước khi data load | Thêm loading state hoặc mock data đã resolve |
|
|
543
|
+
| Playwright timeout | Page chưa navigate / element ẩn | Kiểm tra route, thêm `waitForSelector` |
|
|
544
|
+
| `expect(page.locator(...)).toBeVisible` fail | Sai selector | Dùng Playwright Inspector để tìm đúng locator |
|
|
545
545
|
|
|
546
546
|
### Mobile failure patterns
|
|
547
547
|
|
|
548
548
|
#### Flutter
|
|
549
|
-
| Error Pattern |
|
|
549
|
+
| Error Pattern | Nguyên nhân thường gặp | Suggested Fix |
|
|
550
550
|
|---|---|---|
|
|
551
|
-
| `pumpAndSettle timed out` | Async operation
|
|
552
|
-
| `No widget found` | Widget
|
|
553
|
-
| `setState called after dispose` | Widget
|
|
554
|
-
| BLoC state mismatch |
|
|
551
|
+
| `pumpAndSettle timed out` | Async operation chưa hoàn thành | Dùng `pump(Duration(...))` cho delay cụ thể |
|
|
552
|
+
| `No widget found` | Widget chưa render / sai finder | Kiểm tra `find.byType`, `find.text`, `find.byKey` |
|
|
553
|
+
| `setState called after dispose` | Widget bị dispose trước khi async xong | Cancel async trong `dispose()` |
|
|
554
|
+
| BLoC state mismatch | Sai event emit | Verify `mockBloc` nhận đúng event |
|
|
555
555
|
|
|
556
556
|
#### React Native
|
|
557
|
-
| Error Pattern |
|
|
557
|
+
| Error Pattern | Nguyên nhân thường gặp | Suggested Fix |
|
|
558
558
|
|---|---|---|
|
|
559
|
-
| `Unable to find element` |
|
|
560
|
-
| `act(...)` warning | Async state
|
|
561
|
-
|
|
|
559
|
+
| `Unable to find element` | Thiếu `testID` hoặc sai query | Thêm `accessibilityLabel` hoặc `testID` vào component |
|
|
560
|
+
| `act(...)` warning | Async state update | Bọc trong `act(async () => { ... })` |
|
|
561
|
+
| Thiếu navigation mock | `useNavigation` chưa mock | Thêm jest mock cho `@react-navigation/native` |
|
|
562
562
|
|
|
563
563
|
#### iOS / Android
|
|
564
|
-
| Error Pattern |
|
|
564
|
+
| Error Pattern | Nguyên nhân thường gặp | Suggested Fix |
|
|
565
565
|
|---|---|---|
|
|
566
|
-
| `XCTAssertEqual failed` |
|
|
567
|
-
| `Compose node not found` |
|
|
568
|
-
| `Hilt injection failed` |
|
|
569
|
-
| Emulator not available | `connectedAndroidTest`
|
|
566
|
+
| `XCTAssertEqual failed` | Sai giá trị kỳ vọng | Kiểm tra output ViewModel cho mock đã cho |
|
|
567
|
+
| `Compose node not found` | Sai `contentDescription` / `testTag` | Thêm `Modifier.testTag(...)` vào composable |
|
|
568
|
+
| `Hilt injection failed` | Thiếu test module | Thêm `@UninstallModules` + `@BindValue` trong test class |
|
|
569
|
+
| Emulator not available | `connectedAndroidTest` không có device | Khởi động emulator trước, chờ nó boot |
|
|
570
570
|
|
|
571
571
|
---
|
|
572
572
|
|
|
573
573
|
## Write Trace State
|
|
574
574
|
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
575
|
+
Sau khi chạy, lưu kết quả vào **TSV authoritative** trong service để chúng tới được
|
|
576
|
+
report Living Docs ở spec module (qua `/sync` + `/validate-traces`). Các file test
|
|
577
|
+
ở lại trong service — chỉ *status* của lần chạy được report.
|
|
578
578
|
|
|
579
|
-
|
|
580
|
-
|
|
579
|
+
Cập nhật `{paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv` (nếu `domain`/`prd_slug` không phân giải được từ spec target, định vị TSV bằng cách glob `{paths.trace_dir}/**/{UC-ID}.tsv` — nó được tạo trước đó bởi `/generate-bdd`) — cho mỗi scenario row (khớp `sc_id` qua tag
|
|
580
|
+
`@trace.verifies={UC-ID}-SC{N}` của test). *(Umbrella + `spec_source`: `trace_dir` là `{spec_source}/.trace` — test chạy từ `service_root` nhưng update `dev_selftest` ghi vào **spec repo**; commit/push spec submodule cho nó.)*
|
|
581
581
|
|
|
582
|
-
|
|
|
582
|
+
| Cột | Giá trị |
|
|
583
583
|
|--------|-------|
|
|
584
|
-
| `dev_selftest` | `pass`
|
|
585
|
-
| `dev_selftest_at` |
|
|
584
|
+
| `dev_selftest` | `pass` nếu mọi test của SC này pass · `fail` nếu có cái fail · `not_run` nếu test của nó bị skip/vắng |
|
|
585
|
+
| `dev_selftest_at` | hôm nay `YYYY-MM-DD` |
|
|
586
586
|
|
|
587
|
-
|
|
588
|
-
(
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
587
|
+
Giữ nguyên mọi cột khác — đặc biệt **không bao giờ** đụng `qc_status`/`qc_run_at`
|
|
588
|
+
(kết quả QC automation chính thức, do `/qc-run-test` sở hữu). `dev_selftest` (dev smoke)
|
|
589
|
+
và `qc_status` (QC chính thức) là hai tín hiệu riêng. `dev_selftest`/`dev_selftest_at` cũng
|
|
590
|
+
trực giao với `status` (OK/GAP/DRIFT/UNTRACKED): `status` theo dõi *coverage*, `dev_selftest`
|
|
591
|
+
theo dõi *kết quả chạy* gần nhất của dev.
|
|
592
592
|
|
|
593
593
|
## Refresh Panel Mirror
|
|
594
|
-
#
|
|
594
|
+
# Làm mới panel mirror của Living Docs *(local, chế độ umbrella)*
|
|
595
595
|
|
|
596
|
-
*
|
|
597
|
-
|
|
596
|
+
*Bỏ qua hoàn toàn ở chế độ single-service (không có `services` và không có `setup.spec_source`) — ở đó
|
|
597
|
+
`.trace/` của chính repo CHÍNH LÀ vị trí panel, nên không có gì để mirror.*
|
|
598
598
|
|
|
599
|
-
|
|
599
|
+
Sau khi cập nhật TSV authoritative tại `{paths.trace_dir}`:
|
|
600
600
|
|
|
601
|
-
**
|
|
602
|
-
`{paths.trace_dir}`
|
|
603
|
-
|
|
604
|
-
commit/push
|
|
605
|
-
1.
|
|
606
|
-
2.
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
601
|
+
**Khi `setup.spec_source` được đặt (trace gộp — trường hợp phổ biến):**
|
|
602
|
+
`{paths.trace_dir}` phân giải về `{spec_source}/.trace` — vị trí authoritative duy nhất.
|
|
603
|
+
Lệnh này chạy từ `service_root`, nên thao tác ghi là **liên-repo vào spec submodule**;
|
|
604
|
+
commit/push spec submodule cho lần cập nhật trace (giống như `feedback/`).
|
|
605
|
+
1. Phân giải `panel_mirror = ./.trace` tại **gốc workspace hiện tại**.
|
|
606
|
+
2. Nếu `panel_mirror` phân giải ra path khác với `{paths.trace_dir}`, copy mỗi
|
|
607
|
+
`{UC-ID}.tsv` vừa cập nhật → `{panel_mirror}/{UC-ID}.tsv` (tạo thư mục; ghi đè).
|
|
608
|
+
Không namespace theo service — chỉ có một bộ trace; service sở hữu được mang trong
|
|
609
|
+
`@trace.service` của từng row.
|
|
610
610
|
|
|
611
|
-
**Legacy (
|
|
612
|
-
Copy
|
|
613
|
-
(
|
|
611
|
+
**Legacy (không có `spec_source` — trace theo service):**
|
|
612
|
+
Copy mỗi `{UC-ID}.tsv` vừa cập nhật → `{panel_mirror}/{service-name}/{UC-ID}.tsv`
|
|
613
|
+
(namespace theo `active_service`).
|
|
614
614
|
|
|
615
|
-
|
|
616
|
-
**
|
|
617
|
-
`{spec_source}/.living-docs/`)
|
|
618
|
-
|
|
619
|
-
sub-agent.
|
|
615
|
+
Cách này giữ panel Living Docs của workspace đang mở luôn mới **giữa các lần sync** — nó chỉ là
|
|
616
|
+
một **mirror tiện lợi cục bộ**. File `trace-report.json` đã merge (canonical, trong
|
|
617
|
+
`{spec_source}/.living-docs/`) được build lại bởi `/sync` hoặc `/validate-traces`. Với các lệnh
|
|
618
|
+
được orchestrate, làm việc này một lần trong orchestrator sau khi tất cả sub-agent trả về — không phải
|
|
619
|
+
bên trong từng sub-agent.
|
|
620
620
|
|
|
621
621
|
|
|
622
622
|
## Output
|
|
623
623
|
|
|
624
|
-
# Report Footer —
|
|
624
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
625
625
|
|
|
626
|
-
|
|
626
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
627
627
|
|
|
628
628
|
## Status Badge
|
|
629
629
|
|
|
630
|
-
|
|
631
|
-
- `✅ Complete` —
|
|
632
|
-
- `❌ Failed` —
|
|
633
|
-
- `⚠️ Warnings` —
|
|
630
|
+
Chọn một theo kết quả:
|
|
631
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
632
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
633
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
634
634
|
|
|
635
635
|
## Output Artifacts
|
|
636
636
|
|
|
637
|
-
|
|
637
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
638
638
|
```
|
|
639
639
|
Output Artifacts:
|
|
640
|
-
{created|updated} {file-path} ({
|
|
641
|
-
{created|updated} {file-path} ({
|
|
640
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
641
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
642
642
|
```
|
|
643
643
|
|
|
644
|
-
|
|
644
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
645
645
|
|
|
646
646
|
## Pipeline Position
|
|
647
647
|
|
|
648
|
-
|
|
649
|
-
|
|
648
|
+
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`,
|
|
649
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
650
650
|
|
|
651
651
|
```
|
|
652
652
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
653
653
|
```
|
|
654
654
|
|
|
655
|
-
|
|
655
|
+
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:
|
|
656
656
|
|
|
657
657
|
| Phase | Commands |
|
|
658
658
|
|-------|----------|
|
|
@@ -666,61 +666,61 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
666
666
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
667
667
|
| Trace Audit | `/validate-traces` |
|
|
668
668
|
|
|
669
|
-
|
|
669
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
670
670
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
671
671
|
|
|
672
|
-
**
|
|
673
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
674
|
-
**
|
|
672
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
673
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
674
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
675
675
|
|
|
676
|
-
##
|
|
676
|
+
## Gợi ý lệnh tiếp theo
|
|
677
677
|
|
|
678
|
-
|
|
678
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
679
679
|
|
|
680
|
-
|
|
|
680
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
681
681
|
|-------------------------|-----------------------------------------------|
|
|
682
|
-
| /setup-ai-first | `/define-product`
|
|
682
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
683
683
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
684
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
685
|
-
| /refine-prd |
|
|
686
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
687
|
-
| /generate-design-spec | Designer review →
|
|
688
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
689
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
690
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
684
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
685
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
686
|
+
| /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 |
|
|
687
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
688
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
689
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
690
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
691
691
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
692
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
693
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
694
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
695
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
696
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
692
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
693
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
694
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
695
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
696
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
697
697
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
698
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
699
|
-
| /generate-code |
|
|
698
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
699
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
700
700
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
701
701
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
702
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
703
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
704
|
-
| /dev-smoke-test |
|
|
705
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
706
|
-
| /fix-bug |
|
|
707
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
708
|
-
| /report-bug |
|
|
709
|
-
| /propose-scenario |
|
|
710
|
-
| /learn |
|
|
711
|
-
| /sync | `/validate-traces`
|
|
712
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
713
|
-
|
|
714
|
-
|
|
702
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
703
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
704
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
705
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
706
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
707
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
708
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
709
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
710
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
711
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
712
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
713
|
+
|
|
714
|
+
Định dạng footer như sau:
|
|
715
715
|
```
|
|
716
716
|
---
|
|
717
717
|
Status : {badge}
|
|
718
|
-
{Output Artifacts
|
|
718
|
+
{khối Output Artifacts}
|
|
719
719
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
720
|
-
(review
|
|
721
|
-
Next : {
|
|
720
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
721
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
722
722
|
```
|
|
723
|
-
*(
|
|
723
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
724
724
|
|
|
725
725
|
|
|
726
726
|
```
|
|
@@ -732,13 +732,13 @@ Next : {suggested command with example arguments}
|
|
|
732
732
|
|------|-------|------------|
|
|
733
733
|
|
|
734
734
|
## Recommendations
|
|
735
|
-
{
|
|
735
|
+
{fix cụ thể cho từng failure}
|
|
736
736
|
|
|
737
737
|
Trace: {paths.trace_dir}/{domain}/{prd-slug}/{UC-ID}.tsv updated (dev_selftest, dev_selftest_at)
|
|
738
738
|
|
|
739
739
|
Next:
|
|
740
|
-
|
|
741
|
-
|
|
740
|
+
Mọi test pass → /review-code {UC-ID}
|
|
741
|
+
Test fail → /fix-bug {TICKET_ID} (bug thật) hoặc fix test (sai expectation)
|
|
742
742
|
|
|
743
|
-
📊 Living Docs:
|
|
743
|
+
📊 Living Docs: chạy /validate-traces (hoặc /sync) để push trace này lên dashboard spec-module.
|
|
744
744
|
```
|