@edupia-tutor/spec-driven-docs 0.14.0 → 0.14.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commands/debug.md +435 -435
- package/commands/debug.tmpl +111 -111
- package/commands/define-product.md +330 -327
- package/commands/define-product.tmpl +50 -47
- package/commands/dev-gen-test.md +364 -364
- package/commands/dev-gen-test.tmpl +63 -63
- package/commands/dev-run-test.md +375 -375
- package/commands/dev-run-test.tmpl +74 -74
- package/commands/dev-smoke-test.md +340 -340
- package/commands/dev-smoke-test.tmpl +60 -60
- package/commands/fix-bug.md +402 -402
- package/commands/fix-bug.tmpl +78 -78
- package/commands/generate-bdd.md +512 -512
- package/commands/generate-bdd.tmpl +211 -211
- package/commands/generate-code.md +480 -482
- package/commands/generate-code.tmpl +179 -181
- package/commands/generate-design-spec.md +495 -495
- package/commands/generate-design-spec.tmpl +219 -219
- package/commands/generate-prd.md +445 -396
- package/commands/generate-prd.tmpl +45 -198
- package/commands/generate-spec-manifest.md +337 -337
- package/commands/generate-spec-manifest.tmpl +57 -57
- package/commands/generate-tech-docs.md +364 -364
- package/commands/generate-tech-docs.tmpl +84 -84
- package/commands/learn.md +346 -346
- package/commands/learn.tmpl +22 -22
- package/commands/map-testids.md +321 -321
- package/commands/map-testids.tmpl +41 -41
- package/commands/propose-scenario.md +334 -334
- package/commands/propose-scenario.tmpl +54 -54
- package/commands/qc-analyze.md +322 -323
- package/commands/qc-analyze.tmpl +42 -43
- package/commands/qc-design-test.md +303 -303
- package/commands/qc-design-test.tmpl +23 -23
- package/commands/qc-plan.md +296 -296
- package/commands/qc-plan.tmpl +16 -16
- package/commands/qc-report.md +301 -301
- package/commands/qc-report.tmpl +21 -21
- package/commands/qc-review.md +297 -297
- package/commands/qc-review.tmpl +17 -17
- package/commands/qc-run-test.md +336 -336
- package/commands/qc-run-test.tmpl +35 -35
- package/commands/refine-prd.md +426 -428
- package/commands/refine-prd.tmpl +61 -61
- package/commands/report-bug.md +350 -350
- package/commands/report-bug.tmpl +70 -70
- package/commands/review-code.md +363 -363
- package/commands/review-code.tmpl +39 -39
- package/commands/review-context.md +577 -579
- package/commands/review-context.tmpl +212 -212
- package/commands/review-tech-docs.md +426 -426
- package/commands/review-tech-docs.tmpl +146 -146
- package/commands/setup-ai-first.md +237 -237
- package/commands/setup-ai-first.tmpl +131 -131
- package/commands/sync.md +145 -145
- package/commands/sync.tmpl +93 -93
- package/commands/update-framework.md +88 -88
- package/commands/update-framework.tmpl +36 -36
- package/commands/validate-traces.md +379 -379
- package/commands/validate-traces.tmpl +99 -99
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +435 -435
- package/core/commands/define-product.md +330 -327
- package/core/commands/dev-gen-test.md +364 -364
- package/core/commands/dev-run-test.md +375 -375
- package/core/commands/dev-smoke-test.md +340 -340
- package/core/commands/fix-bug.md +402 -402
- package/core/commands/generate-bdd.md +512 -512
- package/core/commands/generate-code.md +480 -482
- package/core/commands/generate-design-spec.md +495 -495
- package/core/commands/generate-prd.md +445 -396
- package/core/commands/generate-spec-manifest.md +337 -337
- package/core/commands/generate-tech-docs.md +364 -364
- package/core/commands/learn.md +346 -346
- package/core/commands/map-testids.md +321 -321
- package/core/commands/propose-scenario.md +334 -334
- package/core/commands/qc-analyze.md +322 -323
- package/core/commands/qc-design-test.md +303 -303
- package/core/commands/qc-plan.md +296 -296
- package/core/commands/qc-report.md +301 -301
- package/core/commands/qc-review.md +297 -297
- package/core/commands/qc-run-test.md +336 -336
- package/core/commands/refine-prd.md +426 -428
- package/core/commands/report-bug.md +350 -350
- package/core/commands/review-code.md +363 -363
- package/core/commands/review-context.md +577 -579
- package/core/commands/review-tech-docs.md +426 -426
- package/core/commands/setup-ai-first.md +237 -237
- package/core/commands/sync.md +145 -145
- package/core/commands/update-framework.md +88 -88
- package/core/commands/validate-traces.md +379 -379
- package/core/skills/code/SKILL.md +388 -388
- package/core/skills/debug/SKILL.md +390 -390
- package/core/skills/design-spec/SKILL.md +316 -316
- package/core/skills/discovery/SKILL.md +7 -547
- package/core/skills/prd/SKILL.md +298 -394
- package/core/skills/setup-ai-first/SKILL.md +79 -79
- package/core/skills/spec/SKILL.md +176 -176
- package/core/skills/test/SKILL.md +602 -602
- package/core/steps/capture-lesson.md +44 -44
- package/core/steps/context-loader.md +174 -174
- package/core/steps/gate.md +54 -54
- package/core/steps/report-footer.md +52 -52
- package/core/steps/review-fanout.md +85 -87
- package/core/steps/spawn-agent.md +45 -45
- package/core/steps/trace-mirror.md +21 -21
- package/core/templates/architecture.template.md +37 -37
- package/core/templates/design-spec.template.md +77 -77
- package/core/templates/platform-guide.template.md +47 -47
- package/core/templates/prd.template.md +106 -231
- package/core/templates/product-definition.template.md +101 -88
- package/docs/04-operations/publishing.md +20 -3
- package/package.json +1 -1
- package/skills/code/SKILL.md +388 -388
- package/skills/code/SKILL.tmpl +56 -56
- package/skills/debug/SKILL.md +390 -390
- package/skills/debug/SKILL.tmpl +60 -60
- package/skills/design-spec/SKILL.md +316 -316
- package/skills/design-spec/SKILL.tmpl +36 -36
- package/skills/discovery/SKILL.md +7 -547
- package/skills/discovery/SKILL.tmpl +7 -140
- package/skills/prd/SKILL.md +298 -394
- package/skills/prd/SKILL.tmpl +40 -151
- package/skills/setup-ai-first/SKILL.md +79 -79
- package/skills/setup-ai-first/SKILL.tmpl +27 -27
- package/skills/spec/SKILL.md +176 -176
- package/skills/spec/SKILL.tmpl +18 -18
- package/skills/test/SKILL.md +602 -602
- package/skills/test/SKILL.tmpl +44 -44
- package/steps/capture-lesson.md +44 -44
- package/steps/context-loader.md +174 -174
- package/steps/gate.md +54 -54
- package/steps/report-footer.md +52 -52
- package/steps/review-fanout.md +85 -87
- package/steps/spawn-agent.md +45 -45
- package/steps/trace-mirror.md +21 -21
- package/templates/architecture.template.md +37 -37
- package/templates/design-spec.template.md +77 -77
- package/templates/platform-guide.template.md +47 -47
- package/templates/prd.template.md +106 -231
- package/templates/product-definition.template.md +101 -88
package/commands/generate-prd.md
CHANGED
|
@@ -1,145 +1,145 @@
|
|
|
1
|
-
# /generate-prd —
|
|
1
|
+
# /generate-prd — Sinh Product Requirements Document
|
|
2
2
|
|
|
3
3
|
## Gate
|
|
4
|
-
# Gate —
|
|
4
|
+
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
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ó.
|
|
7
7
|
|
|
8
|
-
##
|
|
8
|
+
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
11
11
|
|
|
12
|
-
1.
|
|
13
|
-
2.
|
|
14
|
-
- **
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
3.
|
|
12
|
+
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
13
|
+
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
14
|
+
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
15
|
+
- Đặt target file = `payload.target_file`
|
|
16
|
+
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
|
+
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
|
+
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
|
+
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).
|
|
21
21
|
|
|
22
|
-
##
|
|
22
|
+
## Bước 0-B — Kiểm tra Model
|
|
23
23
|
|
|
24
|
-
*
|
|
24
|
+
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
25
25
|
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
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.
|
|
27
|
+
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.
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Hiển thị và chờ phản hồi:
|
|
30
30
|
|
|
31
31
|
```
|
|
32
32
|
⚙️ MODEL CHECK
|
|
33
33
|
──────────────────────────────────────────────────────────────────
|
|
34
|
-
Recommended : claude-opus-4 (
|
|
35
|
-
Why needed :
|
|
36
|
-
|
|
34
|
+
Recommended : claude-opus-4 (hoặc model Opus mới nhất)
|
|
35
|
+
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
36
|
+
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
37
37
|
|
|
38
|
-
|
|
39
|
-
• Settings → Model →
|
|
40
|
-
•
|
|
38
|
+
Cách đổi trong Claude Code:
|
|
39
|
+
• Settings → Model → chọn "claude-opus"
|
|
40
|
+
• hoặc: /model → chọn claude-opus
|
|
41
41
|
|
|
42
|
-
|
|
43
|
-
Y —
|
|
44
|
-
S —
|
|
42
|
+
Đang chạy claude-opus?
|
|
43
|
+
Y — đúng, đang dùng claude-opus → tiếp tục
|
|
44
|
+
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)
|
|
45
45
|
──────────────────────────────────────────────────────────────────
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
- "Y" →
|
|
49
|
-
- "S" →
|
|
50
|
-
- "N"
|
|
48
|
+
- "Y" → tiếp tục sang Bước 1.
|
|
49
|
+
- "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).
|
|
50
|
+
- "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."
|
|
51
51
|
|
|
52
|
-
##
|
|
52
|
+
## Bước 1 — Xác định Target File
|
|
53
53
|
|
|
54
|
-
1.
|
|
55
|
-
2.
|
|
56
|
-
- **BDD
|
|
57
|
-
- **PRD
|
|
58
|
-
- **tech-docs
|
|
59
|
-
- **design-spec
|
|
54
|
+
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.
|
|
55
|
+
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/`):
|
|
56
|
+
- **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 đó.
|
|
57
|
+
- **Lệnh PRD** (target là `prd.md`): `{specs_dir}/{domain}/*/prd.md` (khớp feature folder có id tương ứng), nếu không thì `{specs_dir}/*/*/prd.md`.
|
|
58
|
+
- **Lệnh tech-docs**: `{specs_dir}/{domain}/*/tech-docs/{UC-ID}*-tech-design*.md`.
|
|
59
|
+
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
60
60
|
|
|
61
|
-
|
|
62
|
-
3.
|
|
63
|
-
-
|
|
64
|
-
-
|
|
65
|
-
-
|
|
61
|
+
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.
|
|
62
|
+
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
63
|
+
- Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/prd.md` cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
|
|
64
|
+
- 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)"
|
|
65
|
+
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
66
66
|
|
|
67
|
-
##
|
|
67
|
+
## Bước 2 — Chạy Context Loader
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
69
|
+
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`.
|
|
70
|
+
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.
|
|
71
71
|
|
|
72
|
-
##
|
|
72
|
+
## Bước 3 — CHECKPOINT
|
|
73
73
|
|
|
74
|
-
|
|
74
|
+
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:
|
|
75
75
|
|
|
76
76
|
```
|
|
77
77
|
CHECKPOINT
|
|
78
78
|
-----------
|
|
79
79
|
Target : {resolved file path}
|
|
80
|
-
Project : {project.name
|
|
80
|
+
Project : {project.name từ project-context.yaml}
|
|
81
81
|
Tech stack : {language} / {framework}
|
|
82
|
-
Module : {module
|
|
83
|
-
Domains : {
|
|
82
|
+
Module : {module nếu có, else "not configured"}
|
|
83
|
+
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
84
84
|
|
|
85
|
-
|
|
85
|
+
Tiếp tục? (Y/N)
|
|
86
86
|
```
|
|
87
87
|
|
|
88
|
-
|
|
89
|
-
- "Y" →
|
|
90
|
-
- "N" →
|
|
88
|
+
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
89
|
+
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
90
|
+
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
91
91
|
|
|
92
92
|
|
|
93
|
-
*
|
|
93
|
+
*Lưu ý: Với lệnh này, target file ở Bước 1 là một file product-definition trong `{paths.product_definitions_dir}/`. Phân giải từ `$ARGUMENTS` hoặc liệt kê thư mục và hỏi.*
|
|
94
94
|
|
|
95
95
|
## Context
|
|
96
|
-
# Context Loader —
|
|
96
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
97
97
|
|
|
98
|
-
|
|
98
|
+
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.
|
|
99
99
|
|
|
100
|
-
**
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
100
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
101
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
102
|
+
- 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.
|
|
103
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
104
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
105
|
+
- 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.
|
|
106
106
|
|
|
107
107
|
---
|
|
108
108
|
|
|
109
|
-
##
|
|
109
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
112
112
|
|
|
113
113
|
**Tech Stack:**
|
|
114
|
-
- `tech_stack.language` →
|
|
115
|
-
- `tech_stack.framework` →
|
|
116
|
-
- `tech_stack.build_tool` → build tool (
|
|
117
|
-
- `tech_stack.test_framework` → test framework (
|
|
118
|
-
- `tech_stack.database` → database (
|
|
119
|
-
- `tech_stack.module` →
|
|
114
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
115
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
116
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
117
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
118
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
119
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
120
120
|
|
|
121
121
|
**Conventions:**
|
|
122
|
-
- `conventions.build_command` →
|
|
123
|
-
- `conventions.test_command` →
|
|
124
|
-
- `conventions.service_run` →
|
|
125
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
122
|
+
- `conventions.build_command` → cách compile/build
|
|
123
|
+
- `conventions.test_command` → cách chạy test
|
|
124
|
+
- `conventions.service_run` → cách khởi động service
|
|
125
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
126
126
|
|
|
127
127
|
**Domains:**
|
|
128
|
-
- `domains` →
|
|
129
|
-
|
|
130
|
-
**Paths (
|
|
131
|
-
- `paths.specs_dir` → spec
|
|
132
|
-
- `paths.refinement_dir` → findings/review
|
|
133
|
-
- `paths.qc_dir` → QC automation
|
|
134
|
-
- `paths.qc_skills_dir` →
|
|
135
|
-
- `paths.product_definitions_dir` → product
|
|
136
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
137
|
-
- `paths.business_dictionary` → path
|
|
138
|
-
- `paths.core_entities` → path
|
|
139
|
-
- `paths.tech_docs_dir` →
|
|
140
|
-
- `paths.trace_dir` →
|
|
141
|
-
|
|
142
|
-
|
|
128
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
129
|
+
|
|
130
|
+
**Paths (nếu có):**
|
|
131
|
+
- `paths.specs_dir` → gốc của spec artifact — PRD, BDD, tech-docs, design-spec. Cấu trúc: `{specs_dir}/{domain}/{prd-slug}/{prd.md | bdd/ | tech-docs/ | design-spec/}`
|
|
132
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
133
|
+
- `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}/`)
|
|
134
|
+
- `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 đè)
|
|
135
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
136
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
137
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
138
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
139
|
+
- `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/`)
|
|
140
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
141
|
+
|
|
142
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
143
143
|
- `specs_dir` = `specs`
|
|
144
144
|
- `refinement_dir` = `.agent/review`
|
|
145
145
|
- `qc_dir` = `docs`
|
|
@@ -151,184 +151,184 @@ If `paths` section is absent, use these defaults:
|
|
|
151
151
|
- `tech_docs_dir` = `specs`
|
|
152
152
|
- `trace_dir` = `.trace`
|
|
153
153
|
|
|
154
|
-
|
|
154
|
+
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.
|
|
155
155
|
|
|
156
|
-
**
|
|
156
|
+
**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ụ:
|
|
157
157
|
- `specs/payment/create-invoice/prd.md` → `prd_slug = create-invoice`
|
|
158
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
159
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
160
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
158
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
159
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
160
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
161
161
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
162
162
|
|
|
163
|
-
|
|
163
|
+
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ừ đó.
|
|
164
164
|
|
|
165
|
-
|
|
165
|
+
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.
|
|
166
166
|
|
|
167
167
|
---
|
|
168
168
|
|
|
169
|
-
##
|
|
169
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
170
170
|
|
|
171
|
-
*
|
|
171
|
+
*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.*
|
|
172
172
|
|
|
173
|
-
|
|
173
|
+
Nếu có section `services`:
|
|
174
174
|
|
|
175
|
-
**1.
|
|
176
|
-
-
|
|
177
|
-
-
|
|
178
|
-
*(
|
|
179
|
-
-
|
|
175
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
176
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
177
|
+
- 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.
|
|
178
|
+
*(vd: `specs/user/create-account/prd.md` **và** `specs/user/create-account/bdd/system/UC1.feature` đều → domain = `user`, prd_slug = `create-account`)*
|
|
179
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
180
180
|
|
|
181
|
-
**2. Route
|
|
182
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
183
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
184
|
-
-
|
|
185
|
-
-
|
|
186
|
-
-
|
|
181
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
182
|
+
- 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.
|
|
183
|
+
- 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.
|
|
184
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
185
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
186
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
187
187
|
|
|
188
|
-
**3. Fallback** —
|
|
189
|
-
-
|
|
190
|
-
-
|
|
188
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
189
|
+
- Giữ path mặc định từ Bước 1
|
|
190
|
+
- Đặt `active_service = unresolved`
|
|
191
191
|
|
|
192
|
-
**4.
|
|
193
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
194
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
192
|
+
**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:`:
|
|
193
|
+
- 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`.)*
|
|
194
|
+
- 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.)*
|
|
195
195
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
196
196
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
197
197
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
198
198
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
199
199
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
200
200
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
201
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
201
|
+
- 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`.)*
|
|
202
202
|
|
|
203
|
-
> **
|
|
203
|
+
> **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.
|
|
204
204
|
|
|
205
205
|
---
|
|
206
206
|
|
|
207
|
-
##
|
|
207
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
208
208
|
|
|
209
|
-
*
|
|
209
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
210
210
|
|
|
211
|
-
|
|
211
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
212
212
|
|
|
213
|
-
**1.
|
|
213
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
214
214
|
- `{active_service}/.agent/project-context.yaml`
|
|
215
215
|
- `{active_service}/project-context.yaml`
|
|
216
216
|
|
|
217
|
-
**2.
|
|
217
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
218
218
|
|
|
219
|
-
|
|
|
219
|
+
| Biến | Nguồn |
|
|
220
220
|
|----------|--------|
|
|
221
|
-
| `conventions.test_command` |
|
|
222
|
-
| `conventions.build_command` |
|
|
223
|
-
| `paths.trace_dir` | **
|
|
224
|
-
| `paths.specs_dir` | **
|
|
221
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
222
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
223
|
+
| `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`). |
|
|
224
|
+
| `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. |
|
|
225
225
|
|
|
226
|
-
**3.
|
|
227
|
-
-
|
|
228
|
-
- **
|
|
226
|
+
**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:
|
|
227
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
228
|
+
- **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/`).
|
|
229
229
|
|
|
230
|
-
**4.
|
|
230
|
+
**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).
|
|
231
231
|
|
|
232
232
|
---
|
|
233
233
|
|
|
234
|
-
##
|
|
234
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
235
235
|
|
|
236
|
-
|
|
237
|
-
Merge framework
|
|
238
|
-
|
|
236
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
237
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
238
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
239
239
|
|
|
240
240
|
---
|
|
241
241
|
|
|
242
|
-
##
|
|
242
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
243
243
|
|
|
244
|
-
|
|
244
|
+
*Đâ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.*
|
|
245
245
|
|
|
246
|
-
CLAUDE.md
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
246
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
247
|
+
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
|
|
248
|
+
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
|
|
249
|
+
service phải thắng khi sinh code.
|
|
250
250
|
|
|
251
|
-
**
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
251
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
252
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
253
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
254
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
255
255
|
|
|
256
|
-
**
|
|
257
|
-
*
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
Overlay
|
|
261
|
-
coding standards,
|
|
262
|
-
(
|
|
256
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
257
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
258
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
259
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
260
|
+
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,
|
|
261
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
262
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
263
263
|
|
|
264
|
-
|
|
264
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
265
265
|
|
|
266
|
-
- **§1 Project Overview** →
|
|
267
|
-
- **§2 Architecture** → layer
|
|
268
|
-
- **§3 Coding Standards** →
|
|
269
|
-
- **§5 Error Handling** → exception
|
|
270
|
-
- **§7 Git Conventions** →
|
|
266
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
267
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
268
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
269
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
270
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
271
271
|
|
|
272
|
-
**
|
|
273
|
-
-
|
|
274
|
-
-
|
|
275
|
-
-
|
|
276
|
-
-
|
|
272
|
+
**Quy tắc phân giải:**
|
|
273
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
274
|
+
- 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}`.
|
|
275
|
+
- 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).
|
|
276
|
+
- 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.
|
|
277
277
|
|
|
278
278
|
---
|
|
279
279
|
|
|
280
|
-
##
|
|
280
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
281
281
|
|
|
282
|
-
|
|
282
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
283
283
|
|
|
284
|
-
|
|
284
|
+
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.
|
|
285
285
|
|
|
286
|
-
|
|
286
|
+
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*`.
|
|
287
287
|
|
|
288
288
|
---
|
|
289
289
|
|
|
290
|
-
##
|
|
290
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
291
291
|
|
|
292
|
-
|
|
292
|
+
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).
|
|
293
293
|
|
|
294
|
-
|
|
295
|
-
- **Canonical Terms** →
|
|
296
|
-
- **Banned Terms** →
|
|
297
|
-
- **Status / Enum Registry** →
|
|
294
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
295
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
296
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
297
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
298
298
|
|
|
299
|
-
|
|
300
|
-
-
|
|
301
|
-
-
|
|
299
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
300
|
+
- 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
|
|
301
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
304
304
|
|
|
305
305
|
---
|
|
306
306
|
|
|
307
|
-
##
|
|
307
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
308
308
|
|
|
309
|
-
|
|
310
|
-
|
|
309
|
+
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).
|
|
310
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
311
311
|
|
|
312
|
-
|
|
313
|
-
- **Entity catalog** →
|
|
314
|
-
- **Field name registry** →
|
|
315
|
-
- **Relationship map** →
|
|
312
|
+
Nếu tồn tại, đọc và lưu:
|
|
313
|
+
- **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ệ
|
|
314
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
315
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
316
316
|
|
|
317
|
-
**
|
|
318
|
-
-
|
|
319
|
-
-
|
|
320
|
-
-
|
|
317
|
+
**Cách dùng catalog này:**
|
|
318
|
+
- 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
|
|
319
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
320
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
321
321
|
|
|
322
|
-
|
|
322
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
323
323
|
|
|
324
324
|
---
|
|
325
325
|
|
|
326
|
-
##
|
|
326
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
327
327
|
|
|
328
|
-
|
|
328
|
+
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:
|
|
329
329
|
|
|
330
330
|
```
|
|
331
|
-
active_module = tech_stack.module (
|
|
331
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
332
332
|
```
|
|
333
333
|
|
|
334
334
|
| `platform_type` | Modules |
|
|
@@ -337,206 +337,245 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
337
337
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
338
338
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
339
339
|
|
|
340
|
-
|
|
340
|
+
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.
|
|
341
341
|
|
|
342
|
-
|
|
342
|
+
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).
|
|
343
343
|
|
|
344
344
|
---
|
|
345
345
|
|
|
346
|
-
##
|
|
346
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
347
347
|
|
|
348
|
-
*
|
|
349
|
-
|
|
348
|
+
*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`
|
|
349
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
350
350
|
|
|
351
|
-
|
|
352
|
-
-
|
|
353
|
-
- Else
|
|
354
|
-
-
|
|
351
|
+
Phân giải path file lessons:
|
|
352
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
353
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
354
|
+
- Ở 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`
|
|
355
355
|
|
|
356
|
-
|
|
357
|
-
-
|
|
358
|
-
-
|
|
359
|
-
-
|
|
356
|
+
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:
|
|
357
|
+
- 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).
|
|
358
|
+
- 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).
|
|
359
|
+
- 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.
|
|
360
360
|
|
|
361
|
-
|
|
361
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
362
362
|
|
|
363
363
|
---
|
|
364
364
|
|
|
365
|
-
##
|
|
365
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
366
366
|
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
(recency
|
|
367
|
+
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.
|
|
368
|
+
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
|
|
369
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
370
370
|
|
|
371
|
-
|
|
371
|
+
Xuất đúng khối này:
|
|
372
372
|
```
|
|
373
373
|
[CTX LOADED]
|
|
374
374
|
Stack : {language} / {framework} / {database}
|
|
375
375
|
Platform : {active_module} ({platform_type})
|
|
376
|
-
Layers : {
|
|
377
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
376
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
377
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
378
378
|
Ticket : {ticket_prefix}-
|
|
379
379
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
380
380
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
381
|
-
Lessons : {loaded — N guardrails |
|
|
381
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
382
382
|
Service : {active_service} ({active_service_module}) | single-service
|
|
383
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
384
|
-
Status : {FULL | PARTIAL —
|
|
383
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
384
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
385
385
|
```
|
|
386
386
|
|
|
387
|
-
|
|
387
|
+
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.
|
|
388
388
|
|
|
389
389
|
---
|
|
390
390
|
|
|
391
|
-
##
|
|
391
|
+
## Hoàn tất nạp Context
|
|
392
392
|
|
|
393
|
-
|
|
394
|
-
-
|
|
395
|
-
-
|
|
396
|
-
- Coding standards
|
|
397
|
-
-
|
|
398
|
-
-
|
|
399
|
-
- Entity catalog (field
|
|
400
|
-
-
|
|
393
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
394
|
+
- Định danh dự án, tech stack, convention module
|
|
395
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
396
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
397
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
398
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
399
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
400
|
+
- Toàn bộ path đã cấu hình
|
|
401
401
|
|
|
402
|
-
|
|
402
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
403
403
|
|
|
404
404
|
|
|
405
|
-
*
|
|
405
|
+
*Context bổ sung cho lệnh này: Đọc toàn bộ file product-definition. Trích xuất: **TICKET-ID**, **domain**, **tên feature**, dữ liệu Phase 1-7.*
|
|
406
406
|
|
|
407
|
-
CHECKPOINT
|
|
407
|
+
CHECKPOINT trước khi sinh: "Sinh PRD cho **{TICKET-ID} — {feature}** (domain: {domain}). Tiếp tục? (Y/N)"
|
|
408
408
|
|
|
409
409
|
---
|
|
410
410
|
|
|
411
|
-
##
|
|
411
|
+
## Quy tắc thuật ngữ *(áp dụng nếu business-dictionary.md tồn tại)*
|
|
412
412
|
|
|
413
|
-
- **
|
|
414
|
-
- **
|
|
415
|
-
- **NEW TERM DETECTION**:
|
|
416
|
-
-
|
|
417
|
-
-
|
|
418
|
-
-
|
|
419
|
-
|
|
420
|
-
-
|
|
413
|
+
- **Thay banned term**: thay mọi banned term bằng bản chuẩn tương đương (xem dictionary § Banned Terms).
|
|
414
|
+
- **Dùng canonical term**: chỉ dùng các thuật ngữ được định nghĩa trong dictionary.
|
|
415
|
+
- **NEW TERM DETECTION**: Nếu một thuật ngữ trong input PO xuất hiện ≥2 lần và KHÔNG có trong dictionary → **DỪNG** và hỏi PO:
|
|
416
|
+
- Thuật ngữ đó nghĩa là gì trong ngữ cảnh hệ thống?
|
|
417
|
+
- English canonical term nên dùng là gì?
|
|
418
|
+
- Có cần bổ sung vào business-dictionary.md không?
|
|
419
|
+
Sau khi PO confirm → cập nhật `business-dictionary.md` (nếu đồng ý) → tiếp tục sinh.
|
|
420
|
+
- Nếu không có banned term và tất cả thuật ngữ đều chuẩn → tiếp tục không gián đoạn.
|
|
421
421
|
|
|
422
|
-
## Cross-Reference
|
|
422
|
+
## Quy tắc Cross-Reference
|
|
423
423
|
|
|
424
|
-
|
|
424
|
+
Bất kỳ chỗ nào nhắc tới một TICKET-ID khác trong PRD (pre-condition, BR, ghi chú, appendix) → **PHẢI** là inline link:
|
|
425
425
|
```
|
|
426
426
|
[TICKET-ID](./TICKET-ID-slug.md)
|
|
427
427
|
```
|
|
428
|
-
|
|
428
|
+
Không bao giờ để TICKET-ID dạng plain text nếu file PRD tương ứng tồn tại trong `{paths.specs_dir}/{domain}/{prd-slug}/`.
|
|
429
429
|
|
|
430
|
-
## UC
|
|
430
|
+
## Quy ước đánh số UC và BR
|
|
431
431
|
|
|
432
|
-
- **UC ID**: `{TICKET-ID}-UC{N}` — N
|
|
433
|
-
- **BR ID**: `{TICKET-ID}-UC{N}-BR{M}` — **M
|
|
434
|
-
-
|
|
432
|
+
- **UC ID**: `{TICKET-ID}-UC{N}` — N bắt đầu từ 1, tăng theo từng use case.
|
|
433
|
+
- **BR ID**: `{TICKET-ID}-UC{N}-BR{M}` — **M tăng liên tục trên toàn PRD** (KHÔNG reset theo từng UC).
|
|
434
|
+
- Ví dụ: UC1 → BR1, BR2; UC2 → BR3, BR4 (KHÔNG phải BR1, BR2 lại từ đầu).
|
|
435
435
|
|
|
436
436
|
---
|
|
437
437
|
|
|
438
|
-
## Platform Strategy — PRD
|
|
438
|
+
## Platform Strategy — PRD là tài liệu nghiệp vụ (không technical)
|
|
439
439
|
|
|
440
|
-
PRD mô tả **WHAT** (yêu cầu nghiệp vụ) — không
|
|
441
|
-
|
|
440
|
+
PRD mô tả **WHAT** (yêu cầu nghiệp vụ) — không nhét chi tiết **kỹ thuật** (API, token, endpoint, HTTP status, tên class/bảng/cột DB, query). Những thứ đó thuộc **Tech Docs**.
|
|
441
|
+
PRD **được phép** có User Flow + Wireframe ở mức nghiệp vụ (§4) để BA/QC/Dev cùng hình dung; chỉ **chi tiết visual** (màu sắc, layout pixel, animation, micro-interaction) mới thuộc **Design Spec**.
|
|
442
442
|
|
|
443
|
-
| ✅ Viết trong PRD (
|
|
443
|
+
| ✅ Viết trong PRD (nghiệp vụ) | ❌ KHÔNG viết trong PRD |
|
|
444
444
|
|---|---|
|
|
445
|
-
| "Đăng nhập thành công → truy cập được tính năng" | "
|
|
446
|
-
| "Sai
|
|
447
|
-
|
|
|
445
|
+
| "Đăng nhập thành công → truy cập được tính năng" | "API trả về JWT token" ← Tech Docs |
|
|
446
|
+
| "Sai mật khẩu 5 lần → khoá tài khoản 30 phút" | "Hiển thị spinner khi loading" ← Design Spec |
|
|
447
|
+
| Wireframe mức nghiệp vụ: màn hình có gì, hành động ra kết quả gì | "Animation fade 300ms, màu #FF0000" ← Design Spec |
|
|
448
448
|
|
|
449
449
|
**Một PRD phục vụ tất cả platform:**
|
|
450
450
|
- **FE/App team** → đọc PRD + Design Spec → `/generate-bdd` (UI-level scenarios)
|
|
451
451
|
- **BE team** → đọc PRD trực tiếp → `/generate-bdd` (API-level scenarios)
|
|
452
|
-
- Design Spec là tài liệu riêng cho FE/App —
|
|
452
|
+
- Design Spec là tài liệu **chi tiết visual** riêng cho FE/App — Wireframe nghiệp vụ trong PRD chỉ là khung.
|
|
453
453
|
|
|
454
|
-
Khi viết AC, nếu PO đề cập chi tiết
|
|
455
|
-
*"Chi tiết
|
|
454
|
+
Khi viết AC, nếu PO đề cập chi tiết visual (màu sắc, animation, layout pixel) → nhắc nhở:
|
|
455
|
+
*"Chi tiết visual này thuộc về Design Spec, không thuộc PRD. Ghi nhận lại để tạo Design Spec sau."*
|
|
456
456
|
|
|
457
457
|
---
|
|
458
458
|
|
|
459
459
|
## Generate
|
|
460
460
|
|
|
461
|
-
|
|
461
|
+
Ghi `{paths.specs_dir}/{domain}/{prd-slug}/prd.md` theo cấu trúc dưới đây.
|
|
462
462
|
|
|
463
463
|
---
|
|
464
464
|
|
|
465
|
-
|
|
466
|
-
# {TICKET-
|
|
465
|
+
````markdown
|
|
466
|
+
# {TICKET}-{N} {Feature Name}
|
|
467
|
+
|
|
468
|
+
<!--
|
|
469
|
+
Template này được sử dụng bởi workflow /generate-prd.
|
|
470
|
+
AI Agent sẽ điền các section dựa trên input từ PO.
|
|
471
|
+
Các placeholder {…} cần được thay thế bằng nội dung thực tế.
|
|
472
|
+
|
|
473
|
+
FORMAT CHUẨN: Business Rule = bảng 3 cột
|
|
474
|
+
ID | Business Rule | Business Logic (KHÔNG tách Business Logic ra khối riêng).
|
|
475
|
+
|
|
476
|
+
TERMINOLOGY:
|
|
477
|
+
- Tuân thủ 100% từ điển project: specs/domain-knowledge/business-dictionary.md
|
|
478
|
+
(KHÔNG dùng từ điển của project khác). Thay banned term bằng canonical term;
|
|
479
|
+
nếu phát hiện banned term trong input PO → thay + ghi chú trong "Giả định AI".
|
|
480
|
+
- Status/Enum values → tham chiếu core-entities.md (Enum Registry).
|
|
481
|
+
|
|
482
|
+
CROSS-REFERENCE (BẮT BUỘC): Bất kỳ chỗ nào nhắc đến một tính năng/ticket khác
|
|
483
|
+
(pre-condition, business rule, giả định, AC, hay bất kỳ section nào) → PHẢI gắn inline link:
|
|
484
|
+
[TICKET-ID](./TICKET-ID-slug.md)
|
|
485
|
+
Không để TICKET-ID dạng plain text nếu tồn tại file PRD tương ứng.
|
|
486
|
+
Ngoài ra, ghi rõ quan hệ phụ thuộc trong "Tài liệu tham khảo" ở Appendix.
|
|
487
|
+
|
|
488
|
+
NEW TERM DETECTION: Nếu input PO xuất hiện thuật ngữ CHƯA CÓ trong business-dictionary.md
|
|
489
|
+
và lặp lại ≥ 2 lần → DỪNG lại, hỏi PO confirm trước khi tiếp tục:
|
|
490
|
+
+ Thuật ngữ đó nghĩa gì trong ngữ cảnh hệ thống?
|
|
491
|
+
+ English term chuẩn nên dùng là gì?
|
|
492
|
+
+ Có cần bổ sung vào business-dictionary.md không?
|
|
493
|
+
Sau khi PO confirm → cập nhật business-dictionary.md (nếu PO đồng ý) rồi mới tiếp tục.
|
|
494
|
+
|
|
495
|
+
NUMBERING:
|
|
496
|
+
- UC ID: {TICKET}-{N}-UC{n} (n bắt đầu từ 1, tăng theo từng use case)
|
|
497
|
+
- BR ID: {TICKET}-{N}-UC{n}-BR{m} (m tăng LIÊN TỤC xuyên suốt PRD, KHÔNG reset mỗi UC)
|
|
498
|
+
-->
|
|
467
499
|
|
|
468
500
|
---
|
|
469
501
|
|
|
470
502
|
## Metadata
|
|
471
503
|
|
|
472
|
-
| Field | Value
|
|
473
|
-
|
|
474
|
-
| **PRD ID** | {TICKET-
|
|
475
|
-
| **Version** | 1.0
|
|
476
|
-
| **Status** | draft
|
|
477
|
-
| **Author** |
|
|
478
|
-
| **Domain** | {domain}
|
|
479
|
-
| **Created** | {
|
|
480
|
-
| **Updated** | {
|
|
481
|
-
| **
|
|
504
|
+
| Field | Value |
|
|
505
|
+
|---------------|------------------------------------------|
|
|
506
|
+
| **PRD ID** | {TICKET}-{N} |
|
|
507
|
+
| **Version** | 1.0 |
|
|
508
|
+
| **Status** | draft |
|
|
509
|
+
| **Author** | AI-assisted |
|
|
510
|
+
| **Domain** | {domain} |
|
|
511
|
+
| **Created** | {date} |
|
|
512
|
+
| **Updated** | {date} |
|
|
513
|
+
| **Jira Ticket** | [{TICKET}-{N}]({ticket_url}) |
|
|
514
|
+
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
482
515
|
|
|
483
516
|
---
|
|
484
517
|
|
|
485
518
|
# Feature
|
|
486
519
|
|
|
487
|
-
{
|
|
520
|
+
**{Feature Name}**
|
|
521
|
+
|
|
522
|
+
{Đoạn mô tả tổng quan: feature làm gì, cho ai, giải quyết vấn đề gì — lấy từ product-definition.}
|
|
488
523
|
|
|
489
524
|
---
|
|
490
525
|
|
|
491
|
-
# 1.
|
|
526
|
+
# 1. Tổng quan
|
|
492
527
|
|
|
493
528
|
## a. User Story
|
|
494
529
|
|
|
495
|
-
- **As a** {
|
|
496
|
-
- **I want to** {
|
|
497
|
-
-
|
|
530
|
+
- **Là một (As a)** {persona}
|
|
531
|
+
- **Tôi muốn (I want to)** {action}
|
|
532
|
+
- **Để (So that)** {benefit}
|
|
498
533
|
|
|
499
|
-
## b.
|
|
534
|
+
## b. Phạm vi
|
|
500
535
|
|
|
501
536
|
**In Scope**
|
|
537
|
+
- {hạng mục trong phạm vi 1}
|
|
538
|
+
- {hạng mục trong phạm vi 2}
|
|
502
539
|
|
|
503
|
-
|
|
504
|
-
- {
|
|
540
|
+
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
541
|
+
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
505
542
|
|
|
506
543
|
---
|
|
507
544
|
|
|
508
545
|
# 2. Acceptance Criteria
|
|
509
546
|
|
|
510
|
-
|
|
511
|
-
|
|
547
|
+
**AC1:** {Tiêu chí nghiệm thu, văn xuôi, kiểm chứng được.}
|
|
548
|
+
|
|
549
|
+
**AC2:** {…}
|
|
512
550
|
|
|
513
551
|
---
|
|
514
552
|
|
|
515
553
|
# 3. Use Case
|
|
516
554
|
|
|
517
|
-
#### {TICKET-
|
|
555
|
+
#### {TICKET}-{N}-UC1: {Tên use case}
|
|
556
|
+
|
|
557
|
+
**Actor:** {actor}
|
|
558
|
+
|
|
559
|
+
**Description:** {mô tả luồng}
|
|
560
|
+
|
|
561
|
+
**Pre-condition:**
|
|
562
|
+
- {điều kiện trước 1}
|
|
518
563
|
|
|
519
|
-
-
|
|
520
|
-
-
|
|
521
|
-
- **Pre-condition:** {Condition that must be true BEFORE use case begins}
|
|
522
|
-
- **Post-condition:** {State / result AFTER use case completes}
|
|
564
|
+
**Post-condition:**
|
|
565
|
+
- {kết quả sau 1}
|
|
523
566
|
|
|
524
567
|
**Business Rule**
|
|
525
568
|
|
|
526
|
-
| ID | Business Rule |
|
|
527
|
-
|
|
528
|
-
| {TICKET-
|
|
529
|
-
| {TICKET-
|
|
569
|
+
| ID | Business Rule | Business Logic |
|
|
570
|
+
|----|---------------|----------------|
|
|
571
|
+
| {TICKET}-{N}-UC1-BR1 | {luật ngắn gọn} | - {logic chi tiết, xuống dòng bằng `<br/>`}<br/>- {…} |
|
|
572
|
+
| {TICKET}-{N}-UC1-BR2 | {…} | - {…} |
|
|
530
573
|
|
|
531
|
-
|
|
574
|
+
---
|
|
532
575
|
|
|
533
|
-
|
|
534
|
-
- Logic 1
|
|
535
|
-
- Logic 2
|
|
536
|
-
- Logic 3
|
|
576
|
+
#### {TICKET}-{N}-UC2: {Tên use case}
|
|
537
577
|
|
|
538
|
-
|
|
539
|
-
- Logic
|
|
578
|
+
{lặp cấu trúc UC như trên; BR đánh số tiếp tục BR3, BR4…}
|
|
540
579
|
|
|
541
580
|
---
|
|
542
581
|
|
|
@@ -544,47 +583,51 @@ Write `{paths.specs_dir}/{domain}/{prd-slug}/prd.md` using the structure below.
|
|
|
544
583
|
|
|
545
584
|
## a. User Flow
|
|
546
585
|
|
|
547
|
-
{Brief description of sequence and decision branches}
|
|
548
|
-
|
|
549
586
|
```mermaid
|
|
550
587
|
flowchart TD
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
C -->|Yes| D[Result A]
|
|
554
|
-
C -->|No| E[Result B]
|
|
588
|
+
START(["{điểm bắt đầu}"]) --> A{"{điểm quyết định}"}
|
|
589
|
+
A -->|{nhánh}| B["{bước}"]
|
|
555
590
|
```
|
|
556
591
|
|
|
557
592
|
## b. Wireframe
|
|
558
593
|
|
|
559
|
-
|
|
594
|
+
### Screen 1: {Tên màn}
|
|
560
595
|
|
|
561
|
-
|
|
596
|
+
| Thành phần | Chi tiết |
|
|
597
|
+
|------------|----------|
|
|
598
|
+
| **Screen** | {tên/ngữ cảnh màn} |
|
|
599
|
+
| **Components** | - {thành phần 1}<br/>- {thành phần 2} |
|
|
600
|
+
| **Actions** | - {hành động 1 → kết quả}<br/>- {hành động 2 → kết quả} |
|
|
601
|
+
|
|
602
|
+
---
|
|
562
603
|
|
|
563
|
-
|
|
564
|
-
- {Component 1}
|
|
565
|
-
- {Component 2}
|
|
566
|
-
- {Component 3}
|
|
604
|
+
### Screen 2: {Tên màn}
|
|
567
605
|
|
|
568
|
-
|
|
569
|
-
- {Action 1} → {Result}
|
|
570
|
-
- {Action 2} → {Result}
|
|
606
|
+
{lặp bảng như trên cho từng màn}
|
|
571
607
|
|
|
572
608
|
---
|
|
573
609
|
|
|
574
610
|
# Appendix
|
|
575
611
|
|
|
576
|
-
##
|
|
612
|
+
## Input gốc từ PO
|
|
577
613
|
|
|
578
|
-
> {
|
|
614
|
+
> {Trích nguyên văn input/ghi chú gốc của PO + đường dẫn product-definition nguồn.}
|
|
579
615
|
|
|
580
|
-
##
|
|
616
|
+
## Tài liệu tham khảo
|
|
581
617
|
|
|
582
|
-
- {
|
|
618
|
+
- [{TICKET liên quan}](./{file}.md) — {quan hệ: pre-condition / overlapping / related…}
|
|
619
|
+
- Từ điển nghiệp vụ: `{path}/business-dictionary.md`
|
|
620
|
+
- Domain knowledge: `{path}/{domain}.md`
|
|
583
621
|
|
|
584
|
-
## Existing API Contract *(
|
|
622
|
+
## Existing API Contract *(CHỈ brownfield — điền khi API Source = existing; greenfield BỎ QUA cả section này)*
|
|
585
623
|
|
|
586
|
-
|
|
587
|
-
|
|
624
|
+
<!--
|
|
625
|
+
Chỉ dùng khi PRD bọc một API đã tồn tại trên hệ thống. PO ghi lại contract để:
|
|
626
|
+
- /generate-bdd (system) dùng trực tiếp làm input — không cần tổng hợp từ FE/App BDD;
|
|
627
|
+
- /generate-tech-docs chạy mode reverse-document (mô tả lại as-is, không design mới);
|
|
628
|
+
- /review-tech-docs bỏ qua cổng T7 cross-team sign-off (contract đã cố định).
|
|
629
|
+
Nếu greenfield (thiết kế mới) → xoá toàn bộ section này.
|
|
630
|
+
-->
|
|
588
631
|
|
|
589
632
|
| Method | Path | Auth | Request | Response |
|
|
590
633
|
|--------|------|------|---------|----------|
|
|
@@ -596,77 +639,83 @@ flowchart TD
|
|
|
596
639
|
|-------------|------------|----------------|
|
|
597
640
|
| {4xx/5xx} | {ERR_CODE} | {condition} |
|
|
598
641
|
|
|
599
|
-
|
|
642
|
+
## Giả định AI
|
|
600
643
|
|
|
601
|
-
|
|
644
|
+
> {Giả định / độ vênh AI phát hiện khi đối chiếu product-definition với domain-knowledge — cần PO review. AI KHÔNG tự hoà giải.}
|
|
602
645
|
|
|
603
|
-
|
|
646
|
+
- **Q1 — [AI DRAFT] {tiêu đề}:** {mô tả độ vênh + nguồn}. **Cần PO chốt {điều gì}.**
|
|
604
647
|
|
|
605
|
-
|
|
606
|
-
```
|
|
648
|
+
_(Nếu không có độ vênh: ghi "Không có — toàn bộ nội dung đã được PO xác nhận qua Product Definition.")_
|
|
607
649
|
|
|
608
650
|
---
|
|
609
651
|
|
|
610
|
-
|
|
652
|
+
# Change Log
|
|
611
653
|
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
- [ ] No banned terms (if dictionary exists)
|
|
618
|
-
- [ ] User Flow includes error path / exception path
|
|
619
|
-
- [ ] Wireframe covers all screens related to Use Cases
|
|
620
|
-
- [ ] **Định dạng (readability)**: User Story / AC / các field của UC (Actor, Description, Pre/Post-condition) viết dạng bullet `- **Label:** …` — mỗi ý MỘT dòng, KHÔNG viết các dòng liền nhau (sẽ bị dồn thành 1 đoạn khi render); có một dòng trống trước và sau mỗi bảng
|
|
654
|
+
### v1.0 — {mô tả} ({date})
|
|
655
|
+
|
|
656
|
+
| Mục | Thay đổi |
|
|
657
|
+
|-----|----------|
|
|
658
|
+
| — | Bản đầu — sinh từ product-definition. |
|
|
621
659
|
|
|
622
|
-
|
|
660
|
+
---
|
|
661
|
+
|
|
662
|
+
<!--
|
|
663
|
+
NEXT STEPS:
|
|
664
|
+
Khi PRD được approve (status: approved), chạy:
|
|
665
|
+
/generate-bdd "specs/{domain}/{prd-slug}/prd.md"
|
|
666
|
+
để sinh BDD feature specs từ PRD này.
|
|
667
|
+
-->
|
|
623
668
|
|
|
624
|
-
|
|
669
|
+
````
|
|
625
670
|
|
|
626
|
-
```markdown
|
|
627
671
|
---
|
|
628
672
|
|
|
629
|
-
##
|
|
673
|
+
## Quality Checklist *(kiểm tra trước khi ghi)*
|
|
630
674
|
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
675
|
+
- [ ] Mọi AC đều testable (pass/fail rõ ràng), không có chi tiết kỹ thuật (API/token/DB) hay visual chi tiết (màu sắc, font, animation)
|
|
676
|
+
- [ ] Mỗi UC có Actor / Description / Pre-condition / Post-condition
|
|
677
|
+
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung bảng 3 cột `ID | Business Rule | Business Logic`
|
|
678
|
+
- [ ] BR ID tăng liên tục trên toàn PRD — không reset theo từng UC
|
|
679
|
+
- [ ] Mọi cross-reference TICKET-ID đều là inline link `[TICKET-ID](./file.md)`
|
|
680
|
+
- [ ] Không có banned term (nếu dictionary tồn tại)
|
|
681
|
+
- [ ] User Flow có cả luồng lỗi / luồng ngoại lệ
|
|
682
|
+
- [ ] Wireframe phủ tất cả màn hình liên quan tới Use Case
|
|
683
|
+
- [ ] **Định dạng (readability)**: User Story / AC / các field của UC (Actor, Description, Pre/Post-condition) viết dạng bullet `- **Label:** …` — mỗi ý MỘT dòng, KHÔNG viết các dòng liền nhau (sẽ bị dồn thành 1 đoạn khi render); có một dòng trống trước và sau mỗi bảng
|
|
635
684
|
|
|
636
685
|
## Output
|
|
637
686
|
|
|
638
|
-
# Report Footer —
|
|
687
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
639
688
|
|
|
640
|
-
|
|
689
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
641
690
|
|
|
642
691
|
## Status Badge
|
|
643
692
|
|
|
644
|
-
|
|
645
|
-
- `✅ Complete` —
|
|
646
|
-
- `❌ Failed` —
|
|
647
|
-
- `⚠️ Warnings` —
|
|
693
|
+
Chọn một theo kết quả:
|
|
694
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
695
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
696
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
648
697
|
|
|
649
698
|
## Output Artifacts
|
|
650
699
|
|
|
651
|
-
|
|
700
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
652
701
|
```
|
|
653
702
|
Output Artifacts:
|
|
654
|
-
{created|updated} {file-path} ({
|
|
655
|
-
{created|updated} {file-path} ({
|
|
703
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
704
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
656
705
|
```
|
|
657
706
|
|
|
658
|
-
|
|
707
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
659
708
|
|
|
660
709
|
## Pipeline Position
|
|
661
710
|
|
|
662
|
-
|
|
663
|
-
|
|
711
|
+
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`,
|
|
712
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
664
713
|
|
|
665
714
|
```
|
|
666
715
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
667
716
|
```
|
|
668
717
|
|
|
669
|
-
|
|
718
|
+
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:
|
|
670
719
|
|
|
671
720
|
| Phase | Commands |
|
|
672
721
|
|-------|----------|
|
|
@@ -680,69 +729,69 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
680
729
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
681
730
|
| Trace Audit | `/validate-traces` |
|
|
682
731
|
|
|
683
|
-
|
|
732
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
684
733
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
685
734
|
|
|
686
|
-
**
|
|
687
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
688
|
-
**
|
|
735
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
736
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
737
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
689
738
|
|
|
690
|
-
##
|
|
739
|
+
## Gợi ý lệnh tiếp theo
|
|
691
740
|
|
|
692
|
-
|
|
741
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
693
742
|
|
|
694
|
-
|
|
|
743
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
695
744
|
|-------------------------|-----------------------------------------------|
|
|
696
|
-
| /setup-ai-first | `/define-product`
|
|
745
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
697
746
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
698
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
699
|
-
| /refine-prd |
|
|
700
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
701
|
-
| /generate-design-spec | Designer review →
|
|
702
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
703
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
704
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
747
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
748
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
749
|
+
| /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 |
|
|
750
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
751
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
752
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
753
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
705
754
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
706
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
707
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
708
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
709
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
710
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
755
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
756
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
757
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
758
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
759
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
711
760
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
712
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
713
|
-
| /generate-code |
|
|
761
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
762
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
714
763
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
715
764
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
716
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
717
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
718
|
-
| /dev-smoke-test |
|
|
719
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
720
|
-
| /fix-bug |
|
|
721
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
722
|
-
| /report-bug |
|
|
723
|
-
| /propose-scenario |
|
|
724
|
-
| /learn |
|
|
725
|
-
| /sync | `/validate-traces`
|
|
726
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
727
|
-
|
|
728
|
-
|
|
765
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
766
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
767
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
768
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
769
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
770
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
771
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
772
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
773
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
774
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
775
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
776
|
+
|
|
777
|
+
Định dạng footer như sau:
|
|
729
778
|
```
|
|
730
779
|
---
|
|
731
780
|
Status : {badge}
|
|
732
|
-
{Output Artifacts
|
|
781
|
+
{khối Output Artifacts}
|
|
733
782
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
734
|
-
(review
|
|
735
|
-
Next : {
|
|
783
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
784
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
736
785
|
```
|
|
737
|
-
*(
|
|
786
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
738
787
|
|
|
739
788
|
|
|
740
789
|
```
|
|
741
|
-
/generate-prd
|
|
790
|
+
/generate-prd Hoàn tất — {TICKET-ID}
|
|
742
791
|
---
|
|
743
792
|
Status : ✅ Complete
|
|
744
793
|
Output Artifacts:
|
|
745
794
|
created {paths.specs_dir}/{domain}/{prd-slug}/prd.md (PRD v1.0)
|
|
746
795
|
Next : /refine-prd {paths.specs_dir}/{domain}/{prd-slug}/prd.md
|
|
747
|
-
→
|
|
796
|
+
→ rồi /review-context {prd-file} ← kiểm tra chất lượng PRD trước khi sinh BDD
|
|
748
797
|
```
|