@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
|
@@ -1,166 +1,166 @@
|
|
|
1
|
-
# /generate-tech-docs —
|
|
1
|
+
# /generate-tech-docs — Sinh Technical Design 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 ở Bước 1 là một file `.feature` hoặc UC-ID. Nếu `$ARGUMENTS` là UC-ID trần, định vị feature bằng cách glob `{paths.specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature` (wildcard `*` cho prd-slug chưa biết, `**` đệ quy cho thư mục con `web/`·`app/`·`system/` — BE tech-doc phân giải từ BDD `system/`); lấy `domain` + `prd_slug` từ path khớp. Mọi output bên dưới dùng `{prd-slug}` đã phân giải đó.*
|
|
94
94
|
|
|
95
|
-
**Quality Gate**:
|
|
95
|
+
**Quality Gate**: Trước khi sinh, kiểm tra file BDD findings:
|
|
96
96
|
|
|
97
|
-
1.
|
|
98
|
-
2. **
|
|
97
|
+
1. Tìm `{paths.refinement_dir}/{uc-id}-review-bdd-findings.yaml`.
|
|
98
|
+
2. **Nếu file không tồn tại** → cảnh báo và hỏi:
|
|
99
99
|
```
|
|
100
|
-
⚠️ /review-context
|
|
101
|
-
|
|
102
|
-
|
|
100
|
+
⚠️ /review-context chưa chạy cho file feature này.
|
|
101
|
+
Khuyến nghị: chạy /review-context {feature-file} trước để kiểm tra chất lượng BDD.
|
|
102
|
+
Tiếp tục mà không review? (Y/N)
|
|
103
103
|
```
|
|
104
|
-
- Y →
|
|
105
|
-
- N →
|
|
106
|
-
3. **
|
|
107
|
-
|
|
104
|
+
- Y → tiếp tục (chấp nhận rủi ro)
|
|
105
|
+
- N → dừng; chạy `/review-context {feature-file}` trước
|
|
106
|
+
3. **Nếu file tồn tại** → kiểm tra các finding critical `status: "pending"` chưa giải quyết.
|
|
107
|
+
Nếu có → **HALT** và in:
|
|
108
108
|
```
|
|
109
109
|
❌ Quality Gate Failed — {feature-file}
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
110
|
+
Phát hiện finding BDD critical chưa giải quyết.
|
|
111
|
+
Chạy: /review-context --fix {feature-file} ← auto-fix những gì có thể
|
|
112
|
+
Rồi: /review-context --resume {feature-file} ← áp dụng các finding được chấp nhận còn lại
|
|
113
|
+
Rồi chạy lại: /generate-tech-docs {feature-file}
|
|
114
114
|
```
|
|
115
115
|
|
|
116
116
|
## Context
|
|
117
|
-
# Context Loader —
|
|
117
|
+
# Context Loader — Nạp toàn bộ context dự án
|
|
118
118
|
|
|
119
|
-
|
|
119
|
+
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.
|
|
120
120
|
|
|
121
|
-
**
|
|
122
|
-
-
|
|
123
|
-
-
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
-
|
|
121
|
+
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
122
|
+
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
123
|
+
- 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.
|
|
124
|
+
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
125
|
+
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
126
|
+
- 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.
|
|
127
127
|
|
|
128
128
|
---
|
|
129
129
|
|
|
130
|
-
##
|
|
130
|
+
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
131
131
|
|
|
132
|
-
|
|
132
|
+
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
133
133
|
|
|
134
134
|
**Tech Stack:**
|
|
135
|
-
- `tech_stack.language` →
|
|
136
|
-
- `tech_stack.framework` →
|
|
137
|
-
- `tech_stack.build_tool` → build tool (
|
|
138
|
-
- `tech_stack.test_framework` → test framework (
|
|
139
|
-
- `tech_stack.database` → database (
|
|
140
|
-
- `tech_stack.module` →
|
|
135
|
+
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
136
|
+
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
137
|
+
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
138
|
+
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
139
|
+
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
140
|
+
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
141
141
|
|
|
142
142
|
**Conventions:**
|
|
143
|
-
- `conventions.build_command` →
|
|
144
|
-
- `conventions.test_command` →
|
|
145
|
-
- `conventions.service_run` →
|
|
146
|
-
- `conventions.ticket_prefix` → ticket ID
|
|
143
|
+
- `conventions.build_command` → cách compile/build
|
|
144
|
+
- `conventions.test_command` → cách chạy test
|
|
145
|
+
- `conventions.service_run` → cách khởi động service
|
|
146
|
+
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
147
147
|
|
|
148
148
|
**Domains:**
|
|
149
|
-
- `domains` →
|
|
150
|
-
|
|
151
|
-
**Paths (
|
|
152
|
-
- `paths.specs_dir` → spec
|
|
153
|
-
- `paths.refinement_dir` → findings/review
|
|
154
|
-
- `paths.qc_dir` → QC automation
|
|
155
|
-
- `paths.qc_skills_dir` →
|
|
156
|
-
- `paths.product_definitions_dir` → product
|
|
157
|
-
- `paths.domain_knowledge_dir` → domain knowledge
|
|
158
|
-
- `paths.business_dictionary` → path
|
|
159
|
-
- `paths.core_entities` → path
|
|
160
|
-
- `paths.tech_docs_dir` →
|
|
161
|
-
- `paths.trace_dir` →
|
|
162
|
-
|
|
163
|
-
|
|
149
|
+
- `domains` → danh sách các business domain đang hoạt động
|
|
150
|
+
|
|
151
|
+
**Paths (nếu có):**
|
|
152
|
+
- `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/}`
|
|
153
|
+
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
154
|
+
- `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}/`)
|
|
155
|
+
- `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 đè)
|
|
156
|
+
- `paths.product_definitions_dir` → gốc product definition
|
|
157
|
+
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
158
|
+
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
159
|
+
- `paths.core_entities` → path tới core-entities.md
|
|
160
|
+
- `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/`)
|
|
161
|
+
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}.tsv`
|
|
162
|
+
|
|
163
|
+
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
164
164
|
- `specs_dir` = `specs`
|
|
165
165
|
- `refinement_dir` = `.agent/review`
|
|
166
166
|
- `qc_dir` = `docs`
|
|
@@ -172,184 +172,184 @@ If `paths` section is absent, use these defaults:
|
|
|
172
172
|
- `tech_docs_dir` = `specs`
|
|
173
173
|
- `trace_dir` = `.trace`
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
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.
|
|
176
176
|
|
|
177
|
-
**
|
|
177
|
+
**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ụ:
|
|
178
178
|
- `specs/payment/create-invoice/prd.md` → `prd_slug = create-invoice`
|
|
179
|
-
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
180
|
-
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(
|
|
181
|
-
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(
|
|
179
|
+
- `specs/payment/create-invoice/bdd/system/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `system`)*
|
|
180
|
+
- `specs/payment/create-invoice/bdd/web/PAY-UC1.feature` → `prd_slug = create-invoice` *(KHÔNG phải `web`)*
|
|
181
|
+
- `specs/payment/create-invoice/tech-docs/PAY-UC1-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
182
182
|
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
183
183
|
|
|
184
|
-
|
|
184
|
+
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ừ đó.
|
|
185
185
|
|
|
186
|
-
|
|
186
|
+
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.
|
|
187
187
|
|
|
188
188
|
---
|
|
189
189
|
|
|
190
|
-
##
|
|
190
|
+
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
191
191
|
|
|
192
|
-
*
|
|
192
|
+
*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.*
|
|
193
193
|
|
|
194
|
-
|
|
194
|
+
Nếu có section `services`:
|
|
195
195
|
|
|
196
|
-
**1.
|
|
197
|
-
-
|
|
198
|
-
-
|
|
199
|
-
*(
|
|
200
|
-
-
|
|
196
|
+
**1. Phát hiện active domain** (theo thứ tự ưu tiên):
|
|
197
|
+
- Đọc `@trace.domain` từ frontmatter của target file (nếu Gate đã nạp một target file)
|
|
198
|
+
- 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.
|
|
199
|
+
*(vd: `specs/user/create-account/prd.md` **và** `specs/user/create-account/bdd/system/UC1.feature` đều → domain = `user`, prd_slug = `create-account`)*
|
|
200
|
+
- Nếu `$ARGUMENTS` chứa một path, trích xuất segment domain sau `specs_dir`
|
|
201
201
|
|
|
202
|
-
**2. Route
|
|
203
|
-
- Override `paths.specs_dir` → `services.{domain}.specs_dir` — **
|
|
204
|
-
- Override `paths.tech_docs_dir` → `services.{domain}.tech_docs_dir` — **
|
|
205
|
-
-
|
|
206
|
-
-
|
|
207
|
-
-
|
|
202
|
+
**2. Route tới service** — nếu active domain khớp với một key trong `services`:
|
|
203
|
+
- 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.
|
|
204
|
+
- 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.
|
|
205
|
+
- Lưu `active_service` = `services.{domain}.path`
|
|
206
|
+
- Lưu `active_service_module` = `services.{domain}.module`
|
|
207
|
+
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
208
208
|
|
|
209
|
-
**3. Fallback** —
|
|
210
|
-
-
|
|
211
|
-
-
|
|
209
|
+
**3. Fallback** — nếu không phát hiện được domain hoặc không có service key khớp:
|
|
210
|
+
- Giữ path mặc định từ Bước 1
|
|
211
|
+
- Đặt `active_service = unresolved`
|
|
212
212
|
|
|
213
|
-
**4.
|
|
214
|
-
- Override `paths.specs_dir` → `{spec_source}/specs` — **
|
|
215
|
-
- Override `paths.tech_docs_dir` → `{spec_source}/specs` — **
|
|
213
|
+
**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:`:
|
|
214
|
+
- 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`.)*
|
|
215
|
+
- 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.)*
|
|
216
216
|
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
217
217
|
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
218
218
|
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
219
219
|
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
220
220
|
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
221
221
|
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
222
|
-
- Override `paths.trace_dir` → `{spec_source}/.trace` — **
|
|
222
|
+
- 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`.)*
|
|
223
223
|
|
|
224
|
-
> **
|
|
224
|
+
> **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.
|
|
225
225
|
|
|
226
226
|
---
|
|
227
227
|
|
|
228
|
-
##
|
|
228
|
+
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
229
229
|
|
|
230
|
-
*
|
|
230
|
+
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc context ở chế độ single-service.*
|
|
231
231
|
|
|
232
|
-
|
|
232
|
+
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
233
233
|
|
|
234
|
-
**1.
|
|
234
|
+
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
235
235
|
- `{active_service}/.agent/project-context.yaml`
|
|
236
236
|
- `{active_service}/project-context.yaml`
|
|
237
237
|
|
|
238
|
-
**2.
|
|
238
|
+
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
239
239
|
|
|
240
|
-
|
|
|
240
|
+
| Biến | Nguồn |
|
|
241
241
|
|----------|--------|
|
|
242
|
-
| `conventions.test_command` |
|
|
243
|
-
| `conventions.build_command` |
|
|
244
|
-
| `paths.trace_dir` | **
|
|
245
|
-
| `paths.specs_dir` | **
|
|
242
|
+
| `conventions.test_command` | `conventions.test_command` của service |
|
|
243
|
+
| `conventions.build_command` | `conventions.build_command` của service |
|
|
244
|
+
| `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`). |
|
|
245
|
+
| `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. |
|
|
246
246
|
|
|
247
|
-
**3.
|
|
248
|
-
-
|
|
249
|
-
- **
|
|
247
|
+
**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:
|
|
248
|
+
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
249
|
+
- **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/`).
|
|
250
250
|
|
|
251
|
-
**4.
|
|
251
|
+
**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).
|
|
252
252
|
|
|
253
253
|
---
|
|
254
254
|
|
|
255
|
-
##
|
|
255
|
+
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
256
256
|
|
|
257
|
-
|
|
258
|
-
Merge framework
|
|
259
|
-
|
|
257
|
+
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
258
|
+
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
259
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
260
260
|
|
|
261
261
|
---
|
|
262
262
|
|
|
263
|
-
##
|
|
263
|
+
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
264
264
|
|
|
265
|
-
|
|
265
|
+
*Đâ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.*
|
|
266
266
|
|
|
267
|
-
CLAUDE.md
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
267
|
+
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
268
|
+
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
|
|
269
|
+
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
|
|
270
|
+
service phải thắng khi sinh code.
|
|
271
271
|
|
|
272
|
-
**
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
272
|
+
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
273
|
+
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
274
|
+
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
275
|
+
kiến trúc + coding standards duy nhất của dự án.
|
|
276
276
|
|
|
277
|
-
**
|
|
278
|
-
*
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
Overlay
|
|
282
|
-
coding standards,
|
|
283
|
-
(
|
|
277
|
+
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
278
|
+
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
279
|
+
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
280
|
+
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
281
|
+
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,
|
|
282
|
+
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
283
|
+
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
284
284
|
|
|
285
|
-
|
|
285
|
+
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
286
286
|
|
|
287
|
-
- **§1 Project Overview** →
|
|
288
|
-
- **§2 Architecture** → layer
|
|
289
|
-
- **§3 Coding Standards** →
|
|
290
|
-
- **§5 Error Handling** → exception
|
|
291
|
-
- **§7 Git Conventions** →
|
|
287
|
+
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
288
|
+
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
289
|
+
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
290
|
+
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
291
|
+
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
292
292
|
|
|
293
|
-
**
|
|
294
|
-
-
|
|
295
|
-
-
|
|
296
|
-
-
|
|
297
|
-
-
|
|
293
|
+
**Quy tắc phân giải:**
|
|
294
|
+
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
295
|
+
- 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}`.
|
|
296
|
+
- 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).
|
|
297
|
+
- 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.
|
|
298
298
|
|
|
299
299
|
---
|
|
300
300
|
|
|
301
|
-
##
|
|
301
|
+
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
302
302
|
|
|
303
|
-
|
|
303
|
+
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
304
304
|
|
|
305
|
-
|
|
305
|
+
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.
|
|
306
306
|
|
|
307
|
-
|
|
307
|
+
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*`.
|
|
308
308
|
|
|
309
309
|
---
|
|
310
310
|
|
|
311
|
-
##
|
|
311
|
+
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
312
312
|
|
|
313
|
-
|
|
313
|
+
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).
|
|
314
314
|
|
|
315
|
-
|
|
316
|
-
- **Canonical Terms** →
|
|
317
|
-
- **Banned Terms** →
|
|
318
|
-
- **Status / Enum Registry** →
|
|
315
|
+
Nếu tồn tại, đọc và trích xuất:
|
|
316
|
+
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
317
|
+
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
318
|
+
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
319
319
|
|
|
320
|
-
|
|
321
|
-
-
|
|
322
|
-
-
|
|
320
|
+
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
321
|
+
- 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
|
|
322
|
+
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
323
323
|
|
|
324
|
-
|
|
324
|
+
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
325
325
|
|
|
326
326
|
---
|
|
327
327
|
|
|
328
|
-
##
|
|
328
|
+
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
329
329
|
|
|
330
|
-
|
|
331
|
-
|
|
330
|
+
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).
|
|
331
|
+
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
332
332
|
|
|
333
|
-
|
|
334
|
-
- **Entity catalog** →
|
|
335
|
-
- **Field name registry** →
|
|
336
|
-
- **Relationship map** →
|
|
333
|
+
Nếu tồn tại, đọc và lưu:
|
|
334
|
+
- **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ệ
|
|
335
|
+
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
336
|
+
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
337
337
|
|
|
338
|
-
**
|
|
339
|
-
-
|
|
340
|
-
-
|
|
341
|
-
-
|
|
338
|
+
**Cách dùng catalog này:**
|
|
339
|
+
- 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
|
|
340
|
+
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
341
|
+
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
342
342
|
|
|
343
|
-
|
|
343
|
+
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
344
344
|
|
|
345
345
|
---
|
|
346
346
|
|
|
347
|
-
##
|
|
347
|
+
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
348
348
|
|
|
349
|
-
|
|
349
|
+
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:
|
|
350
350
|
|
|
351
351
|
```
|
|
352
|
-
active_module = tech_stack.module (
|
|
352
|
+
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
353
353
|
```
|
|
354
354
|
|
|
355
355
|
| `platform_type` | Modules |
|
|
@@ -358,141 +358,141 @@ active_module = tech_stack.module (e.g. "java-spring", "react", "flutter")
|
|
|
358
358
|
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular` |
|
|
359
359
|
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
360
360
|
|
|
361
|
-
|
|
361
|
+
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.
|
|
362
362
|
|
|
363
|
-
|
|
363
|
+
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).
|
|
364
364
|
|
|
365
365
|
---
|
|
366
366
|
|
|
367
|
-
##
|
|
367
|
+
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
368
368
|
|
|
369
|
-
*
|
|
370
|
-
|
|
369
|
+
*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`
|
|
370
|
+
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
371
371
|
|
|
372
|
-
|
|
373
|
-
-
|
|
374
|
-
- Else
|
|
375
|
-
-
|
|
372
|
+
Phân giải path file lessons:
|
|
373
|
+
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
374
|
+
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
375
|
+
- Ở 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`
|
|
376
376
|
|
|
377
|
-
|
|
378
|
-
-
|
|
379
|
-
-
|
|
380
|
-
-
|
|
377
|
+
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:
|
|
378
|
+
- 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).
|
|
379
|
+
- 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).
|
|
380
|
+
- 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.
|
|
381
381
|
|
|
382
|
-
|
|
382
|
+
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
383
383
|
|
|
384
384
|
---
|
|
385
385
|
|
|
386
|
-
##
|
|
386
|
+
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
387
387
|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
(recency
|
|
388
|
+
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.
|
|
389
|
+
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
|
|
390
|
+
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
391
391
|
|
|
392
|
-
|
|
392
|
+
Xuất đúng khối này:
|
|
393
393
|
```
|
|
394
394
|
[CTX LOADED]
|
|
395
395
|
Stack : {language} / {framework} / {database}
|
|
396
396
|
Platform : {active_module} ({platform_type})
|
|
397
|
-
Layers : {
|
|
398
|
-
CLAUDE.md : {root + {service_root} | {service_root}
|
|
397
|
+
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
398
|
+
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
399
399
|
Ticket : {ticket_prefix}-
|
|
400
400
|
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
401
401
|
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
402
|
-
Lessons : {loaded — N guardrails |
|
|
402
|
+
Lessons : {loaded — N guardrails | chưa có}
|
|
403
403
|
Service : {active_service} ({active_service_module}) | single-service
|
|
404
|
-
Svc Root : {service_root} — conventions + trace_dir
|
|
405
|
-
Status : {FULL | PARTIAL —
|
|
404
|
+
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
405
|
+
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
406
406
|
```
|
|
407
407
|
|
|
408
|
-
|
|
408
|
+
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.
|
|
409
409
|
|
|
410
410
|
---
|
|
411
411
|
|
|
412
|
-
##
|
|
412
|
+
## Hoàn tất nạp Context
|
|
413
413
|
|
|
414
|
-
|
|
415
|
-
-
|
|
416
|
-
-
|
|
417
|
-
- Coding standards
|
|
418
|
-
-
|
|
419
|
-
-
|
|
420
|
-
- Entity catalog (field
|
|
421
|
-
-
|
|
414
|
+
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
415
|
+
- Định danh dự án, tech stack, convention module
|
|
416
|
+
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
417
|
+
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
418
|
+
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
419
|
+
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
420
|
+
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
421
|
+
- Toàn bộ path đã cấu hình
|
|
422
422
|
|
|
423
|
-
|
|
423
|
+
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
424
424
|
|
|
425
425
|
|
|
426
426
|
---
|
|
427
427
|
|
|
428
|
-
## Step 0 —
|
|
428
|
+
## Step 0 — Phát hiện Platform & Route Output
|
|
429
429
|
|
|
430
|
-
|
|
430
|
+
Đọc `@trace.platform` từ header file feature (`web` | `app` | `system`). Nếu vắng, fallback về `platform_type` từ context (`web-frontend`/`mobile` → FE; `backend` → BE).
|
|
431
431
|
|
|
432
432
|
| Platform | `active_tech_design` | Output file |
|
|
433
433
|
|----------|----------------------|-------------|
|
|
434
|
-
| `system` / backend | **`be`** —
|
|
435
|
-
| `web` / `app` (web-frontend / mobile) | **`fe`** —
|
|
434
|
+
| `system` / backend | **`be`** — **API contract** liên team (authoritative) | `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` |
|
|
435
|
+
| `web` / `app` (web-frontend / mobile) | **`fe`** — **client technical design** (tiêu thụ BE contract) | `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md` |
|
|
436
436
|
|
|
437
|
-
|
|
437
|
+
Lưu `active_tech_design` và `tech_design_path`. Hậu tố `-{platform}` (giống design-spec) giữ doc FE không đụng độ BE contract — cả hai sống trong spec repo dùng chung khi `spec_source` được set.
|
|
438
438
|
|
|
439
439
|
---
|
|
440
440
|
|
|
441
441
|
## Step 0.5 — FE/App Precondition Gate
|
|
442
442
|
|
|
443
|
-
*
|
|
443
|
+
*Bỏ qua toàn bộ step này cho BE (`active_tech_design = be`).*
|
|
444
444
|
|
|
445
|
-
|
|
445
|
+
Một FE/App technical design là artifact **dẫn xuất**: layer tích hợp API của nó map lên BE contract đã chốt, và state/error model đến từ system behavior. Cả hai input upstream PHẢI tồn tại trước — **HALT** nếu thiếu một trong hai:
|
|
446
446
|
|
|
447
|
-
1. **System BDD** —
|
|
448
|
-
|
|
447
|
+
1. **System BDD** — định vị `{paths.specs_dir}/{domain}/{prd-slug}/bdd/system/{TICKET-ID}*.feature`.
|
|
448
|
+
Nếu không tìm thấy → HALT:
|
|
449
449
|
```
|
|
450
|
-
❌
|
|
451
|
-
|
|
452
|
-
→ PO/BE: /generate-bdd {prd-file} (
|
|
450
|
+
❌ Không thể sinh FE tech-design — không tìm thấy System BDD cho {TICKET-ID}.
|
|
451
|
+
FE design cần behavior mức system (đối diện BE) trước.
|
|
452
|
+
→ PO/BE: /generate-bdd {prd-file} (sinh BDD platform `system/`)
|
|
453
453
|
```
|
|
454
|
-
2. **BE tech-docs (API contract)** —
|
|
455
|
-
-
|
|
454
|
+
2. **BE tech-docs (API contract)** — định vị doc BE `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md` và đọc `@trace.status` của nó.
|
|
455
|
+
- Không tìm thấy → HALT:
|
|
456
456
|
```
|
|
457
|
-
❌
|
|
458
|
-
|
|
459
|
-
→ BE: /generate-tech-docs {system .feature} → /review-tech-docs (approve) → publish
|
|
457
|
+
❌ Không thể sinh FE tech-design — không tìm thấy BE API contract.
|
|
458
|
+
Layer tích hợp FE map tới BE contract; nó phải tồn tại trước.
|
|
459
|
+
→ BE: /generate-tech-docs {system .feature} → /review-tech-docs (approve) → publish lên spec repo
|
|
460
460
|
```
|
|
461
|
-
-
|
|
461
|
+
- Tìm thấy nhưng `@trace.status` ≠ `approved` → WARN và hỏi:
|
|
462
462
|
```
|
|
463
|
-
⚠️ BE contract {UC-ID}-tech-design.md
|
|
464
|
-
|
|
465
|
-
|
|
463
|
+
⚠️ BE contract {UC-ID}-tech-design.md đang status: {status} (chưa approved) — nó còn có thể đổi.
|
|
464
|
+
Thiết kế FE integration dựa trên contract chưa chốt có rủi ro rework.
|
|
465
|
+
Vẫn tiếp tục? (Y/N)
|
|
466
466
|
```
|
|
467
|
-
- Y →
|
|
467
|
+
- Y → tiếp tục (chấp nhận rủi ro) · N → dừng, chờ BE approve.
|
|
468
468
|
|
|
469
|
-
|
|
469
|
+
Lưu `system_bdd_path` và `be_contract_path` — chúng là input chính cho FE §3/§4 bên dưới.
|
|
470
470
|
|
|
471
471
|
---
|
|
472
472
|
|
|
473
473
|
## Brownfield Check
|
|
474
474
|
|
|
475
|
-
*BE (`active_tech_design = be`)
|
|
475
|
+
*Chỉ BE (`active_tech_design = be`) — với FE thì "existing contract" là doc BE đã nạp ở Step 0.5.*
|
|
476
476
|
|
|
477
|
-
|
|
478
|
-
|
|
477
|
+
Đọc header file `.feature` nguồn tìm `@trace.api_source`.
|
|
478
|
+
Cũng kiểm tra bảng Metadata của PRD nguồn tìm `| **API Source** | existing |`.
|
|
479
479
|
|
|
480
480
|
| Value | Mode |
|
|
481
481
|
|-------|------|
|
|
482
482
|
| `existing` | **Reverse-document** — API đã tồn tại; mô tả lại as-is, note gaps, không cần design mới |
|
|
483
483
|
| absent / other | **Greenfield** — thiết kế API từ đầu |
|
|
484
484
|
|
|
485
|
-
|
|
485
|
+
Lưu `active_mode = {reverse-document | greenfield}`.
|
|
486
486
|
|
|
487
|
-
|
|
487
|
+
Nếu `active_mode = reverse-document` → nạp bảng "Existing API Contract" từ PRD làm input cho §2.
|
|
488
488
|
|
|
489
489
|
---
|
|
490
490
|
|
|
491
491
|
## CHECKPOINT — Tech Design Plan
|
|
492
492
|
|
|
493
|
-
|
|
493
|
+
Trước khi sinh, quét file feature lấy số scenario, các BR tham chiếu, và entity. Hiện plan cho `active_tech_design` đã phân giải và chờ Y:
|
|
494
494
|
|
|
495
|
-
**
|
|
495
|
+
**Nếu `active_tech_design = be`:**
|
|
496
496
|
```
|
|
497
497
|
Tech Design Plan — {UC-ID} (BE · API contract)
|
|
498
498
|
──────────────────────────────────────────────────────
|
|
@@ -504,12 +504,12 @@ Scenarios: {N} scenarios
|
|
|
504
504
|
BDD ver : {trace.bdd_version}
|
|
505
505
|
Output : {paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md
|
|
506
506
|
|
|
507
|
-
|
|
507
|
+
Section cần sinh:
|
|
508
508
|
§1 Overview
|
|
509
509
|
§2 API Endpoints ({Reverse-document: mô tả lại từ PRD contract | Greenfield: infer từ scenarios})
|
|
510
|
-
§3 Data Model ({
|
|
510
|
+
§3 Data Model ({entity từ core-entities.md liên quan UC này})
|
|
511
511
|
§4 Service Flow
|
|
512
|
-
§5 Business Rules ({N}
|
|
512
|
+
§5 Business Rules ({N} BR từ header feature)
|
|
513
513
|
§6 Error Handling
|
|
514
514
|
§7 Database Changes
|
|
515
515
|
§8 Caching Strategy
|
|
@@ -518,7 +518,7 @@ Sections to generate:
|
|
|
518
518
|
Proceed? (Y/N)
|
|
519
519
|
```
|
|
520
520
|
|
|
521
|
-
**
|
|
521
|
+
**Nếu `active_tech_design = fe`:**
|
|
522
522
|
```
|
|
523
523
|
Tech Design Plan — {UC-ID} (FE · {platform} · client design)
|
|
524
524
|
──────────────────────────────────────────────────────
|
|
@@ -529,32 +529,32 @@ Inputs : System BDD → {system_bdd_path}
|
|
|
529
529
|
Scenarios : {N} FE scenarios | BDD ver: {trace.bdd_version}
|
|
530
530
|
Output : {paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md
|
|
531
531
|
|
|
532
|
-
|
|
533
|
-
§1 Overview (
|
|
534
|
-
§2 Component Architecture (tree + reuse
|
|
535
|
-
§2b Test Selectors (
|
|
532
|
+
Section cần sinh:
|
|
533
|
+
§1 Overview (scope FE của UC này)
|
|
534
|
+
§2 Component Architecture (tree + reuse từ figma-components catalog)
|
|
535
|
+
§2b Test Selectors (test-id ổn định cho element có action — QC contract, attr theo platform)
|
|
536
536
|
§3 State Management (store/slices/state shape ← System BDD Then-clauses)
|
|
537
|
-
§4 API Integration Layer (port/adapter:
|
|
537
|
+
§4 API Integration Layer (port/adapter: mỗi BE endpoint → FE service → DTO/model)
|
|
538
538
|
§5 Routing / Navigation
|
|
539
539
|
§6 Data Fetching & Client Caching (query keys, invalidation, optimistic updates)
|
|
540
|
-
§7 Error & Loading States (
|
|
540
|
+
§7 Error & Loading States (theo từng scenario)
|
|
541
541
|
§8 Cross-Cutting (auth token, i18n, feature flags)
|
|
542
|
-
{§9 Offline / platform specifics — app
|
|
542
|
+
{§9 Offline / platform specifics — chỉ app}
|
|
543
543
|
──────────────────────────────────────────────────────
|
|
544
544
|
Proceed? (Y/N)
|
|
545
545
|
```
|
|
546
546
|
|
|
547
|
-
|
|
547
|
+
Chờ "Y" rõ ràng trước khi sinh.
|
|
548
548
|
|
|
549
549
|
---
|
|
550
550
|
|
|
551
551
|
## Generate
|
|
552
552
|
|
|
553
|
-
|
|
553
|
+
Sinh document cho `active_tech_design` đã phân giải.
|
|
554
554
|
|
|
555
555
|
### Path A — BE API contract (`active_tech_design = be`)
|
|
556
556
|
|
|
557
|
-
|
|
557
|
+
Ghi `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.md`:
|
|
558
558
|
|
|
559
559
|
```markdown
|
|
560
560
|
# Technical Design — {UC-ID}: {Feature}
|
|
@@ -562,10 +562,10 @@ Write `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.m
|
|
|
562
562
|
---
|
|
563
563
|
@trace.id: {UC-ID}
|
|
564
564
|
@trace.domain: {domain}
|
|
565
|
-
@trace.service: {
|
|
566
|
-
@trace.module: {
|
|
565
|
+
@trace.service: {đọc @trace.service từ header file .feature}
|
|
566
|
+
@trace.module: {đọc @trace.module từ header file .feature}
|
|
567
567
|
@trace.prd: {TICKET-ID}
|
|
568
|
-
@trace.bdd_version: {
|
|
568
|
+
@trace.bdd_version: {đọc @trace.bdd_version từ header file .feature}
|
|
569
569
|
@trace.revision: 1
|
|
570
570
|
@trace.status: draft
|
|
571
571
|
@trace.api_source: {existing | —}
|
|
@@ -587,7 +587,7 @@ Write `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design.m
|
|
|
587
587
|
|
|
588
588
|
## §3. Data Model
|
|
589
589
|
|
|
590
|
-
|
|
590
|
+
Các entity chính và quan hệ.
|
|
591
591
|
|
|
592
592
|
## §4. Service Flow
|
|
593
593
|
|
|
@@ -595,7 +595,7 @@ Key entities and relationships.
|
|
|
595
595
|
|
|
596
596
|
## §5. Business Rules Implementation
|
|
597
597
|
|
|
598
|
-
| BR-ID | Rule |
|
|
598
|
+
| BR-ID | Rule | Cách implement |
|
|
599
599
|
|-------|------|-------------------------|
|
|
600
600
|
| {UC-ID}-BR1 | {rule} | {approach} |
|
|
601
601
|
|
|
@@ -607,15 +607,15 @@ Key entities and relationships.
|
|
|
607
607
|
|
|
608
608
|
## §7. Database Changes
|
|
609
609
|
|
|
610
|
-
Migration
|
|
610
|
+
Migration script hoặc thay đổi schema.
|
|
611
611
|
|
|
612
612
|
## §8. Caching Strategy
|
|
613
613
|
|
|
614
|
-
|
|
614
|
+
Cache gì, TTL, trigger invalidation.
|
|
615
615
|
|
|
616
616
|
## §9. Cross-Service Dependencies
|
|
617
617
|
|
|
618
|
-
|
|
618
|
+
Lời gọi ngoài, event phát ra/tiêu thụ.
|
|
619
619
|
|
|
620
620
|
## Changelog
|
|
621
621
|
|
|
@@ -626,7 +626,7 @@ External calls, events produced/consumed.
|
|
|
626
626
|
|
|
627
627
|
### Path B — FE/App client technical design (`active_tech_design = fe`)
|
|
628
628
|
|
|
629
|
-
|
|
629
|
+
Ghi `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{platform}.md`. Layer tích hợp §4 map **trực tiếp lên BE contract** đã nạp ở Step 0.5 — mỗi FE service method phải trace tới một endpoint có thật trong `{be_contract_path}` (không bịa endpoint). State và error model ở §3/§7 dẫn xuất từ mệnh đề `Then` của **System BDD**.
|
|
630
630
|
|
|
631
631
|
```markdown
|
|
632
632
|
# FE Technical Design — {UC-ID} ({platform}): {Feature}
|
|
@@ -635,12 +635,12 @@ Write `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{UC-ID}-tech-design-{
|
|
|
635
635
|
@trace.id: {UC-ID}
|
|
636
636
|
@trace.domain: {domain}
|
|
637
637
|
@trace.platform: {web | app}
|
|
638
|
-
@trace.service: {
|
|
639
|
-
@trace.module: {
|
|
638
|
+
@trace.service: {đọc @trace.service từ header file .feature}
|
|
639
|
+
@trace.module: {đọc @trace.module — vd react / nextjs / vue / angular / flutter}
|
|
640
640
|
@trace.prd: {TICKET-ID}
|
|
641
|
-
@trace.bdd_version: {
|
|
641
|
+
@trace.bdd_version: {đọc @trace.bdd_version từ header file .feature FE}
|
|
642
642
|
@trace.system_bdd: {system_bdd_path}
|
|
643
|
-
@trace.be_contract: {UC-ID}-tech-design.md #
|
|
643
|
+
@trace.be_contract: {UC-ID}-tech-design.md # BE API contract mà design này tiêu thụ
|
|
644
644
|
@trace.testid_attr: {data-testid (web) | testID (react-native) | Key/Semantics (flutter) | accessibilityIdentifier (native-ios)}
|
|
645
645
|
@trace.revision: 1
|
|
646
646
|
@trace.status: draft
|
|
@@ -708,8 +708,8 @@ Query keys, cache invalidation triggers, optimistic updates, refetch policy (cli
|
|
|
708
708
|
|
|
709
709
|
Auth token injection/refresh, i18n keys, feature flags, analytics events.
|
|
710
710
|
|
|
711
|
-
{## §9. Offline / Platform Specifics — app
|
|
712
|
-
{
|
|
711
|
+
{## §9. Offline / Platform Specifics — chỉ app}
|
|
712
|
+
{Hành vi cached-data, banner offline, background sync, platform permission.}
|
|
713
713
|
|
|
714
714
|
## Changelog
|
|
715
715
|
|
|
@@ -718,55 +718,55 @@ Auth token injection/refresh, i18n keys, feature flags, analytics events.
|
|
|
718
718
|
| 1 | {YYYY-MM-DD} | Initial FE design from {UC-ID} ({platform}) BDD v{bdd_version}, mapping BE contract {UC-ID}-tech-design.md |
|
|
719
719
|
```
|
|
720
720
|
|
|
721
|
-
## Publish —
|
|
721
|
+
## Publish — chia sẻ doc (umbrella + spec repo dùng chung)
|
|
722
722
|
|
|
723
|
-
|
|
723
|
+
Nếu `paths.tech_docs_dir` phân giải **dưới `setup.spec_source`** (vd `{spec_source}/specs/{domain}/{prd-slug}/tech-docs`), doc vừa được ghi **bên trong spec submodule**. Publish nó (commit 2 tầng) để cả team đọc qua `/sync` — doc BE là **API contract** liên team; doc FE là **client design** mà các FE/App dev khác (và reviewer) tiêu thụ:
|
|
724
724
|
|
|
725
725
|
```bash
|
|
726
726
|
cd {spec_source}
|
|
727
727
|
git add {tech_design_path} # be: {UC-ID}-tech-design.md · fe: {UC-ID}-tech-design-{platform}.md
|
|
728
728
|
git commit -m "docs({UC-ID}): {be: tech design / API contract | fe: FE tech design ({platform})}"
|
|
729
|
-
git push origin {spec_branch} #
|
|
729
|
+
git push origin {spec_branch} # branch mà đồng đội track trong .gitmodules
|
|
730
730
|
cd -
|
|
731
731
|
git add {spec_source} && git commit -m "chore: bump spec pointer ({UC-ID} {be|fe} tech design)"
|
|
732
732
|
```
|
|
733
733
|
|
|
734
|
-
|
|
734
|
+
Nếu `tech_docs_dir` là **local** — tức không có `setup.spec_source` (single-repo, hoặc repo BE đa-service thuần không có spec module dùng chung) — bỏ qua bước này; không cần publish liên-repo. Khi nào `spec_source` được set, tech-docs route vào spec submodule và bước publish này áp dụng.
|
|
735
735
|
|
|
736
736
|
## Output
|
|
737
737
|
|
|
738
|
-
# Report Footer —
|
|
738
|
+
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
739
739
|
|
|
740
|
-
|
|
740
|
+
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
741
741
|
|
|
742
742
|
## Status Badge
|
|
743
743
|
|
|
744
|
-
|
|
745
|
-
- `✅ Complete` —
|
|
746
|
-
- `❌ Failed` —
|
|
747
|
-
- `⚠️ Warnings` —
|
|
744
|
+
Chọn một theo kết quả:
|
|
745
|
+
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
746
|
+
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
747
|
+
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
748
748
|
|
|
749
749
|
## Output Artifacts
|
|
750
750
|
|
|
751
|
-
|
|
751
|
+
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
752
752
|
```
|
|
753
753
|
Output Artifacts:
|
|
754
|
-
{created|updated} {file-path} ({
|
|
755
|
-
{created|updated} {file-path} ({
|
|
754
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
755
|
+
{created|updated} {file-path} ({mô tả ngắn})
|
|
756
756
|
```
|
|
757
757
|
|
|
758
|
-
|
|
758
|
+
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
759
759
|
|
|
760
760
|
## Pipeline Position
|
|
761
761
|
|
|
762
|
-
|
|
763
|
-
|
|
762
|
+
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`,
|
|
763
|
+
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
764
764
|
|
|
765
765
|
```
|
|
766
766
|
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
767
767
|
```
|
|
768
768
|
|
|
769
|
-
|
|
769
|
+
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:
|
|
770
770
|
|
|
771
771
|
| Phase | Commands |
|
|
772
772
|
|-------|----------|
|
|
@@ -780,70 +780,70 @@ Find the current command in this phase legend and mark **its** phase in the map
|
|
|
780
780
|
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
781
781
|
| Trace Audit | `/validate-traces` |
|
|
782
782
|
|
|
783
|
-
|
|
783
|
+
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
784
784
|
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
785
785
|
|
|
786
|
-
**
|
|
787
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`)
|
|
788
|
-
**
|
|
786
|
+
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
787
|
+
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
788
|
+
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
789
789
|
|
|
790
|
-
##
|
|
790
|
+
## Gợi ý lệnh tiếp theo
|
|
791
791
|
|
|
792
|
-
|
|
792
|
+
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
793
793
|
|
|
794
|
-
|
|
|
794
|
+
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
795
795
|
|-------------------------|-----------------------------------------------|
|
|
796
|
-
| /setup-ai-first | `/define-product`
|
|
796
|
+
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
797
797
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
798
|
-
| /generate-prd | `/refine-prd {prd-file}`
|
|
799
|
-
| /refine-prd |
|
|
800
|
-
| /review-context (PRD) | FE/App: `/generate-design-spec {prd-file}` (
|
|
801
|
-
| /generate-design-spec | Designer review →
|
|
802
|
-
| /generate-bdd | `/review-context {feature-file}`
|
|
803
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}`
|
|
804
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (
|
|
798
|
+
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
799
|
+
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
800
|
+
| /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 |
|
|
801
|
+
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
802
|
+
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
803
|
+
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
804
|
+
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
805
805
|
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
806
|
-
| /qc-design-test | `/qc-review {UC-ID}` (test-case
|
|
807
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}`
|
|
808
|
-
| /qc-run-test | `/qc-report {UC-ID}`
|
|
809
|
-
| /qc-review (script) | `/qc-report {UC-ID}`
|
|
810
|
-
| /qc-report | `/validate-traces {UC-ID}`
|
|
806
|
+
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
807
|
+
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
808
|
+
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
809
|
+
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
810
|
+
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
811
811
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
812
|
-
| /review-tech-docs | `/generate-code {feature-file}`
|
|
813
|
-
| /generate-code |
|
|
812
|
+
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
813
|
+
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
814
814
|
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
815
815
|
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
816
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}`
|
|
817
|
-
| /review-code | `/dev-smoke-test {UC-ID}`
|
|
818
|
-
| /dev-smoke-test |
|
|
819
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`;
|
|
820
|
-
| /fix-bug |
|
|
821
|
-
| /debug | `/fix-bug {ticket-id}`
|
|
822
|
-
| /report-bug |
|
|
823
|
-
| /propose-scenario |
|
|
824
|
-
| /learn |
|
|
825
|
-
| /sync | `/validate-traces`
|
|
826
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync`
|
|
827
|
-
|
|
828
|
-
|
|
816
|
+
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
817
|
+
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
818
|
+
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
819
|
+
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}`; GAP → `/dev-gen-test {UC-ID}`; tất cả OK → tạo PR |
|
|
820
|
+
| /fix-bug | Tạo PR và link tới ticket |
|
|
821
|
+
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
822
|
+
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
823
|
+
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
824
|
+
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
825
|
+
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
826
|
+
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
827
|
+
|
|
828
|
+
Định dạng footer như sau:
|
|
829
829
|
```
|
|
830
830
|
---
|
|
831
831
|
Status : {badge}
|
|
832
|
-
{Output Artifacts
|
|
832
|
+
{khối Output Artifacts}
|
|
833
833
|
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
834
|
-
(review
|
|
835
|
-
Next : {
|
|
834
|
+
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
835
|
+
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
836
836
|
```
|
|
837
|
-
*(
|
|
837
|
+
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
838
838
|
|
|
839
839
|
|
|
840
840
|
```
|
|
841
|
-
/generate-tech-docs
|
|
841
|
+
/generate-tech-docs Hoàn tất — {UC-ID} ({active_tech_design: BE API contract | FE {platform} client design})
|
|
842
842
|
File: {tech_design_path}
|
|
843
843
|
Next: /review-tech-docs {tech_design_path}
|
|
844
|
-
← SA/Lead review
|
|
845
|
-
→
|
|
846
|
-
→
|
|
844
|
+
← cần SA/Lead review trước khi sinh code
|
|
845
|
+
→ nếu nó sống trong spec repo dùng chung: commit + push lên spec submodule (xem Publish ở trên) để đồng đội `/sync` đọc được
|
|
846
|
+
→ sau khi approved:
|
|
847
847
|
BE → /generate-code {system .feature}
|
|
848
|
-
FE → /generate-code {web|app .feature} --phase=integration (
|
|
848
|
+
FE → /generate-code {web|app .feature} --phase=integration (wire API thật theo §4 của doc này)
|
|
849
849
|
```
|