@educa-corp/sdd-framework 0.4.0 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/build.js +9 -0
- package/bin/index.js +115 -4
- package/bin/self-check.js +236 -0
- package/bin/trace-schema.json +692 -0
- package/commands/debug.md +16 -10
- package/commands/define-product.md +16 -10
- package/commands/dev-gen-test.md +16 -10
- package/commands/dev-run-test.md +18 -11
- package/commands/dev-run-test.tmpl +2 -1
- package/commands/dev-smoke-test.md +16 -10
- package/commands/fix-bug.md +71 -13
- package/commands/fix-bug.tmpl +29 -3
- package/commands/generate-architecture.md +16 -10
- package/commands/generate-bdd.md +118 -35
- package/commands/generate-bdd.tmpl +89 -15
- package/commands/generate-code.md +49 -13
- package/commands/generate-code.tmpl +33 -3
- package/commands/generate-design-spec.md +16 -10
- package/commands/generate-prd.md +16 -10
- package/commands/generate-spec-manifest.md +16 -10
- package/commands/generate-tech-docs.md +19 -13
- package/commands/generate-tech-docs.tmpl +2 -2
- package/commands/learn.md +16 -10
- package/commands/map-testids.md +16 -10
- package/commands/propose-scenario.md +36 -12
- package/commands/propose-scenario.tmpl +20 -2
- package/commands/qc-analyze.md +16 -10
- package/commands/qc-design-test.md +16 -10
- package/commands/qc-plan.md +16 -10
- package/commands/qc-report.md +16 -10
- package/commands/qc-review.md +16 -10
- package/commands/qc-run-test.md +38 -12
- package/commands/qc-run-test.tmpl +22 -2
- package/commands/refine-prd.md +16 -10
- package/commands/report-bug.md +16 -10
- package/commands/review-code.md +56 -12
- package/commands/review-code.tmpl +40 -2
- package/commands/review-context.md +58 -14
- package/commands/review-context.tmpl +42 -4
- package/commands/review-tech-docs.md +47 -12
- package/commands/review-tech-docs.tmpl +31 -2
- package/commands/setup-ai-first.md +23 -14
- package/commands/setup-ai-first.tmpl +7 -4
- package/commands/sync.md +3 -2
- package/commands/update-framework.md +40 -2
- package/commands/update-framework.tmpl +37 -0
- package/commands/validate-traces.md +165 -18
- package/commands/validate-traces.tmpl +149 -8
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/README.md +56 -0
- package/core/commands/debug.md +16 -10
- package/core/commands/define-product.md +16 -10
- package/core/commands/dev-gen-test.md +16 -10
- package/core/commands/dev-run-test.md +18 -11
- package/core/commands/dev-smoke-test.md +16 -10
- package/core/commands/fix-bug.md +71 -13
- package/core/commands/generate-architecture.md +16 -10
- package/core/commands/generate-bdd.md +118 -35
- package/core/commands/generate-code.md +49 -13
- package/core/commands/generate-design-spec.md +16 -10
- package/core/commands/generate-prd.md +16 -10
- package/core/commands/generate-spec-manifest.md +16 -10
- package/core/commands/generate-tech-docs.md +19 -13
- package/core/commands/learn.md +16 -10
- package/core/commands/map-testids.md +16 -10
- package/core/commands/propose-scenario.md +36 -12
- package/core/commands/qc-analyze.md +16 -10
- package/core/commands/qc-design-test.md +16 -10
- package/core/commands/qc-plan.md +16 -10
- package/core/commands/qc-report.md +16 -10
- package/core/commands/qc-review.md +16 -10
- package/core/commands/qc-run-test.md +38 -12
- package/core/commands/refine-prd.md +16 -10
- package/core/commands/report-bug.md +16 -10
- package/core/commands/review-code.md +56 -12
- package/core/commands/review-context.md +58 -14
- package/core/commands/review-tech-docs.md +47 -12
- package/core/commands/setup-ai-first.md +23 -14
- package/core/commands/sync.md +3 -2
- package/core/commands/update-framework.md +40 -2
- package/core/commands/validate-traces.md +165 -18
- package/core/modules/android-compose/stack-profile.yaml +1 -1
- package/core/modules/flutter/stack-profile.yaml +1 -1
- package/core/modules/ios-swiftui/stack-profile.yaml +1 -1
- package/core/modules/java-spring/stack-profile.yaml +1 -1
- package/core/modules/nextjs/stack-profile.yaml +1 -1
- package/core/modules/nuxt/stack-profile.yaml +1 -1
- package/core/modules/phaser-game/stack-profile.yaml +1 -1
- package/core/modules/php-laravel/stack-profile.yaml +1 -1
- package/core/modules/qc-playwright/stack-profile.yaml +1 -1
- package/core/modules/react/stack-profile.yaml +1 -1
- package/core/modules/react-native/stack-profile.yaml +1 -1
- package/core/modules/vue/stack-profile.yaml +1 -1
- package/core/rules/workflow.md +11 -0
- package/core/steps/gate.md +13 -8
- package/core/steps/report-footer.md +3 -2
- package/core/templates/README.md +47 -0
- package/core/templates/feature.template +13 -10
- package/core/templates/project-context.yaml +26 -14
- package/core/templates/tech-design.template.md +1 -1
- package/docs/02-concepts/traceability.md +29 -6
- package/docs/04-reference/trace-schema.md +128 -37
- package/modules/android-compose/stack-profile.yaml +1 -1
- package/modules/flutter/stack-profile.yaml +1 -1
- package/modules/ios-swiftui/stack-profile.yaml +1 -1
- package/modules/java-spring/stack-profile.yaml +1 -1
- package/modules/nextjs/stack-profile.yaml +1 -1
- package/modules/nuxt/stack-profile.yaml +1 -1
- package/modules/phaser-game/stack-profile.yaml +1 -1
- package/modules/php-laravel/stack-profile.yaml +1 -1
- package/modules/qc-playwright/stack-profile.yaml +1 -1
- package/modules/react/stack-profile.yaml +1 -1
- package/modules/react-native/stack-profile.yaml +1 -1
- package/modules/vue/stack-profile.yaml +1 -1
- package/package.json +50 -49
- package/rules/workflow.md +11 -0
- package/scripts/migrate-bdd-platform.js +286 -0
- package/steps/gate.md +13 -8
- package/steps/report-footer.md +3 -2
- package/templates/README.md +47 -0
- package/templates/feature.template +13 -10
- package/templates/project-context.yaml +26 -14
- package/templates/tech-design.template.md +1 -1
package/core/rules/workflow.md
CHANGED
|
@@ -18,6 +18,17 @@
|
|
|
18
18
|
- Do NOT create files outside the directories specified in `project-context.yaml → paths`.
|
|
19
19
|
- If new scope is discovered mid-command, STOP and ask: "I found additional scope [{description}]. Should I include it? (Y/N)"
|
|
20
20
|
|
|
21
|
+
## Trace Contract
|
|
22
|
+
|
|
23
|
+
- Contract trace (field `@trace.*`, cột `.tsv`, path pattern, giá trị enum) có **một
|
|
24
|
+
nguồn-sự-thật máy đọc**: `bin/trace-schema.json`. Bản cho người đọc:
|
|
25
|
+
`docs/04-reference/trace-schema.md` — giữ hai file đồng bộ.
|
|
26
|
+
- Đổi contract (thêm/bỏ/đổi nghĩa một field, path, hay giá trị enum) → **sửa
|
|
27
|
+
`bin/trace-schema.json` TRƯỚC**, rồi mới sửa lệnh. `npm run build` chạy
|
|
28
|
+
`bin/self-check.js` và **fail** nếu lệnh lệch schema.
|
|
29
|
+
- Field có consumer mà **không có producer** là lỗi chặn build — đó chính là hình dạng
|
|
30
|
+
của G1 (`@trace.sc_version`: 3 consumer, 0 producer, DRIFT chết mà không ai báo).
|
|
31
|
+
|
|
21
32
|
## Code Generation
|
|
22
33
|
|
|
23
34
|
- Never generate code for files not backed by a `.feature` spec (unless `/fix-bug` or `/debug`).
|
package/core/steps/gate.md
CHANGED
|
@@ -29,23 +29,23 @@ Hiển thị và chờ phản hồi:
|
|
|
29
29
|
```
|
|
30
30
|
⚙️ MODEL CHECK
|
|
31
31
|
──────────────────────────────────────────────────────────────────
|
|
32
|
-
Recommended :
|
|
32
|
+
Recommended : model Opus mới nhất
|
|
33
33
|
Why needed : Phân tích spec, review kiến trúc, sinh code đòi hỏi
|
|
34
|
-
suy luận sâu. Model nhỏ hơn dễ bỏ sót edge case.
|
|
34
|
+
suy luận sâu. Model nhỏ hơn (Haiku/Sonnet) dễ bỏ sót edge case.
|
|
35
35
|
|
|
36
36
|
Cách đổi trong Claude Code:
|
|
37
|
-
•
|
|
38
|
-
• hoặc:
|
|
37
|
+
• /model → chọn model Opus
|
|
38
|
+
• hoặc: Settings → Model
|
|
39
39
|
|
|
40
|
-
Đang chạy
|
|
41
|
-
Y — đúng
|
|
40
|
+
Đang chạy một model Opus?
|
|
41
|
+
Y — đúng → tiếp tục
|
|
42
42
|
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)
|
|
43
43
|
──────────────────────────────────────────────────────────────────
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
- "Y" → tiếp tục sang Bước 1.
|
|
47
47
|
- "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).
|
|
48
|
-
- "N" hoặc bất kỳ giá trị nào khác → **DỪNG.** Xuất: "Vui lòng chuyển sang
|
|
48
|
+
- "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."
|
|
49
49
|
|
|
50
50
|
## Bước 1 — Xác định Target File
|
|
51
51
|
|
|
@@ -54,7 +54,12 @@ Hiển thị và chờ phản hồi:
|
|
|
54
54
|
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/`):
|
|
55
55
|
- **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 đó.
|
|
56
56
|
- **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.)*
|
|
57
|
-
- **Lệnh tech-docs
|
|
57
|
+
- **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:
|
|
58
|
+
- `$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`.
|
|
59
|
+
- `$ARGUMENTS` là **TICKET-ID** → glob trực tiếp như trên.
|
|
60
|
+
- Chưa biết domain → `{specs_dir}/*/*/tech-docs/{TICKET-ID}-tech-design.md`.
|
|
61
|
+
- 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.
|
|
62
|
+
*(Đừ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`.)*
|
|
58
63
|
- **Lệnh design-spec**: `{specs_dir}/{domain}/*/design-spec/{TICKET-ID}*.md`.
|
|
59
64
|
|
|
60
65
|
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.
|
|
@@ -71,6 +71,7 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
71
71
|
| /qc-run-test | `/qc-report {UC-ID}` rồi `/qc-review {UC-ID}` (review script) |
|
|
72
72
|
| /qc-review (script) | `/qc-report {UC-ID}` rồi tạo PR nếu APPROVED |
|
|
73
73
|
| /qc-report | `/validate-traces {UC-ID}` để làm mới Living Docs (qc_status) |
|
|
74
|
+
| /map-testids | `/qc-design-test {UC-ID}` (QC dựng Page Object từ contract §4.5.6 vừa ghi) |
|
|
74
75
|
| /generate-tech-docs | `/review-tech-docs {tech-design-file}` |
|
|
75
76
|
| /review-tech-docs | `/generate-code {feature-file}` nếu APPROVED; sửa doc nếu NEEDS_FIX |
|
|
76
77
|
| /generate-code | Lần gen đầu → `/review-code {UC-ID}`; gen lại → `/dev-gen-test {UC-ID}` |
|
|
@@ -79,8 +80,8 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
79
80
|
| /dev-run-test (failing) | `/fix-bug {ticket-id}` hoặc `/debug {error}` |
|
|
80
81
|
| /review-code | `/dev-smoke-test {UC-ID}` hoặc tạo PR |
|
|
81
82
|
| /dev-smoke-test | Tạo PR và link tới ticket |
|
|
82
|
-
| /validate-traces | DRIFT/UNTRACKED → `/generate-code {UC-ID}
|
|
83
|
-
| /fix-bug |
|
|
83
|
+
| /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** |
|
|
84
|
+
| /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 |
|
|
84
85
|
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
85
86
|
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
86
87
|
| /propose-scenario | Báo PO/Dev review proposal trong `feedback/bdd-proposals/` |
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# templates/ — build-time skeletons
|
|
2
|
+
|
|
3
|
+
> **Nếu bạn đang mở thư mục này ở `.agent/templates/` trong một project: sửa file ở đây KHÔNG có tác dụng.**
|
|
4
|
+
|
|
5
|
+
## Vì sao
|
|
6
|
+
|
|
7
|
+
Các skeleton trong thư mục này được `{{include}}` **nướng cứng vào file lệnh lúc `npm run build`**:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
templates/feature.template
|
|
11
|
+
↓ {{include:templates/feature.template}} ← bin/build.js, thay thế văn bản lúc build
|
|
12
|
+
commands/generate-bdd.md
|
|
13
|
+
↓ copy vào core/ → mirror sang .agent/
|
|
14
|
+
.agent/commands/generate-bdd.md ← LỆNH THẬT SỰ CHẠY (đã chứa sẵn skeleton)
|
|
15
|
+
.agent/templates/feature.template ← bản tham khảo, KHÔNG lệnh nào đọc
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Không lệnh nào đọc một path template lúc chạy. `paths.feature_template` / `paths.prd_template` từng tồn tại trong `project-context.yaml` nhưng chưa bao giờ có tác dụng — đã được gỡ bỏ (xem `GAPS.md` G9).
|
|
19
|
+
|
|
20
|
+
**Thêm nữa:** `.agent/` là vùng bị ghi đè. `/update-framework` chạy `npx … --init`, và `--init` copy `core/` → `.agent/` **vô điều kiện** (`bin/index.js` → `copyDirRecursive`, không có existence check, không backup). File duy nhất được giữ lại là `.agent/project-context.yaml`. Nên mọi chỉnh sửa ở `.agent/templates/` sẽ **biến mất im lặng** ở lần nâng cấp kế tiếp.
|
|
21
|
+
|
|
22
|
+
## Muốn đổi cấu trúc artifact sinh ra thì làm gì
|
|
23
|
+
|
|
24
|
+
Sửa file trong **repo framework** rồi build lại:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# trong repo sdd-framework
|
|
28
|
+
vim templates/feature.template # hoặc prd.template.md, tech-design.template.md, …
|
|
29
|
+
npm run build # inline lại vào commands/*.md + core/ + .agent/
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Rồi phát hành version mới; project chạy `/update-framework` để nhận.
|
|
33
|
+
|
|
34
|
+
## File nào ở đây đi vào đâu
|
|
35
|
+
|
|
36
|
+
| Template | Được include vào | Trở thành |
|
|
37
|
+
|---|---|---|
|
|
38
|
+
| `feature.template` | `commands/generate-bdd.tmpl` | mỗi file `.feature` |
|
|
39
|
+
| `prd.template.md` | `commands/generate-prd.tmpl` | mỗi PRD |
|
|
40
|
+
| `tech-design.template.md` | `commands/generate-tech-docs.tmpl` | tech-doc gộp / PRD |
|
|
41
|
+
| `design-spec.template.md` | `commands/generate-design-spec.tmpl` | design-spec / platform |
|
|
42
|
+
| `architecture.template.md` | `commands/generate-architecture.tmpl` | tài liệu kiến trúc |
|
|
43
|
+
| `product-definition.template.md` | `commands/define-product.tmpl` | product definition |
|
|
44
|
+
| `platform-guide.template.md` | (tham khảo) | — |
|
|
45
|
+
| `project-context.yaml` | **không** include — được copy thẳng làm file config khởi tạo | `.agent/project-context.yaml` |
|
|
46
|
+
|
|
47
|
+
> Lưu ý `project-context.yaml` là ngoại lệ duy nhất: nó **được** copy ra làm file thật của project, và **được bảo vệ** khỏi ghi đè khi nâng cấp (chỉ tạo nếu chưa tồn tại).
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# ============================================================
|
|
2
2
|
# @trace.id: {TICKET-ID}-UC{N}
|
|
3
3
|
# @trace.title: <Feature name>
|
|
4
|
-
# @trace.revision: 1 ← field tĩnh;
|
|
4
|
+
# @trace.revision: 1 ← field tĩnh; version theo dõi bằng @trace.bdd_version
|
|
5
5
|
# @trace.domain: <domain>
|
|
6
|
-
# @trace.platform: {active_platform — web | app | system
|
|
6
|
+
# @trace.platform: {active_platform — web | app | system} ← BẮT BUỘC mọi mode; phải khớp segment bdd/{platform}/ của path
|
|
7
7
|
# @trace.service: {active_service — bỏ trong spec repo mode}
|
|
8
8
|
# @trace.module: {active_module trong umbrella mode; "unknown" trong spec repo mode}
|
|
9
9
|
# @trace.status: draft
|
|
@@ -11,8 +11,8 @@
|
|
|
11
11
|
# @trace.created_at: {YYYY-MM-DD}
|
|
12
12
|
# @trace.prd: {TICKET-ID}
|
|
13
13
|
# @trace.prd_version: {đọc từ metadata PRD "| **Version** |"}
|
|
14
|
-
# @trace.bdd_version: {1.0 nếu gen mới; tăng 0.1 khi gen lại
|
|
15
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
14
|
+
# @trace.bdd_version: {cấp FILE — 1.0 nếu gen mới; tăng 0.1 khi gen lại. Khác @trace.sc_version (cấp từng SC) bên dưới}
|
|
15
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m}, {TICKET-ID}-UC{N}-BR{m+1} ← {m} lấy NGUYÊN từ PRD §3: BR đánh số LIÊN TỤC toàn PRD, KHÔNG reset theo UC
|
|
16
16
|
# @trace.dataset: {domain}.testdata.yaml
|
|
17
17
|
# ============================================================
|
|
18
18
|
|
|
@@ -59,8 +59,8 @@ Feature: <Feature name>
|
|
|
59
59
|
|
|
60
60
|
# Side-effects: <liệt kê ngắn các Then side-effect cần verify>
|
|
61
61
|
# @trace.scenario: {TICKET-ID}-UC{N}-SC1
|
|
62
|
-
# @trace.sc_version: 1.0
|
|
63
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
62
|
+
# @trace.sc_version: 1.0 ← cấp SCENARIO. Sửa thân SC này (tên/step/table/side-effect) thì +0.1, nếu không code cũ mãi hiện OK
|
|
63
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m}
|
|
64
64
|
@happy
|
|
65
65
|
Scenario: <mô tả business outcome — dùng động từ chính xác: create/receive/assign/block>
|
|
66
66
|
Given <input state — alias từ dataset>
|
|
@@ -71,7 +71,7 @@ Feature: <Feature name>
|
|
|
71
71
|
# Side-effects: <...>
|
|
72
72
|
# @trace.scenario: {TICKET-ID}-UC{N}-SC2
|
|
73
73
|
# @trace.sc_version: 1.0
|
|
74
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
74
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m}
|
|
75
75
|
@happy @alternative
|
|
76
76
|
Scenario: <cùng theme NHÓM 1 nhưng path khác — vd: giá trị enum khác>
|
|
77
77
|
Given <state>
|
|
@@ -85,7 +85,7 @@ Feature: <Feature name>
|
|
|
85
85
|
# Side-effects: <...>
|
|
86
86
|
# @trace.scenario: {TICKET-ID}-UC{N}-SC3
|
|
87
87
|
# @trace.sc_version: 1.0
|
|
88
|
-
# @trace.business_rules: {TICKET-ID}-UC{N}-
|
|
88
|
+
# @trace.business_rules: {TICKET-ID}-UC{N}-BR{m+2}
|
|
89
89
|
@edge
|
|
90
90
|
Scenario: <scenario boundary / error>
|
|
91
91
|
Given <state>
|
|
@@ -97,8 +97,8 @@ Feature: <Feature name>
|
|
|
97
97
|
# AC1 (...) → SC1, SC2
|
|
98
98
|
# AC2 (...) → SC3
|
|
99
99
|
# BR mapping (mỗi bullet PHẢI có ≥1 SC — C.2):
|
|
100
|
-
# {TICKET-ID}-UC{N}-
|
|
101
|
-
# {TICKET-ID}-UC{N}-
|
|
100
|
+
# {TICKET-ID}-UC{N}-BR{m} (...) → SC1, SC2
|
|
101
|
+
# {TICKET-ID}-UC{N}-BR{m+2} (...) → SC3
|
|
102
102
|
# Wireframe mapping (mỗi component/action ≥1 SC — C.1):
|
|
103
103
|
# Screen "<screen name>":
|
|
104
104
|
# [x] <action 1> → SC1
|
|
@@ -111,6 +111,9 @@ Feature: <Feature name>
|
|
|
111
111
|
|
|
112
112
|
# === PRE-MERGE CHECKLIST ===
|
|
113
113
|
# - [ ] Mỗi SC có Side-effects + @trace.scenario + @trace.sc_version + @trace.business_rules
|
|
114
|
+
# - [ ] SỬA nội dung một SC (tên / step / data table / side-effect) → đã bump @trace.sc_version của
|
|
115
|
+
# CHÍNH SC đó (+0.1). Quên bump = code sinh từ SC cũ vẫn hiện OK, không ai biết phải regen.
|
|
116
|
+
# (Đổi @trace.business_rules / tag / comment → KHÔNG bump: không đổi hành vi cần implement.)
|
|
114
117
|
# - [ ] Coverage Matrix: 0 dòng MISSING (C.1)
|
|
115
118
|
# - [ ] FE/App: mỗi Screen State (≠default) + AC-UI behavioral của design-spec có ≥1 SC (C.1 mở rộng)
|
|
116
119
|
# - [ ] Mỗi AC/BR map tới ≥1 SC (C.2)
|
|
@@ -25,28 +25,41 @@ project:
|
|
|
25
25
|
# All paths are relative to workspace root.
|
|
26
26
|
paths:
|
|
27
27
|
# Feature-Package Layout:
|
|
28
|
-
# specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md
|
|
29
|
-
# specs/{domain}/{prd-slug}/bdd/
|
|
30
|
-
# specs/{domain}/{prd-slug}/tech-docs/
|
|
31
|
-
# specs/{domain}/{prd-slug}/design-spec/
|
|
32
|
-
#
|
|
28
|
+
# specs/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md — PRD document
|
|
29
|
+
# specs/{domain}/{prd-slug}/bdd/{platform}/ — BDD .feature ({platform} = web | app | system)
|
|
30
|
+
# specs/{domain}/{prd-slug}/tech-docs/ — Technical design (ONE merged doc per PRD: {TICKET-ID}-tech-design.md)
|
|
31
|
+
# specs/{domain}/{prd-slug}/design-spec/ — Design specs (FE/App only)
|
|
32
|
+
# specs/{domain}/{prd-slug}/changelog/ — PRD changelog overflow (created once history exceeds 5 versions)
|
|
33
|
+
# .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv — Trace state (ONE book per UC × platform)
|
|
34
|
+
#
|
|
35
|
+
# The {platform} segment is NOT optional — in any mode, including umbrella.
|
|
36
|
+
# A UC's `web` and `system` features are two different files; without the segment they
|
|
37
|
+
# collide on one filename and overwrite each other. Trace is split the same way, so the
|
|
38
|
+
# spec layout has to match it. Every .feature also carries `@trace.platform` matching
|
|
39
|
+
# its own {platform} segment. (Projects still on the old flat bdd/ layout:
|
|
40
|
+
# run `npx @educa-corp/sdd-framework --migrate-bdd-platform` — dry-run by default.)
|
|
33
41
|
#
|
|
34
42
|
# specs_dir is the unified root for all spec artifact types (PRD, BDD, tech-docs, design-spec).
|
|
35
43
|
# prd-slug is derived from the PRD folder path — not a separate config variable.
|
|
36
44
|
specs_dir: "specs"
|
|
37
|
-
templates_dir: "specs/templates"
|
|
38
45
|
|
|
39
46
|
# Source code root — gốc mã nguồn của service/app này (nơi generate-code đặt & quét code).
|
|
40
47
|
# BE thường suy vị trí từ CLAUDE.md §2 (code_base_package + layer); src_dir là gốc chung,
|
|
41
48
|
# và là NGUỒN CHÍNH cho FE (component/hook/service/adapter) + phạm vi quét reuse (DS5).
|
|
42
49
|
# Ví dụ: "src" (mono FE), "app/src", "src/main/java" (BE). Chỉnh theo layout thật của repo.
|
|
43
50
|
src_dir: "src"
|
|
44
|
-
feature_template: ".agent/templates/feature.template" # SoT skeleton .feature (dùng bởi /generate-bdd qua {{include}})
|
|
45
|
-
bdd_writing_guide: "specs/templates/bdd-writing-guide.md"
|
|
46
|
-
trace_report: "specs/.trace/trace-report.md"
|
|
47
51
|
|
|
48
|
-
#
|
|
49
|
-
|
|
52
|
+
# ── Template artifact — KHÔNG cấu hình được ──
|
|
53
|
+
# Đã bỏ 6 key chết (không lệnh nào đọc): feature_template · prd_template ·
|
|
54
|
+
# templates_dir · bdd_writing_guide · product_definition_template · trace_report.
|
|
55
|
+
# Các skeleton được {{include}} NƯỚNG CỨNG vào file lệnh lúc `npm run build`,
|
|
56
|
+
# nên lệnh không bao giờ đọc một path template lúc chạy.
|
|
57
|
+
# (trace_report còn trỏ sai hẳn: report thật là {trace_dir}/trace-report.json.)
|
|
58
|
+
#
|
|
59
|
+
# Đổi cấu trúc .feature / PRD sinh ra = sửa templates/*.template* TRONG REPO
|
|
60
|
+
# FRAMEWORK rồi build lại. Sửa .agent/templates/* trong project KHÔNG có tác
|
|
61
|
+
# dụng, và sẽ bị GHI ĐÈ IM LẶNG ở lần /update-framework kế tiếp (--init copy
|
|
62
|
+
# core/ → .agent/ vô điều kiện; file duy nhất được giữ là .agent/project-context.yaml).
|
|
50
63
|
refinement_dir: ".agent/review"
|
|
51
64
|
|
|
52
65
|
# QC's OWN analysis/design working docs (qc-analyze/plan/design-test outputs:
|
|
@@ -66,7 +79,6 @@ paths:
|
|
|
66
79
|
|
|
67
80
|
# Product Definitions
|
|
68
81
|
product_definitions_dir: "specs/product-definition"
|
|
69
|
-
product_definition_template: "specs/templates/product-definition.template.md"
|
|
70
82
|
|
|
71
83
|
# Domain Knowledge
|
|
72
84
|
domain_knowledge_dir: "specs/domain-knowledge"
|
|
@@ -90,7 +102,7 @@ paths:
|
|
|
90
102
|
# This variable is no longer needed as a separate path — derived from specs_dir.
|
|
91
103
|
# design_spec_dir: "specs/design-spec" ← removed; use specs_dir instead
|
|
92
104
|
|
|
93
|
-
# Trace (internal structure: .trace/{domain}/{prd-slug}/{UC-ID}.tsv)
|
|
105
|
+
# Trace (internal structure: .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv — one book per UC × platform)
|
|
94
106
|
trace_dir: ".trace"
|
|
95
107
|
|
|
96
108
|
# Tester / QC feedback (written by /report-bug and /propose-scenario).
|
|
@@ -133,7 +145,7 @@ domains:
|
|
|
133
145
|
# specs_dir → {spec_source}/specs # unified root — PRD/BDD/tech-docs/design-spec
|
|
134
146
|
# tech_docs_dir → {spec_source}/specs # merged into specs_dir
|
|
135
147
|
# domain_knowledge_dir → {spec_source}/specs/domain-knowledge
|
|
136
|
-
# trace_dir → {spec_source}/.trace # structure: .trace/{domain}/{prd-slug}/{UC-ID}.tsv
|
|
148
|
+
# trace_dir → {spec_source}/.trace # structure: .trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv
|
|
137
149
|
# (You can still override these manually in paths: section below.)
|
|
138
150
|
# With spec_source set, only ONE override is needed instead of four separate dir vars.
|
|
139
151
|
#
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
@trace.service: {service — từ header BDD @trace.service}
|
|
41
41
|
@trace.module: {module liên quan — vd dotnet, angular}
|
|
42
42
|
@trace.platforms: {system | web | app — tuỳ thư mục BDD nào tồn tại}
|
|
43
|
-
@trace.
|
|
43
|
+
@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ố.}
|
|
44
44
|
@trace.api_source: {existing | —}
|
|
45
45
|
@trace.revision: 1
|
|
46
46
|
@trace.status: draft
|
|
@@ -10,9 +10,11 @@
|
|
|
10
10
|
|
|
11
11
|
| Artifact | Trace tag |
|
|
12
12
|
|----------|-----------|
|
|
13
|
-
| **BDD
|
|
14
|
-
| **
|
|
15
|
-
| **
|
|
13
|
+
| **BDD file** (header) | `@trace.id` · **`@trace.platform`** · `@trace.domain` · `@trace.prd` · `@trace.prd_version` · `@trace.bdd_version` · `@trace.status` |
|
|
14
|
+
| **BDD scenario** (mỗi SC) | `@trace.scenario` · **`@trace.sc_version`** · `@trace.business_rules` |
|
|
15
|
+
| **Code** (boundary only) | `@trace.implements` · `@trace.source` · **`@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision`** — lặp cả block theo **từng UC** trong file đa-UC |
|
|
16
|
+
| **Code** (chỗ chưa implement) | `@trace.stub` · `@trace.stub_owner` · `@trace.stub_for` · `@trace.seam_pending` · `@trace.seam_port` |
|
|
17
|
+
| **Test** | `@trace.verifies` |
|
|
16
18
|
| **Bug fix** | `@trace.fixes` · `@trace.root_cause` · `@trace.regression` |
|
|
17
19
|
|
|
18
20
|
→ Đầy đủ field & format: [Reference › Trace Schema](../04-reference/trace-schema.md).
|
|
@@ -65,10 +67,31 @@ Chỉ tag `@trace` ở **boundary**, không tag mọi file → tránh **tag expl
|
|
|
65
67
|
|
|
66
68
|
---
|
|
67
69
|
|
|
68
|
-
##
|
|
70
|
+
## Version sống ở đâu — và vì sao code CŨNG mang version
|
|
69
71
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
+
**Spec là SSOT của "version hiện tại". Code mang version của "lúc tôi được sinh ra".** Hai thứ khác nhau, nên không phải dual SSOT.
|
|
73
|
+
|
|
74
|
+
| Nơi | Ghi cái gì | Ai ghi |
|
|
75
|
+
|---|---|---|
|
|
76
|
+
| `.feature` / PRD / tech-doc | version **hiện tại** của spec — SSOT | tác giả spec |
|
|
77
|
+
| `.tsv` `spec_ver` | gương của `@trace.sc_version` hiện tại | `/generate-bdd`, `/validate-traces` |
|
|
78
|
+
| `.tsv` `gen_ver` | version scenario **tại thời điểm codegen**, theo từng SC | `/generate-code` |
|
|
79
|
+
| **Code** `@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision` | version của **từng artifact upstream** tại thời điểm codegen, theo từng **method** | `/generate-code` |
|
|
80
|
+
|
|
81
|
+
Drift = **so các mốc này với nhau**; sự lệch nhau chính là tín hiệu, không phải lỗi dữ liệu:
|
|
82
|
+
|
|
83
|
+
- `spec_ver != gen_ver` → `DRIFT` (scenario đổi sau khi sinh code)
|
|
84
|
+
- `@trace.prd_version` trong code < Version PRD hiện tại → `PRD_DRIFT`
|
|
85
|
+
- `@trace.bdd_version` trong code < `.feature` hiện tại → `BDD_DRIFT`
|
|
86
|
+
- `@trace.tech_doc_revision` trong code < `@trace.revision` của tech-doc → `TECHDOC_DRIFT`
|
|
87
|
+
|
|
88
|
+
**Vì sao không thể bỏ tag version trong code và chỉ dựa vào `.tsv`:**
|
|
89
|
+
|
|
90
|
+
1. **Độ phân giải khác nhau.** `.tsv` là một sổ cho mỗi UC × platform. Một **file code** có thể phục vụ nhiều UC, mỗi UC ở một version khác nhau — chỉ tag đặt cạnh từng method mới diễn đạt được "UC1 ở bdd v1.4, UC3 ở v2.1".
|
|
91
|
+
2. **Vòng đời khác nhau.** `.tsv` là artifact **sinh ra**, có thể regen/xoá/mirror; ở chế độ umbrella nó còn nằm ở **repo khác** (spec submodule) với code. Tag trong code là bản ghi duy nhất **đi cùng** code qua mọi lần copy/move/merge.
|
|
92
|
+
3. **Sự lệch nhau là thứ ta muốn đo.** Nếu chỉ có một bản ghi thì không có gì để so — đó mới là lúc drift trở nên không phát hiện được.
|
|
93
|
+
|
|
94
|
+
> ⚠️ **Đừng "tối ưu" bằng cách gỡ tag version khỏi code.** `/validate-traces` Step 4/5/5c **đọc chính các tag đó**; gỡ đi là làm drift detection mù **im lặng** — build vẫn xanh, dashboard vẫn đẹp. `/review-code` lăng kính 1 gắn cờ **major** cho mỗi block `@trace.implements` thiếu tag version đi kèm.
|
|
72
95
|
|
|
73
96
|
---
|
|
74
97
|
|
|
@@ -4,54 +4,100 @@
|
|
|
4
4
|
|
|
5
5
|
> Field metadata `@trace.*` và cột file `.tsv`. Giải thích khái niệm → [Traceability](../02-concepts/traceability.md).
|
|
6
6
|
|
|
7
|
+
> ⚙️ **Bản máy đọc: `bin/trace-schema.json`.** File đó là nguồn-sự-thật mà `bin/self-check.js`
|
|
8
|
+
> đối chiếu với `commands/*.tmpl` + `steps/*.md` mỗi lần `npm run build` — build **fail** nếu
|
|
9
|
+
> lệnh lệch schema. Đổi contract thì sửa file JSON **trước**, rồi sửa lệnh, rồi cập nhật trang này.
|
|
10
|
+
|
|
7
11
|
---
|
|
8
12
|
|
|
9
13
|
## Trace tags theo artifact
|
|
10
14
|
|
|
11
|
-
### BDD
|
|
15
|
+
### BDD — header file (`.feature`)
|
|
16
|
+
|
|
17
|
+
| Tag | Ý nghĩa | Bắt buộc |
|
|
18
|
+
|-----|---------|:--------:|
|
|
19
|
+
| `@trace.id` | UC-ID — `{TICKET-ID}-UC{N}` (vd `SEG01-UC1`) | ✅ |
|
|
20
|
+
| `@trace.platform` | `web` / `app` / `system` — **mọi mode, kể cả umbrella** | ✅ |
|
|
21
|
+
| `@trace.domain` | Domain nghiệp vụ | ✅ |
|
|
22
|
+
| `@trace.prd` | TICKET-ID của PRD nguồn | ✅ |
|
|
23
|
+
| `@trace.prd_version` | Version PRD lúc sinh BDD | ✅ |
|
|
24
|
+
| `@trace.bdd_version` | Version **cả file** — tăng 0.1 mỗi lần gen lại / `--fix` | ✅ |
|
|
25
|
+
| `@trace.status` | `draft` / `in-review` / `approved` — cổng duyệt BDD | ✅ |
|
|
26
|
+
| `@trace.title` · `@trace.revision` · `@trace.author` · `@trace.created_at` · `@trace.business_rules` · `@trace.dataset` | thông tin | ⚪ |
|
|
27
|
+
| `@trace.service` · `@trace.module` | chỉ **umbrella mode**; vắng ở spec repo mode là đúng | ⚪ có điều kiện |
|
|
28
|
+
| `@trace.api_source` | `existing` — chỉ khi `platform = system` và PRD brownfield | ⚪ có điều kiện |
|
|
29
|
+
|
|
30
|
+
> **`@trace.platform` là field load-bearing nhất.** Thiếu nó: `/generate-code` không quyết được BE/FE (và **cấm** fallback sang `platform_type`), không định vị được sổ trace `{UC-ID}-{platform}.tsv`, không tìm được design-spec. Nó phải **khớp** segment `{platform}` của đường dẫn file.
|
|
31
|
+
|
|
32
|
+
### BDD — mỗi scenario
|
|
12
33
|
|
|
13
34
|
| Tag | Ý nghĩa |
|
|
14
35
|
|-----|---------|
|
|
15
|
-
| `@trace.
|
|
16
|
-
|
|
|
17
|
-
| `@trace.business_rules` | BR liên quan
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
| `@trace.status` | `draft` / `in-review` / `approved` (gate) |
|
|
21
|
-
| `@trace.platform` | `web` / `app` / `system` |
|
|
22
|
-
| `@trace.domain` | Domain nghiệp vụ |
|
|
36
|
+
| `@trace.scenario` | SC-ID — `{UC-ID}-SC{N}` (vd `SEG01-UC1-SC3`) |
|
|
37
|
+
| **`@trace.sc_version`** | Version **của riêng scenario này**. Tăng 0.1 khi **thân SC** đổi (tên · step · data table · side-effect). |
|
|
38
|
+
| `@trace.business_rules` | BR liên quan — `{TICKET-ID}-UC{N}-BR{m}` |
|
|
39
|
+
|
|
40
|
+
> **`sc_version` vs `bdd_version`:** `sc_version` là tín hiệu **duy nhất** cho `DRIFT` (`spec_ver != gen_ver`). `bdd_version` bắt thay đổi cấp file mà `sc_version` không thấy (Background, dataset, Business Definition, Coverage Matrix). Quên bump `sc_version` = code sinh từ scenario cũ **vĩnh viễn** hiện `OK`.
|
|
23
41
|
|
|
24
|
-
### Code (boundary only)
|
|
42
|
+
### Code — entry-point (boundary only)
|
|
43
|
+
|
|
44
|
+
```java
|
|
45
|
+
// @trace.implements=SEG01-UC1-SC3
|
|
46
|
+
// @trace.prd_version=1.2
|
|
47
|
+
// @trace.bdd_version=1.4
|
|
48
|
+
// @trace.tech_doc_revision=3
|
|
49
|
+
// @trace.source=specs/segment/scoring/bdd/system/SEG01-UC1-scoring.feature
|
|
50
|
+
public ScoreDto calculate(...) { }
|
|
51
|
+
```
|
|
25
52
|
|
|
26
53
|
| Tag | Ý nghĩa |
|
|
27
54
|
|-----|---------|
|
|
28
55
|
| `@trace.implements` | SC mà method này hiện thực |
|
|
29
|
-
| `@trace.
|
|
56
|
+
| `@trace.prd_version` · `@trace.bdd_version` · `@trace.tech_doc_revision` | version của từng artifact upstream **tại thời điểm codegen** — nguồn của `PRD_DRIFT` / `BDD_DRIFT` / `TECHDOC_DRIFT` |
|
|
57
|
+
| `@trace.source` | `.feature` nguồn — **phải gồm segment `{platform}`** |
|
|
58
|
+
|
|
59
|
+
> **File phủ nhiều UC → lặp CẢ BLOCK theo từng method.** Không gộp về một header file, không trỏ thư mục. 3 tag version là scalar **theo từng UC**; gộp lại thì không diễn đạt được "UC1 ở bdd v1.4, UC3 ở v2.1" → drift báo oan hoặc mù. Và các lệnh tra tag bằng **khớp chuỗi chính xác**, nên `@trace.source` trỏ thư mục sẽ ra 0 kết quả → UC rơi về `UNTRACKED` dù code đã có.
|
|
60
|
+
|
|
61
|
+
### Code — chỗ chưa implement (sổ `_seams.tsv`)
|
|
30
62
|
|
|
31
|
-
|
|
63
|
+
| Tag | Đặt ở đâu | Ý nghĩa |
|
|
64
|
+
|-----|---|---------|
|
|
65
|
+
| `@trace.stub` · `@trace.stub_owner` · `@trace.stub_for` | method trắng | logic thuộc BDD **khác của cùng feature** — ai để trắng / ai sẽ lấp / trách nhiệm gì |
|
|
66
|
+
| `@trace.seam_pending` · `@trace.seam_port` | class stub | port **cross-UC** do UC khác sở hữu, hàng thật chưa có |
|
|
32
67
|
|
|
33
68
|
### Test
|
|
34
69
|
|
|
35
70
|
| Tag | Ý nghĩa |
|
|
36
71
|
|-----|---------|
|
|
37
|
-
| `@trace.verifies` | SC mà test kiểm chứng
|
|
38
|
-
| `@trace.covers` | Phạm vi phủ |
|
|
72
|
+
| `@trace.verifies` | SC mà test kiểm chứng — `{UC-ID}-SC{N}` |
|
|
39
73
|
|
|
40
74
|
### Bug fix
|
|
41
75
|
|
|
42
76
|
| Tag | Ý nghĩa |
|
|
43
77
|
|-----|---------|
|
|
44
|
-
| `@trace.fixes` |
|
|
78
|
+
| `@trace.fixes` | `{BUG-ID}` nếu fix từ bug report đã file, else TICKET_ID |
|
|
45
79
|
| `@trace.root_cause` | Nguyên nhân gốc |
|
|
46
80
|
| `@trace.regression` | Test regression thêm vào |
|
|
47
81
|
|
|
82
|
+
### Tech-doc gộp (header, cấp PRD)
|
|
83
|
+
|
|
84
|
+
| Tag | Ý nghĩa |
|
|
85
|
+
|-----|---------|
|
|
86
|
+
| `@trace.id` · `@trace.domain` · `@trace.prd` | định danh |
|
|
87
|
+
| `@trace.ucs` | **danh sách** UC mà doc này phủ |
|
|
88
|
+
| `@trace.platforms` | platform có mặt |
|
|
89
|
+
| `@trace.bdd_versions` | **map theo platform** (`system=1.5, web=1.9`). Tên **số nhiều** để phân biệt với `@trace.bdd_version` (scalar) của `.feature` — cùng tên cho hai kiểu dữ liệu sẽ làm vỡ parser generic. |
|
|
90
|
+
| `@trace.revision` | integer, bump mỗi lần sửa — nguồn của `TECHDOC_DRIFT` |
|
|
91
|
+
| `@trace.status` | `draft` / `in-review` / `approved` — cổng của `/generate-code` DS3 |
|
|
92
|
+
| `@trace.api_source` | `existing` → chế độ reverse-document, bỏ cổng T7 |
|
|
93
|
+
|
|
48
94
|
---
|
|
49
95
|
|
|
50
96
|
## Boundary-only tagging
|
|
51
97
|
|
|
52
98
|
| ✅ Tag | ❌ Không tag |
|
|
53
99
|
|--------|-------------|
|
|
54
|
-
| Controller · Handler · Middleware · Steps file | Entity · Repository · DTO · Interface · Base class |
|
|
100
|
+
| Controller · Handler · Middleware · Consumer · Steps file | Entity · Repository · DTO · Interface · Base class |
|
|
55
101
|
|
|
56
102
|
Shared code dò qua **import chain** từ boundary → tránh tag explosion.
|
|
57
103
|
|
|
@@ -59,34 +105,79 @@ Shared code dò qua **import chain** từ boundary → tránh tag explosion.
|
|
|
59
105
|
|
|
60
106
|
## Trace state — `.tsv`
|
|
61
107
|
|
|
62
|
-
Đường dẫn: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv`
|
|
108
|
+
Đường dẫn: `.trace/{domain}/{prd-slug}/{UC-ID}-{platform}.tsv` — **một sổ cho mỗi UC × platform** (`sc_id` chỉ độc nhất trong phạm vi đó; `web-SC1` và `system-SC1` là hai scenario khác nhau). Ở umbrella + `spec_source`, sổ nằm trong spec repo.
|
|
109
|
+
|
|
110
|
+
**22 cột, tab-separated:**
|
|
111
|
+
|
|
112
|
+
| # | Cột | Ý nghĩa | Chủ ghi |
|
|
113
|
+
|---|-----|---------|---------|
|
|
114
|
+
| 1 | `sc_id` | `{UC-ID}-SC{N}` | generate-bdd |
|
|
115
|
+
| 2 | `sc_title` | tiêu đề scenario | generate-bdd |
|
|
116
|
+
| 3 | `spec_ver` | gương của `@trace.sc_version` hiện tại | generate-bdd · validate-traces |
|
|
117
|
+
| 4 | `gen_ver` | `spec_ver` **tại thời điểm codegen** | generate-code |
|
|
118
|
+
| 5 | `implemented_by` | `{Class}.{method}` (`—` nếu chưa) | generate-code |
|
|
119
|
+
| 6 | `test_count` | số test phủ SC | dev-gen-test · fix-bug |
|
|
120
|
+
| 7 | `test_classes` | tên test class / describe | dev-gen-test · fix-bug |
|
|
121
|
+
| 8 | `dev_selftest` | `pass`/`fail`/`not_run` — **dev tự chạy** | dev-run-test |
|
|
122
|
+
| 9 | `dev_selftest_at` | ngày | dev-run-test |
|
|
123
|
+
| 10 | `qc_status` | `pass`/`fail`/`skip`/`not_run` — **QC chính thức** | qc-run-test |
|
|
124
|
+
| 11 | `qc_run_at` | ngày | qc-run-test |
|
|
125
|
+
| 12 | `qc_owner` | SC đang chờ ai: `dev` / `po` | qc-run-test · report-bug |
|
|
126
|
+
| 13 | `qc_blocked_by` | `BUG-{id}` / `GAP-{id}` | qc-run-test · report-bug |
|
|
127
|
+
| 14 | `prd_version` | version PRD lúc sinh BDD | generate-bdd |
|
|
128
|
+
| 15 | `bdd_version` | version `.feature` | generate-bdd · review-context |
|
|
129
|
+
| 16 | `tech_doc_revision` | `@trace.revision` của tech-doc | generate-code · review-tech-docs |
|
|
130
|
+
| 17 | `fe_tech_doc_revision` | revision lúc FE wire adapter thật (§4.5.4) | generate-code |
|
|
131
|
+
| 18 | `prd_status` | gương của PRD Metadata `Status` | generate-bdd · validate-traces |
|
|
132
|
+
| 19 | `uc_status` | gương của `@trace.status` (`.feature`) | generate-bdd · validate-traces |
|
|
133
|
+
| 20 | `fe_phase` | `ui` / `integrated` / `—` | generate-code `--phase` |
|
|
134
|
+
| 21 | `status` | tổng hợp — xem bảng dưới | validate-traces |
|
|
135
|
+
| 22 | `last_updated` | `YYYY-MM-DD` | mọi lệnh ghi row |
|
|
136
|
+
|
|
137
|
+
> `dev_selftest` (dev smoke) và `qc_status` (QC chính thức) là **hai tín hiệu riêng**, không bao giờ gộp. Cả hai **trực giao** với `status` — `status` đo *coverage*, chúng đo *kết quả chạy*.
|
|
138
|
+
|
|
139
|
+
> Giá trị rỗng trong TSV là `—`. Khi xuất JSON: `implemented_by`→`null`, `test_count`→`0`, `test_classes`→`[]`, `tech_doc_revision`/`fe_tech_doc_revision`→`0`, `dev_selftest`/`qc_status`→`"not_run"`.
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## Phân loại `status` (thứ tự ưu tiên, first-match-wins)
|
|
63
144
|
|
|
64
|
-
|
|
|
65
|
-
|
|
66
|
-
|
|
|
67
|
-
| `implemented_by
|
|
68
|
-
| `spec_ver
|
|
69
|
-
|
|
|
70
|
-
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
145
|
+
| # | Trạng thái | Điều kiện | Hành động |
|
|
146
|
+
|---|-----------|-----------|-----------|
|
|
147
|
+
| 0 | **ORPHANED** | SC **không còn trong `.feature`** nhưng `implemented_by != —` | Người quyết định: xoá code+test, hoặc đưa scenario trở lại |
|
|
148
|
+
| 1 | **UNTRACKED** | `implemented_by == —` | `/generate-code` |
|
|
149
|
+
| 2 | **DRIFT** | có code **và** `spec_ver != gen_ver` | regen **trước khi** test |
|
|
150
|
+
| 3 | **GAP** | có code **và** `test_count == —`/`0` | `/dev-gen-test` |
|
|
151
|
+
| 4 | **OK** | version khớp, có code, có test | đủ phủ |
|
|
152
|
+
|
|
153
|
+
`code_coverage = (rows where implemented_by != —) / total_scs` — **`total_scs` loại row `ORPHANED`** (không còn là scope; tính vào sẽ bóp méo coverage vì thứ không ai cần implement).
|
|
154
|
+
|
|
155
|
+
> **ORPHANED là Rule 0** vì 4 rule kia đều giả định scenario **còn tồn tại**. Để rule khác thắng thì mỗi giá trị route người dùng sang một lệnh vô nghĩa: `GAP`→sinh test cho SC không tồn tại · `DRIFT`→regen từ SC đã xoá · `OK`→cho tạo PR.
|
|
156
|
+
>
|
|
157
|
+
> **DRIFT xét trước GAP** vì `/generate-code` xử `GAP` = "skip codegen" còn `DRIFT` = "regenerate". Nếu GAP thắng, code lỗi thời bị bỏ qua và test lại sinh trên code cũ.
|
|
75
158
|
|
|
76
159
|
---
|
|
77
160
|
|
|
78
|
-
##
|
|
161
|
+
## Cờ audit (không phải cột — do `/validate-traces` tính)
|
|
162
|
+
|
|
163
|
+
| Cờ | Nguồn | Nghĩa |
|
|
164
|
+
|---|---|---|
|
|
165
|
+
| `PRD_DRIFT` | Step 4 | code mang `@trace.prd_version` cũ hơn PRD hiện tại |
|
|
166
|
+
| `BDD_DRIFT` | Step 5c | code mang `@trace.bdd_version` cũ hơn `.feature` |
|
|
167
|
+
| `TECHDOC_DRIFT` · `FE_TECHDOC_DRIFT` | Step 5 | code sinh từ revision tech-doc cũ hơn |
|
|
168
|
+
| `TECHDOC_STALE_VS_BDD` | Step 5c | tech-doc dựng từ BDD cũ hơn `.feature` hiện tại |
|
|
169
|
+
| `TRACE_ORPHAN` 🔴 | Step 2b | tag `@trace.implements`/`@trace.verifies` trỏ SC không tồn tại **và** không có row TSV |
|
|
170
|
+
| `SEAM_UNWIRED` 🔴 | Step 5b | hàng thật đã có nhưng consumer còn wire vào stub |
|
|
171
|
+
| `STUB_UNRESOLVED` 🔴 | Step 5b | method còn trắng dù owner đã gen / có hàm song song |
|
|
172
|
+
| `SEAM_PENDING` · `STUB_PENDING` | Step 5b | owner UC chưa gen — **bình thường**, chỉ nhắc |
|
|
79
173
|
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
| 2 | **DRIFT** | `implemented_by != —` AND `spec_ver != gen_ver` |
|
|
84
|
-
| 3 | **GAP** | `implemented_by != —` AND (`test_count == —` OR `0`) |
|
|
85
|
-
| 4 | **OK** | `spec_ver == gen_ver` AND `implemented_by != —` AND `test_count > 0` |
|
|
174
|
+
> 🔴 = **chặn PR**. Build xanh, test từng-UC xanh, coverage đẹp — nhưng luồng ghép chạy vào no-op hoặc code trỏ vào scenario đã bị xoá.
|
|
175
|
+
|
|
176
|
+
---
|
|
86
177
|
|
|
87
|
-
|
|
178
|
+
## Xuất JSON cho panel
|
|
88
179
|
|
|
89
|
-
|
|
180
|
+
`trace-report.json` giữ enum `status` **đúng 4 giá trị** `OK`/`DRIFT`/`GAP`/`UNTRACKED` — VS Code extension "Spec Driven Docs Tools" sống ngoài repo framework và switch trên field này. Row `ORPHANED` xuất ra là `"status": "DRIFT"` + `"orphaned": true`; panel cũ hiện nó như DRIFT (đúng nghĩa, không im lặng), panel mới đọc `orphaned` để hiện nhãn riêng. **TSV giữ nguyên chữ `ORPHANED`** — TSV là nguồn-sự-thật.
|
|
90
181
|
|
|
91
182
|
---
|
|
92
183
|
|
|
@@ -23,6 +23,6 @@ coding_standards:
|
|
|
23
23
|
|
|
24
24
|
trace_tags:
|
|
25
25
|
implements: "@trace.implements={UC-ID}-SC{N}"
|
|
26
|
-
source: "@trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
26
|
+
source: "@trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
27
27
|
verifies: "@trace.verifies={UC-ID}"
|
|
28
28
|
test_type: "@trace.test_type=unit|integration"
|
|
@@ -69,6 +69,6 @@ testing:
|
|
|
69
69
|
|
|
70
70
|
trace_tags:
|
|
71
71
|
implements: "// @trace.implements={UC-ID}-SC{N}"
|
|
72
|
-
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
72
|
+
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
73
73
|
verifies: "// @trace.verifies={UC-ID}"
|
|
74
74
|
test_type: "// @trace.test_type=unit|e2e"
|
|
@@ -53,6 +53,6 @@ testing:
|
|
|
53
53
|
|
|
54
54
|
trace_tags:
|
|
55
55
|
implements: "// @trace.implements={UC-ID}-SC{N}"
|
|
56
|
-
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{UC-ID}.feature"
|
|
56
|
+
source: "// @trace.source=specs/{domain}/{prd-slug}/bdd/{platform}/{UC-ID}-{slug}.feature"
|
|
57
57
|
verifies: "// @trace.verifies={UC-ID}"
|
|
58
58
|
test_type: "// @trace.test_type=unit|integration"
|