@edupia-tutor/spec-driven-docs 0.14.7 → 0.14.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commands/generate-bdd.md +59 -4
- package/commands/generate-bdd.tmpl +59 -4
- package/commands/generate-code.md +18 -1
- package/commands/generate-code.tmpl +18 -1
- package/commands/generate-design-spec.md +35 -5
- package/commands/generate-design-spec.tmpl +35 -5
- package/commands/generate-prd.md +7 -4
- package/commands/generate-tech-docs.md +1 -0
- package/commands/generate-tech-docs.tmpl +1 -0
- package/commands/propose-scenario.md +6 -2
- package/commands/propose-scenario.tmpl +6 -2
- package/commands/qc-analyze.md +14 -0
- package/commands/qc-analyze.tmpl +14 -0
- package/commands/refine-prd.md +15 -4
- package/commands/refine-prd.tmpl +15 -4
- package/commands/review-context.md +15 -11
- package/commands/review-context.tmpl +15 -11
- package/commands/validate-traces.md +1 -0
- package/commands/validate-traces.tmpl +1 -0
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/generate-bdd.md +59 -4
- package/core/commands/generate-code.md +18 -1
- package/core/commands/generate-design-spec.md +35 -5
- package/core/commands/generate-prd.md +7 -4
- package/core/commands/generate-tech-docs.md +1 -0
- package/core/commands/propose-scenario.md +6 -2
- package/core/commands/qc-analyze.md +14 -0
- package/core/commands/refine-prd.md +15 -4
- package/core/commands/review-context.md +15 -11
- package/core/commands/validate-traces.md +1 -0
- package/core/skills/code/SKILL.md +7 -759
- package/core/skills/debug/SKILL.md +9 -859
- package/core/skills/design-spec/SKILL.md +3 -582
- package/core/skills/prd/SKILL.md +5 -464
- package/core/skills/setup-ai-first/SKILL.md +3 -208
- package/core/skills/spec/SKILL.md +7 -450
- package/core/skills/test/SKILL.md +10 -1290
- package/core/steps/spawn-agent.md +12 -7
- package/core/templates/prd.template.md +7 -4
- package/docs/01-getting-started/core-concepts.md +2 -2
- package/docs/01-getting-started/quickstart.md +4 -3
- package/docs/02-guides/bdd-input-checklist.md +68 -0
- package/docs/02-guides/developer/README.md +3 -0
- package/docs/02-guides/developer/bdd-and-trace.md +1 -0
- package/docs/02-guides/developer/commands.md +3 -3
- package/docs/02-guides/developer/pr-checklist.md +1 -0
- package/docs/02-guides/developer/workflow.md +2 -2
- package/docs/02-guides/prd-input-checklist.md +94 -0
- package/docs/02-guides/product-owner/README.md +3 -1
- package/docs/02-guides/product-owner/commands.md +1 -1
- package/docs/02-guides/tech-docs-input-checklist.md +82 -0
- package/docs/02-guides/tester/README.md +1 -1
- package/docs/02-guides/tester/bug-reporting.md +1 -1
- package/docs/02-guides/tester/qc-automation.md +1 -1
- package/docs/03-concepts/README.md +1 -0
- package/docs/03-concepts/mechanisms-explained.md +34 -0
- package/docs/03-concepts/pipeline.md +12 -9
- package/docs/03-concepts/traceability.md +4 -1
- package/docs/04-operations/bug-flow.md +2 -0
- package/docs/05-reference/command-cheatsheet.md +8 -8
- package/docs/05-reference/commands.md +12 -10
- package/docs/05-reference/trace-schema.md +2 -1
- package/package.json +1 -1
- package/skills/code/SKILL.md +7 -759
- package/skills/code/SKILL.tmpl +7 -164
- package/skills/debug/SKILL.md +9 -859
- package/skills/debug/SKILL.tmpl +9 -252
- package/skills/design-spec/SKILL.md +3 -582
- package/skills/design-spec/SKILL.tmpl +3 -87
- package/skills/prd/SKILL.md +5 -464
- package/skills/prd/SKILL.tmpl +5 -63
- package/skills/setup-ai-first/SKILL.md +3 -208
- package/skills/setup-ai-first/SKILL.tmpl +3 -108
- package/skills/spec/SKILL.md +7 -450
- package/skills/spec/SKILL.tmpl +7 -162
- package/skills/test/SKILL.md +10 -1290
- package/skills/test/SKILL.tmpl +10 -288
- package/steps/spawn-agent.md +12 -7
- package/templates/prd.template.md +7 -4
|
@@ -4,768 +4,16 @@ description: Sinh implementation code từ BDD spec đã duyệt kèm tag tracea
|
|
|
4
4
|
|
|
5
5
|
# Code Skills — Generate & Review
|
|
6
6
|
|
|
7
|
-
Skill này xử lý `/generate-code`
|
|
7
|
+
Skill này xử lý `/generate-code` và `/review-code`. Để **không lệch schema/gate**, skill KHÔNG nhân bản — mỗi lệnh thực thi **y hệt** command tương ứng.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## /generate-code — Generate Implementation Code
|
|
12
|
-
|
|
13
|
-
### Gate
|
|
14
|
-
|
|
15
|
-
<!-- Directory: specs/*/*/bdd/*.feature -->
|
|
16
|
-
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
17
|
-
|
|
18
|
-
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ó.
|
|
19
|
-
|
|
20
|
-
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
21
|
-
|
|
22
|
-
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
23
|
-
|
|
24
|
-
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
25
|
-
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
26
|
-
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
27
|
-
- Đặt target file = `payload.target_file`
|
|
28
|
-
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
29
|
-
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
30
|
-
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
31
|
-
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
32
|
-
- Đi thẳng tới phần logic riêng của lệnh.
|
|
33
|
-
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).
|
|
34
|
-
|
|
35
|
-
## Bước 0-B — Kiểm tra Model
|
|
36
|
-
|
|
37
|
-
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
38
|
-
|
|
39
|
-
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.
|
|
40
|
-
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.
|
|
41
|
-
|
|
42
|
-
Hiển thị và chờ phản hồi:
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
⚙️ MODEL CHECK
|
|
46
|
-
──────────────────────────────────────────────────────────────────
|
|
47
|
-
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
48
|
-
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
49
|
-
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
50
|
-
|
|
51
|
-
Cách đổi trong Claude Code:
|
|
52
|
-
• Settings → Model → chọn "claude-opus"
|
|
53
|
-
• hoặc: /model → chọn claude-opus
|
|
54
|
-
|
|
55
|
-
Đang chạy claude-opus?
|
|
56
|
-
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
57
|
-
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)
|
|
58
|
-
──────────────────────────────────────────────────────────────────
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
- "Y" → tiếp tục sang Bước 1.
|
|
62
|
-
- "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).
|
|
63
|
-
- "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."
|
|
64
|
-
|
|
65
|
-
## Bước 1 — Xác định Target File
|
|
66
|
-
|
|
67
|
-
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.
|
|
68
|
-
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/`):
|
|
69
|
-
- **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 đó.
|
|
70
|
-
- **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.)*
|
|
71
|
-
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
72
|
-
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
73
|
-
|
|
74
|
-
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.
|
|
75
|
-
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
76
|
-
- 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).
|
|
77
|
-
- 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)"
|
|
78
|
-
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
79
|
-
|
|
80
|
-
## Bước 2 — Chạy Context Loader
|
|
81
|
-
|
|
82
|
-
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`.
|
|
83
|
-
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.
|
|
84
|
-
|
|
85
|
-
## Bước 3 — CHECKPOINT
|
|
86
|
-
|
|
87
|
-
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:
|
|
88
|
-
|
|
89
|
-
```
|
|
90
|
-
CHECKPOINT
|
|
91
|
-
-----------
|
|
92
|
-
Target : {resolved file path}
|
|
93
|
-
Project : {project.name từ project-context.yaml}
|
|
94
|
-
Tech stack : {language} / {framework}
|
|
95
|
-
Module : {module nếu có, else "not configured"}
|
|
96
|
-
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
97
|
-
|
|
98
|
-
Tiếp tục? (Y/N)
|
|
99
|
-
```
|
|
100
|
-
|
|
101
|
-
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
102
|
-
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
103
|
-
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
4. Kiểm tra trace state có sẵn: đọc `.trace/{domain}/{prd-slug}/{UC-ID}.tsv` nếu tồn tại.
|
|
107
|
-
- Xác định: scenario mới vs. drifted (đã đổi) vs. synced (skip)
|
|
108
|
-
|
|
109
|
-
5. Hiện **CHECKPOINT — Comprehension**:
|
|
110
|
-
```
|
|
111
|
-
I understand:
|
|
112
|
-
- Feature: {name} | Ticket: {TICKET_ID if known}
|
|
113
|
-
- UC: {UC-ID} in domain: {domain}
|
|
114
|
-
- Scenarios: {N} total ({X} new, {Y} drifted, {Z} synced-skip)
|
|
115
|
-
- Layer order: {from CLAUDE.md architecture}
|
|
116
|
-
- Files to create/update: [list in generation order]
|
|
117
|
-
|
|
118
|
-
Proceed? (Y/N)
|
|
119
|
-
```
|
|
120
|
-
Chờ xác nhận.
|
|
121
|
-
|
|
122
|
-
### Context Load
|
|
123
|
-
|
|
124
|
-
# Context Loader — Nạp toàn bộ context dự án
|
|
125
|
-
|
|
126
|
-
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.
|
|
127
|
-
|
|
128
|
-
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
129
|
-
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
130
|
-
- 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.
|
|
131
|
-
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
132
|
-
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
133
|
-
- 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.
|
|
134
|
-
|
|
135
|
-
---
|
|
136
|
-
|
|
137
|
-
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
138
|
-
|
|
139
|
-
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
140
|
-
|
|
141
|
-
**Tech Stack:**
|
|
142
|
-
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
143
|
-
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
144
|
-
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
145
|
-
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
146
|
-
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
147
|
-
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
148
|
-
|
|
149
|
-
**Conventions:**
|
|
150
|
-
- `conventions.build_command` → cách compile/build
|
|
151
|
-
- `conventions.test_command` → cách chạy test
|
|
152
|
-
- `conventions.service_run` → cách khởi động service
|
|
153
|
-
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
154
|
-
|
|
155
|
-
**Domains:**
|
|
156
|
-
- `domains` → danh sách các business domain đang hoạt động
|
|
157
|
-
|
|
158
|
-
**Paths (nếu có):**
|
|
159
|
-
- `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)
|
|
160
|
-
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
161
|
-
- `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}/`)
|
|
162
|
-
- `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 đè)
|
|
163
|
-
- `paths.product_definitions_dir` → gốc product definition
|
|
164
|
-
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
165
|
-
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
166
|
-
- `paths.core_entities` → path tới core-entities.md
|
|
167
|
-
- `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/`)
|
|
168
|
-
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
169
|
-
|
|
170
|
-
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
171
|
-
- `specs_dir` = `specs`
|
|
172
|
-
- `refinement_dir` = `.agent/review`
|
|
173
|
-
- `qc_dir` = `docs`
|
|
174
|
-
- `qc_skills_dir` = `.agent/skills/qc`
|
|
175
|
-
- `product_definitions_dir` = `specs/product-definition`
|
|
176
|
-
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
177
|
-
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
178
|
-
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
179
|
-
- `tech_docs_dir` = `specs`
|
|
180
|
-
- `trace_dir` = `.trace`
|
|
181
|
-
|
|
182
|
-
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.
|
|
183
|
-
|
|
184
|
-
**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ụ:
|
|
185
|
-
- `specs/payment/create-invoice/PAY01-create-invoice.md` → `prd_slug = create-invoice`
|
|
186
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
187
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
188
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
189
|
-
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
190
|
-
|
|
191
|
-
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ừ đó.
|
|
192
|
-
|
|
193
|
-
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.
|
|
194
|
-
|
|
195
|
-
---
|
|
196
|
-
|
|
197
|
-
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
198
|
-
|
|
199
|
-
*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.*
|
|
9
|
+
## /generate-code — Sinh Implementation Code
|
|
200
10
|
|
|
201
|
-
|
|
11
|
+
→ **Đọc và tuân theo `commands/generate-code.md`** với cùng `$ARGUMENTS`.
|
|
202
12
|
|
|
203
|
-
|
|
204
|
-
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
205
|
-
- 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.
|
|
206
|
-
*(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`)*
|
|
207
|
-
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
208
|
-
|
|
209
|
-
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
210
|
-
- 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.
|
|
211
|
-
- 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.
|
|
212
|
-
- Lưu `active_service` = `services.{domain}.path`
|
|
213
|
-
- Lưu `active_service_module` = `services.{domain}.module`
|
|
214
|
-
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
215
|
-
|
|
216
|
-
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
217
|
-
- Giữ path mặc định từ Bước 1
|
|
218
|
-
- Đặt `active_service = unresolved`
|
|
219
|
-
|
|
220
|
-
**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:`:
|
|
221
|
-
- 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`.)*
|
|
222
|
-
- 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.)*
|
|
223
|
-
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
224
|
-
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
225
|
-
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
226
|
-
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
227
|
-
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
228
|
-
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
229
|
-
- 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`.)*
|
|
230
|
-
|
|
231
|
-
> **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.
|
|
232
|
-
|
|
233
|
-
---
|
|
234
|
-
|
|
235
|
-
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
236
|
-
|
|
237
|
-
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
238
|
-
|
|
239
|
-
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
240
|
-
|
|
241
|
-
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
242
|
-
- `{active_service}/.agent/project-context.yaml`
|
|
243
|
-
- `{active_service}/project-context.yaml`
|
|
244
|
-
|
|
245
|
-
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
246
|
-
|
|
247
|
-
| Biến | Nguồn |
|
|
248
|
-
|----------|--------|
|
|
249
|
-
| `conventions.test_command` | `conventions.test_command` của service |
|
|
250
|
-
| `conventions.build_command` | `conventions.build_command` của service |
|
|
251
|
-
| `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`). |
|
|
252
|
-
| `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. |
|
|
253
|
-
|
|
254
|
-
**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:
|
|
255
|
-
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
256
|
-
- **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/`).
|
|
257
|
-
|
|
258
|
-
**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).
|
|
259
|
-
|
|
260
|
-
---
|
|
261
|
-
|
|
262
|
-
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
263
|
-
|
|
264
|
-
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
265
|
-
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
266
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
267
|
-
|
|
268
|
-
---
|
|
269
|
-
|
|
270
|
-
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
271
|
-
|
|
272
|
-
*Đâ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.*
|
|
273
|
-
|
|
274
|
-
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
275
|
-
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
|
|
276
|
-
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
|
|
277
|
-
service phải thắng khi sinh code.
|
|
278
|
-
|
|
279
|
-
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
280
|
-
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
281
|
-
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
282
|
-
kiến trúc + coding standards duy nhất của dự án.
|
|
283
|
-
|
|
284
|
-
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
285
|
-
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
286
|
-
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
287
|
-
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
288
|
-
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,
|
|
289
|
-
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
290
|
-
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
291
|
-
|
|
292
|
-
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
293
|
-
|
|
294
|
-
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
295
|
-
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
296
|
-
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
297
|
-
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
298
|
-
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
299
|
-
|
|
300
|
-
**Quy tắc phân giải:**
|
|
301
|
-
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
302
|
-
- 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}`.
|
|
303
|
-
- 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).
|
|
304
|
-
- 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.
|
|
305
|
-
|
|
306
|
-
---
|
|
307
|
-
|
|
308
|
-
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
309
|
-
|
|
310
|
-
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
311
|
-
|
|
312
|
-
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.
|
|
313
|
-
|
|
314
|
-
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*`.
|
|
315
|
-
|
|
316
|
-
---
|
|
317
|
-
|
|
318
|
-
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
319
|
-
|
|
320
|
-
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).
|
|
321
|
-
|
|
322
|
-
Nếu tồn tại, đọc và trích xuất:
|
|
323
|
-
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
324
|
-
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
325
|
-
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
326
|
-
|
|
327
|
-
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
328
|
-
- 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
|
|
329
|
-
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
330
|
-
|
|
331
|
-
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
332
|
-
|
|
333
|
-
---
|
|
334
|
-
|
|
335
|
-
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
336
|
-
|
|
337
|
-
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).
|
|
338
|
-
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
339
|
-
|
|
340
|
-
Nếu tồn tại, đọc và lưu:
|
|
341
|
-
- **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ệ
|
|
342
|
-
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
343
|
-
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
344
|
-
|
|
345
|
-
**Cách dùng catalog này:**
|
|
346
|
-
- 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
|
|
347
|
-
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
348
|
-
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
349
|
-
|
|
350
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
351
|
-
|
|
352
|
-
---
|
|
13
|
+
Command lo: guard mềm BDD `@trace.status` approved + Design Spec (approved/độ-tươi/sanity) cho FE/App · `--phase=ui`/`--phase=integration` · branch + build verify · trace TSV (22 cột) `@trace.implements`.
|
|
353
14
|
|
|
354
|
-
##
|
|
15
|
+
## /review-code — Code Review chỉ-đọc (READ-ONLY)
|
|
355
16
|
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
```
|
|
359
|
-
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
360
|
-
```
|
|
361
|
-
|
|
362
|
-
| `platform_type` | Modules |
|
|
363
|
-
|---|---|
|
|
364
|
-
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
365
|
-
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
366
|
-
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
367
|
-
|
|
368
|
-
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.
|
|
369
|
-
|
|
370
|
-
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).
|
|
371
|
-
|
|
372
|
-
---
|
|
373
|
-
|
|
374
|
-
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
375
|
-
|
|
376
|
-
*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`
|
|
377
|
-
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
378
|
-
|
|
379
|
-
Phân giải path file lessons:
|
|
380
|
-
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
381
|
-
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
382
|
-
- Ở 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`
|
|
383
|
-
|
|
384
|
-
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:
|
|
385
|
-
- 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).
|
|
386
|
-
- 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).
|
|
387
|
-
- 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.
|
|
388
|
-
|
|
389
|
-
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
390
|
-
|
|
391
|
-
---
|
|
392
|
-
|
|
393
|
-
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
394
|
-
|
|
395
|
-
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.
|
|
396
|
-
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
|
|
397
|
-
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
398
|
-
|
|
399
|
-
Xuất đúng khối này:
|
|
400
|
-
```
|
|
401
|
-
[CTX LOADED]
|
|
402
|
-
Stack : {language} / {framework} / {database}
|
|
403
|
-
Platform : {active_module} ({platform_type})
|
|
404
|
-
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
405
|
-
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
406
|
-
Ticket : {ticket_prefix}-
|
|
407
|
-
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
408
|
-
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
409
|
-
Lessons : {loaded — N guardrails | chưa có}
|
|
410
|
-
Service : {active_service} ({active_service_module}) | single-service
|
|
411
|
-
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
412
|
-
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
413
|
-
```
|
|
414
|
-
|
|
415
|
-
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.
|
|
416
|
-
|
|
417
|
-
---
|
|
418
|
-
|
|
419
|
-
## Hoàn tất nạp Context
|
|
420
|
-
|
|
421
|
-
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
422
|
-
- Định danh dự án, tech stack, convention module
|
|
423
|
-
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
424
|
-
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
425
|
-
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
426
|
-
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
427
|
-
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
428
|
-
- Toàn bộ path đã cấu hình
|
|
429
|
-
|
|
430
|
-
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
Cũng đọc:
|
|
434
|
-
- File `.feature` (cần implement gì)
|
|
435
|
-
- Tech doc `specs/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` (nếu tồn tại)
|
|
436
|
-
- File entity/model có sẵn trong domain này (để theo pattern)
|
|
437
|
-
|
|
438
|
-
### Branch
|
|
439
|
-
|
|
440
|
-
Tạo feature branch:
|
|
441
|
-
```bash
|
|
442
|
-
git checkout -b feature/{TICKET_ID}-{slug}
|
|
443
|
-
# If no ticket ID: feature/{UC-ID}-{slug}
|
|
444
|
-
```
|
|
445
|
-
|
|
446
|
-
### Generate
|
|
447
|
-
|
|
448
|
-
Sinh code theo thứ tự layer (thích ứng theo stack của bạn):
|
|
449
|
-
|
|
450
|
-
**Cho một backend phân lớp điển hình (vd Controller → Service → Repository):**
|
|
451
|
-
|
|
452
|
-
1. **DTOs / Request-Response models** — validate input, shape output
|
|
453
|
-
2. **Domain entity / model** — biểu diễn dữ liệu
|
|
454
|
-
3. **Repository / Data Access** — query, filter
|
|
455
|
-
4. **Service interface** — contract
|
|
456
|
-
5. **Service implementation** — business logic, `@Transactional` khi cần
|
|
457
|
-
6. **Facade interface** (nếu kiến trúc dùng facade layer) — contract orchestration
|
|
458
|
-
7. **Facade implementation** — orchestration liên-service
|
|
459
|
-
8. **Controller / Handler** — HTTP mapping, auth, tag `@trace`
|
|
460
|
-
|
|
461
|
-
**Quan trọng: Tag traceability trên mỗi controller method:**
|
|
462
|
-
```
|
|
463
|
-
# @trace.implements={UC-ID}-SC{N}
|
|
464
|
-
# @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature
|
|
465
|
-
```
|
|
466
|
-
(Dùng cú pháp comment của ngôn ngữ bạn)
|
|
467
|
-
|
|
468
|
-
### Self-Review (3 vòng)
|
|
469
|
-
|
|
470
|
-
Sau khi sinh, verify:
|
|
471
|
-
- [ ] Mỗi scenario trong .feature có controller endpoint tương ứng
|
|
472
|
-
- [ ] Tag `@trace.implements` trên mỗi endpoint
|
|
473
|
-
- [ ] Tôn trọng quy tắc layer kiến trúc (từ CLAUDE.md)
|
|
474
|
-
- [ ] Error handling khớp CLAUDE.md §error_handling
|
|
475
|
-
- [ ] Không magic number, không debug logging
|
|
476
|
-
- [ ] Theo coding standards từ CLAUDE.md
|
|
477
|
-
|
|
478
|
-
Nếu phát hiện issue → fix inline trước khi tiếp tục.
|
|
479
|
-
|
|
480
|
-
### Build Verify
|
|
481
|
-
|
|
482
|
-
```bash
|
|
483
|
-
{BUILD_COMMAND} # from project-context.yaml, max 3 retries
|
|
484
|
-
```
|
|
485
|
-
|
|
486
|
-
Nếu build fail: đọc lỗi, fix, retry. Sau 3 lần fail, report cho user kèm diagnosis.
|
|
487
|
-
|
|
488
|
-
### Write Trace State
|
|
489
|
-
|
|
490
|
-
Cập nhật `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`:
|
|
491
|
-
```
|
|
492
|
-
UC-ID\tSC-ID\tsc_version\timplemented_by\tlast_updated
|
|
493
|
-
{UC-ID}\tSC1\t{hash of scenario text}\t{ControllerClass}.{method}\t{date}
|
|
494
|
-
```
|
|
495
|
-
|
|
496
|
-
### Commit
|
|
497
|
-
|
|
498
|
-
```bash
|
|
499
|
-
git add {changed files}
|
|
500
|
-
git commit -m "{commit_format from CLAUDE.md}: {description}"
|
|
501
|
-
```
|
|
502
|
-
|
|
503
|
-
### Report
|
|
504
|
-
|
|
505
|
-
```
|
|
506
|
-
/generate-code Complete — {UC-ID}
|
|
507
|
-
- Files created: {N} | Updated: {M}
|
|
508
|
-
- Build: SUCCESS (attempt {K}/3)
|
|
509
|
-
- Branch: feature/{TICKET_ID}-{slug}
|
|
510
|
-
- Trace: .trace/{domain}/{prd-slug}/{UC-ID}.tsv updated
|
|
511
|
-
```
|
|
512
|
-
|
|
513
|
-
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
514
|
-
|
|
515
|
-
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
516
|
-
|
|
517
|
-
## Status Badge
|
|
518
|
-
|
|
519
|
-
Chọn một theo kết quả:
|
|
520
|
-
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
521
|
-
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
522
|
-
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
523
|
-
|
|
524
|
-
## Output Artifacts
|
|
525
|
-
|
|
526
|
-
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
527
|
-
```
|
|
528
|
-
Output Artifacts:
|
|
529
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
530
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
531
|
-
```
|
|
532
|
-
|
|
533
|
-
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
534
|
-
|
|
535
|
-
## Pipeline Position
|
|
536
|
-
|
|
537
|
-
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`,
|
|
538
|
-
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
539
|
-
|
|
540
|
-
```
|
|
541
|
-
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
542
|
-
```
|
|
543
|
-
|
|
544
|
-
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:
|
|
545
|
-
|
|
546
|
-
| Phase | Commands |
|
|
547
|
-
|-------|----------|
|
|
548
|
-
| Discovery | `/define-product` |
|
|
549
|
-
| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
550
|
-
| Design Spec | `/generate-design-spec` |
|
|
551
|
-
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
552
|
-
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
553
|
-
| Code | `/generate-code` · `/review-code` |
|
|
554
|
-
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
555
|
-
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
556
|
-
| Trace Audit | `/validate-traces` |
|
|
557
|
-
|
|
558
|
-
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
559
|
-
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
560
|
-
|
|
561
|
-
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
562
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
563
|
-
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
564
|
-
|
|
565
|
-
## Gợi ý lệnh tiếp theo
|
|
566
|
-
|
|
567
|
-
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
568
|
-
|
|
569
|
-
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
570
|
-
|-------------------------|-----------------------------------------------|
|
|
571
|
-
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
572
|
-
| /define-product | `/generate-prd {product-definition-file}` |
|
|
573
|
-
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
574
|
-
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
575
|
-
| /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
|
|
576
|
-
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
577
|
-
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
578
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
579
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
580
|
-
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
581
|
-
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
582
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
583
|
-
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
584
|
-
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
585
|
-
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
586
|
-
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
587
|
-
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
588
|
-
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
589
|
-
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
590
|
-
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
591
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
592
|
-
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
593
|
-
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
594
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
595
|
-
| /fix-bug | Tạo PR và link tới ticket |
|
|
596
|
-
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
597
|
-
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
598
|
-
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
599
|
-
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
600
|
-
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
601
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
602
|
-
|
|
603
|
-
Định dạng footer như sau:
|
|
604
|
-
```
|
|
605
|
-
---
|
|
606
|
-
Status : {badge}
|
|
607
|
-
{khối Output Artifacts}
|
|
608
|
-
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
609
|
-
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
610
|
-
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
611
|
-
```
|
|
612
|
-
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
---
|
|
616
|
-
|
|
617
|
-
## /review-code — Code Review chỉ-đọc
|
|
618
|
-
|
|
619
|
-
**QUAN TRỌNG**: Đây là READ-ONLY. Report issue nhưng KHÔNG sửa.
|
|
620
|
-
|
|
621
|
-
### Input
|
|
622
|
-
|
|
623
|
-
Nhận: UC-ID, file path, hoặc tên branch hiện tại.
|
|
624
|
-
|
|
625
|
-
### Review Dimensions
|
|
626
|
-
|
|
627
|
-
#### 1. Traceability
|
|
628
|
-
- [ ] Mỗi controller endpoint có tag `@trace.implements`?
|
|
629
|
-
- [ ] Mỗi test file có tag `@trace.verifies`?
|
|
630
|
-
- [ ] Không có tag `@trace` ở layer không phải controller (Service, Repository, v.v.)?
|
|
631
|
-
- [ ] `.trace/{domain}/{prd-slug}/{UC-ID}.tsv` cập nhật chưa?
|
|
632
|
-
|
|
633
|
-
#### 2. Layer Architecture (từ CLAUDE.md)
|
|
634
|
-
- [ ] Mỗi class ở đúng layer?
|
|
635
|
-
- [ ] Phụ thuộc giữa layer đi đúng chiều?
|
|
636
|
-
- [ ] Không layer nào bị bypass (vd Controller gọi Repository trực tiếp)?
|
|
637
|
-
|
|
638
|
-
#### 3. Coding Standards (từ CLAUDE.md)
|
|
639
|
-
- [ ] Tuân theo naming convention?
|
|
640
|
-
- [ ] Response wrapper dùng nhất quán?
|
|
641
|
-
- [ ] Exception được throw (không bị nuốt hoặc tự build vào response)?
|
|
642
|
-
- [ ] Không magic number?
|
|
643
|
-
- [ ] Không dữ liệu nhạy cảm trong log?
|
|
644
|
-
- [ ] Annotation transaction đúng?
|
|
645
|
-
|
|
646
|
-
#### 4. Spec Compliance
|
|
647
|
-
- [ ] Mỗi scenario trong .feature có implementation?
|
|
648
|
-
- [ ] Không có endpoint không tài liệu (code không có spec backing)?
|
|
649
|
-
|
|
650
|
-
### Output
|
|
651
|
-
|
|
652
|
-
```
|
|
653
|
-
/review-code Report — {UC-ID}
|
|
654
|
-
Critical: {X} | Major: {Y} | Minor: {Z}
|
|
655
|
-
|
|
656
|
-
### Critical
|
|
657
|
-
| # | File | Line | Issue | Suggested Fix |
|
|
658
|
-
|---|------|------|-------|---------------|
|
|
659
|
-
|
|
660
|
-
### Major
|
|
661
|
-
| # | File | Line | Issue | Suggested Fix |
|
|
662
|
-
|
|
663
|
-
### Minor
|
|
664
|
-
| # | File | Line | Issue | Suggested Fix |
|
|
665
|
-
|
|
666
|
-
Verdict: APPROVED ✅ | NEEDS_FIX ❌
|
|
667
|
-
```
|
|
668
|
-
|
|
669
|
-
Nếu `NEEDS_FIX`: liệt kê file cụ thể cần đổi và chạy `/fix-bug` hoặc sửa inline.
|
|
670
|
-
|
|
671
|
-
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
672
|
-
|
|
673
|
-
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
674
|
-
|
|
675
|
-
## Status Badge
|
|
676
|
-
|
|
677
|
-
Chọn một theo kết quả:
|
|
678
|
-
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
679
|
-
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
680
|
-
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
681
|
-
|
|
682
|
-
## Output Artifacts
|
|
683
|
-
|
|
684
|
-
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
685
|
-
```
|
|
686
|
-
Output Artifacts:
|
|
687
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
688
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
689
|
-
```
|
|
690
|
-
|
|
691
|
-
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
692
|
-
|
|
693
|
-
## Pipeline Position
|
|
694
|
-
|
|
695
|
-
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`,
|
|
696
|
-
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
697
|
-
|
|
698
|
-
```
|
|
699
|
-
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
700
|
-
```
|
|
701
|
-
|
|
702
|
-
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:
|
|
703
|
-
|
|
704
|
-
| Phase | Commands |
|
|
705
|
-
|-------|----------|
|
|
706
|
-
| Discovery | `/define-product` |
|
|
707
|
-
| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
708
|
-
| Design Spec | `/generate-design-spec` |
|
|
709
|
-
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
710
|
-
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
711
|
-
| Code | `/generate-code` · `/review-code` |
|
|
712
|
-
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
713
|
-
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
714
|
-
| Trace Audit | `/validate-traces` |
|
|
715
|
-
|
|
716
|
-
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
717
|
-
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
718
|
-
|
|
719
|
-
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
720
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
721
|
-
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
722
|
-
|
|
723
|
-
## Gợi ý lệnh tiếp theo
|
|
724
|
-
|
|
725
|
-
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
726
|
-
|
|
727
|
-
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
728
|
-
|-------------------------|-----------------------------------------------|
|
|
729
|
-
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
730
|
-
| /define-product | `/generate-prd {product-definition-file}` |
|
|
731
|
-
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
732
|
-
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
733
|
-
| /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
|
|
734
|
-
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
735
|
-
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
736
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
737
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
738
|
-
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
739
|
-
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
740
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
741
|
-
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
742
|
-
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
743
|
-
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
744
|
-
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
745
|
-
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
746
|
-
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
747
|
-
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
748
|
-
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
749
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
750
|
-
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
751
|
-
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
752
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
753
|
-
| /fix-bug | Tạo PR và link tới ticket |
|
|
754
|
-
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
755
|
-
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
756
|
-
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
757
|
-
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
758
|
-
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
759
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
760
|
-
|
|
761
|
-
Định dạng footer như sau:
|
|
762
|
-
```
|
|
763
|
-
---
|
|
764
|
-
Status : {badge}
|
|
765
|
-
{khối Output Artifacts}
|
|
766
|
-
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
767
|
-
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
768
|
-
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
769
|
-
```
|
|
770
|
-
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
17
|
+
→ **Đọc và tuân theo `commands/review-code.md`** với cùng `$ARGUMENTS`.
|
|
771
18
|
|
|
19
|
+
Command lo: Pre-Review Scan · 4 lăng kính (Traceability · Layer Architecture · Coding Standards · Spec Compliance) · đề xuất ghi Lesson cho lỗi AI lặp.
|