@educa-corp/sdd-framework 0.5.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/build.js +113 -19
- package/bin/gate-trace.js +487 -0
- package/bin/index.js +445 -146
- package/bin/lint-trace.js +643 -0
- package/bin/self-check.js +804 -2
- package/bin/trace-schema.json +621 -10
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/README.md +20 -0
- package/core/commands/amend-prd.md +518 -0
- package/core/commands/debug.md +123 -511
- package/core/commands/define-product.md +86 -510
- package/core/commands/dev-gen-test.md +86 -510
- package/core/commands/dev-run-test.md +133 -519
- package/core/commands/dev-smoke-test.md +86 -510
- package/core/commands/extend-prd.md +128 -522
- package/core/commands/fix-bug.md +118 -509
- package/core/commands/generate-architecture.md +94 -515
- package/core/commands/generate-bdd.md +128 -513
- package/core/commands/generate-code.md +119 -510
- package/core/commands/generate-design-spec.md +86 -510
- package/core/commands/generate-prd.md +89 -510
- package/core/commands/generate-spec-manifest.md +86 -510
- package/core/commands/generate-tech-docs.md +120 -512
- package/core/commands/learn.md +172 -496
- package/core/commands/map-testids.md +86 -510
- package/core/commands/propose-scenario.md +86 -510
- package/core/commands/qc-analyze.md +86 -510
- package/core/commands/qc-design-test.md +86 -510
- package/core/commands/qc-plan.md +86 -510
- package/core/commands/qc-report.md +86 -510
- package/core/commands/qc-review.md +86 -510
- package/core/commands/qc-run-test.md +115 -513
- package/core/commands/refine-prd.md +112 -522
- package/core/commands/report-bug.md +86 -510
- package/core/commands/review-code.md +123 -511
- package/core/commands/review-context.md +136 -522
- package/core/commands/review-tech-docs.md +90 -511
- package/core/commands/setup-ai-first.md +166 -138
- package/core/commands/sync.md +155 -107
- package/core/commands/update-framework.md +16 -103
- package/core/commands/validate-traces.md +426 -511
- package/core/hooks/data-guard.js +174 -83
- package/core/hooks/settings.json +2 -1
- package/core/rules/workflow.md +64 -4
- package/core/steps/capture-lesson.md +34 -1
- package/core/steps/context-loader.md +50 -8
- package/core/steps/gate.md +92 -35
- package/core/steps/report-footer.md +23 -0
- package/core/templates/README.md +24 -1
- package/core/templates/ci/trace-gate.yml +146 -0
- package/core/templates/feature.template +1 -1
- package/core/templates/hooks/pre-push +61 -0
- package/docs/02-concepts/architecture.md +61 -6
- package/docs/02-concepts/traceability.md +57 -0
- package/docs/03-guides/architect.md +63 -0
- package/docs/04-reference/commands.md +148 -134
- package/docs/04-reference/model-selection.md +32 -19
- package/docs/04-reference/trace-schema.md +39 -0
- package/docs/explain/02b-extend-prd.md +1 -1
- package/docs/explain/02c-amend-prd.md +152 -0
- package/docs/explain/21-validate-traces.md +2 -1
- package/docs/explain/27-learn.md +5 -3
- package/docs/explain/28-sync.md +25 -0
- package/docs/explain/README.md +136 -135
- package/package.json +5 -9
- package/commands/debug.md +0 -917
- package/commands/debug.tmpl +0 -257
- package/commands/define-product.md +0 -862
- package/commands/define-product.tmpl +0 -225
- package/commands/dev-gen-test.md +0 -1124
- package/commands/dev-gen-test.tmpl +0 -490
- package/commands/dev-run-test.md +0 -859
- package/commands/dev-run-test.tmpl +0 -225
- package/commands/dev-smoke-test.md +0 -798
- package/commands/dev-smoke-test.tmpl +0 -217
- package/commands/extend-prd.md +0 -907
- package/commands/extend-prd.tmpl +0 -270
- package/commands/fix-bug.md +0 -910
- package/commands/fix-bug.tmpl +0 -197
- package/commands/generate-architecture.md +0 -775
- package/commands/generate-architecture.tmpl +0 -194
- package/commands/generate-bdd.md +0 -1347
- package/commands/generate-bdd.tmpl +0 -590
- package/commands/generate-code.md +0 -1283
- package/commands/generate-code.tmpl +0 -649
- package/commands/generate-design-spec.md +0 -1161
- package/commands/generate-design-spec.tmpl +0 -524
- package/commands/generate-prd.md +0 -1143
- package/commands/generate-prd.tmpl +0 -223
- package/commands/generate-spec-manifest.md +0 -745
- package/commands/generate-spec-manifest.tmpl +0 -164
- package/commands/generate-tech-docs.md +0 -1344
- package/commands/generate-tech-docs.tmpl +0 -273
- package/commands/learn.md +0 -723
- package/commands/learn.tmpl +0 -63
- package/commands/map-testids.md +0 -662
- package/commands/map-testids.tmpl +0 -81
- package/commands/propose-scenario.md +0 -783
- package/commands/propose-scenario.tmpl +0 -202
- package/commands/qc-analyze.md +0 -693
- package/commands/qc-analyze.tmpl +0 -112
- package/commands/qc-design-test.md +0 -650
- package/commands/qc-design-test.tmpl +0 -69
- package/commands/qc-plan.md +0 -630
- package/commands/qc-plan.tmpl +0 -49
- package/commands/qc-report.md +0 -641
- package/commands/qc-report.tmpl +0 -60
- package/commands/qc-review.md +0 -634
- package/commands/qc-review.tmpl +0 -53
- package/commands/qc-run-test.md +0 -750
- package/commands/qc-run-test.tmpl +0 -116
- package/commands/refine-prd.md +0 -1074
- package/commands/refine-prd.tmpl +0 -278
- package/commands/report-bug.md +0 -729
- package/commands/report-bug.tmpl +0 -148
- package/commands/review-code.md +0 -803
- package/commands/review-code.tmpl +0 -143
- package/commands/review-context.md +0 -1323
- package/commands/review-context.tmpl +0 -527
- package/commands/review-tech-docs.md +0 -982
- package/commands/review-tech-docs.tmpl +0 -401
- package/commands/setup-ai-first.md +0 -574
- package/commands/setup-ai-first.tmpl +0 -378
- package/commands/sync.md +0 -486
- package/commands/sync.tmpl +0 -384
- package/commands/update-framework.md +0 -290
- package/commands/update-framework.tmpl +0 -188
- package/commands/validate-traces.md +0 -1435
- package/commands/validate-traces.tmpl +0 -854
- package/hooks/data-guard.js +0 -141
- package/hooks/settings.json +0 -18
- package/modules/android-compose/module.yaml +0 -13
- package/modules/android-compose/stack-profile.yaml +0 -57
- package/modules/angular/architecture-snippets/component-patterns.md +0 -187
- package/modules/angular/module.yaml +0 -6
- package/modules/angular/stack-profile.yaml +0 -38
- package/modules/context-engineering/architecture-snippets/context-design.md +0 -119
- package/modules/context-engineering/module.yaml +0 -9
- package/modules/context-engineering/stack-profile.yaml +0 -61
- package/modules/dotnet/architecture-snippets/clean-arch.md +0 -160
- package/modules/dotnet/module.yaml +0 -6
- package/modules/dotnet/stack-profile.yaml +0 -50
- package/modules/flutter/module.yaml +0 -14
- package/modules/flutter/stack-profile.yaml +0 -59
- package/modules/golang/architecture-snippets/domain-layout.md +0 -283
- package/modules/golang/module.yaml +0 -6
- package/modules/golang/stack-profile.yaml +0 -40
- package/modules/ios-swiftui/module.yaml +0 -13
- package/modules/ios-swiftui/stack-profile.yaml +0 -55
- package/modules/java-spring/architecture-snippets/layered-arch.md +0 -201
- package/modules/java-spring/module.yaml +0 -15
- package/modules/java-spring/stack-profile.yaml +0 -28
- package/modules/nextjs/architecture-snippets/app-router-patterns.md +0 -269
- package/modules/nextjs/module.yaml +0 -14
- package/modules/nextjs/stack-profile.yaml +0 -74
- package/modules/nuxt/module.yaml +0 -14
- package/modules/nuxt/stack-profile.yaml +0 -58
- package/modules/phaser-game/architecture-snippets/phaser-scene-patterns.md +0 -646
- package/modules/phaser-game/module.yaml +0 -15
- package/modules/phaser-game/stack-profile.yaml +0 -90
- package/modules/php-laravel/architecture-snippets/service-repository.md +0 -302
- package/modules/php-laravel/module.yaml +0 -15
- package/modules/php-laravel/stack-profile.yaml +0 -56
- package/modules/qc-playwright/stack-profile.yaml +0 -66
- package/modules/react/architecture-snippets/hooks-query-patterns.md +0 -254
- package/modules/react/module.yaml +0 -14
- package/modules/react/stack-profile.yaml +0 -63
- package/modules/react-native/module.yaml +0 -14
- package/modules/react-native/stack-profile.yaml +0 -56
- package/modules/vue/module.yaml +0 -14
- package/modules/vue/stack-profile.yaml +0 -65
- package/rules/data-protection.md +0 -80
- package/rules/workflow.md +0 -73
- package/scripts/init.sh +0 -49
- package/scripts/upgrade.sh +0 -94
- package/skills/code/SKILL.md +0 -19
- package/skills/code/SKILL.tmpl +0 -19
- package/skills/debug/SKILL.md +0 -19
- package/skills/debug/SKILL.tmpl +0 -19
- package/skills/design-spec/SKILL.md +0 -11
- package/skills/design-spec/SKILL.tmpl +0 -11
- package/skills/discovery/SKILL.md +0 -14
- package/skills/discovery/SKILL.tmpl +0 -14
- package/skills/prd/SKILL.md +0 -19
- package/skills/prd/SKILL.tmpl +0 -19
- package/skills/qc/qa-analyst/DOC_GAPS.template.md +0 -63
- package/skills/qc/qa-analyst/acceptance-criteria.md +0 -60
- package/skills/qc/qa-analyst/business-rules.md +0 -59
- package/skills/qc/qa-analyst/data-flow.md +0 -64
- package/skills/qc/qa-analyst/spec-breakdown.md +0 -61
- package/skills/qc/qa-designer/e2e/journey.md +0 -41
- package/skills/qc/qa-designer/exploratory/charter.md +0 -68
- package/skills/qc/qa-designer/exploratory/explore-to-functional.md +0 -43
- package/skills/qc/qa-designer/functional/api.md +0 -45
- package/skills/qc/qa-designer/functional/gui-feature.md +0 -46
- package/skills/qc/qa-designer/functional/gui-screen.md +0 -52
- package/skills/qc/qa-designer/integration/api.md +0 -42
- package/skills/qc/qa-designer/integration/db.md +0 -39
- package/skills/qc/qa-designer/integration/gui.md +0 -40
- package/skills/qc/qa-designer/integration/kafka.md +0 -40
- package/skills/qc/qa-designer/non-functional.md +0 -40
- package/skills/qc/qa-planner/test-plan.md +0 -120
- package/skills/qc/qa-reviewer/script/e2e.md +0 -87
- package/skills/qc/qa-reviewer/script/exploratory.md +0 -45
- package/skills/qc/qa-reviewer/script/functional.md +0 -101
- package/skills/qc/qa-reviewer/script/integration.md +0 -91
- package/skills/qc/qa-reviewer/script/non-functional.md +0 -126
- package/skills/qc/qa-reviewer/test-case/e2e.md +0 -73
- package/skills/qc/qa-reviewer/test-case/exploratory.md +0 -43
- package/skills/qc/qa-reviewer/test-case/functional.md +0 -76
- package/skills/qc/qa-reviewer/test-case/integration.md +0 -69
- package/skills/qc/qa-reviewer/test-case/non-functional.md +0 -73
- package/skills/qc/qa-runner/e2e.md +0 -49
- package/skills/qc/qa-runner/exploratory/session.md +0 -36
- package/skills/qc/qa-runner/functional/api.md +0 -35
- package/skills/qc/qa-runner/functional/gui-feature.md +0 -51
- package/skills/qc/qa-runner/functional/gui-screen.md +0 -55
- package/skills/qc/qa-runner/integration.md +0 -47
- package/skills/qc/qa-runner/non-functional.md +0 -49
- package/skills/qc/qa-runner/report/report.md +0 -37
- package/skills/setup-ai-first/SKILL.md +0 -19
- package/skills/setup-ai-first/SKILL.tmpl +0 -19
- package/skills/spec/SKILL.md +0 -19
- package/skills/spec/SKILL.tmpl +0 -19
- package/skills/test/SKILL.md +0 -18
- package/skills/test/SKILL.tmpl +0 -18
- package/steps/business-language.md +0 -56
- package/steps/capture-lesson.md +0 -79
- package/steps/context-loader.md +0 -385
- package/steps/gate.md +0 -94
- package/steps/report-footer.md +0 -102
- package/steps/review-fanout.md +0 -159
- package/steps/spawn-agent.md +0 -129
- package/steps/trace-mirror.md +0 -53
- package/templates/README.md +0 -47
- package/templates/architecture.template.md +0 -394
- package/templates/design-spec.template.md +0 -217
- package/templates/feature.template +0 -123
- package/templates/platform-guide.template.md +0 -145
- package/templates/prd.template.md +0 -283
- package/templates/product-definition.template.md +0 -188
- package/templates/project-context.yaml +0 -212
- package/templates/tech-design.template.md +0 -490
|
@@ -1,1344 +0,0 @@
|
|
|
1
|
-
# /generate-tech-docs — Sinh Tài liệu Thiết kế Kỹ thuật (một doc gộp per-PRD)
|
|
2
|
-
|
|
3
|
-
> **Mô hình phạm vi:** MỘT tài liệu thiết kế kỹ thuật cho mỗi **PRD**, không phải
|
|
4
|
-
> per-UC — một blueprint **full-stack, gộp** (backend API/data/DB **và** client
|
|
5
|
-
> component/state/integration trong một file, nối bằng sequence diagram xuyên
|
|
6
|
-
> tầng) để bất kỳ dev nào đọc là implement được cả feature.
|
|
7
|
-
>
|
|
8
|
-
> **Tech lead trỏ lệnh vào (các) file BDD cụ thể cần thiết kế lúc này** — một file,
|
|
9
|
-
> hoặc một batch nhỏ (vd `system/` + `web/` + `app/` của cùng một UC). Lệnh chỉ nạp
|
|
10
|
-
> **đúng các file đó** (giữ context nhỏ) rồi ghi/mở rộng tài liệu tech-design duy
|
|
11
|
-
> nhất của PRD. Chạy lại cho (các) file BDD kế tiếp thì doc **lớn dần** — mỗi lần
|
|
12
|
-
> chạy là **append**, không bao giờ regenerate toàn bộ. Lệnh KHÔNG tự gom mọi BDD
|
|
13
|
-
> của PRD (sẽ nổ context).
|
|
14
|
-
|
|
15
|
-
## Gate
|
|
16
|
-
# Gate — Quy trình vào chuẩn cho mọi lệnh
|
|
17
|
-
|
|
18
|
-
Mọi lệnh PHẢI chạy gate này trước khi thực thi phần logic riêng của nó.
|
|
19
|
-
|
|
20
|
-
## Bước 0 — Kiểm tra chế độ Sub-Agent
|
|
21
|
-
|
|
22
|
-
Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ một orchestrator hay không:
|
|
23
|
-
|
|
24
|
-
1. Thử parse `$ARGUMENTS` dưới dạng JSON.
|
|
25
|
-
2. Nếu parse thành công **và** chứa `"_agent_mode": true`:
|
|
26
|
-
- **Bỏ qua hoàn toàn Bước 1, 2 và 3 của Gate này.**
|
|
27
|
-
- Đặt target file = `payload.target_file`
|
|
28
|
-
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
29
|
-
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
30
|
-
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
31
|
-
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
32
|
-
- Đi thẳng tới phần logic riêng của lệnh.
|
|
33
|
-
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
34
|
-
|
|
35
|
-
## Bước 0-B — Kiểm tra Model
|
|
36
|
-
|
|
37
|
-
*Bỏ qua bước này nếu `_agent_mode: true` (sub-agent — orchestrator đã kiểm tra rồi).*
|
|
38
|
-
|
|
39
|
-
Các lệnh sinh nội dung và review phức tạp đòi hỏi khả năng suy luận mạnh.
|
|
40
|
-
Dùng model nhỏ hơn sẽ rủi ro: bỏ sót edge case, phân tích spec thiếu sót, vi phạm kiến trúc.
|
|
41
|
-
|
|
42
|
-
Hiển thị và chờ phản hồi:
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
-
⚙️ MODEL CHECK
|
|
46
|
-
──────────────────────────────────────────────────────────────────
|
|
47
|
-
Recommended : model Opus mới nhất
|
|
48
|
-
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
49
|
-
suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
|
|
50
|
-
|
|
51
|
-
Cách đổi trong Claude Code:
|
|
52
|
-
• /model → chọn model Opus
|
|
53
|
-
• hoặc: Settings → Model
|
|
54
|
-
|
|
55
|
-
Đang chạy một model Opus?
|
|
56
|
-
Y — đúng → tiếp tục
|
|
57
|
-
S — bỏ qua kiểm tra (tôi chấp nhận rủi ro chất lượng thấp hơn với model hiện tại)
|
|
58
|
-
──────────────────────────────────────────────────────────────────
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
- "Y" → tiếp tục sang Bước 1.
|
|
62
|
-
- "S" → tiếp tục sang Bước 1 (người dùng chấp nhận rủi ro, thêm ⚠️ vào report cuối).
|
|
63
|
-
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang một model Opus (`/model`) rồi chạy lại lệnh này."
|
|
64
|
-
|
|
65
|
-
## Bước 1 — Xác định Target File
|
|
66
|
-
|
|
67
|
-
0. **Tách cờ trước khi resolve target.** `$ARGUMENTS` có thể lẫn các `--flag` (vd `--phase=integration`, `--comment`, `--fix`). **Loại bỏ mọi token bắt đầu bằng `--`** ra khỏi phần dùng để tìm target — chỉ giữ phần path/UC-ID/ticket. (Các flag đó do phần logic riêng của lệnh parse ở bước sau, KHÔNG phải tên file.)
|
|
68
|
-
1. Nếu `$ARGUMENTS` (đã tách cờ) được cung cấp và trỏ tới một file tồn tại → dùng trực tiếp làm target.
|
|
69
|
-
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/`):
|
|
70
|
-
- **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 đó.
|
|
71
|
-
- **Lệnh PRD** (target là file PRD `{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder, cạnh `bdd/`): `{specs_dir}/{domain}/*/{TICKET-ID}*.md` nếu biết TICKET-ID; nếu không, `{specs_dir}/{domain}/*/*.md` (khớp feature folder có id tương ứng), hoặc `{specs_dir}/*/*/*.md` nếu domain cũng chưa biết. *(Glob `*/*.md` ở cấp gốc folder chỉ khớp PRD — tech-docs/design-spec `.md` nằm sâu hơn trong thư mục con.)*
|
|
72
|
-
- **Lệnh tech-docs** — target là tech-doc **gộp cấp PRD** `{TICKET-ID}-tech-design.md` (MỘT doc phủ nhiều UC; danh sách UC nằm ở `@trace.ucs`). Vì tên file mang `{TICKET-ID}` chứ **không** mang `{UC-ID}`, phải tách trước khi glob:
|
|
73
|
-
- `$ARGUMENTS` là **UC-ID** (`{TICKET-ID}-UC{N}`) → lấy `{TICKET-ID}` = phần **trước** `-UC`, rồi glob `{specs_dir}/{domain}/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
74
|
-
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
75
|
-
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
76
|
-
- Vẫn không khớp → glob rộng `{specs_dir}/*/*/tech-docs/*tech-design*.md` rồi liệt kê để người dùng chọn.
|
|
77
|
-
*(Đừng glob `{UC-ID}*-tech-design*.md` — nó nở thành `FT-001-UC1*-tech-design*.md` và **không bao giờ** khớp `FT-001-tech-design.md`.)*
|
|
78
|
-
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
79
|
-
|
|
80
|
-
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.
|
|
81
|
-
3. Nếu `$ARGUMENTS` rỗng hoặc không tìm thấy file khớp:
|
|
82
|
-
- Liệt kê các file trong thư mục liên quan của lệnh này (vd: `specs/*/*/*.md` — file PRD ở gốc mỗi feature folder — cho lệnh PRD, `specs/*/*/bdd/**/*.feature` cho lệnh BDD).
|
|
83
|
-
- 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)"
|
|
84
|
-
- Chờ người dùng chọn rồi mới tiếp tục.
|
|
85
|
-
|
|
86
|
-
## Bước 2 — Chạy Context Loader
|
|
87
|
-
|
|
88
|
-
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`.
|
|
89
|
-
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.
|
|
90
|
-
|
|
91
|
-
## Bước 3 — CHECKPOINT
|
|
92
|
-
|
|
93
|
-
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:
|
|
94
|
-
|
|
95
|
-
```
|
|
96
|
-
CHECKPOINT
|
|
97
|
-
-----------
|
|
98
|
-
Target : {resolved file path}
|
|
99
|
-
Project : {project.name từ project-context.yaml}
|
|
100
|
-
Tech stack : {language} / {framework}
|
|
101
|
-
Module : {module nếu có, else "not configured"}
|
|
102
|
-
Domains : {danh sách domain, ngăn cách bởi dấu phẩy}
|
|
103
|
-
|
|
104
|
-
Tiếp tục? (Y/N)
|
|
105
|
-
```
|
|
106
|
-
|
|
107
|
-
Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp tục.
|
|
108
|
-
- "Y" → tiếp tục sang các bước riêng của lệnh bên dưới.
|
|
109
|
-
- "N" → dừng lại và hỏi người dùng muốn thay đổi gì.
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
*Với lệnh này, `$ARGUMENTS` là **input BDD tech lead chọn tường minh** — một hay nhiều path `.feature` và/hoặc UC-id (cách nhau bằng khoảng trắng), KHÔNG phải cả PRD để glob. Phân giải mỗi tham số thành một `.feature` (Gate Bước 1: `{paths.specs_dir}/{domain}/*/bdd/**/{UC-ID}*.feature`), gom vào `input_features` (batch), và suy `{domain}` + `{prd-slug}` + `{TICKET-ID}` từ (các) path khớp — tất cả PHẢI cùng một PRD. Output là doc gộp **duy nhất** của PRD; lần chạy này chỉ thiết kế (các) UC có trong `input_features`.*
|
|
113
|
-
|
|
114
|
-
## Context
|
|
115
|
-
# Context Loader — Nạp toàn bộ context dự án
|
|
116
|
-
|
|
117
|
-
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.
|
|
118
|
-
|
|
119
|
-
**Hướng dẫn ưu tiên (chống lost-in-middle):**
|
|
120
|
-
- Bước 1–2 là PROJECT-CONFIG — nạp trước, phân giải mọi path và metadata.
|
|
121
|
-
- 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.
|
|
122
|
-
- Bước 4 là SAFETY — quy tắc bảo vệ dữ liệu, thực thi ngầm suốt cả phiên.
|
|
123
|
-
- Bước 5–6 là DOMAIN KNOWLEDGE — thuật ngữ và định nghĩa entity.
|
|
124
|
-
- 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.
|
|
125
|
-
|
|
126
|
-
---
|
|
127
|
-
|
|
128
|
-
## Bước 1 — [PROJECT-CONFIG] Nạp project-context.yaml
|
|
129
|
-
|
|
130
|
-
Đọc `.agent/project-context.yaml`. Trích xuất và lưu:
|
|
131
|
-
|
|
132
|
-
**Tech Stack:**
|
|
133
|
-
- `tech_stack.language` → ngôn ngữ đang dùng (vd: Java 17, TypeScript, C#, Go)
|
|
134
|
-
- `tech_stack.framework` → framework đang dùng (vd: Spring Boot 3.2, Angular 17, .NET 8)
|
|
135
|
-
- `tech_stack.build_tool` → build tool (vd: Maven, npm, dotnet, go)
|
|
136
|
-
- `tech_stack.test_framework` → test framework (vd: JUnit 5 + Mockito, Jest, xUnit)
|
|
137
|
-
- `tech_stack.database` → database (vd: PostgreSQL, MySQL, MongoDB)
|
|
138
|
-
- `tech_stack.module` → module profile đang dùng (vd: java-spring, angular, dotnet, golang, context-engineering)
|
|
139
|
-
|
|
140
|
-
**Conventions:**
|
|
141
|
-
- `conventions.build_command` → cách compile/build
|
|
142
|
-
- `conventions.test_command` → cách chạy test
|
|
143
|
-
- `conventions.service_run` → cách khởi động service
|
|
144
|
-
- `conventions.ticket_prefix` → tiền tố ticket ID (vd: PROJ, FEAT, UC)
|
|
145
|
-
|
|
146
|
-
**Domains:**
|
|
147
|
-
- `domains` → danh sách các business domain đang hoạt động
|
|
148
|
-
|
|
149
|
-
**Paths (nếu có):**
|
|
150
|
-
- `paths.specs_dir` → gốc của spec artifact — PRD, BDD, tech-docs, design-spec. Cấu trúc: `{specs_dir}/{domain}/{prd-slug}/{ {TICKET-ID}-{prd-slug}.md | bdd/ | tech-docs/ | design-spec/}` (file PRD đặt tên `{TICKET-ID}-{prd-slug}.md`, là file `.md` duy nhất ở gốc feature folder)
|
|
151
|
-
- `paths.refinement_dir` → thư mục output cho findings/review
|
|
152
|
-
- `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}/`)
|
|
153
|
-
- `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 đè)
|
|
154
|
-
- `paths.product_definitions_dir` → gốc product definition
|
|
155
|
-
- `paths.domain_knowledge_dir` → gốc domain knowledge
|
|
156
|
-
- `paths.business_dictionary` → path tới business-dictionary.md
|
|
157
|
-
- `paths.core_entities` → path tới core-entities.md
|
|
158
|
-
- `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/`)
|
|
159
|
-
- `paths.src_dir` → gốc mã nguồn (nơi generate-code đặt & quét code; nguồn chính cho FE + phạm vi reuse-scan của DS5)
|
|
160
|
-
- `paths.trace_dir` → thư mục trạng thái trace; cấu trúc: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` (mỗi UC × platform một sổ)
|
|
161
|
-
|
|
162
|
-
Nếu không có section `paths`, dùng các giá trị mặc định:
|
|
163
|
-
- `specs_dir` = `specs`
|
|
164
|
-
- `refinement_dir` = `.agent/review`
|
|
165
|
-
- `qc_dir` = `docs`
|
|
166
|
-
- `qc_skills_dir` = `.agent/skills/qc`
|
|
167
|
-
- `product_definitions_dir` = `specs/product-definition`
|
|
168
|
-
- `domain_knowledge_dir` = `specs/domain-knowledge`
|
|
169
|
-
- `business_dictionary` = `specs/domain-knowledge/business-dictionary.md`
|
|
170
|
-
- `core_entities` = `specs/domain-knowledge/core-entities.md`
|
|
171
|
-
- `tech_docs_dir` = `specs`
|
|
172
|
-
- `src_dir` = `src`
|
|
173
|
-
- `trace_dir` = `.trace`
|
|
174
|
-
|
|
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
|
-
|
|
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
|
-
- `specs/payment/create-invoice/PAY01-create-invoice.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/PAY01-tech-design.md` → `prd_slug = create-invoice` *(KHÔNG phải `tech-docs`)*
|
|
182
|
-
- `specs/payment/create-invoice/design-spec/PAY-design-spec-web.md` → `prd_slug = create-invoice`
|
|
183
|
-
|
|
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
|
-
|
|
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
|
-
|
|
188
|
-
---
|
|
189
|
-
|
|
190
|
-
## Bước 1.5 — [SERVICE ROUTING] Phân giải path service (chế độ umbrella)
|
|
191
|
-
|
|
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
|
-
|
|
194
|
-
Nếu có section `services`:
|
|
195
|
-
|
|
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/USR01-create-account.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
|
-
|
|
202
|
-
**1b. Phát hiện active platform** (chỉ cần khi service ở dạng map-theo-platform — bước 2b):
|
|
203
|
-
- Đọc `@trace.platform` từ header của target `.feature` (`system` | `web` | `app`) — Gate đã resolve target trước bước này.
|
|
204
|
-
- Nếu target không mang `@trace.platform` (vd target là PRD `.md`), thử suy từ segment `bdd/{platform}/` trong path target.
|
|
205
|
-
- Nếu vẫn không xác định được → `active_platform = null`.
|
|
206
|
-
|
|
207
|
-
**2. Route tới service** — nếu active domain khớp một key trong `services`.
|
|
208
|
-
|
|
209
|
-
Hình dung việc này như **tra địa chỉ**: đi từ `domain`, có thể qua `platform`, có thể qua `prd_slug`, cho tới khi chỉ còn đúng một submodule.
|
|
210
|
-
|
|
211
|
-
Thứ trỏ tới đích gọi là một **service entry**. Nó chỉ có hai kiểu:
|
|
212
|
-
|
|
213
|
-
| Kiểu | Nhận ra bằng | Nghĩa |
|
|
214
|
-
|---|---|---|
|
|
215
|
-
| **Đã chốt** | có `path` | Xong — đây là submodule cần tìm |
|
|
216
|
-
| **Tra tiếp** | có `by_prd_slug` | Ô này còn nhiều submodule → tra thêm một nấc bằng `prd_slug` (2c) |
|
|
217
|
-
|
|
218
|
-
**Kiểm tra hợp lệ TRƯỚC khi dùng một entry** (làm ngay, đừng đợi tới 2a/2b/2c — sai ở đây mà đi tiếp là route nhầm repo mà không báo gì):
|
|
219
|
-
|
|
220
|
-
| Entry trông thế nào | Xử lý |
|
|
221
|
-
|---|---|
|
|
222
|
-
| có `path`, không có `by_prd_slug` | hợp lệ → dùng |
|
|
223
|
-
| có `by_prd_slug`, không có `path` | hợp lệ → tra tiếp (2c) |
|
|
224
|
-
| **có CẢ HAI** | ❌ lỗi cấu hình → `active_service = unresolved`. **KHÔNG** ưu tiên `path` rồi bỏ qua `by_prd_slug` — như vậy mọi feature sẽ âm thầm route về cùng một repo. Báo đúng key sai để người dùng sửa. |
|
|
225
|
-
| **không có cái nào** (và cũng không phải map platform) | ❌ lỗi cấu hình → `unresolved`, nêu rõ entry thiếu `path`/`by_prd_slug` |
|
|
226
|
-
| `by_prd_slug` chứa entry lại có `by_prd_slug` | ❌ lỗi cấu hình → `unresolved`. Chỉ tra đúng **một** nấc slug, không đệ quy |
|
|
227
|
-
|
|
228
|
-
Còn `services.{domain}` thì có thể là **một service entry** (chốt luôn ở cấp domain), hoặc **một map platform → service entry** (phải qua nấc platform trước). Nhận dạng theo đúng thứ tự này:
|
|
229
|
-
|
|
230
|
-
| Thấy gì trong `services.{domain}` | Đi nhánh |
|
|
231
|
-
|---|---|
|
|
232
|
-
| có `path` | **2a** — chốt luôn |
|
|
233
|
-
| có `by_prd_slug` | **2c** — tra bằng `prd_slug` |
|
|
234
|
-
| không có cả hai (chỉ có các sub-key `system`/`web`/`app`…) | **2b** — tra bằng `platform`, rồi lặp lại đúng bảng này cho entry con |
|
|
235
|
-
|
|
236
|
-
**2a. Dạng phẳng** — `services.{domain}` có **trực tiếp** `path`/`module` (một domain ↔ một service, mọi platform về cùng submodule). Route như cũ:
|
|
237
|
-
- Lưu `active_service` = `services.{domain}.path`
|
|
238
|
-
- Lưu `active_service_module` = `services.{domain}.module`
|
|
239
|
-
- Nếu service có `module` riêng → dùng nó làm `active_module` (override `tech_stack.module`)
|
|
240
|
-
|
|
241
|
-
**2b. Dạng map-theo-platform** — `services.{domain}` **KHÔNG** có `path` trực tiếp mà chứa các sub-key platform (`system` / `web` / `app`), mỗi cái là một **service entry** (một business-domain trải trên nhiều platform/submodule). Route theo `active_platform` (bước 1b):
|
|
242
|
-
- Nếu `active_platform` khớp một sub-key → `entry = services.{domain}.{active_platform}`. Nếu `entry` có `path` → lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`). Nếu `entry` có `by_prd_slug` → **đi tiếp sang 2c** với entry đó.
|
|
243
|
-
- Nếu `active_platform = null` (chưa xác định platform, vd đang thao tác cấp PRD) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = platform`, và lưu `service_candidates` = map platform→`{path, module}`. **Làm phẳng luôn ở đây:** platform nào có entry `by_prd_slug` thì giải bằng `prd_slug` hiện tại (target cấp PRD vẫn nằm trong một feature-package nên `prd_slug` đã biết từ bước 1) → `service_candidates.{platform}` vẫn là `{path, module}` phẳng. Nếu `prd_slug` không khớp key nào, ghi platform đó là `unresolved` kèm lý do thay vì bỏ im. Nhờ vậy **mọi lệnh downstream chỉ cần biết một kiểu `service_candidates`**. Lệnh cần một service cụ thể (`/generate-code`, `/dev-*`, `/fix-bug`) luôn chạy trên target `.feature` có platform nên sẽ resolve được ở lần chạy đó; lệnh cấp PRD (`/generate-prd`, `/refine-prd`) không cần service cụ thể.
|
|
244
|
-
- Nếu `active_platform` xác định nhưng không có sub-key tương ứng → `active_service = unresolved` (xem Fallback) với lý do "domain `{domain}` chưa cấu hình platform `{active_platform}`".
|
|
245
|
-
|
|
246
|
-
**2c. Dạng map-theo-prd_slug** — một service entry chứa `by_prd_slug` thay cho `path`: **một ô của bảng định tuyến ứng với NHIỀU submodule**, mỗi feature-package một submodule. Dùng khi một platform (hoặc cả một domain) bị chia thành nhiều repo theo feature — ví dụ mỗi mini-game webview là một repo riêng.
|
|
247
|
-
|
|
248
|
-
Đến đây `prd_slug` đã được trích ở bước 1 (không cần detect thêm gì). Route:
|
|
249
|
-
|
|
250
|
-
- Nếu `prd_slug` khớp một key dưới `by_prd_slug` → `entry = {…}.by_prd_slug.{prd_slug}`; lưu `active_service = entry.path`, `active_service_module = entry.module` (→ `active_module`, override `tech_stack.module`).
|
|
251
|
-
**"Khớp" ở đây là khớp CHÍNH XÁC toàn chuỗi, phân biệt hoa/thường.** KHÔNG prefix, KHÔNG bỏ hậu tố, KHÔNG so gần đúng: `dap-chuot-v2` **không** khớp key `dap-chuot`; `Ban-Cung` **không** khớp `ban-cung`. Feature mới tách ra từ một feature cũ là một repo khác cho tới khi có người khai nó vào bảng.
|
|
252
|
-
- Nếu `prd_slug = null` (chưa xác định feature-package — chỉ xảy ra khi không có target file, vd `$ARGUMENTS` rỗng) → **KHÔNG** chốt một service; đặt `active_service = multi`, `service_candidates_kind = prd_slug`, và lưu `service_candidates` = toàn map `by_prd_slug` (slug → `{path, module}`).
|
|
253
|
-
⚠️ Đây là kiểu `service_candidates` **khác** với 2b — lệnh nào duyệt `service_candidates` theo platform (vd `/generate-bdd` sinh `bdd/{platform}/`) phải kiểm `service_candidates_kind = platform` trước; gặp `prd_slug` thì DỪNG và yêu cầu người dùng chỉ rõ target, đừng coi slug là platform.
|
|
254
|
-
- Nếu `prd_slug` xác định nhưng **không** có key tương ứng → `active_service = unresolved` với lý do rõ: "domain `{domain}`{, platform `{active_platform}`} chưa cấu hình prd_slug `{prd_slug}`". **KHÔNG** tự đoán submodule gần đúng theo tên.
|
|
255
|
-
|
|
256
|
-
Vị trí đặt `by_prd_slug` — hợp lệ ở **cả hai cấp**:
|
|
257
|
-
- **Dưới một platform** (lồng trong 2b): `services.{domain}.{platform}.by_prd_slug` — platform đó có nhiều repo, các platform khác vẫn `{path, module}` như thường.
|
|
258
|
-
- **Ngay dưới domain** (thay cho `path` của 2a): `services.{domain}.by_prd_slug` — domain không chia platform nhưng vẫn nhiều repo theo feature.
|
|
259
|
-
|
|
260
|
-
*(`by_prd_slug` lồng trong `by_prd_slug` là vô nghĩa — nếu gặp, coi là lỗi cấu hình: `active_service = unresolved`, nêu rõ để người dùng sửa file. Một entry vừa có `path` vừa có `by_prd_slug` cũng là lỗi cấu hình — báo lỗi, không âm thầm ưu tiên cái nào.)*
|
|
261
|
-
|
|
262
|
-
Ví dụ (một domain trải nhiều platform, riêng `webview` chia theo feature):
|
|
263
|
-
```yaml
|
|
264
|
-
services:
|
|
265
|
-
learning:
|
|
266
|
-
system: { path: "backend", module: "java-spring" }
|
|
267
|
-
web: { path: "web-app", module: "nextjs" }
|
|
268
|
-
webview:
|
|
269
|
-
by_prd_slug:
|
|
270
|
-
dap-chuot: { path: "games/whac-a-mole", module: "phaser-game" }
|
|
271
|
-
ban-cung: { path: "games/archery", module: "phaser-game" }
|
|
272
|
-
```
|
|
273
|
-
→ target `specs/learning/dap-chuot/bdd/webview/UC1.feature` cho `domain = learning`,
|
|
274
|
-
`active_platform = webview`, `prd_slug = dap-chuot` → `active_service = games/whac-a-mole`.
|
|
275
|
-
|
|
276
|
-
*(Cả 2a/2b/2c: override `paths.specs_dir`/`paths.tech_docs_dir` per-service CHỈ khi `setup.spec_source` KHÔNG được đặt. Khi `spec_source` ĐƯỢC đặt, MỌI BDD/tech-doc là artifact liên team → để bước 4 route sang spec repo; KHÔNG pin per-service ở đây.)*
|
|
277
|
-
|
|
278
|
-
**3. Fallback**:
|
|
279
|
-
- Không phát hiện được domain, hoặc domain không khớp key nào trong `services` → giữ path mặc định từ Bước 1, đặt `active_service = unresolved`.
|
|
280
|
-
- Domain khớp một map-theo-platform (2b) nhưng `active_platform` xác định mà thiếu sub-key tương ứng → `active_service = unresolved`, ghi lý do rõ để lệnh DỪNG báo lỗi cấu hình (không tự đoán platform).
|
|
281
|
-
- Entry là map-theo-prd_slug (2c) nhưng `prd_slug` xác định mà thiếu key tương ứng → `active_service = unresolved`, ghi lý do rõ (không tự đoán submodule).
|
|
282
|
-
- Entry sai cấu trúc (vừa có `path` vừa có `by_prd_slug`, hoặc `by_prd_slug` lồng nhau) → `active_service = unresolved`, nêu đúng key sai để người dùng sửa `project-context.yaml`.
|
|
283
|
-
|
|
284
|
-
**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:`:
|
|
285
|
-
- 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`.)*
|
|
286
|
-
- 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.)*
|
|
287
|
-
- Override `paths.domain_knowledge_dir` → `{spec_source}/specs/domain-knowledge`
|
|
288
|
-
- Override `paths.business_dictionary` → `{spec_source}/specs/domain-knowledge/business-dictionary.md`
|
|
289
|
-
- Override `paths.core_entities` → `{spec_source}/specs/domain-knowledge/core-entities.md`
|
|
290
|
-
- Override `paths.bug_reports_dir` → `{spec_source}/feedback/bug-reports`
|
|
291
|
-
- Override `paths.bdd_proposals_dir` → `{spec_source}/feedback/bdd-proposals`
|
|
292
|
-
- Override `paths.prd_change_requests_dir` → `{spec_source}/feedback/prd-change-requests`
|
|
293
|
-
- 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}-{platform}.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`.)*
|
|
294
|
-
- Override `paths.refinement_dir` → `{spec_source}/.agent/review` — **luôn khi `spec_source` được đặt.** Findings review (`/refine-prd`, `/review-context`, `/review-tech-docs`) là artifact liên-team *về* tài liệu trong spec repo (PRD/BDD/tech-design) — thuộc cùng khu vực ghi với `.trace/` và `feedback/`. Các lệnh review chạy từ working dir của service (BE repo) nhưng **ghi findings vào `{spec_source}/.agent/review/`**, KHÔNG phải `.agent/review` của service repo. Bên trong flat, phân biệt bằng tên file đã prefix `{prd-slug}`/`{UC-ID}`/`{TICKET-ID}`. *(`.agent/review` theo service chỉ khi không có `spec_source`.)*
|
|
295
|
-
|
|
296
|
-
> **Vì sao đặt dưới `spec_source`:** PRD, BDD, tech-docs, design-spec, domain knowledge, feedback của tester, **trạng thái coverage `.trace/`**, **và findings review `.agent/review/`** đề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/`, `.agent/review/` và `feedback/` là khu vực **ghi** của dev/QC/reviewer 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.
|
|
297
|
-
|
|
298
|
-
---
|
|
299
|
-
|
|
300
|
-
## Bước 1.6 — [SERVICE CONVENTIONS] Nạp convention riêng của service (chế độ umbrella)
|
|
301
|
-
|
|
302
|
-
*Bỏ qua hoàn toàn bước này nếu `active_service` là `"unresolved"` hoặc `"multi"` (chưa chốt một service — dạng map-theo-platform ở cấp PRD) hoặc context ở chế độ single-service.*
|
|
303
|
-
|
|
304
|
-
Khi `active_service` đã được phân giải thành một path thật ở Bước 1.5 (vd: `user-service/`):
|
|
305
|
-
|
|
306
|
-
**1. Định vị config của service** — thử theo thứ tự ưu tiên:
|
|
307
|
-
- `{active_service}/.agent/project-context.yaml`
|
|
308
|
-
- `{active_service}/project-context.yaml`
|
|
309
|
-
|
|
310
|
-
**2. Nếu tìm thấy, override bằng giá trị riêng của service:**
|
|
311
|
-
|
|
312
|
-
| Biến | Nguồn |
|
|
313
|
-
|----------|--------|
|
|
314
|
-
| `conventions.test_command` | `conventions.test_command` của service |
|
|
315
|
-
| `conventions.build_command` | `conventions.build_command` của service |
|
|
316
|
-
| `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`). |
|
|
317
|
-
| `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. |
|
|
318
|
-
| `paths.refinement_dir` | **Nếu `spec_source` được đặt → giữ route spec-repo của bước 4 (`{spec_source}/.agent/review`); bỏ qua mọi `refinement_dir` cấp service** (findings review là artifact liên team). Chỉ khi không có `spec_source`: `{active_service}/.agent/review`. |
|
|
319
|
-
|
|
320
|
-
**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:
|
|
321
|
-
- Các lệnh shell (`/dev-run-test`, `/dev-gen-test`) chạy **bên trong** `service_root`
|
|
322
|
-
- **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/`).
|
|
323
|
-
|
|
324
|
-
**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).
|
|
325
|
-
|
|
326
|
-
---
|
|
327
|
-
|
|
328
|
-
## Bước 2 — [PROJECT-CONFIG] Nạp module stack profile (có điều kiện)
|
|
329
|
-
|
|
330
|
-
Nếu `tech_stack.module` được đặt, đọc `.agent/modules/{module}/stack-profile.yaml`.
|
|
331
|
-
Merge các convention riêng của framework (layer pattern, test pattern, quy tắc đặt tên) vào context đã nạp.
|
|
332
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
333
|
-
|
|
334
|
-
---
|
|
335
|
-
|
|
336
|
-
## Bước 3 — [CRITICAL] Nạp CLAUDE.md (phân tầng: root + service overlay)
|
|
337
|
-
|
|
338
|
-
*Đâ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.*
|
|
339
|
-
|
|
340
|
-
CLAUDE.md được nạp theo **hai tầng** để các quy tắc toàn-umbrella và kiến trúc/coding standards
|
|
341
|
-
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
|
|
342
|
-
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
|
|
343
|
-
service phải thắng khi sinh code.
|
|
344
|
-
|
|
345
|
-
**Tầng 1 — [BASE] Root CLAUDE.md (toàn umbrella).**
|
|
346
|
-
Đọc `CLAUDE.md` ở gốc repo. Coi nội dung của nó là **nền tảng dùng chung** cho cả umbrella —
|
|
347
|
-
git convention, tư thế bảo vệ dữ liệu, quy tắc xuyên suốt, và (ở chế độ single-service) là
|
|
348
|
-
kiến trúc + coding standards duy nhất của dự án.
|
|
349
|
-
|
|
350
|
-
**Tầng 2 — [OVERLAY] Service CLAUDE.md (chỉ chế độ umbrella).**
|
|
351
|
-
*Chỉ chạy nếu `service_root` đã được set ở Bước 1.6 (tức đã route tới một service thật).*
|
|
352
|
-
Đọc `{service_root}/CLAUDE.md`. File này định nghĩa kiến trúc + coding standards của **stack
|
|
353
|
-
thực sự đang được triển khai** (vd: `user-service` = java-spring, `web` = nextjs).
|
|
354
|
-
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,
|
|
355
|
-
coding standards, và error handling. Các giá trị Tầng 1 mà service không định nghĩa lại
|
|
356
|
-
(vd: git convention, banned pattern dùng chung toàn tổ chức) vẫn có hiệu lực.
|
|
357
|
-
|
|
358
|
-
Từ kết quả **đã merge**, trích xuất và lưu:
|
|
359
|
-
|
|
360
|
-
- **§1 Project Overview** → tên dự án, ngôn ngữ, framework, lệnh build/test, domains
|
|
361
|
-
- **§2 Architecture** → thứ tự layer (vd: Controller → Facade → Service → Repository), quy tắc kiến trúc — *service overlay thắng*
|
|
362
|
-
- **§2 Package Layout** → **base package** (vd `vn.edupia.{service}`) + **chiến lược đặt package** (by-layer / by-feature) + nơi code một domain sống. Đây là **quy ước đặt code trên đĩa**, PHẢI enforce khi sinh code. Nếu §2 chỉ nêu base package + thứ tự layer mà **không** nói tới sub-package theo feature → hiểu là **by-layer**: các layer đặt **TRỰC TIẾP** dưới base package (vd `vn.edupia.{service}.service`, `.repository`); feature/UC/prd-slug **KHÔNG** thành sub-package, chỉ phân biệt ở **tên class**. Lưu `code_base_package` + `package_strategy` — *service overlay thắng*.
|
|
363
|
-
- **§3 Coding Standards** → quy tắc đặt tên (class, method), kiểu response wrapper, pattern bị cấm — *service overlay thắng*
|
|
364
|
-
- **§5 Error Handling** → kiểu exception, mapping HTTP status code, tên class not-found exception — *service overlay thắng*
|
|
365
|
-
- **§7 Git Conventions** → pattern đặt tên branch, format commit message — *lấy theo root trừ khi service định nghĩa lại*
|
|
366
|
-
|
|
367
|
-
**Quy tắc phân giải:**
|
|
368
|
-
- Nếu cả hai tầng tồn tại → merge như trên; ghi `claude_md_source = root + {service_root}`.
|
|
369
|
-
- 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}`.
|
|
370
|
-
- 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).
|
|
371
|
-
- 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.
|
|
372
|
-
|
|
373
|
-
---
|
|
374
|
-
|
|
375
|
-
## Bước 4 — [SAFETY] Nạp quy tắc bảo vệ dữ liệu
|
|
376
|
-
|
|
377
|
-
Đọc `.agent/rules/data-protection.md` (hoặc `rules/data-protection.md` từ bản cài đặt framework).
|
|
378
|
-
|
|
379
|
-
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.
|
|
380
|
-
|
|
381
|
-
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*`.
|
|
382
|
-
|
|
383
|
-
---
|
|
384
|
-
|
|
385
|
-
## Bước 5 — [DOMAIN] Nạp Business Dictionary (có điều kiện)
|
|
386
|
-
|
|
387
|
-
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).
|
|
388
|
-
|
|
389
|
-
Nếu tồn tại, đọc và trích xuất:
|
|
390
|
-
- **Canonical Terms** → danh sách đầy đủ các thuật ngữ chuẩn và định nghĩa
|
|
391
|
-
- **Banned Terms** → danh sách đầy đủ các thuật ngữ bị cấm và bản thay thế chuẩn
|
|
392
|
-
- **Status / Enum Registry** → các giá trị enum được phép theo từng entity
|
|
393
|
-
|
|
394
|
-
Lưu danh sách banned term để **thực thi chủ động** suốt phiên làm việc của lệnh:
|
|
395
|
-
- 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
|
|
396
|
-
- Tự động thay banned term bằng bản chuẩn tương đương
|
|
397
|
-
|
|
398
|
-
Nếu file không tồn tại → bỏ qua âm thầm. Không cảnh báo hay chặn.
|
|
399
|
-
|
|
400
|
-
---
|
|
401
|
-
|
|
402
|
-
## Bước 6 — [DOMAIN] Nạp Core Entities (có điều kiện)
|
|
403
|
-
|
|
404
|
-
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).
|
|
405
|
-
Path mặc định: `specs/domain-knowledge/core-entities.md`.
|
|
406
|
-
|
|
407
|
-
Nếu tồn tại, đọc và lưu:
|
|
408
|
-
- **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ệ
|
|
409
|
-
- **Field name registry** → tên field chuẩn dùng trong code và tài liệu được sinh ra
|
|
410
|
-
- **Relationship map** → cách các entity liên hệ với nhau (1:N, N:N, embedded, v.v.)
|
|
411
|
-
|
|
412
|
-
**Cách dùng catalog này:**
|
|
413
|
-
- 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
|
|
414
|
-
- Khi sinh PRD/BDD: tham chiếu tên entity từ catalog này để nhất quán
|
|
415
|
-
- Khi sinh tech-docs: dùng catalog này làm nguồn chân lý cho định nghĩa entity
|
|
416
|
-
|
|
417
|
-
Nếu file không tồn tại → bỏ qua âm thầm.
|
|
418
|
-
|
|
419
|
-
---
|
|
420
|
-
|
|
421
|
-
## Bước 6.5 — [PLATFORM] Suy ra active_module và platform_type
|
|
422
|
-
|
|
423
|
-
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:
|
|
424
|
-
|
|
425
|
-
```
|
|
426
|
-
active_module = tech_stack.module (vd: "java-spring", "react", "flutter")
|
|
427
|
-
```
|
|
428
|
-
|
|
429
|
-
| `platform_type` | Modules |
|
|
430
|
-
|---|---|
|
|
431
|
-
| `backend` | `java-spring`, `golang`, `dotnet`, `php-laravel`, `context-engineering` |
|
|
432
|
-
| `web-frontend` | `react`, `nextjs`, `vue`, `nuxt`, `angular`, `phaser-game` |
|
|
433
|
-
| `mobile` | `flutter`, `react-native`, `ios-swiftui`, `android-compose` |
|
|
434
|
-
|
|
435
|
-
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.
|
|
436
|
-
|
|
437
|
-
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).
|
|
438
|
-
|
|
439
|
-
---
|
|
440
|
-
|
|
441
|
-
## Bước 6.7 — [GUARDRAILS] Nạp Project Lessons (có điều kiện)
|
|
442
|
-
|
|
443
|
-
*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`
|
|
444
|
-
hoặc được chấp nhận trong `/review-code`, `/fix-bug`, `/debug`.*
|
|
445
|
-
|
|
446
|
-
Phân giải path file lessons:
|
|
447
|
-
- Dùng `paths.lessons_file` nếu được set (có thể bị service override ở chế độ umbrella, Bước 1.6)
|
|
448
|
-
- Else mặc định `specs/domain-knowledge/lessons-learned.md`
|
|
449
|
-
- Ở 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`
|
|
450
|
-
|
|
451
|
-
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:
|
|
452
|
-
- 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).
|
|
453
|
-
- 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).
|
|
454
|
-
- 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.
|
|
455
|
-
|
|
456
|
-
Nếu file không tồn tại → bỏ qua âm thầm (chưa có lesson nào được ghi nhận).
|
|
457
|
-
|
|
458
|
-
---
|
|
459
|
-
|
|
460
|
-
## Bước 7 — [RECAP] Working Memory Recap (chống lost-in-middle)
|
|
461
|
-
|
|
462
|
-
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.
|
|
463
|
-
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
|
|
464
|
-
(hiệu ứng recency — tươi mới nhất trong bộ nhớ làm việc khi bắt đầu task).
|
|
465
|
-
|
|
466
|
-
Xuất đúng khối này:
|
|
467
|
-
```
|
|
468
|
-
[CTX LOADED]
|
|
469
|
-
Stack : {language} / {framework} / {database}
|
|
470
|
-
Platform : {active_module} ({platform_type})
|
|
471
|
-
Layers : {thứ tự layer từ CLAUDE.md §2 đã merge, vd: Controller → Facade → Service → Repository}
|
|
472
|
-
Package : {code_base_package}.{layer} · {by-layer | by-feature} ← feature/UC → tên class, KHÔNG thành package (nếu by-layer)
|
|
473
|
-
CLAUDE.md : {root + {service_root} | chỉ {service_root} | chỉ root | ⚠️ service overlay THIẾU — dùng root | missing}
|
|
474
|
-
Ticket : {ticket_prefix}-
|
|
475
|
-
Dict : {loaded — N canonical terms, M banned terms | missing}
|
|
476
|
-
Entities : {loaded — EntityA, EntityB, EntityC | missing}
|
|
477
|
-
Lessons : {loaded — N guardrails | chưa có}
|
|
478
|
-
Platform : {active_platform: system | web | app | — nếu chưa xác định}
|
|
479
|
-
Service : {active_service} ({active_service_module}) [← domain{/platform}{/prd_slug} nếu route qua by_prd_slug] | multi (map-theo-platform hoặc map-theo-prd_slug, chốt khi target đủ platform/prd_slug) | single-service
|
|
480
|
-
Svc Root : {service_root} — đã nạp conventions + trace_dir từ config service | —
|
|
481
|
-
Status : {FULL | PARTIAL — thiếu: CLAUDE.md / business-dict / core-entities | MINIMAL}
|
|
482
|
-
```
|
|
483
|
-
|
|
484
|
-
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.
|
|
485
|
-
|
|
486
|
-
---
|
|
487
|
-
|
|
488
|
-
## Hoàn tất nạp Context
|
|
489
|
-
|
|
490
|
-
Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
491
|
-
- Định danh dự án, tech stack, convention module
|
|
492
|
-
- Quy tắc kiến trúc và thứ tự layer ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
493
|
-
- Coding standards và quy tắc đặt tên ← **[CRITICAL — giữ trong bộ nhớ làm việc]**
|
|
494
|
-
- Quy tắc bảo vệ dữ liệu (pattern file nhạy cảm không bao giờ truy cập)
|
|
495
|
-
- Quy tắc thuật ngữ kèm danh sách banned term ← **[DOMAIN — áp dụng cho mọi từ được sinh ra]**
|
|
496
|
-
- Entity catalog (tên field, kiểu, invariant) ← **[DOMAIN — dùng khi sinh code]**
|
|
497
|
-
- Toàn bộ path đã cấu hình
|
|
498
|
-
|
|
499
|
-
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
---
|
|
503
|
-
|
|
504
|
-
## Bước 0 — Phân giải batch đầu vào (file mà tech lead trỏ vào)
|
|
505
|
-
|
|
506
|
-
1. Parse `$ARGUMENTS` thành danh sách feature tech lead chọn. Mỗi token là một path `.feature` hoặc một UC-id; phân giải mỗi cái thành file thật (Gate Bước 1). Danh sách này là `input_features` — **batch được thiết kế trong lần chạy này**. **Đừng** mở rộng nó bằng cách glob BDD anh em; chỉ nạp đúng các file này.
|
|
507
|
-
2. **Phân giải định danh từ header, KHÔNG từ tên file.** Với mỗi feature đọc `# @trace.prd` → `{TICKET-ID}` và `# @trace.id` → `{UC-ID}` (cả hai không chứa slug và là chuẩn; TICKET-ID như `FEAT-01-2` có dấu gạch, và slug/title của một UC có thể khác nhau theo platform — vd `…-UC3-sua-cau-bo-qua` (system) vs `…-UC3-sua-cau-quay-lai-bo-qua` (web), nên **đừng bao giờ** parse tên file bằng chuỗi). `{domain}` + `{prd-slug}` lấy từ path (Gate Bước 1). Gom batch thành các UC theo `@trace.id`, để cùng một UC trên system/web/app là **một** UC. Lấy **title** chuẩn của mỗi UC từ PRD (không phải title feature riêng theo platform).
|
|
508
|
-
**Guard cùng-PRD:** nếu `@trace.prd` khác nhau trong batch → DỪNG: *"Các file thuộc PRD khác nhau ({list}). Chạy /generate-tech-docs mỗi PRD một lần."*
|
|
509
|
-
3. **Cảnh báo mềm cỡ batch (không chặn):** nếu `input_features` có **hơn 5** file:
|
|
510
|
-
```
|
|
511
|
-
⚠️ {N} file BDD trong một lần chạy. Batch lớn nạp nhiều context hơn và có thể
|
|
512
|
-
làm giảm chất lượng thiết kế. Cân nhắc chia nhỏ (vd theo UC, hoặc theo platform).
|
|
513
|
-
Tiếp tục với cả {N}? (Y/N)
|
|
514
|
-
```
|
|
515
|
-
Y → tiếp tục với tất cả · N → để tech lead chạy lại với ít file hơn.
|
|
516
|
-
4. Với mỗi feature trong batch, đọc header + body: `@trace.service`, `@trace.module`, `@trace.platform`, `@trace.bdd_version`, `@trace.status`, `@trace.api_source`, UC id, các scenario (`SC{n}`), và business rule được tham chiếu (`BR{m}`).
|
|
517
|
-
5. Xác định **các platform có trong batch** — cái này quyết định lần chạy sinh ra gì:
|
|
518
|
-
- feature `system/` → sinh/mở rộng các section **backend** (§2–§4.4, §6–§8) cho UC của nó.
|
|
519
|
-
- feature `web/` và/hoặc `app/` → sinh/mở rộng block **client §4.5** cho platform đó, và thêm flow của platform đó vào lane **§5** (5.B/5.C).
|
|
520
|
-
- batch không có feature client → không có việc §4.5 lần này (lần chạy sau trỏ vào BDD `web/`·`app/` sẽ append).
|
|
521
|
-
- **batch không có feature `system/` (PRD chỉ client):** **đừng** bịa BE contract. §4.1 chỉ liệt kê các endpoint mà client **tiêu thụ** (external / bên thứ ba / của team khác / existing), reverse-document từ mệnh đề Then của client BDD + PRD và đánh dấu "consumed (external)"; nếu feature không gọi mạng → §4 = "N/A — client-only, không backend". §4.5.4 map tới bất cứ gì §4.1 liệt kê (hoặc không có).
|
|
522
|
-
- Ghi `@trace.bdd_versions` (**số nhiều** — map theo platform, vd `system=1.5, web=1.9`) từ `@trace.bdd_version` (**số ít**, scalar) của mỗi feature — đừng làm phẳng về một số. *(Tên khác nhau là cố ý: cùng một tên cho hai kiểu dữ liệu sẽ làm vỡ mọi parser generic.)*
|
|
523
|
-
6. Đường dẫn output — doc **duy nhất** của PRD:
|
|
524
|
-
```
|
|
525
|
-
{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md
|
|
526
|
-
```
|
|
527
|
-
*(Không có `{UC-ID}` và không có hậu tố `-{platform}` — một doc gộp per-PRD lớn dần qua các lần chạy.)*
|
|
528
|
-
|
|
529
|
-
Lưu `input_features`, `platforms_present`, danh sách scenario theo từng UC, và `output_path`.
|
|
530
|
-
|
|
531
|
-
---
|
|
532
|
-
|
|
533
|
-
## Bước 0.5 — [ARCH] Nạp Architecture Context (nếu có)
|
|
534
|
-
|
|
535
|
-
Tech-design chắt lọc kiến trúc hệ thống thành API contract + client design, nên đây là **nơi duy nhất** trong pipeline nạp `architecture.md` (SSOT cross-cutting sinh bởi `/generate-architecture`). Không nạp toàn cục ở context-loader — chỉ lệnh này cần nó ở mức sâu.
|
|
536
|
-
|
|
537
|
-
1. **Phân giải path:** `{paths.specs_dir}/architecture.md` (mặc định `specs/architecture.md`). Chế độ umbrella: context-loader đã trỏ `specs_dir`/`service_root` về service đang active → dùng `architecture.md` của chính service đó (kiến trúc là code-level, per-service).
|
|
538
|
-
2. **Nếu file KHÔNG tồn tại** → bỏ qua âm thầm, đặt `arch = none`. Vẫn dựa vào CLAUDE.md §2 (layers/rules) + core-entities như trước. (Gợi ý mềm một lần trong report cuối: "Chưa có architecture.md — cân nhắc chạy `/generate-architecture` để tech-design bám kiến trúc hệ thống.")
|
|
539
|
-
3. **Nếu tồn tại** → đọc **có chọn lọc theo tier** (mỗi mục có marker `<!-- tier: core|conditional|ops -->`):
|
|
540
|
-
- **Nạp** thân các mục **`core` + `conditional`** — đây là phần ảnh hưởng code/API/data: layer boundaries + dependency direction, phân loại/nguồn dữ liệu, injection rules, luồng xác thực, response API chuẩn, caching/sharding/messaging, multi-tenant/identity-resolution.
|
|
541
|
-
- **BỎ QUA** các mục **`ops`** (Observability, Triển khai & DevOps, Chiến lược kiểm thử, NFR) — không đổi thiết kế API/data-model, chỉ làm nhiễu context.
|
|
542
|
-
- Các section §2–§4 (data model, API contract, integration) PHẢI nhất quán với phần đã nạp — KHÔNG tự suy khác.
|
|
543
|
-
4. **Mục đang STUB (`<!-- status: stub -->`):** nếu một UC trong batch **chạm** tới một concern mà mục tương ứng còn stub (vd UC có tenant scoping nhưng §Multi-tenant là stub) → **cảnh báo mềm** trong report: *"§{Mục} chưa tài liệu hoá trong architecture.md — chạy `/generate-architecture --section={slug}` để tech-design chính xác hơn."* Vẫn tiếp tục dựa vào CLAUDE.md.
|
|
544
|
-
5. **Trust-gate — đọc frontmatter `verified_by`:**
|
|
545
|
-
- `verified_by: AI-draft` (hoặc trống) → nội dung do AI dựng từ config/tài liệu/code, CHƯA ai verify. Vẫn dùng làm tham chiếu nhưng **cảnh báo** trong report: *"⚠️ architecture.md còn là AI-draft chưa verify — tech-design có thể kế thừa giả định sai. Nên để Tech Lead verify (đổi `verified_by`) trước khi chốt."* Khi mâu thuẫn với CLAUDE.md/BDD thì ưu tiên CLAUDE.md/BDD.
|
|
546
|
-
- `verified_by: {người thật}` → coi là ràng buộc kiến trúc chính thức.
|
|
547
|
-
|
|
548
|
-
Lưu `arch` (`none` | `ai-draft` | `verified`) để dùng ở các bước sinh section và report.
|
|
549
|
-
|
|
550
|
-
---
|
|
551
|
-
|
|
552
|
-
## Bước 1 — Chế độ Fresh vs Append
|
|
553
|
-
|
|
554
|
-
Kiểm tra `output_path` đã tồn tại chưa.
|
|
555
|
-
|
|
556
|
-
- **Chưa tồn tại → chế độ FRESH.** Tạo doc từ template, chỉ điền (các) UC trong `input_features`. (Section của các UC không thuộc batch này giữ placeholder `{…}` / được thêm ở lần chạy sau.)
|
|
557
|
-
- **Đã tồn tại → chế độ APPEND.** Doc là tăng dần — không bao giờ regenerate từ đầu (sẽ đè mất chỉnh tay và sign-off của reviewer). Đọc bảng **§10 UC Coverage** và **Changelog** hiện có → `covered_ucs`. Với mỗi UC trong `input_features`, phân loại:
|
|
558
|
-
- **UC mới** (không có trong `covered_ucs`) → **thêm** các section của nó: sequence diagram §5 mới **đúng lane platform** (5.A/5.B/5.C, đánh số sau cái cuối cùng hiện có *trong lane đó*); với §4.5 — nếu **platform** này mới với doc → nhóm `### 4.5 — {platform}` mới, ngược lại thêm sub-block `§4.5.1.x {Screen} — {UC}` + row vào §4.5.6 dùng chung của nhóm platform đó (đừng lặp nhóm); row mới ở §3/§4.3/§8/§9. Rồi cập nhật §10 (row khoá theo platform×SC) và thêm một row Changelog.
|
|
559
|
-
- **UC đã phủ được trỏ lại** (có trong `covered_ucs`) → đây là refresh/mở rộng có chủ đích (vd tech lead giờ trỏ vào BDD `web/` của một UC mà backend đã thiết kế, hoặc BDD bump version). Xác nhận trước khi đụng nội dung có sẵn:
|
|
560
|
-
```
|
|
561
|
-
↻ {UC-ID} đã có trong {TICKET-ID}-tech-design.md.
|
|
562
|
-
Lần chạy này sẽ {thêm block client {platform} (§4.5) | refresh cho BDD v{new}}.
|
|
563
|
-
Cập nhật các section của UC này? (Y = merge/mở rộng · N = bỏ qua UC này)
|
|
564
|
-
```
|
|
565
|
-
Y → merge (thêm platform/§ còn thiếu hoặc refresh phần đã đổi, giữ nguyên prose không liên quan) · N → bỏ qua UC đó.
|
|
566
|
-
|
|
567
|
-
Lưu `mode` (`fresh` | `append`) và, theo từng UC của batch, hành động của nó (`add-new` | `extend-platform` | `refresh` | `skip`). Nếu mọi UC đều `skip` → báo "không có gì để làm" và dừng.
|
|
568
|
-
|
|
569
|
-
---
|
|
570
|
-
|
|
571
|
-
## Bước 2 — Cổng Chất lượng (mọi feature nguồn)
|
|
572
|
-
|
|
573
|
-
Với **mỗi** feature BDD trong scope:
|
|
574
|
-
|
|
575
|
-
1. Tìm `{paths.refinement_dir}/{uc-id}-{platform}-review-bdd-findings.yaml` — `{platform}` = `@trace.platform` của chính feature này (đọc ở Bước 0). Findings là **per (UC × platform)**: mỗi `.feature` của từng platform được review vào file riêng, nên kiểm đúng file khớp feature **này** — không phải của platform anh em (feature `system` phải được gác bởi findings `system`, không phải `web`).
|
|
576
|
-
- **Thiếu** → cảnh báo mềm (không chặn):
|
|
577
|
-
```
|
|
578
|
-
⚠️ /review-context chưa chạy cho {uc-id}.feature.
|
|
579
|
-
Khuyến nghị: chạy /review-context {feature-file} trước để kiểm chất lượng BDD.
|
|
580
|
-
```
|
|
581
|
-
- **Có** → kiểm các finding critical chưa xử lý với `status: "pending"`. Nếu có → **DỪNG** và in (các) feature vi phạm:
|
|
582
|
-
```
|
|
583
|
-
❌ Cổng Chất lượng thất bại — {feature-file}
|
|
584
|
-
Còn finding BDD critical chưa xử lý.
|
|
585
|
-
Chạy: /review-context --fix {feature-file} ← auto-fix những gì có thể
|
|
586
|
-
Rồi: /review-context --resume {feature-file}
|
|
587
|
-
Rồi chạy lại: /generate-tech-docs {đúng các feature file đó}
|
|
588
|
-
```
|
|
589
|
-
2. Đọc `# @trace.status:` của feature (tín hiệu duyệt chuẩn). Nếu feature nào ≠ `approved` → cảnh báo mềm (đồng bộ generate-code / qc-analyze): *"BDD {uc-id} chưa approved (@trace.status: {status}) — tech design dựng từ BDD chưa chốt có thể phải làm lại. Tiếp tục? (Y/N)"*.
|
|
590
|
-
|
|
591
|
-
Cổng này chỉ chạy cho `input_features` (batch) — không bao giờ quét BDD ngoài cái tech lead trỏ vào.
|
|
592
|
-
|
|
593
|
-
---
|
|
594
|
-
|
|
595
|
-
## Bước 3 — Điều kiện tiên quyết Client (chỉ khi batch có feature `web/` hoặc `app/`)
|
|
596
|
-
|
|
597
|
-
Các block client §4.5 (phân cấp component, map Figma → design-system, hình dạng state, test selector) được **suy ra** từ design spec. Định vị nó:
|
|
598
|
-
|
|
599
|
-
- **Design Spec** — `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}*.md`.
|
|
600
|
-
- **Tìm thấy** → nạp; Screen Specs / Component Inventory / Screen States của nó cấp cho §4.5 và mô hình state client ở §4.5.3.
|
|
601
|
-
- **Không thấy** → cảnh báo mềm (không chặn cứng — các section backend vẫn giá trị đầy đủ, và §4.5 có thể draft chỉ-text từ client BDD, đánh dấu degraded):
|
|
602
|
-
```
|
|
603
|
-
⚠️ Không tìm thấy design-spec cho {TICKET-ID}. §4.5 (map UI component, tham chiếu
|
|
604
|
-
Figma, test selector) sẽ được draft chỉ từ BDD và đánh dấu
|
|
605
|
-
"[DRAFT — no design-spec]". Chạy /generate-design-spec trước để đủ độ trung thực.
|
|
606
|
-
Tiếp tục? (Y/N)
|
|
607
|
-
```
|
|
608
|
-
|
|
609
|
-
Cũng nạp, khi có, catalog Figma component (`figma-components/{module}.md`) và design token (đã nạp bởi context-loader Bước 6-B/6-C) để ưu tiên component trong catalog ở §4.5.1/§4.5.2 và token thật ở §4.5.5.
|
|
610
|
-
|
|
611
|
-
> **Lưu ý:** vì BE và FE giờ nằm trong **cùng** một tài liệu, không còn cổng "BE contract phải tồn tại trước" — backend contract (§4) và client design (§4.5) được sinh cùng nhau. §4.5.4 vẫn yêu cầu mỗi client service method map tới một endpoint **thật** khai báo ở §4.1 (đừng bịa endpoint).
|
|
612
|
-
|
|
613
|
-
---
|
|
614
|
-
|
|
615
|
-
## Bước 4 — Kiểm tra Brownfield
|
|
616
|
-
|
|
617
|
-
Đọc `@trace.api_source` ở header mỗi feature của batch, và kiểm bảng Metadata của PRD tìm `| **API Source** | existing |`.
|
|
618
|
-
|
|
619
|
-
| Giá trị | Chế độ |
|
|
620
|
-
|-------|------|
|
|
621
|
-
| `existing` | **Reverse-document** — API đã tồn tại; mô tả as-is, ghi chú gap so với BDD, không thiết kế mới |
|
|
622
|
-
| vắng / khác | **Greenfield** — thiết kế API từ scenario |
|
|
623
|
-
|
|
624
|
-
Lưu `active_mode`. Nếu `reverse-document`, nạp appendix "Existing API Contract" từ PRD làm input cho §4.
|
|
625
|
-
|
|
626
|
-
---
|
|
627
|
-
|
|
628
|
-
## CHECKPOINT — Kế hoạch Tech Design
|
|
629
|
-
|
|
630
|
-
Trước khi sinh, hiện kế hoạch và chờ **Y** rõ ràng:
|
|
631
|
-
|
|
632
|
-
```
|
|
633
|
-
Kế hoạch Tech Design — {TICKET-ID} (doc full-stack / PRD)
|
|
634
|
-
──────────────────────────────────────────────────────
|
|
635
|
-
PRD : {TICKET-ID} — {feature title}
|
|
636
|
-
Chế độ : {Fresh (doc mới) | Append (mở rộng doc có sẵn)}
|
|
637
|
-
Batch : {M} file feature lần này:
|
|
638
|
-
- {input_features[0]} ({platform} · UC{n} · {add-new|extend-platform|refresh})
|
|
639
|
-
- {…}
|
|
640
|
-
Service : {trace.service} Module: {trace.module}
|
|
641
|
-
Platform : {các platform trong batch}
|
|
642
|
-
Chế độ API : {Reverse-document (API existing) | Greenfield (thiết kế mới)}
|
|
643
|
-
Scenario : {N} scenario trong batch
|
|
644
|
-
BDD ver : {bdd_version lớn nhất trong batch}
|
|
645
|
-
Design-spec: {đã nạp | ⚠️ thiếu (§4.5 degraded) | n/a — batch không có feature client}
|
|
646
|
-
UC của doc : đã phủ → {covered_ucs hoặc "chưa (doc mới)"}; lần này → {batch UCs}
|
|
647
|
-
Output : {output_path} ({tạo | mở rộng})
|
|
648
|
-
|
|
649
|
-
Section sẽ {sinh | thêm} cho batch này:
|
|
650
|
-
{backend (system trong batch): §1–§4.4, §6–§8}
|
|
651
|
-
{client (web/app trong batch): §4.5 cho {platform}}
|
|
652
|
-
§5 Key Flows — {N} sequence diagram trong lane platform (5.A system/5.B web/5.C app), mỗi cái tiêu đề "platform · SC"
|
|
653
|
-
§9 Design Decisions (row mới) · §10 UC Coverage (khoá theo platform×SC) · §11 Cross-cutting · Changelog
|
|
654
|
-
──────────────────────────────────────────────────────
|
|
655
|
-
Tiếp tục? (Y/N)
|
|
656
|
-
```
|
|
657
|
-
|
|
658
|
-
Chờ "Y" rõ ràng.
|
|
659
|
-
|
|
660
|
-
---
|
|
661
|
-
|
|
662
|
-
## Sinh
|
|
663
|
-
|
|
664
|
-
Ghi/mở rộng `{output_path}` dùng template dưới đây, chỉ sinh **nội dung cho (các) UC** trong `input_features`. Điền các placeholder `{…}` liên quan và xoá các comment hướng dẫn khi làm.
|
|
665
|
-
|
|
666
|
-
- Section **Backend** (§2–§4.4, §6–§8) đến từ feature `system/` trong batch (hoặc, brownfield, từ contract existing của PRD).
|
|
667
|
-
- Block **Client** §4.5 đến từ feature `web/`·`app/` trong batch + design-spec. Dùng **cùng** giá trị test-id giữa web/app cho cùng một element logic (chỉ khác attribute theo platform).
|
|
668
|
-
- **§5 Key Flows** — một mermaid sequence diagram cho mỗi scenario của batch, participant trải mọi tầng (client component → service → API → external API → DB). **Gom theo lane platform** (5.A system · 5.B web · 5.C app) và đặt tiêu đề mỗi diagram bằng **platform · SC** (vd `web · UC1-SC1`) — vì `{UC}-SC{N}` chỉ độc nhất trong (UC × platform): `system UC1-SC1` và `web UC1-SC1` là hai scenario khác nhau. Đừng bao giờ ghi trơ `UC1-SC1`. Chỉ tạo lane cho platform có BDD.
|
|
669
|
-
- **§1/§2** (Overview/Actors, Architecture) là cấp PRD: viết ở lần chạy đầu; các lần sau chỉ mở rộng nếu batch thêm actor/integration thật sự mới.
|
|
670
|
-
- **§10 UC Coverage** — một row UC (có cột Platforms) + bảng con coverage-scenario khoá theo **(platform, SC)** — mỗi platform×SC một row, vì cùng số SC ở platform khác nhau là scenario khác nhau. Đây là mỏ neo mà chế độ APPEND đọc. Luôn cập nhật nó cho (các) UC/platform của batch.
|
|
671
|
-
|
|
672
|
-
**Chế độ APPEND (doc đã tồn tại):** **đừng** viết lại section có sẵn. Chèn diagram §5 của UC batch **vào đúng lane platform** (5.A/5.B/5.C, đánh số sau cái cuối trong lane đó, tiêu đề `platform · SC`), các row mới ở §3/§4.3/§8/§9; với §4.5 — platform mới → nhóm `### 4.5 — {platform}` mới, ngược lại thêm sub-block `§4.5.1.x {Screen} — {UC}` + row vào §4.5.6 dùng chung của nhóm (không lặp nhóm); rồi cập nhật §10 (row khoá theo platform×SC) và thêm một row Changelog. Bump `@trace.revision` và làm mới `@trace.ucs` / `@trace.platforms` ở header, và cập nhật entry của platform vừa đụng trong map `@trace.bdd_versions` (vd set `web=2.0`, giữ nguyên `system`).
|
|
673
|
-
|
|
674
|
-
<!--
|
|
675
|
-
════════════════════════════════════════════════════════════════════════════
|
|
676
|
-
TEMPLATE: Tài liệu Thiết kế Kỹ thuật (per-PRD, full-stack, gộp)
|
|
677
|
-
Dùng bởi: /generate-tech-docs
|
|
678
|
-
════════════════════════════════════════════════════════════════════════════
|
|
679
|
-
|
|
680
|
-
MÔ HÌNH PHẠM VI
|
|
681
|
-
- MỘT tài liệu cho mỗi PRD (không phải per-UC). Nó bao phủ MỌI use case của PRD
|
|
682
|
-
trong một thiết kế full-stack gộp: backend (API, mô hình dữ liệu, DB) VÀ client
|
|
683
|
-
(component, state, tích hợp API) đặt cạnh nhau, nối bằng sequence diagram xuyên
|
|
684
|
-
tầng. Đây là "bản vẽ thi công" mà bất kỳ dev nào mở ra để implement cả feature.
|
|
685
|
-
- ĐẦU VÀO là các file BDD của PRD (web/ · app/ · system/), KHÔNG phải văn xuôi PRD.
|
|
686
|
-
PRD chỉ nạp để lấy bối cảnh Overview/Goals/Actors.
|
|
687
|
-
|
|
688
|
-
TĂNG DẦN / APPEND
|
|
689
|
-
- Khi BDD mới được thêm vào cùng PRD về sau, tài liệu này được MỞ RỘNG, không sinh
|
|
690
|
-
lại: thêm section + sequence diagram của UC mới, cập nhật ma trận Độ phủ UC (§10)
|
|
691
|
-
và Changelog. KHÔNG bao giờ đè nội dung có sẵn hay chỉnh tay.
|
|
692
|
-
|
|
693
|
-
QUY TẮC ĐIỀN
|
|
694
|
-
- Thay MỌI placeholder {…} bằng nội dung thật. Xoá các comment hướng dẫn.
|
|
695
|
-
- THUẬT NGỮ: tuân 100% từ điển dự án (specs/domain-knowledge/business-dictionary.md).
|
|
696
|
-
Giá trị status/enum → core-entities.md (Enum Registry). Entity → core-entities.md.
|
|
697
|
-
- Giữ code/DTO/DB mẫu theo idiom stack của dự án (xem stack-profile của module đang
|
|
698
|
-
dùng). Snippet C#/Angular bên dưới chỉ MANG TÍNH MINH HOẠ — thay bằng stack thật.
|
|
699
|
-
- Section không áp dụng cho PRD này: GIỮ heading và viết "N/A — {lý do}" thay vì
|
|
700
|
-
xoá, để cấu trúc luôn nhất quán, dễ đoán.
|
|
701
|
-
- Mọi sequence diagram / API / rule phải truy vết được về một scenario: tham chiếu
|
|
702
|
-
id SC (vd UC1-SC3) mà nó phục vụ.
|
|
703
|
-
-->
|
|
704
|
-
|
|
705
|
-
# {Feature Area} — Tài liệu Thiết kế Kỹ thuật: {PRD Title}
|
|
706
|
-
|
|
707
|
-
<!-- Khối @trace (cấp PRD). ucs = mọi UC mà doc này phủ; nối thêm id khi thêm UC. GIỮ NGUYÊN key @trace.* — máy đọc. -->
|
|
708
|
-
---
|
|
709
|
-
@trace.id: {TICKET-ID}
|
|
710
|
-
@trace.domain: {domain}
|
|
711
|
-
@trace.prd: {TICKET-ID}
|
|
712
|
-
@trace.ucs: {TICKET-ID}-UC1, {TICKET-ID}-UC2{, …}
|
|
713
|
-
@trace.service: {service — từ header BDD @trace.service}
|
|
714
|
-
@trace.module: {module liên quan — vd dotnet, angular}
|
|
715
|
-
@trace.platforms: {system | web | app — tuỳ thư mục BDD nào tồn tại}
|
|
716
|
-
@trace.bdd_versions: {MAP theo từng platform — số nhiều, KHÁC @trace.bdd_version (scalar) của .feature — vd system=1.5, web=1.9, app=1.7; chỉ platform có mặt. Mỗi feature mang bdd_version riêng; đừng gộp về một số.}
|
|
717
|
-
@trace.api_source: {existing | —}
|
|
718
|
-
@trace.revision: 1
|
|
719
|
-
@trace.status: draft
|
|
720
|
-
@trace.generated_at: {YYYY-MM-DD}
|
|
721
|
-
---
|
|
722
|
-
|
|
723
|
-
> **Tài liệu liên quan:** {link các PRD / tech-design anh em mà doc này phụ thuộc, vd [OTHER-TICKET](../{other-slug}/tech-docs/{OTHER-TICKET}-tech-design.md)}. Xoá nếu không có.
|
|
724
|
-
|
|
725
|
-
## 1. Tổng quan (Overview)
|
|
726
|
-
|
|
727
|
-
<!-- 2–4 câu: feature làm gì, ai dùng, hình dạng kỹ thuật cốt lõi (nguồn dữ liệu,
|
|
728
|
-
side effect chính). Nêu rõ dữ liệu đến từ đâu (DB vs API ngoài) và thao tác ghi
|
|
729
|
-
chính. Nguồn: PRD + system BDD. -->
|
|
730
|
-
|
|
731
|
-
{Feature làm gì, tác nhân chính, và cơ chế kỹ thuật cốt lõi. Nêu rõ dữ liệu nào được
|
|
732
|
-
sở hữu (DB) vs lấy live (API ngoài), và thao tác ghi chính.}
|
|
733
|
-
|
|
734
|
-
### Mục tiêu (Goals)
|
|
735
|
-
|
|
736
|
-
<!-- Liệt kê mục tiêu kỹ thuật — suy từ mục tiêu PRD, diễn đạt thành thứ hệ thống
|
|
737
|
-
phải đảm bảo. -->
|
|
738
|
-
|
|
739
|
-
- {Mục tiêu 1}
|
|
740
|
-
- {Mục tiêu 2}
|
|
741
|
-
|
|
742
|
-
### Tác nhân nghiệp vụ (Business Actors)
|
|
743
|
-
|
|
744
|
-
| Tác nhân | Mô tả | Kênh |
|
|
745
|
-
|-------|-------------|---------|
|
|
746
|
-
| {Actor} | {vai trò & quyền} | {đường vào, vd App → Widget → Portal → API} |
|
|
747
|
-
|
|
748
|
-
---
|
|
749
|
-
|
|
750
|
-
## 2. Tổng quan Kiến trúc (Architecture Overview)
|
|
751
|
-
|
|
752
|
-
### 2.1 Kiến trúc tổng thể (High-level Architecture)
|
|
753
|
-
|
|
754
|
-
<!-- ASCII (hoặc mermaid) topology thể hiện các hệ thống feature này chạm tới:
|
|
755
|
-
client → gateway → service(s) → data store / API ngoài. Chỉ giữ các component
|
|
756
|
-
mà PRD NÀY thực sự dùng. Nguồn: architecture.md / project-context.yaml (services, stack). -->
|
|
757
|
-
|
|
758
|
-
```
|
|
759
|
-
{Sơ đồ ASCII hoặc mermaid các component feature này chạm tới}
|
|
760
|
-
```
|
|
761
|
-
|
|
762
|
-
> **Lưu ý:** {chỉ ra dữ liệu nào lấy live từ API ngoài vs lưu trong DB sở hữu, và lớp cache + TTL nếu có.}
|
|
763
|
-
|
|
764
|
-
### 2.2 Mẫu giao tiếp (Communication Patterns)
|
|
765
|
-
|
|
766
|
-
| Mẫu | Dùng cho | Phạm vi (UC/SC) |
|
|
767
|
-
|---------|-------|---------------|
|
|
768
|
-
| {Client → Gateway → API} | {auth / action} | {UC1} |
|
|
769
|
-
| {API → API ngoài} | {lấy gì, cache TTL} | {UC1-SC…} |
|
|
770
|
-
|
|
771
|
-
---
|
|
772
|
-
|
|
773
|
-
## 3. Mô hình Dữ liệu (Data Model)
|
|
774
|
-
|
|
775
|
-
<!-- Nguồn: core-entities.md (entity sở hữu) + mệnh đề Then của BDD (state) + PRD.
|
|
776
|
-
Phân biệt entity SỞ HỮU (trong DB) với model NGUỒN-API (lấy live, không lưu).
|
|
777
|
-
Chỉ liệt kê field mà PRD này đọc hoặc ghi. -->
|
|
778
|
-
|
|
779
|
-
### 3.1 Thiết kế Entity (Entity Design)
|
|
780
|
-
|
|
781
|
-
#### {EntityName} ({DB entity | POCO nguồn-API})
|
|
782
|
-
|
|
783
|
-
{Một dòng: nó biểu diễn gì, và được lưu hay lấy live.}
|
|
784
|
-
|
|
785
|
-
| Field | Kiểu | Dùng trong {TICKET-ID} |
|
|
786
|
-
|-------|------|----------------------|
|
|
787
|
-
| `{field}` | `{type}` | {feature này dùng thế nào — đọc/ghi, SC nào} |
|
|
788
|
-
|
|
789
|
-
<!-- Lặp lại cho mỗi entity. Nếu feature có chuyển trạng thái đáng kể, thêm bảng/sơ đồ
|
|
790
|
-
state nhỏ như dưới. -->
|
|
791
|
-
|
|
792
|
-
**Chuyển trạng thái (nếu có):**
|
|
793
|
-
|
|
794
|
-
```
|
|
795
|
-
{state A}: {điều kiện} → {kết quả / tín hiệu UI}
|
|
796
|
-
{state B}: {điều kiện} → {kết quả}
|
|
797
|
-
```
|
|
798
|
-
|
|
799
|
-
**Ràng buộc:**
|
|
800
|
-
- {invariant enforce ở tầng application/DB, vd đúng một primary cho mỗi tenant}
|
|
801
|
-
|
|
802
|
-
### 3.2 Quan hệ Entity (Entity Relationships)
|
|
803
|
-
|
|
804
|
-
```
|
|
805
|
-
{sơ đồ quan hệ — cardinality, khoá join, field nào read-only vs sở hữu}
|
|
806
|
-
```
|
|
807
|
-
|
|
808
|
-
### 3.3 Ranh giới Nguồn dữ liệu (Data Source Boundaries)
|
|
809
|
-
|
|
810
|
-
<!-- Phát biểu gọn PRD NÀY đọc gì vs ghi gì, và cái gì được uỷ thác nơi khác.
|
|
811
|
-
Chống lem phạm vi. -->
|
|
812
|
-
|
|
813
|
-
**Phạm vi {TICKET-ID}: {ĐỌC … / GHI …}.**
|
|
814
|
-
|
|
815
|
-
| Trách nhiệm | Trong phạm vi? | Do ai xử lý |
|
|
816
|
-
|----------------|-----------|-----------|
|
|
817
|
-
| {đọc list đã gộp} | ✅ Có | {endpoint / service} |
|
|
818
|
-
| {ghi cờ X} | ✅ Có | {service} |
|
|
819
|
-
| {dữ liệu gốc} | ❌ Read-only | {API ngoài + cache} |
|
|
820
|
-
| {mối lo module khác} | ❌ Không | {module/team} |
|
|
821
|
-
|
|
822
|
-
### 3.4 Multi-tenant & Sharding
|
|
823
|
-
|
|
824
|
-
<!-- Chỉ khi dự án multi-tenant. Nếu không, viết "N/A — single tenant". -->
|
|
825
|
-
|
|
826
|
-
- {khoá tenant trên entity, cách ly bằng query-filter, phân giải shard — từ architecture.md}
|
|
827
|
-
|
|
828
|
-
---
|
|
829
|
-
|
|
830
|
-
## 4. Hợp đồng API (API Contracts)
|
|
831
|
-
|
|
832
|
-
<!-- Contract backend. Greenfield: thiết kế endpoint từ scenario BDD. Brownfield
|
|
833
|
-
(@trace.api_source = existing): reverse-document API đang chạy as-is và ghi chú
|
|
834
|
-
gap so với kỳ vọng BDD. Đánh dấu REUSE vs NEW rõ ràng.
|
|
835
|
-
PRD CHỈ-CLIENT (không có BDD system/ — feature này không sở hữu backend): ĐỪNG
|
|
836
|
-
bịa contract BE. §4.1 khi đó liệt kê các endpoint mà client TIÊU THỤ (ngoài /
|
|
837
|
-
bên thứ ba / của team khác / có sẵn), đánh dấu "consumed (external)",
|
|
838
|
-
reverse-document từ mệnh đề Then của BDD client + PRD; chỉ điền §4.2/§4.3 nếu
|
|
839
|
-
biết shape. Nếu feature không gọi mạng gì cả → viết "N/A — client-only, no backend".
|
|
840
|
-
§4.5.4 ánh xạ method client tới bất cứ gì §4.1 liệt kê (hoặc không có). -->
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
### 4.1 Endpoints
|
|
844
|
-
|
|
845
|
-
```
|
|
846
|
-
{METHOD} {/path} # NEW | REUSE ({nguồn}) — {mục đích một dòng}
|
|
847
|
-
```
|
|
848
|
-
|
|
849
|
-
### 4.2 Model Request/Response (Request/Response Models)
|
|
850
|
-
|
|
851
|
-
<!-- Thể hiện shape DTO theo idiom của stack. Ghi rõ field nào đến từ DB vs API ngoài. -->
|
|
852
|
-
|
|
853
|
-
```{lang}
|
|
854
|
-
{định nghĩa DTO kèm comment nguồn từng field}
|
|
855
|
-
```
|
|
856
|
-
|
|
857
|
-
### 4.3 Validation & Mã lỗi (Validation & Error Codes)
|
|
858
|
-
|
|
859
|
-
**Quy tắc validation:**
|
|
860
|
-
|
|
861
|
-
```{lang}
|
|
862
|
-
{quy tắc validation, theo idiom stack (vd FluentValidation / class-validator)}
|
|
863
|
-
```
|
|
864
|
-
|
|
865
|
-
| Code | HTTP Status | Mô tả | Trace |
|
|
866
|
-
|------|-------------|-------------|-------|
|
|
867
|
-
| `{ERROR_CODE}` | {4xx/5xx} | {khi nào phát sinh} | {UC1-SC…} |
|
|
868
|
-
|
|
869
|
-
### 4.4 Logic Handler (endpoint chính)
|
|
870
|
-
|
|
871
|
-
<!-- Với các thao tác ghi không tầm thường, viết rõ các bước có thứ tự (validation →
|
|
872
|
-
transaction → commit/rollback → return). Giữ sequence diagram và code khớp nhau. -->
|
|
873
|
-
|
|
874
|
-
**{HandlerName}:**
|
|
875
|
-
1. {bước}
|
|
876
|
-
2. {bước — ranh giới transaction nếu có}
|
|
877
|
-
|
|
878
|
-
### 4.5 Ánh xạ Component UI (UI Component Mapping) — {platform} ({framework})
|
|
879
|
-
|
|
880
|
-
<!-- Thiết kế CLIENT, NHÓM THEO PLATFORM: một section "### 4.5 … — {platform}" cho mỗi
|
|
881
|
-
platform client có trong BDD (một nhóm web, một nhóm app). ĐỪNG đặt tên heading
|
|
882
|
-
này theo màn hình — màn hình/UC nằm ở các sub-block bên dưới.
|
|
883
|
-
Bên trong một nhóm platform:
|
|
884
|
-
• §4.5.1 Cây Component — lặp sub-block theo màn hình/UC:
|
|
885
|
-
"#### 4.5.1.x {Screen} — {UC}". Một PRD nhiều màn hình/UC → nhiều sub-block
|
|
886
|
-
trong CÙNG nhóm platform (không bao giờ tạo nhóm 4.5 thứ hai cho cùng platform).
|
|
887
|
-
• §4.5.2–§4.5.5 — tương tự theo màn hình/UC ở chỗ chúng khác nhau.
|
|
888
|
-
• §4.5.6 Test Selectors — MỘT bảng dùng chung cho cả nhóm platform; cột
|
|
889
|
-
"Phục vụ SC" mang (UC · SC) để consumer per-UC lọc row của mình.
|
|
890
|
-
Append: platform mới → nhóm "### 4.5 — {platform}" mới; màn hình/UC mới trong
|
|
891
|
-
platform đã có → thêm sub-block + row vào §4.5.6 (đừng lặp nhóm).
|
|
892
|
-
Bỏ hẳn §4.5 với PRD backend-only. -->
|
|
893
|
-
|
|
894
|
-
> **Nguồn:** {file Figma + node id, từ design-spec}
|
|
895
|
-
> **Stack:** {framework, state primitive, thư viện component}
|
|
896
|
-
> <!-- @figma.url: {url figma cấp node} -->
|
|
897
|
-
|
|
898
|
-
#### 4.5.1 Cây Component (Component Hierarchy) — {Screen} ({UC})
|
|
899
|
-
|
|
900
|
-
<!-- Lặp sub-block này theo màn hình/UC trong nhóm platform này (4.5.1.a, 4.5.1.b …). -->
|
|
901
|
-
|
|
902
|
-
```
|
|
903
|
-
{cây component — container vs presentational, con có điều kiện}
|
|
904
|
-
```
|
|
905
|
-
|
|
906
|
-
#### 4.5.2 Ánh xạ file Component (Component File Mapping)
|
|
907
|
-
|
|
908
|
-
| Component | Path | Loại | Trách nhiệm |
|
|
909
|
-
|-----------|------|------|---------|
|
|
910
|
-
| `{Component}` | `{path}` | {Feature/Child} | {trách nhiệm} |
|
|
911
|
-
|
|
912
|
-
#### 4.5.3 Quản lý State (State Management) ({state primitive})
|
|
913
|
-
|
|
914
|
-
<!-- Shape state suy từ mệnh đề Then của System BDD + shape response từ §4.2.
|
|
915
|
-
Thể hiện giá trị dẫn xuất/tính toán và input của chúng. -->
|
|
916
|
-
|
|
917
|
-
```{lang}
|
|
918
|
-
{khai báo state kèm comment nguồn (mỗi cái map tới field BDD / field BE nào)}
|
|
919
|
-
```
|
|
920
|
-
|
|
921
|
-
#### 4.5.4 Tầng tích hợp API (API Integration Layer — port/adapter)
|
|
922
|
-
|
|
923
|
-
<!-- Cấu hình modal/route + bản đồ tích hợp API: mỗi method service client → một
|
|
924
|
-
endpoint THẬT từ §4.1 (đừng bịa endpoint). Lỗi → state UI theo từng SC.
|
|
925
|
-
Bảng này là thứ /generate-code --phase=integration đọc để wire adapter thật. -->
|
|
926
|
-
|
|
927
|
-
| Method client | Endpoint (§4.1) | Map request | Response → model | Lỗi → UI |
|
|
928
|
-
|---------------|-----------------|-------------|------------------|-----------|
|
|
929
|
-
| {svc.getX()} | {GET /…} | {params} | {DTO → ViewModel} | {4xx → state/toast} |
|
|
930
|
-
|
|
931
|
-
#### 4.5.5 Ánh xạ Figma → Design System
|
|
932
|
-
|
|
933
|
-
| Element Figma | Class/token design system | Ghi chú |
|
|
934
|
-
|---------------|---------------------------|-------|
|
|
935
|
-
| {element} | {class / token} | {size, màu, state} |
|
|
936
|
-
|
|
937
|
-
#### 4.5.6 Test Selectors — id element cho phần tử có action (hợp đồng QC)
|
|
938
|
-
|
|
939
|
-
<!-- Test-id ổn định cho mỗi element tương tác để QC định vị trực tiếp (không scan
|
|
940
|
-
runtime). Quy ước: {uc-lower}-{screen}-{element}-{type}; ĐỪNG nhúng số scenario.
|
|
941
|
-
Attribute theo platform: web data-testid · RN testID · Flutter Key/Semantics ·
|
|
942
|
-
iOS accessibilityIdentifier. Dùng lại CÙNG giá trị id trên web/app cho cùng một
|
|
943
|
-
element logic.
|
|
944
|
-
MỘT bảng dùng chung cho cả nhóm platform (phủ mọi màn hình/UC của platform này).
|
|
945
|
-
Cột "Phục vụ SC" mang (UC · SC) để consumer per-UC (generate-code / qc) lọc row
|
|
946
|
-
của mình qua §10. Nhóm §4.5 này vốn đã theo platform, nên platform là ngầm định
|
|
947
|
-
(khối web → web · SC). -->
|
|
948
|
-
|
|
949
|
-
| Test-ID | Element | Component (§4.5.1.x) | Action | Phục vụ SC (UC · SC) |
|
|
950
|
-
|---------|---------|----------------------|--------|---------------------|
|
|
951
|
-
| `{uc}-{screen}-{element}-{type}` | {Nút submit} | {Component} | {submit} | {UC1 · SC1, UC1 · SC3} |
|
|
952
|
-
|
|
953
|
-
---
|
|
954
|
-
|
|
955
|
-
## 5. Luồng chính (Key Flows — Sequence Diagrams)
|
|
956
|
-
|
|
957
|
-
<!-- MỘT mermaid sequence diagram cho mỗi scenario đáng kể. Participant xuyên tầng:
|
|
958
|
-
component client → service → API → API ngoài → DB.
|
|
959
|
-
⚠ id SC chỉ duy nhất trong phạm vi (UC × platform): `{UC}-SC1` ở `system` và
|
|
960
|
-
`{UC}-SC1` ở `web` là HAI scenario KHÁC nhau. Nên gom luồng vào các LANE PLATFORM
|
|
961
|
-
(5.A system · 5.B web · 5.C app) và LUÔN ghi kèm platform với SC, vd
|
|
962
|
-
"(web · UC1-SC1)". Đừng bao giờ viết "UC1-SC1" trơ ở đây — mơ hồ.
|
|
963
|
-
Chỉ đưa các lane có BDD tồn tại trong PRD này. -->
|
|
964
|
-
|
|
965
|
-
### 5.A Luồng System
|
|
966
|
-
|
|
967
|
-
<!-- Một diagram cho mỗi scenario system-BDD. Bỏ lane này nếu không có BDD system/. -->
|
|
968
|
-
|
|
969
|
-
#### 5.A.1 {tên} (system · {UC}-SC…)
|
|
970
|
-
|
|
971
|
-
```mermaid
|
|
972
|
-
sequenceDiagram
|
|
973
|
-
participant {A} as {Actor}
|
|
974
|
-
{…}
|
|
975
|
-
```
|
|
976
|
-
|
|
977
|
-
### 5.B Luồng Web
|
|
978
|
-
|
|
979
|
-
<!-- Một diagram cho mỗi scenario web-BDD. Bỏ lane này nếu không có BDD web/. -->
|
|
980
|
-
|
|
981
|
-
#### 5.B.1 {tên} (web · {UC}-SC…)
|
|
982
|
-
|
|
983
|
-
```mermaid
|
|
984
|
-
sequenceDiagram
|
|
985
|
-
{…}
|
|
986
|
-
```
|
|
987
|
-
|
|
988
|
-
### 5.C Luồng App
|
|
989
|
-
|
|
990
|
-
<!-- Một diagram cho mỗi scenario app-BDD. Bỏ lane này nếu không có BDD app/. -->
|
|
991
|
-
|
|
992
|
-
#### 5.C.1 {tên} (app · {UC}-SC…)
|
|
993
|
-
|
|
994
|
-
```mermaid
|
|
995
|
-
sequenceDiagram
|
|
996
|
-
{…}
|
|
997
|
-
```
|
|
998
|
-
|
|
999
|
-
<!-- Đánh số trong từng lane: 5.A.1, 5.A.2 … / 5.B.1 … / 5.C.1 …. Với scenario mà
|
|
1000
|
-
hiệu ứng lấn sang module khác, ghi "(covered by {OTHER-UC})". -->
|
|
1001
|
-
|
|
1002
|
-
**Điểm tích hợp chính (bảng tuỳ chọn cho mỗi luồng):**
|
|
1003
|
-
|
|
1004
|
-
| Bước | Chuyển trạng thái | Verify bởi (platform · SC) |
|
|
1005
|
-
|------|------------------|-----------------------------|
|
|
1006
|
-
| {bước} | {trước → sau} | {web · UC1-SC…} |
|
|
1007
|
-
|
|
1008
|
-
---
|
|
1009
|
-
|
|
1010
|
-
## 6. Điểm tích hợp (Integration Points)
|
|
1011
|
-
|
|
1012
|
-
| Tích hợp | Chiều | Phương thức | Mô tả |
|
|
1013
|
-
|-------------|-----------|--------|-------------|
|
|
1014
|
-
| {Client → API} | Outbound (client) | {REST/Bearer} | {gì} |
|
|
1015
|
-
| {API → Ngoài} | Outbound (server) | {REST + header} | {gì, cache TTL} |
|
|
1016
|
-
|
|
1017
|
-
### 6.1 Event Bus / Messaging
|
|
1018
|
-
|
|
1019
|
-
<!-- Event Kafka/queue mà feature này produce/consume. "N/A — no events" nếu không có. -->
|
|
1020
|
-
|
|
1021
|
-
{events, hoặc N/A}
|
|
1022
|
-
|
|
1023
|
-
### 6.2 Phụ thuộc Cross-Service (Cross-Service Dependencies)
|
|
1024
|
-
|
|
1025
|
-
| Service phụ thuộc | Cần gì | Contract | Trạng thái |
|
|
1026
|
-
|-------------------|---------------|----------|--------|
|
|
1027
|
-
| {service} | {cần} | {endpoint} | {✅ Có / ⚠️ pending} |
|
|
1028
|
-
|
|
1029
|
-
---
|
|
1030
|
-
|
|
1031
|
-
## 7. Bảo mật & Phân quyền (Security & Authorization)
|
|
1032
|
-
|
|
1033
|
-
### 7.1 Xác thực (Authentication)
|
|
1034
|
-
|
|
1035
|
-
{Luồng auth + loại token/TTL. Nguồn: auth PRD + rule dự án.}
|
|
1036
|
-
|
|
1037
|
-
### 7.2 Quy tắc Phân quyền (Authorization Rules)
|
|
1038
|
-
|
|
1039
|
-
| Action | Role/quyền yêu cầu | Mô tả | Trace |
|
|
1040
|
-
|--------|--------------------------|-------------|-------|
|
|
1041
|
-
| {action} | {role} | {enforce thế nào, ở đâu} | {UC1-SC… / ngoài phạm vi} |
|
|
1042
|
-
|
|
1043
|
-
---
|
|
1044
|
-
|
|
1045
|
-
## 8. Xử lý lỗi & Trường hợp biên (Error Handling & Edge Cases)
|
|
1046
|
-
|
|
1047
|
-
<!-- Một row cho mỗi scenario lỗi / biên / âm trong BDD. Phải khớp với mã lỗi §4.3
|
|
1048
|
-
và các sequence diagram lỗi §5. -->
|
|
1049
|
-
|
|
1050
|
-
| Scenario | Chiến lược | Chi tiết | Trace |
|
|
1051
|
-
|----------|----------|---------|-------|
|
|
1052
|
-
| {điều kiện} | {cách xử lý} | {hành vi, message, side effect} | {UC1-SC…, BR…} |
|
|
1053
|
-
|
|
1054
|
-
---
|
|
1055
|
-
|
|
1056
|
-
## 9. Quyết định Thiết kế (Design Decisions)
|
|
1057
|
-
|
|
1058
|
-
<!-- Cái "vì sao" đằng sau các lựa chọn không hiển nhiên, kèm phương án đã cân nhắc.
|
|
1059
|
-
Nguồn: alternatives/assumptions của PRD + lập luận lúc sinh. Đây là thứ giúp
|
|
1060
|
-
reviewer tin tưởng thiết kế. -->
|
|
1061
|
-
|
|
1062
|
-
| # | Quyết định | Lý do | Phương án đã cân nhắc |
|
|
1063
|
-
|---|----------|-----------|-------------------------|
|
|
1064
|
-
| 1 | **{quyết định}** | {vì sao} | {phương án — vì sao loại} |
|
|
1065
|
-
|
|
1066
|
-
### Ánh xạ NFR → Thiết kế (NFR-to-Design Mapping)
|
|
1067
|
-
|
|
1068
|
-
| Nhóm NFR | Yêu cầu PRD | Quyết định thiết kế |
|
|
1069
|
-
|--------------|-----------------|-----------------|
|
|
1070
|
-
| {vd Cách ly multi-tenant} | {yêu cầu} | {cơ chế} |
|
|
1071
|
-
|
|
1072
|
-
---
|
|
1073
|
-
|
|
1074
|
-
## 10. Độ phủ UC (UC Coverage)
|
|
1075
|
-
|
|
1076
|
-
<!-- ĐIỂM NEO ĐỂ APPEND **và là MỤC LỤC cho consumer per-UC**. Mọi UC của PRD có một
|
|
1077
|
-
row; mọi scenario map tới (các) section thiết kế nó.
|
|
1078
|
-
- /generate-tech-docs dùng nó để phát hiện cái gì đã phủ vs còn thiếu.
|
|
1079
|
-
- /generate-code, /map-testids, /qc-* làm việc trên MỘT UC của doc cấp-PRD — chúng
|
|
1080
|
-
tra UC này Ở ĐÂY trước để định vị scenario của nó → các section/lane-§5 (và do đó
|
|
1081
|
-
các endpoint §4.1 mà luồng §5 của nó gọi) thuộc về nó. Đừng lấy
|
|
1082
|
-
endpoint/section của UC khác.
|
|
1083
|
-
⚠ Độ phủ scenario khoá theo (platform, SC) vì id SC lặp giữa các platform —
|
|
1084
|
-
cột Platform để phân biệt. -->
|
|
1085
|
-
|
|
1086
|
-
| UC | Feature | Platforms | Section phủ | Trạng thái |
|
|
1087
|
-
|----|---------|-----------|------------------|--------|
|
|
1088
|
-
| {TICKET-ID}-UC1 | {title} | {system, web, app} | §… | ✅ Covered |
|
|
1089
|
-
|
|
1090
|
-
### Độ phủ Scenario UC1
|
|
1091
|
-
|
|
1092
|
-
<!-- Một row cho mỗi (platform, SC). Cùng số SC ở platform khác nhau = scenario khác
|
|
1093
|
-
nhau → row riêng. -->
|
|
1094
|
-
|
|
1095
|
-
| Platform | Scenario | Section | Business rule |
|
|
1096
|
-
|----------|----------|---------|---------------|
|
|
1097
|
-
| system | {UC}-SC1: {tên} | §5.A.1 | {BR…} |
|
|
1098
|
-
| web | {UC}-SC1: {tên} | §4.5 (web), §5.B.1 | {BR…} |
|
|
1099
|
-
|
|
1100
|
-
<!-- Lặp một khối scenario-coverage cho mỗi UC. -->
|
|
1101
|
-
|
|
1102
|
-
---
|
|
1103
|
-
|
|
1104
|
-
## 11. Cross-cutting & Giả định (Tham chiếu ngoài phạm vi)
|
|
1105
|
-
|
|
1106
|
-
<!-- Các mối lo upstream mà PRD này PHỤ THUỘC VÀO nhưng không implement (cổng admin,
|
|
1107
|
-
UI downstream ở module khác, snapshot đơn hàng…). Giữ để có bối cảnh liên team.
|
|
1108
|
-
Tham chiếu UC/team sở hữu + doc. Nguồn: out-of-scope của PRD + ghi chú BR
|
|
1109
|
-
"out of scope" trong BDD. -->
|
|
1110
|
-
|
|
1111
|
-
### 11.1 {Mối lo}
|
|
1112
|
-
|
|
1113
|
-
> {Trích câu BDD/PRD đã scope nó ra ngoài.}
|
|
1114
|
-
|
|
1115
|
-
{Giải thích ranh giới + một sequence diagram tham chiếu nếu hữu ích.}
|
|
1116
|
-
|
|
1117
|
-
**Sở hữu bởi:** {team / module}. Xem {link}.
|
|
1118
|
-
|
|
1119
|
-
---
|
|
1120
|
-
|
|
1121
|
-
## 12. GAP Register — ẩn số thiết kế chưa chốt
|
|
1122
|
-
|
|
1123
|
-
<!--
|
|
1124
|
-
Mọi [GAP: Gn] / [ASSUMPTION: An] đánh dấu inline trong doc PHẢI có đúng MỘT dòng ở đây
|
|
1125
|
-
(và ngược lại — không marker mồ côi, không dòng thừa). Đây là sổ quản lý vòng đời ẩn số.
|
|
1126
|
-
|
|
1127
|
-
- Loại:
|
|
1128
|
-
• nội tại — BE tự quyết (đóng: BE điền giá trị, thay marker)
|
|
1129
|
-
• cross-service — cần team/partner khác (đóng: qua T7 sign-off của owner)
|
|
1130
|
-
• spec-defect — BDD/PRD sai/thiếu (KHÔNG tự đóng: escalate PO sửa .feature/PRD → regen; xem §9 Conflict)
|
|
1131
|
-
- Severity:
|
|
1132
|
-
• 🔴 blocker — code BẮT BUỘC phải có mới đúng → CHẶN approve
|
|
1133
|
-
• 🟢 non-blocker — đoán tạm chạy được, chỉ cần confirm → không chặn
|
|
1134
|
-
(Nhãn GAP/ASSUMPTION KHÔNG tự quyết severity — một ASSUMPTION vẫn có thể là blocker nếu đoán sai sẽ vỡ.)
|
|
1135
|
-
- Status: open → resolved (owner điền giá trị thật → thay marker inline → bump @trace.revision).
|
|
1136
|
-
|
|
1137
|
-
GATE: còn ≥1 🔴 blocker ở trạng thái `open` → @trace.status KHÔNG được lên `approved`
|
|
1138
|
-
(giữ `in-review`) → generate-code bị chặn. Cùng pattern design-spec giữ `draft` khi còn ❌ Missing.
|
|
1139
|
-
-->
|
|
1140
|
-
|
|
1141
|
-
| id | Dùng ở (§) | Điều chưa biết | Loại | Owner confirm | Severity | Status | Đóng thế nào |
|
|
1142
|
-
|----|-----------|----------------|------|---------------|----------|--------|--------------|
|
|
1143
|
-
| G1 | {§4.3} | {shape lỗi khi partner từ chối} | cross-service | {team-payment} | 🔴 blocker | open | {T7 sign-off — owner cung cấp contract} |
|
|
1144
|
-
| A1 | {§4.1} | {timeout mặc định 30s} | nội tại | {BE lead} | 🟢 non-blocker | open | {BE xác nhận, thay giá trị} |
|
|
1145
|
-
|
|
1146
|
-
> Nếu doc **không có** ẩn số nào → ghi "Không có — mọi thiết kế đều có nguồn." **KHÔNG** bịa dòng để lấp trống.
|
|
1147
|
-
|
|
1148
|
-
---
|
|
1149
|
-
|
|
1150
|
-
## Tham chiếu Thiết kế Figma (Figma Design References)
|
|
1151
|
-
|
|
1152
|
-
<!-- @figma.url: {url figma cấp node cho mỗi màn hình} -->
|
|
1153
|
-
- {Screen}: [Figma — {frame}]({url})
|
|
1154
|
-
- Exported: {YYYY-MM-DD}
|
|
1155
|
-
|
|
1156
|
-
---
|
|
1157
|
-
|
|
1158
|
-
## Changelog
|
|
1159
|
-
|
|
1160
|
-
| Revision | Ngày | Thay đổi |
|
|
1161
|
-
|----------|------|---------|
|
|
1162
|
-
| 1 | {YYYY-MM-DD} | Sinh lần đầu từ BDD {TICKET-ID} (v{bdd_version}): {liệt kê UC đã phủ} |
|
|
1163
|
-
<!-- Khi append: thêm một row cho mỗi lần mở rộng, vd "2 | {ngày} | Thêm UC3 (§5.9, §10) từ BDD mới v{n}" -->
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
---
|
|
1167
|
-
|
|
1168
|
-
## Self-Review Gate — REFUTE trước khi ghi *(bắt buộc; chạy cả Fresh lẫn Append)*
|
|
1169
|
-
|
|
1170
|
-
Trước khi finalize/append doc, **tự phản biện bản nháp** qua 4 cổng dưới — không phải "sinh rồi tin", mà "sinh rồi ĐỐI CHIẾU với ngữ cảnh rộng hơn + khai GAP tường minh". Nguyên tắc nền: **Completeness ≠ Coverage** — "mọi SC được map" là *cần*, KHÔNG *đủ*; trung thành với lát BDD trước mặt không phải là đúng khi nó chỉ là một lát cắt. Cổng nào không đạt → **sửa, hoặc khai `[GAP]` / `[ASSUMPTION: {owner} confirm]` ngay tại chỗ trong doc** — TUYỆT ĐỐI không bỏ trắng, không bịa lặng.
|
|
1171
|
-
|
|
1172
|
-
**Cổng 1 — RECONCILE (đối chiếu chéo, đọc-ngược CÓ GIỚI HẠN).**
|
|
1173
|
-
Đọc-ngược **bounded** — chỉ 3 nguồn này, KHÔNG kéo toàn bộ BDD của PRD (giữ batch nhỏ):
|
|
1174
|
-
- **PRD Business Rules** của UC → mọi BR có được §3/§4/§5 phản ánh? Nguồn/sự kiện nào BR yêu cầu mà doc thiếu → thêm, hoặc `[GAP]`.
|
|
1175
|
-
- **core-entities.md** → mỗi enum/trạng thái doc dùng có **producer** (ai sinh ra giá trị)? Mỗi cột/field có **writer** (luồng nào set)? Enum mồ côi / cột không writer → sửa hoặc flag.
|
|
1176
|
-
- **Seam UC anh em cùng domain** (chỉ endpoint/entity giao nhau) → không định nghĩa lại contract đã có ở UC khác; không tự mâu thuẫn enum mình vừa viết trong chính doc này.
|
|
1177
|
-
|
|
1178
|
-
**Cổng 2 — GAP-or-FLAG (trung thực, không bịa).**
|
|
1179
|
-
Cần một type/giá trị/policy (auth, config, event, error code) mà **không có nguồn** → **không** chép hình dạng ở boundary, **không** bịa: ghi `[GAP]` hoặc `[ASSUMPTION: {owner} confirm]`. Nếu doc định thiết kế endpoint/flow mà **BDD không định nghĩa nghiệp vụ** (design vượt BDD) → khai GAP + escalate, đừng âm thầm hợp thức hoá.
|
|
1180
|
-
|
|
1181
|
-
**Cổng 2b — Client integration (§4.5.4) cũng phải đủ, không chỉ contract BE.** Với MỖI client method mà một màn hình/UC cần, §4.5.4 phải map đủ: **endpoint thật ở §4.1 · nguồn field request/response · error→UI**. Bất kỳ mảnh nào không suy được từ nguồn → khai `[GAP]` + một dòng §12 (đừng để §4.5.4 khuyết một phần rồi lọt xuống `/generate-code --phase=integration` — đó chính là chỗ FE bị hỏi live). **Severity blocker (🔴)** nếu màn hình không render/hoạt động được khi thiếu mapping đó (→ giữ `@trace.status: in-review`, chặn code-gen tới khi đóng); non-blocker (🟢) nếu chỉ là chi tiết phụ đoán tạm được. Đối xứng với contract BE: front-load ẩn số client về tech-docs, đừng đẩy sang lúc wire adapter.
|
|
1182
|
-
|
|
1183
|
-
**Cổng 3 — CATALOG (không hard-code).**
|
|
1184
|
-
Literal & constant rải rác như luật → gom lại: **generic envelope** (đừng typed-per-thing khi PRD-BR đã đưa hợp đồng chung) + bảng catalog (vd `signal_type × source`) + constants **đặt tên**. Fail nếu còn hằng số/enum inline chưa vào catalog.
|
|
1185
|
-
|
|
1186
|
-
**Cổng 4 — CROSS-SERVICE & COMPLETENESS.**
|
|
1187
|
-
- **Ranh giới:** không kéo định danh **nội bộ** service khác vào lookup của mình — dùng abstraction tầng mình. Tương tác 2 service: nói rõ **bên nào own dedup/ordering** + có **ack path** + cross-field invariant.
|
|
1188
|
-
|
|
1189
|
-
> **Thuật ngữ (đọc nhanh):**
|
|
1190
|
-
> - **dedup** (khử trùng) — cùng một event/message tới **≥2 lần** thì chỉ được xử lý **một** lần (thường qua *idempotency key*). Thiếu → cộng đôi, ghi đôi.
|
|
1191
|
-
> - **ordering** (thứ tự) — event tới **đúng trình tự** phát ra; nếu có thể tới lệch thì chốt: bên nào sắp lại, hay bên nhận phải **chịu được** lệch. Thiếu → state sai (vd "hết hạn" xử lý trước "tạo mới").
|
|
1192
|
-
> - **ack path** (đường xác nhận) — bên nhận xử lý xong **báo lại** bên gửi ("đã nhận/đã xử lý") để bên gửi ngừng gửi lại. Thiếu → mất event, hoặc gửi lại vô hạn.
|
|
1193
|
-
> - **cross-field invariant** — ràng buộc phải **luôn đúng** giữa nhiều field/entity (vd `tổng các phần = tổng`, `trạng thái = paid ⇒ paid_at ≠ null`).
|
|
1194
|
-
- **Không happy-only:** mỗi API/flow phải **xét đủ** nhánh happy + partial + error + rollback, kể cả khi BDD chỉ tả happy. Thiết kế nhánh lỗi **từ nguồn** (PRD-BR về xử lý thất bại · pattern rollback ở CLAUDE.md §2 · chuyển-trạng-thái entity ở core-entities). Chi tiết nào **không suy được từ nguồn** (error code/shape của service khác, quyết định retry-hay-fail…) → **khai `[GAP]`, KHÔNG bịa** (Cổng 2). *Bắt buộc CÓ nhánh lỗi ≠ bịa NỘI DUNG nhánh lỗi.*
|
|
1195
|
-
- **Đủ chi tiết hàm:** hàm cốt lõi tả **điều kiện chọn / nhánh / kết quả**, không dừng ở tên hàm + sequence-diagram.
|
|
1196
|
-
|
|
1197
|
-
**Ghi sổ + cổng chặn (bắt buộc khi có GAP).** Mỗi `[GAP: Gn]`/`[ASSUMPTION: An]` khai inline PHẢI có đúng **một** dòng ở **§12 GAP Register** (không marker mồ côi), gán:
|
|
1198
|
-
- **Loại**: `nội tại` (BE tự quyết) · `cross-service` (team/partner khác — đóng qua T7 sign-off) · `spec-defect` (BDD/PRD sai → escalate PO, xem Conflict register dưới).
|
|
1199
|
-
- **Severity**: 🔴 `blocker` (code bắt buộc phải có mới đúng) · 🟢 `non-blocker` (đoán tạm chạy được, cần confirm). Nhãn GAP/ASSUMPTION **không** tự quyết severity — một ASSUMPTION vẫn có thể là blocker.
|
|
1200
|
-
- **Owner** phải confirm + **Status** = `open`.
|
|
1201
|
-
|
|
1202
|
-
Nếu §12 còn **≥1 🔴 blocker `open`** → set `@trace.status: in-review` (KHÔNG để `approved`) — `generate-code` bị chặn tới khi đóng hết blocker. (Cùng pattern design-spec giữ `draft` khi còn ❌ Missing.) Nếu 0 ẩn số → §12 ghi "Không có", đừng bịa dòng.
|
|
1203
|
-
|
|
1204
|
-
> **Conflict register:** nếu BDD **mâu thuẫn** một invariant kiến trúc (CLAUDE.md §2 / core-entities) → ghi vào §9 Design Decisions như **conflict cần PO sửa `.feature`** (và một dòng §12 loại `spec-defect`), KHÔNG tự quyết, KHÔNG lặng chép.
|
|
1205
|
-
|
|
1206
|
-
> **Guardrail nguồn:** 4 cổng này phản chiếu `project-lessons` **L-012** (nếu project có) — nạp ở context-loader Bước 6.7 như ràng buộc cứng, sống sót qua `/update-framework`. Cổng ở đây là lớp framework; L-012 là lớp project-local; cả hai cùng hiệu lực. `/review-tech-docs` **T8/T9** bắt lại ở cổng review nếu gen bỏ lọt.
|
|
1207
|
-
|
|
1208
|
-
Ghi số `[GAP]`/`[ASSUMPTION]` đã khai vào report Output.
|
|
1209
|
-
|
|
1210
|
-
---
|
|
1211
|
-
|
|
1212
|
-
## Công bố — chia sẻ doc (umbrella + spec repo dùng chung)
|
|
1213
|
-
|
|
1214
|
-
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 được ghi **bên trong spec submodule**. Công bố nó (commit 2 tầng) để cả team đọc qua `/sync` — tech design gộp per-PRD này là blueprint liên team (API contract cho BE, client design cho FE/App):
|
|
1215
|
-
|
|
1216
|
-
```bash
|
|
1217
|
-
cd {spec_source}
|
|
1218
|
-
git add {output_path} # {TICKET-ID}-tech-design.md
|
|
1219
|
-
git commit -m "docs({TICKET-ID}): full-stack technical design ({mode})"
|
|
1220
|
-
git push origin {spec_branch} # branch teammate theo dõi trong .gitmodules
|
|
1221
|
-
cd -
|
|
1222
|
-
git add {spec_source} && git commit -m "chore: bump spec pointer ({TICKET-ID} tech design)"
|
|
1223
|
-
```
|
|
1224
|
-
|
|
1225
|
-
Nếu `tech_docs_dir` là **local** — tức không có `setup.spec_source` (single-repo, hoặc một BE repo đ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.
|
|
1226
|
-
|
|
1227
|
-
## Output
|
|
1228
|
-
|
|
1229
|
-
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
1230
|
-
|
|
1231
|
-
Mọi report của lệnh phải kết thúc bằng section footer chuẩn này.
|
|
1232
|
-
|
|
1233
|
-
## Status Badge
|
|
1234
|
-
|
|
1235
|
-
Chọn một theo kết quả:
|
|
1236
|
-
- `✅ Complete` — mọi bước thành công, không có vấn đề
|
|
1237
|
-
- `❌ Failed` — lệnh không hoàn thành được do lỗi chặn
|
|
1238
|
-
- `⚠️ Warnings` — hoàn thành nhưng có vấn đề không chặn, nên review lại
|
|
1239
|
-
|
|
1240
|
-
## Output Artifacts
|
|
1241
|
-
|
|
1242
|
-
Liệt kê mọi file được tạo hoặc sửa bởi lệnh này:
|
|
1243
|
-
```
|
|
1244
|
-
Output Artifacts:
|
|
1245
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
1246
|
-
{created|updated} {file-path} ({mô tả ngắn})
|
|
1247
|
-
```
|
|
1248
|
-
|
|
1249
|
-
Nếu không ghi file nào (vd: lệnh review hoặc phân tích) → ghi `Output Artifacts: none (read-only)`.
|
|
1250
|
-
|
|
1251
|
-
## Pipeline Position
|
|
1252
|
-
|
|
1253
|
-
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`,
|
|
1254
|
-
để người dùng luôn thấy lệnh này nằm ở đâu trong luồng end-to-end:
|
|
1255
|
-
|
|
1256
|
-
```
|
|
1257
|
-
Discovery → PRD → [Design Spec] → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
1258
|
-
```
|
|
1259
|
-
|
|
1260
|
-
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:
|
|
1261
|
-
|
|
1262
|
-
| Phase | Commands |
|
|
1263
|
-
|-------|----------|
|
|
1264
|
-
| Discovery | `/define-product` |
|
|
1265
|
-
| PRD | `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
1266
|
-
| Design Spec | `/generate-design-spec` |
|
|
1267
|
-
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
1268
|
-
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
1269
|
-
| Code | `/generate-code` · `/review-code` |
|
|
1270
|
-
| Dev Self-Check | `/dev-gen-test` · `/dev-run-test` · `/dev-smoke-test` |
|
|
1271
|
-
| QC | `/qc-analyze` · `/qc-plan` · `/qc-design-test` · `/qc-review` · `/qc-run-test` · `/qc-report` |
|
|
1272
|
-
| Trace Audit | `/validate-traces` |
|
|
1273
|
-
|
|
1274
|
-
Với **lệnh review**, thêm vòng review 3 bước và đánh dấu bước hiện tại, vd:
|
|
1275
|
-
`Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume`.
|
|
1276
|
-
|
|
1277
|
-
**Lệnh xuyên suốt** (`/sync`, `/update-framework`, `/fix-bug`, `/debug`, `/learn`,
|
|
1278
|
-
`/report-bug`, `/propose-scenario`, `/generate-spec-manifest`) nằm ngoài pipeline tuyến tính —
|
|
1279
|
-
**bỏ hẳn dòng Pipeline** cho các lệnh này (đừng cố nhét chúng vào sơ đồ).
|
|
1280
|
-
|
|
1281
|
-
## Gợi ý lệnh tiếp theo
|
|
1282
|
-
|
|
1283
|
-
Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
1284
|
-
|
|
1285
|
-
| Lệnh hiện tại | Gợi ý lệnh tiếp theo |
|
|
1286
|
-
|-------------------------|-----------------------------------------------|
|
|
1287
|
-
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
1288
|
-
| /define-product | `/generate-prd {product-definition-file}` |
|
|
1289
|
-
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
1290
|
-
| /extend-prd | `/refine-prd {prd-file}` (soi phần vừa thêm) rồi `/review-context {prd-file}` → PO duyệt → `/generate-bdd` **chỉ cho UC MỚI**; UC cũ dùng `/validate-traces --realign-prd-version {UC-ID}` |
|
|
1291
|
-
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
1292
|
-
| /review-context (PRD) | Khi 0 critical → PO đặt `Status: approved`, rồi FE/App: `/generate-design-spec {prd-file}` (→ design sign-off → BDD); BE: `/generate-bdd {prd-file}`. Còn critical/NEEDS_FIX → sửa PRD (giữ draft) |
|
|
1293
|
-
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
1294
|
-
| /generate-bdd | `/review-context {feature-file}` để kiểm tra độ phủ |
|
|
1295
|
-
| /review-context (BDD) | `/generate-tech-docs {UC-ID}` nếu APPROVED; sinh lại nếu NEEDS_FIX |
|
|
1296
|
-
| /qc-analyze | `/qc-plan {UC-ID}` (xử lý các gap blocker 🔴 trước) |
|
|
1297
|
-
| /qc-plan | `/qc-design-test {UC-ID}` |
|
|
1298
|
-
| /qc-design-test | `/qc-review {UC-ID}` (review test-case) |
|
|
1299
|
-
| /qc-review (test-case) | `/qc-run-test {UC-ID}` nếu APPROVED; sửa TC nếu NEEDS_FIX |
|
|
1300
|
-
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
1301
|
-
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
1302
|
-
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
1303
|
-
| /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
|
|
1304
|
-
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
1305
|
-
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
1306
|
-
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
1307
|
-
| /dev-gen-test | `/dev-run-test {UC-ID}` |
|
|
1308
|
-
| /dev-run-test (passing) | `/review-code {UC-ID}` |
|
|
1309
|
-
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
1310
|
-
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
1311
|
-
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
1312
|
-
| /validate-traces | **Cờ 🔴 trước (chặn PR):** SEAM_UNWIRED → nối binding sang class thật, xoá/thay stub · STUB_UNRESOLVED → `/generate-code {owner_uc}` (lấp logic tại chỗ + xoá hàm song song) · ORPHANED/TRACE_ORPHAN → quyết định thủ công (xoá code+test, đưa scenario trở lại `.feature`, hoặc sửa `sc_id` của tag). **Rồi:** DRIFT/UNTRACKED → `/generate-code {UC-ID}` · BDD_DRIFT → `/generate-code {feature-file}` · tech-doc lỗi thời vs BDD → `/generate-tech-docs` → `/review-tech-docs` · PRD drift → `/generate-bdd {prd-file}` · GAP → `/dev-gen-test {UC-ID}`. **Chỉ tạo PR khi mọi cờ 🔴 = 0** |
|
|
1313
|
-
| /fix-bug | `/dev-run-test {UC-ID}` (dev_selftest vừa reset về not_run) → tạo PR; nếu fix một `{BUG-ID}` → QC chạy `/qc-run-test {UC-ID}` để verify + đóng bug |
|
|
1314
|
-
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
1315
|
-
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
1316
|
-
| /propose-scenario | **Case A** (thiếu scenario cho AC có sẵn) → báo PO/Dev review trong `feedback/bdd-proposals/`; `/generate-bdd` tự chèn khi `Status: accepted`. **Case B** (requirement mới) → `feedback/prd-change-requests/` — PO phải đưa vào PRD trước, KHÔNG tự vào BDD được; `/validate-traces` nhắc lại kèm số ngày chờ chừng nào `Status: Open` |
|
|
1317
|
-
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
1318
|
-
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
1319
|
-
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
1320
|
-
|
|
1321
|
-
Định dạng footer như sau:
|
|
1322
|
-
```
|
|
1323
|
-
---
|
|
1324
|
-
Status : {badge}
|
|
1325
|
-
{khối Output Artifacts}
|
|
1326
|
-
Pipeline : Discovery → PRD → [BDD ◀ bạn ở đây] → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
1327
|
-
(lệnh review) Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
1328
|
-
Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
1329
|
-
```
|
|
1330
|
-
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
```
|
|
1334
|
-
/generate-tech-docs hoàn tất — {TICKET-ID} (tech design full-stack, {mode})
|
|
1335
|
-
File: {output_path}
|
|
1336
|
-
Lần này: {UC/platform của batch đã thiết kế} | Doc giờ phủ: {mọi UC trong §10}
|
|
1337
|
-
Self-review: {n} [GAP]/[ASSUMPTION] đã khai ← resolve/confirm với owner trước khi /review-tech-docs
|
|
1338
|
-
Next: /review-tech-docs {output_path}
|
|
1339
|
-
← cần SA/Lead review trước khi sinh code
|
|
1340
|
-
→ nếu sống trong spec repo dùng chung: commit + push spec submodule (xem Công bố ở trên) để teammate đọc qua /sync
|
|
1341
|
-
→ sau khi approved:
|
|
1342
|
-
BE → /generate-code {system .feature}
|
|
1343
|
-
FE → /generate-code {web|app .feature} --phase=integration (wire API thật theo §4.5.4 của doc này)
|
|
1344
|
-
```
|