@educa-corp/sdd-framework 0.4.2 → 0.5.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/self-check.js +124 -6
- package/bin/trace-schema.json +1199 -692
- package/commands/debug.md +3 -2
- package/commands/define-product.md +3 -2
- package/commands/dev-gen-test.md +37 -9
- package/commands/dev-run-test.md +37 -9
- package/commands/dev-smoke-test.md +3 -2
- package/commands/extend-prd.md +907 -0
- package/commands/extend-prd.tmpl +270 -0
- package/commands/fix-bug.md +37 -9
- package/commands/generate-architecture.md +3 -2
- package/commands/generate-bdd.md +56 -13
- package/commands/generate-bdd.tmpl +18 -3
- package/commands/generate-code.md +73 -16
- package/commands/generate-code.tmpl +36 -7
- package/commands/generate-design-spec.md +3 -2
- package/commands/generate-prd.md +28 -2
- package/commands/generate-prd.tmpl +25 -0
- package/commands/generate-spec-manifest.md +3 -2
- package/commands/generate-tech-docs.md +3 -2
- package/commands/learn.md +3 -2
- package/commands/map-testids.md +3 -2
- package/commands/propose-scenario.md +55 -3
- package/commands/propose-scenario.tmpl +52 -1
- package/commands/qc-analyze.md +3 -2
- package/commands/qc-design-test.md +4 -2
- package/commands/qc-design-test.tmpl +1 -0
- package/commands/qc-plan.md +3 -2
- package/commands/qc-report.md +3 -2
- package/commands/qc-review.md +3 -2
- package/commands/qc-run-test.md +50 -10
- package/commands/qc-run-test.tmpl +13 -1
- package/commands/refine-prd.md +3 -2
- package/commands/report-bug.md +3 -2
- package/commands/review-code.md +7 -5
- package/commands/review-code.tmpl +4 -3
- package/commands/review-context.md +6 -4
- package/commands/review-context.tmpl +3 -2
- package/commands/review-tech-docs.md +3 -2
- package/commands/setup-ai-first.md +3 -2
- package/commands/sync.md +40 -16
- package/commands/sync.tmpl +37 -14
- package/commands/update-framework.md +3 -2
- package/commands/validate-traces.md +318 -33
- package/commands/validate-traces.tmpl +315 -31
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +3 -2
- package/core/commands/define-product.md +3 -2
- package/core/commands/dev-gen-test.md +37 -9
- package/core/commands/dev-run-test.md +37 -9
- package/core/commands/dev-smoke-test.md +3 -2
- package/core/commands/extend-prd.md +907 -0
- package/core/commands/fix-bug.md +37 -9
- package/core/commands/generate-architecture.md +3 -2
- package/core/commands/generate-bdd.md +56 -13
- package/core/commands/generate-code.md +73 -16
- package/core/commands/generate-design-spec.md +3 -2
- package/core/commands/generate-prd.md +28 -2
- package/core/commands/generate-spec-manifest.md +3 -2
- package/core/commands/generate-tech-docs.md +3 -2
- package/core/commands/learn.md +3 -2
- package/core/commands/map-testids.md +3 -2
- package/core/commands/propose-scenario.md +55 -3
- package/core/commands/qc-analyze.md +3 -2
- package/core/commands/qc-design-test.md +4 -2
- package/core/commands/qc-plan.md +3 -2
- package/core/commands/qc-report.md +3 -2
- package/core/commands/qc-review.md +3 -2
- package/core/commands/qc-run-test.md +50 -10
- package/core/commands/refine-prd.md +3 -2
- package/core/commands/report-bug.md +3 -2
- package/core/commands/review-code.md +7 -5
- package/core/commands/review-context.md +6 -4
- package/core/commands/review-tech-docs.md +3 -2
- package/core/commands/setup-ai-first.md +3 -2
- package/core/commands/sync.md +40 -16
- package/core/commands/update-framework.md +3 -2
- package/core/commands/validate-traces.md +318 -33
- package/core/rules/workflow.md +18 -0
- package/core/steps/report-footer.md +3 -2
- package/core/steps/trace-mirror.md +34 -7
- package/core/templates/feature.template +1 -1
- package/docs/01-getting-started/installation.md +18 -1
- package/docs/01-getting-started/what-is-sdd.md +4 -2
- package/docs/02-concepts/architecture.md +27 -3
- package/docs/02-concepts/pipeline-steps/02-specification.md +39 -3
- package/docs/02-concepts/pipeline-steps/04-bdd.md +24 -2
- package/docs/02-concepts/pipeline-steps/05-tech-docs.md +18 -1
- package/docs/02-concepts/pipeline-steps/06-code.md +35 -4
- package/docs/02-concepts/pipeline-steps/09-validate-traces.md +137 -12
- package/docs/02-concepts/pipeline-steps/10-feedback-loop.md +59 -3
- package/docs/02-concepts/roles-and-hitl.md +1 -1
- package/docs/02-concepts/traceability.md +126 -117
- package/docs/03-guides/developer.md +20 -4
- package/docs/03-guides/product-owner.md +72 -68
- package/docs/03-guides/tester-qa.md +81 -70
- package/docs/04-reference/commands.md +134 -105
- package/docs/04-reference/configuration.md +146 -94
- package/docs/04-reference/trace-schema.md +26 -9
- package/docs/explain/02-generate-prd.md +80 -78
- package/docs/explain/02b-extend-prd.md +125 -0
- package/docs/explain/03-refine-prd.md +86 -86
- package/docs/explain/04-review-context.md +18 -1
- package/docs/explain/06-generate-bdd.md +23 -0
- package/docs/explain/08-review-tech-docs.md +20 -5
- package/docs/explain/10-review-code.md +36 -2
- package/docs/explain/19-qc-run-test.md +87 -67
- package/docs/explain/21-validate-traces.md +74 -68
- package/docs/explain/23-fix-bug.md +19 -3
- package/docs/explain/26-propose-scenario.md +70 -63
- package/docs/explain/README.md +135 -134
- package/package.json +50 -50
- package/rules/workflow.md +18 -0
- package/steps/report-footer.md +3 -2
- package/steps/trace-mirror.md +34 -7
- package/templates/feature.template +1 -1
|
@@ -499,14 +499,17 @@ Kiểm tra mảng `services` có tồn tại trong `project-context.yaml` không
|
|
|
499
499
|
|
|
500
500
|
**Nếu `services` tồn tại (umbrella mode):**
|
|
501
501
|
- Phân giải trace dir:
|
|
502
|
-
- **Nếu `setup.spec_source` được set (consolidated trace):** `all_trace_dirs = [ {spec_source}/.trace ]` — một vị trí authoritative **duy nhất** trong spec repo.
|
|
502
|
+
- **Nếu `setup.spec_source` được set (consolidated trace):** `all_trace_dirs = [ {spec_source}/.trace ]` — một vị trí authoritative **duy nhất** trong spec repo. Không cần tách theo service vì **mỗi row TSV mang service sở hữu ở cột `service` (cột 23)** — `/generate-bdd` ghi nó từ `@trace.service` của header `.feature`. Đây là trường hợp phổ biến.
|
|
503
|
+
> *Trước v0.4.3, câu này nói "scenario mang service qua `@trace.service`" nhưng TSV **không có cột nào** cho nó và JSON report cũng không — nên ở đúng chế độ phổ biến nhất, trace hoàn toàn không trả lời được "scenario này thuộc đội nào". Cột 23 là thứ làm câu trên trở thành sự thật.*
|
|
503
504
|
- **Else (không có spec_source — legacy per-service trace):** một dir mỗi service — `services[N].trace_dir` nếu set, else `{services[N].path}/.trace`; `all_trace_dirs = [ dir1, dir2, … ]`, gắn tag tên service khi đọc.
|
|
504
505
|
- Step 1 đọc TSV từ `all_trace_dirs`.
|
|
505
506
|
- **Phân giải Living Docs home (vị trí report sinh ra):**
|
|
506
507
|
- Nếu `setup.spec_source` được set → `living_docs_dir = {spec_source}/.living-docs`
|
|
507
508
|
*(specs module dùng chung — mount trong mọi service/umbrella workspace, nên panel phân giải nó bất kể dev đứng ở submodule nào)*
|
|
508
509
|
- Else (umbrella không có spec repo riêng) → `living_docs_dir = .living-docs` ở umbrella root
|
|
509
|
-
- **Phân giải panel mirror:** `panel_mirror = ./.trace` ở **gốc workspace hiện tại** (nơi lệnh chạy). Panel VS Code đọc
|
|
510
|
+
- **Phân giải panel mirror:** `panel_mirror = ./.trace-mirror` ở **gốc workspace hiện tại** (nơi lệnh chạy). Panel VS Code đọc report từ workspace đang mở — ghi ở đây là cái làm view không rỗng khi dev mở một service submodule trực tiếp.
|
|
511
|
+
**Bỏ qua toàn bộ mirror nếu `{paths.trace_dir}` đã nằm trong workspace hiện tại** (single-service, hoặc dev mở thẳng spec repo) — panel đọc `.trace/trace-report.json` tại chỗ, không cần bản sao.
|
|
512
|
+
> ⚠️ **`.trace-mirror` ≠ `.trace` — cố ý khác tên.** Trước v0.4.3 cả hai cùng tên `.trace`, nên một luật gitignore theo tên có thể xoá sạch sổ gốc khi hai path trùng nhau. Giờ luật git là tuyệt đối, không có ca nhập nhằng: `.trace-mirror/` **luôn** gitignore · `{paths.trace_dir}` **luôn** commit.
|
|
510
513
|
|
|
511
514
|
**Nếu không có key `services` (single-service mode):**
|
|
512
515
|
- Set `all_trace_dirs = [ {paths.trace_dir} ]`
|
|
@@ -577,19 +580,80 @@ Với mỗi UC, so:
|
|
|
577
580
|
- `prd_version` lưu trong `.tsv` (version tại thời điểm sinh BDD)
|
|
578
581
|
- `@trace.prd_version` trong các file code implement UC đó
|
|
579
582
|
|
|
580
|
-
Nếu layer nào sau version PRD hiện tại →
|
|
583
|
+
Nếu layer nào sau version PRD hiện tại → trích các changelog entry kể từ version đó, rồi **lọc theo phạm vi ảnh hưởng** (dưới đây) để quyết `PRD_DRIFT` 🟠 hay `PRD_STALE_REF` ⓘ.
|
|
584
|
+
|
|
585
|
+
#### Lọc theo phạm vi changelog — chống báo động oan
|
|
586
|
+
|
|
587
|
+
*PRD là tài liệu **cấp feature** phủ nhiều UC, nhưng version của nó là **một scalar**. Nên thêm UC7 — không đụng một chữ nào của UC1–UC6 — vẫn làm cả 6 UC cũ lệch version. So version thuần thì cả 6 ăn cờ đỏ oan.*
|
|
588
|
+
|
|
589
|
+
Đọc các row `# Change Log` của PRD **từ version của layer cũ nhất tới hiện tại**, trích tập UC/AC/BR được nêu. *(`/refine-prd` Phase 3 và `/extend-prd` **bắt buộc** ghi thông tin này vào mỗi row — chính vì mục đích này. `/generate-bdd` Version Check đã dùng nó từ trước; ở đây chỉ là đọc cùng một dữ liệu.)*
|
|
590
|
+
|
|
591
|
+
| Điều kiện | Cờ | Hành động |
|
|
592
|
+
|---|---|---|
|
|
593
|
+
| UC này **có** trong tập bị ảnh hưởng | `PRD_DRIFT` 🟠 | Cần regen thật — theo bảng `drifted_layers` bên dưới |
|
|
594
|
+
| UC này **không** có trong tập, **và** mọi row changelog trong khoảng đều nêu rõ scope | `PRD_STALE_REF` ⓘ | Nội dung không đổi, chỉ con trỏ version cũ. **KHÔNG** route regen — dùng `--realign-prd-version` |
|
|
595
|
+
| **Bất kỳ** row nào trong khoảng mơ hồ (không nêu UC/AC/BR) | `PRD_DRIFT` 🟠 cho **MỌI** UC | Không suy đoán được thì quét rộng |
|
|
596
|
+
|
|
597
|
+
> **Hàng thứ ba là lưới an toàn — hỏng theo hướng an toàn.** Changelog viết ẩu thì ta mất tính năng *lọc*, KHÔNG mất tính năng *cảnh báo*. Đồng bộ với `generate-bdd` Version Check: *"changelog row không nêu rõ UC/AC/BR (mơ hồ) → khuyến nghị F (gen lại toàn bộ)"*.
|
|
598
|
+
>
|
|
599
|
+
> **Vì sao cần bước lọc này:** đây là G1 lộn ngược. G1 làm cờ **im lặng**; so-version-thuần làm cờ **ồn tới mức vô nghĩa** — sau vài lần thêm feature, `PRD_DRIFT` sáng thường trực, người đọc học cách bỏ qua, rồi lần lệch THẬT cũng bị bỏ qua cùng. Kết cục giống hệt nhau: không ai còn tin cờ. Và nó tệ dần theo thời gian — PRD càng nhiều UC, càng nhiều lần bump, nhiễu càng lớn, tức là đánh mạnh nhất vào chính những feature trưởng thành nhất.
|
|
600
|
+
> Framework **đã giải đúng bài này ở cấp scenario**: `sc_version` chỉ bump khi thân scenario thực sự đổi, với lý do ghi thẳng — *"bump vô cớ sẽ tạo DRIFT giả, làm cờ mất giá trị"*. Đây là bản tương ứng ở cấp PRD.
|
|
601
|
+
|
|
602
|
+
**Ghi rõ layer nào lệch** (`drifted_layers` trong JSON — `"tsv"` và/hoặc `"code"`). Đây là thứ quyết định người dùng phải chạy **một** lệnh hay **hai**:
|
|
603
|
+
|
|
604
|
+
| `drifted_layers` | Nghĩa | Hành động |
|
|
605
|
+
|---|---|---|
|
|
606
|
+
| `["tsv"]` | BDD chưa gen lại từ PRD mới; code vẫn khớp cột TSV | `/generate-bdd {prd-file}` là **đủ** |
|
|
607
|
+
| `["tsv","code"]` | Cả BDD lẫn code đều cũ | `/generate-bdd` **rồi** `/generate-code {UC-ID}` |
|
|
608
|
+
| `["code"]` | TSV đã cập nhật nhưng code chưa sinh lại | `/generate-code {UC-ID}` |
|
|
609
|
+
|
|
610
|
+
*Không ghi `drifted_layers` thì hai ca đầu trông hệt nhau — người dùng hoặc chạy thiếu (cờ không sạch) hoặc chạy thừa (sinh lại code không cần thiết).*
|
|
581
611
|
|
|
582
612
|
### Step 5 — Tech-doc revision drift check
|
|
583
613
|
|
|
584
614
|
Mỗi PRD có **một** tech-doc gộp `{paths.tech_docs_dir}/{domain}/{prd-slug}/tech-docs/{TICKET-ID}-tech-design.md` với một `@trace.revision` chung. So revision đó vs hai cột đã lưu:
|
|
585
615
|
|
|
586
616
|
- **Backend drift:** `@trace.revision` của doc vs `tech_doc_revision` trong `.tsv`.
|
|
587
|
-
|
|
588
|
-
- **FE integration drift:** `@trace.revision` của doc vs `fe_tech_doc_revision` trong `.tsv` (row FE `--phase=integration`, theo từng platform).
|
|
589
|
-
Code FE wire theo revision cũ hơn (§4.5.4 đã đổi) → gắn cờ `FE_TECHDOC_DRIFT`.
|
|
617
|
+
- **FE integration drift:** `@trace.revision` của doc vs `fe_tech_doc_revision` trong `.tsv` (row FE `--phase=integration`, theo từng platform; §4.5.4).
|
|
590
618
|
|
|
591
619
|
Skip cột nào chưa có revision đã lưu (`—`), hoặc cả UC chưa có tech-doc.
|
|
592
620
|
|
|
621
|
+
#### Lọc theo phạm vi — ĐỐI XỨNG với Step 4
|
|
622
|
+
|
|
623
|
+
*Tech-doc có **đúng cùng hình dạng** với PRD: một doc **GỘP cấp PRD**, một `@trace.revision` chung cho nhiều UC. Chế độ **APPEND** (`generate-tech-docs` Bước 1) thêm UC mới vào doc đã có → revision bump → **mọi UC cũ lệch**, dù phần của chúng không đổi một dòng.*
|
|
624
|
+
|
|
625
|
+
Đọc **§10 UC Coverage** và **Changelog** của tech-doc, trích tập UC mà row changelog trong khoảng revision đó nêu:
|
|
626
|
+
|
|
627
|
+
| Điều kiện | Cờ |
|
|
628
|
+
|---|---|
|
|
629
|
+
| UC này **có** trong tập bị ảnh hưởng | `TECHDOC_DRIFT` / `FE_TECHDOC_DRIFT` 🟠 |
|
|
630
|
+
| UC này **không** có, changelog nêu rõ scope | `TECHDOC_STALE_REF` ⓘ — dùng `--realign-techdoc-revision` |
|
|
631
|
+
| Row changelog mơ hồ | 🟠 cho **mọi** UC (lưới an toàn) |
|
|
632
|
+
|
|
633
|
+
### Step 5e — Realign mode *(chỉ chạy khi có flag)*
|
|
634
|
+
|
|
635
|
+
*Đường ra rẻ cho hai cờ ⓘ ở Step 4/5. Không có nó thì cờ `PRD_STALE_REF`/`TECHDOC_STALE_REF` **không bao giờ sạch được**: `/generate-bdd` cập nhật được cột TSV, nhưng tag trong code thì chỉ `/generate-code` ghi — mà nó thấy row `OK` là skip (`generate-code` §Read Trace State). Vòng lặp đóng, và lối ra duy nhất là ép sinh lại code cho hàng loạt UC không hề thay đổi.*
|
|
636
|
+
|
|
637
|
+
Parse `$ARGUMENTS`:
|
|
638
|
+
|
|
639
|
+
| Flag | Làm gì |
|
|
640
|
+
|---|---|
|
|
641
|
+
| `--realign-prd-version {UC-ID}` | Cập nhật cột `prd_version` của TSV **và** tag `@trace.prd_version` trong các file code của UC đó → version PRD hiện tại |
|
|
642
|
+
| `--realign-techdoc-revision {UC-ID}` | Tương tự với `tech_doc_revision`/`fe_tech_doc_revision` và tag `@trace.tech_doc_revision` → `@trace.revision` hiện tại |
|
|
643
|
+
|
|
644
|
+
**Ba rào an toàn — bắt buộc, đây là lệnh SỬA CODE:**
|
|
645
|
+
|
|
646
|
+
1. **Từ chối chạy** nếu UC đó có bất kỳ SC nào đang `DRIFT` hoặc `ORPHANED`, hoặc nếu Step 4/5 xếp nó là 🟠 (không phải ⓘ). Khi đó nội dung **có** đổi thật — dán nhãn lại là **che lỗi**. In:
|
|
647
|
+
```
|
|
648
|
+
❌ Từ chối realign {UC-ID}: UC này đang {PRD_DRIFT | có SC DRIFT | ORPHANED}.
|
|
649
|
+
Realign chỉ dành cho ⓘ STALE_REF (nội dung KHÔNG đổi, chỉ con trỏ version cũ).
|
|
650
|
+
Ở đây nội dung có đổi thật → /generate-bdd rồi /generate-code {UC-ID}.
|
|
651
|
+
```
|
|
652
|
+
2. **Chỉ sửa dòng bắt đầu bằng `@trace.`** — không đụng một dòng logic nào. **Guard sau-ghi:** đọc lại file, diff với bản trước; nếu có bất kỳ dòng nào **khác** ngoài các dòng `@trace.*` đã định → **khôi phục file** và dừng.
|
|
653
|
+
3. **In chính xác** file + dòng đã sửa vào report — realign im lặng là realign không kiểm chứng được.
|
|
654
|
+
|
|
655
|
+
Không đụng `dev_selftest`/`qc_status` (luật G28 không áp: **không có logic nào đổi** — đó chính là tiền đề của realign).
|
|
656
|
+
|
|
593
657
|
### Step 5c — BDD version drift check
|
|
594
658
|
|
|
595
659
|
*Đối xứng với Step 4 (PRD drift). Trước đây tầng BDD là tầng DUY NHẤT không có cờ drift — dù `/generate-code` vẫn ghi `@trace.bdd_version` vào code và JSON report vẫn lưu nó. Dữ liệu có, chỉ thiếu phép so.*
|
|
@@ -610,6 +674,29 @@ Code mang version cũ hơn → gắn cờ `BDD_DRIFT`. Kèm theo, liệt kê cá
|
|
|
610
674
|
|
|
611
675
|
**Chiều BDD → tech-doc** *(chỉ report, cổng chặn nằm ở `/review-tech-docs`)*: đọc map `@trace.bdd_versions` của tech-doc gộp; platform nào có `.feature` **mới hơn** entry trong map → gắn cờ `TECHDOC_STALE_VS_BDD`. Đây là ca nguy hiểm hơn drift-về-code: `/generate-code` DS3 thấy tech-doc `approved` sẽ lấy shape §4 **nguyên văn** làm contract "đã chốt", nên contract dựng từ BDD cũ sẽ lan thẳng vào code.
|
|
612
676
|
|
|
677
|
+
### Step 5d — Design-spec drift check *(chỉ FE/App)*
|
|
678
|
+
|
|
679
|
+
*Bỏ qua hoàn toàn với `system`/backend — không có design-spec.*
|
|
680
|
+
|
|
681
|
+
*Đối xứng Step 5c. Design-spec là artifact upstream **cuối cùng** được đưa vào trace: nó điều khiển cả BDD FE/App (Screen States + AC-UI, xem `generate-bdd` §Design Spec — Gate & Load) lẫn code FE (màn hình, component inventory, link Figma frame), nhưng trước đây không có cột, không có tag, không có cờ. Nó **có** tự bảo vệ một chiều — `/generate-design-spec` reset `Status: draft` khi PRD đổi — nhưng chiều ngược lại (designer sửa design-spec SAU KHI BDD/code đã sinh) thì không gì bắt được.*
|
|
682
|
+
|
|
683
|
+
Đọc `| **Version** |` **hiện tại** từ Metadata design-spec tại `{paths.specs_dir}/{domain}/{prd-slug}/design-spec/{TICKET-ID}-design-spec-{platform}-{slug}.md` *(`app-ios`/`app-android` không có bản riêng → fallback bản `-app-`)*.
|
|
684
|
+
|
|
685
|
+
**Chiều design-spec → BDD.** So với cột `design_spec_version` của TSV:
|
|
686
|
+
- Cột **cũ hơn** → `DESIGNSPEC_STALE_VS_BDD` 🟠. BDD FE/App dựng từ design-spec cũ → có thể thiếu Screen State / AC-UI vừa thêm. Route: `/generate-bdd {prd-file}`.
|
|
687
|
+
|
|
688
|
+
**Chiều design-spec → code.** So với tag `@trace.design_spec_version` trong các file code FE implement UC đó:
|
|
689
|
+
- Tag **cũ hơn** → `DESIGNSPEC_DRIFT` 🟠. Route: `/generate-code {feature-file}`.
|
|
690
|
+
|
|
691
|
+
**Không kết luận khi thiếu đầu so:**
|
|
692
|
+
- Cột `design_spec_version` = `—` (TSV cũ, hoặc BDD sinh khi chưa có design-spec) → skip chiều BDD.
|
|
693
|
+
- File code FE **không có** tag `@trace.design_spec_version` (sinh trước khi tag này tồn tại) → skip chiều code, và đếm gộp **một dòng** — y hệt cách Step 5c xử `@trace.bdd_version` thiếu:
|
|
694
|
+
```
|
|
695
|
+
⚠️ {n} file FE thiếu tag @trace.design_spec_version → drift detection mù ở các file này.
|
|
696
|
+
Bổ sung khi sửa file lần tới (/review-code lăng kính Traceability sẽ bắt).
|
|
697
|
+
```
|
|
698
|
+
- Không tìm thấy file design-spec → skip im lặng (feature có thể chưa cần design-spec; `/generate-bdd` đã cảnh báo mềm ở chỗ của nó).
|
|
699
|
+
|
|
613
700
|
### Step 5b — Seam & Stub Audit (mồ côi khi ghép luồng)
|
|
614
701
|
|
|
615
702
|
*Bắt lỗi "gen từng BDD thì đúng, ghép cả luồng thì hỏng": chỗ giả lập còn rỗng trong khi hàng thật đã tồn tại ở nơi khác — luồng chạy vào no-op / hàm thật không ai gọi. Build vẫn xanh, test từng-UC vẫn xanh, nên không cổng nào khác bắt được. Hai loại: `seam` (port cross-UC chưa nối) và `stub` (method trắng nội-feature chưa lấp).*
|
|
@@ -641,7 +728,7 @@ Code mang version cũ hơn → gắn cờ `BDD_DRIFT`. Kèm theo, liệt kê cá
|
|
|
641
728
|
| `stub_owner` ĐÃ gen (hoặc có method song song cùng `stub_for`) mà method vẫn còn `@trace.stub` rỗng | `STUB_UNRESOLVED` 🔴 | **Lỗi thật** — hàm trắng mồ côi (caller chạy vào rỗng) và/hoặc hàm thật mồ côi (không ai gọi). Fill-before-create đã trượt. |
|
|
642
729
|
| Không còn method nào mang `@trace.stub` cho trách nhiệm đó | *(sạch)* | Đã lấp xong. |
|
|
643
730
|
|
|
644
|
-
- **Cập nhật sổ `_seams.tsv`** (nếu tồn tại)
|
|
731
|
+
- **Cập nhật sổ `_seams.tsv`** (nếu tồn tại). **Khớp dòng theo khoá `(kind, name, consumer_uc)`** — `name` là tên port (seam) hoặc trách nhiệm (stub). *Không khớp theo `artifact`: class/method stub có thể được đổi tên hoặc di chuyển giữa hai lần chạy, lúc đó ta sẽ append dòng mới thay vì cập nhật dòng cũ và sổ đẻ ra bản ghi ma.* Cập nhật `status` + `last_updated`; giữ nguyên `owner_uc`/`binding` (do `/generate-code` sở hữu). Theo `kind`:
|
|
645
732
|
- `seam`: `PENDING`→`READY` khi hàng thật xuất hiện mà chưa nối; `→RESOLVED` khi binding đã trỏ hàng thật.
|
|
646
733
|
- `stub`: `PENDING`→`READY` khi phát hiện `STUB_UNRESOLVED`; `→RESOLVED` khi method đã được lấp (hết `@trace.stub`).
|
|
647
734
|
`READY` = đồng nghĩa cờ 🔴 tương ứng (`SEAM_UNWIRED` / `STUB_UNRESOLVED`).
|
|
@@ -681,10 +768,27 @@ fe_integrated = rows where fe_phase == integrated # FE đã wire adapter th
|
|
|
681
768
|
# công việc CHƯA XONG dù status có thể đã là OK (có code + có test trên mock).
|
|
682
769
|
orphaned_count = rows where status == ORPHANED # code còn, scenario đã bị xoá khỏi .feature (Step 2b/Rule 0)
|
|
683
770
|
trace_orphan_count = số tag @trace.implements/@trace.verifies trỏ vào SC không tồn tại VÀ không có row TSV (Step 2b)
|
|
771
|
+
prd_drift_count = số UC bị cờ PRD_DRIFT (lệch version VÀ changelog nêu UC này — Step 4)
|
|
772
|
+
prd_stale_ref_count = số UC bị cờ PRD_STALE_REF (lệch version nhưng changelog KHÔNG nêu UC này —
|
|
773
|
+
nội dung không đổi, chỉ con trỏ cũ). ⓘ không phải lỗi; sạch bằng --realign-prd-version
|
|
774
|
+
techdoc_stale_ref_count = số UC bị cờ TECHDOC_STALE_REF (đối xứng, Step 5)
|
|
684
775
|
bdd_drift_count = số UC×platform bị cờ BDD_DRIFT (code mang @trace.bdd_version cũ hơn .feature — Step 5c)
|
|
776
|
+
techdoc_drift_count = số UC bị cờ TECHDOC_DRIFT (code sinh từ tech_doc_revision cũ hơn @trace.revision — Step 5)
|
|
777
|
+
fe_techdoc_drift_count = số UC×platform bị cờ FE_TECHDOC_DRIFT (FE wire theo fe_tech_doc_revision cũ — Step 5)
|
|
685
778
|
techdoc_stale_vs_bdd_count = số platform mà tech-doc dựng từ bdd_version cũ hơn .feature hiện tại (Step 5c)
|
|
779
|
+
designspec_drift_count = số UC×platform FE bị cờ DESIGNSPEC_DRIFT (code FE mang design_spec_version cũ hơn — Step 5d)
|
|
780
|
+
designspec_stale_vs_bdd_count = số UC×platform FE mà BDD dựng từ design-spec cũ hơn bản hiện tại (Step 5d)
|
|
781
|
+
by_service = map {service → {total_scs, coded_scs, tested_scs, drift_count}} — gom theo cột `service` (cột 23)
|
|
782
|
+
# Trả lời câu số MỘT của dự án nhiều đội: "đội nào còn bao nhiêu việc".
|
|
783
|
+
# Trước khi có cột 23, trace gộp (spec_source) KHÔNG mang thông tin sở hữu ở
|
|
784
|
+
# cấp row nên câu này không trả lời được. Bỏ qua map này ở single-service.
|
|
686
785
|
seam_unwired_count = số seam bị cờ SEAM_UNWIRED (hàng thật đã có nhưng consumer còn wire vào stub — Step 5b)
|
|
786
|
+
seam_pending_count = số seam bị cờ SEAM_PENDING (owner UC chưa gen — ⓘ chưa phải lỗi; PM dùng để xếp thứ tự gen)
|
|
687
787
|
stub_unresolved_count = số stub bị cờ STUB_UNRESOLVED (method còn trắng dù owner đã gen / có hàm song song — Step 5b)
|
|
788
|
+
stub_pending_count = số stub bị cờ STUB_PENDING (owner BDD chưa gen — ⓘ chưa phải lỗi)
|
|
789
|
+
# LUẬT (rules/workflow.md §Trace Contract): MỌI giá trị trong vocabularies.audit_flags phải có
|
|
790
|
+
# một counter {flag_lowercase}_count ở đây VÀ trong summary của JSON. bin/self-check.js R7 ép
|
|
791
|
+
# điều này — thiếu counter = cờ không quan sát được ở tầng tổng hợp, dashboard không thấy.
|
|
688
792
|
dev_selftest_passing = rows where dev_selftest == pass
|
|
689
793
|
dev_selftest_failing = rows where dev_selftest == fail
|
|
690
794
|
dev_selftest_not_run = rows where dev_selftest in (not_run, —)
|
|
@@ -702,6 +806,20 @@ waiting_po = rows where qc_owner == po # PM view: blocked, waiting o
|
|
|
702
806
|
tech_docs_count = count .md files in {paths.tech_docs_dir}/{domain}/*/tech-docs/
|
|
703
807
|
```
|
|
704
808
|
|
|
809
|
+
### Step 7b — Hàng đợi yêu cầu đổi PRD còn treo
|
|
810
|
+
|
|
811
|
+
*Không phải trạng thái trace — nhưng đây là hàng đợi DUY NHẤT trong framework không có lệnh nào quét lại nó, nên nó cần một chỗ để không chìm. Chọn lệnh này vì nó được chạy thường xuyên nhất.*
|
|
812
|
+
|
|
813
|
+
Quét `{paths.prd_change_requests_dir}/*.md` (mặc định `{spec_source}/feedback/prd-change-requests/`; **không** quét `archived/`). Thư mục không tồn tại hoặc rỗng → bỏ qua **im lặng**, không in gì.
|
|
814
|
+
|
|
815
|
+
Với mỗi file, đọc metadata: `UC / Ticket`, `Status`, và tiêu đề. Chỉ giữ `Status: Open` (bỏ qua `incorporated` / `rejected`).
|
|
816
|
+
|
|
817
|
+
Tính `days_waiting` = số ngày từ ngày file được tạo tới hôm nay. Nguồn ngày, theo thứ tự ưu tiên: (1) field ngày trong metadata nếu có · (2) `git -C {REPO} log --diff-filter=A --format=%ad --date=short -1 -- {file}` · (3) không lấy được → để `—`, đừng đoán.
|
|
818
|
+
|
|
819
|
+
Lưu danh sách này cho §Output. **Không** ghi nó vào `trace-report.json` — nó không phải trạng thái trace, và JSON là contract với panel VS Code.
|
|
820
|
+
|
|
821
|
+
> **Vì sao cần bước này:** ba hàng đợi feedback thì hai cái đã có người quét lại mỗi lần chạy — `/fix-bug` đọc `bug-reports/`, `/generate-bdd` quét `bdd-proposals/`. Riêng `prd-change-requests/` không có ai. Chỗ duy nhất nó từng xuất hiện là `/sync` Step 1d, mà Step 1d chỉ hiện những gì về **trong đúng lần pull đó** (`{old_sha}..{new_sha}`) — bỏ lỡ một lần là mất khỏi màn hình vĩnh viễn. Đây là loại yêu cầu **không cờ trace nào bắt được**: nó nói về hành vi chưa có AC nào phủ, nên theo mọi thước đo coverage thì nó không tồn tại.
|
|
822
|
+
|
|
705
823
|
### Step 8 — Ghi JSON report
|
|
706
824
|
|
|
707
825
|
Ghi `{paths.trace_dir}/trace-report.json` (ghi đè nếu tồn tại). File này là source of truth duy nhất cho web dashboard — nó chứa snapshot đầy đủ tại thời điểm `/validate-traces` chạy lần cuối.
|
|
@@ -730,10 +848,19 @@ Schema:
|
|
|
730
848
|
"fe_integrated": 0,
|
|
731
849
|
"orphaned_count": 0,
|
|
732
850
|
"trace_orphan_count": 0,
|
|
851
|
+
"prd_drift_count": 0,
|
|
852
|
+
"prd_stale_ref_count": 0,
|
|
733
853
|
"bdd_drift_count": 0,
|
|
854
|
+
"techdoc_drift_count": 0,
|
|
855
|
+
"techdoc_stale_ref_count": 0,
|
|
856
|
+
"fe_techdoc_drift_count": 0,
|
|
734
857
|
"techdoc_stale_vs_bdd_count": 0,
|
|
858
|
+
"designspec_drift_count": 0,
|
|
859
|
+
"designspec_stale_vs_bdd_count": 0,
|
|
735
860
|
"seam_unwired_count": 0,
|
|
861
|
+
"seam_pending_count": 0,
|
|
736
862
|
"stub_unresolved_count": 0,
|
|
863
|
+
"stub_pending_count": 0,
|
|
737
864
|
"dev_selftest_passing": 0,
|
|
738
865
|
"dev_selftest_failing": 0,
|
|
739
866
|
"dev_selftest_not_run": 0,
|
|
@@ -743,7 +870,12 @@ Schema:
|
|
|
743
870
|
"qc_not_run": 0,
|
|
744
871
|
"waiting_dev": 0,
|
|
745
872
|
"waiting_po": 0,
|
|
746
|
-
"tech_docs_count": 0
|
|
873
|
+
"tech_docs_count": 0,
|
|
874
|
+
"by_service": {
|
|
875
|
+
"<service path, e.g. user-service>": {
|
|
876
|
+
"total_scs": 0, "coded_scs": 0, "tested_scs": 0, "drift_count": 0
|
|
877
|
+
}
|
|
878
|
+
}
|
|
747
879
|
},
|
|
748
880
|
"prds": [
|
|
749
881
|
{
|
|
@@ -778,6 +910,8 @@ Schema:
|
|
|
778
910
|
"bdd_version": "<bdd version when code was generated>",
|
|
779
911
|
"tech_doc_revision": 0,
|
|
780
912
|
"fe_tech_doc_revision": 0,
|
|
913
|
+
"service": "<đội/submodule sở hữu — cột 23; null nếu '—'>",
|
|
914
|
+
"design_spec_version": "<version design-spec lúc sinh BDD — cột 24; null nếu '—'>",
|
|
781
915
|
"status": "OK | DRIFT | GAP | UNTRACKED",
|
|
782
916
|
"orphaned": false,
|
|
783
917
|
"last_updated": "<YYYY-MM-DD>"
|
|
@@ -815,10 +949,34 @@ Schema:
|
|
|
815
949
|
"prd_version_drift": [
|
|
816
950
|
{
|
|
817
951
|
"uc_id": "<UC-ID>",
|
|
818
|
-
"
|
|
819
|
-
"
|
|
952
|
+
"current_prd_version": "<version in PRD file — mốc so sánh>",
|
|
953
|
+
"tsv_prd_version": "<cột prd_version của TSV — version lúc sinh BDD>",
|
|
954
|
+
"code_prd_version": "<tag @trace.prd_version trong code — version lúc sinh code>",
|
|
955
|
+
"drifted_layers": ["tsv", "code"],
|
|
820
956
|
"changelog_since": ["<v1.1: ...>", "<v1.2: ...>"],
|
|
821
|
-
"
|
|
957
|
+
"in_changelog_scope": true,
|
|
958
|
+
"fix": "chỉ [\"tsv\"] → /generate-bdd <prd-file> là đủ · có \"code\" → /generate-bdd rồi /generate-code <UC-ID>"
|
|
959
|
+
}
|
|
960
|
+
],
|
|
961
|
+
"prd_stale_ref": [
|
|
962
|
+
{
|
|
963
|
+
"uc_id": "<UC-ID>",
|
|
964
|
+
"current_prd_version": "<version PRD file>",
|
|
965
|
+
"tsv_prd_version": "<cột prd_version>",
|
|
966
|
+
"code_prd_version": "<tag trong code>",
|
|
967
|
+
"drifted_layers": ["code"],
|
|
968
|
+
"changelog_since": ["<v2.0: thêm UC7 — không đụng UC1>"],
|
|
969
|
+
"in_changelog_scope": false,
|
|
970
|
+
"fix": "/validate-traces --realign-prd-version <UC-ID> (chỉ sửa dòng nhãn, KHÔNG đụng logic)"
|
|
971
|
+
}
|
|
972
|
+
],
|
|
973
|
+
"techdoc_stale_ref": [
|
|
974
|
+
{
|
|
975
|
+
"uc_id": "<UC-ID>",
|
|
976
|
+
"current_revision": 0,
|
|
977
|
+
"code_revision": 0,
|
|
978
|
+
"in_changelog_scope": false,
|
|
979
|
+
"fix": "/validate-traces --realign-techdoc-revision <UC-ID>"
|
|
822
980
|
}
|
|
823
981
|
],
|
|
824
982
|
"bdd_drift": [
|
|
@@ -840,6 +998,24 @@ Schema:
|
|
|
840
998
|
"fix": "/generate-tech-docs <feature-file> then /review-tech-docs"
|
|
841
999
|
}
|
|
842
1000
|
],
|
|
1001
|
+
"designspec_drift": [
|
|
1002
|
+
{
|
|
1003
|
+
"uc_id": "<UC-ID>",
|
|
1004
|
+
"platform": "web | app",
|
|
1005
|
+
"code_design_spec_version": "<@trace.design_spec_version trong code FE>",
|
|
1006
|
+
"current_design_spec_version": "<| **Version** | của design-spec>",
|
|
1007
|
+
"fix": "/generate-code <feature-file>"
|
|
1008
|
+
}
|
|
1009
|
+
],
|
|
1010
|
+
"designspec_stale_vs_bdd": [
|
|
1011
|
+
{
|
|
1012
|
+
"uc_id": "<UC-ID>",
|
|
1013
|
+
"platform": "web | app",
|
|
1014
|
+
"bdd_design_spec_version": "<cột design_spec_version của TSV>",
|
|
1015
|
+
"current_design_spec_version": "<| **Version** | của design-spec>",
|
|
1016
|
+
"fix": "/generate-bdd <prd-file> — BDD có thể thiếu Screen State / AC-UI vừa thêm"
|
|
1017
|
+
}
|
|
1018
|
+
],
|
|
843
1019
|
"orphaned": [
|
|
844
1020
|
{
|
|
845
1021
|
"sc_id": "<SC-ID đã bị xoá khỏi .feature>",
|
|
@@ -862,7 +1038,7 @@ Schema:
|
|
|
862
1038
|
"uc_id": "<UC-ID>",
|
|
863
1039
|
"code_revision": 0,
|
|
864
1040
|
"current_revision": 0,
|
|
865
|
-
"fix": "/generate-code <UC-ID>"
|
|
1041
|
+
"fix": "changelog KHÔNG nêu UC này → /validate-traces --realign-techdoc-revision <UC-ID> (rẻ, không đụng logic) · changelog CÓ nêu → /generate-code <UC-ID> --force"
|
|
866
1042
|
}
|
|
867
1043
|
],
|
|
868
1044
|
"fe_techdoc_drift": [
|
|
@@ -871,7 +1047,7 @@ Schema:
|
|
|
871
1047
|
"platform": "web | app",
|
|
872
1048
|
"code_revision": 0,
|
|
873
1049
|
"current_revision": 0,
|
|
874
|
-
"fix": "/generate-code <UC-ID> --phase=integration"
|
|
1050
|
+
"fix": "changelog KHÔNG nêu UC này → /validate-traces --realign-techdoc-revision <UC-ID> · CÓ nêu → /generate-code <UC-ID> --phase=integration --force"
|
|
875
1051
|
}
|
|
876
1052
|
],
|
|
877
1053
|
"seam_unwired": [
|
|
@@ -909,8 +1085,10 @@ Schema:
|
|
|
909
1085
|
**TSV giữ nguyên chữ `ORPHANED`** trong cột `status` — TSV là nguồn-sự-thật, JSON chỉ là bản xuất cho panel.
|
|
910
1086
|
- `orphaned` (boolean): `true` chỉ khi cột `status` của TSV là `ORPHANED`; mọi row khác ghi `false` (đừng bỏ trống — panel đọc field vắng dễ ra `undefined`).
|
|
911
1087
|
- Luôn ghi vào `{paths.trace_dir}/trace-report.json` bất kể domain filter — nếu có domain filter, chỉ gồm các PRD đó trong `prds[]` nhưng ghi domain vào field `domain`
|
|
912
|
-
- **TSV `"—"` mapping**: khi đọc file TSV, map giá trị dash sang kiểu JSON: `implemented_by: "—"` → `null`; `test_count: "—"` → `0`; `test_classes: "—"` → `[]`; `tech_doc_revision: "—"` → `0`; `fe_tech_doc_revision: "—"` → `0`; `dev_selftest: "—"` → `"not_run"`; `dev_selftest_at: "—"` → `null`; `qc_status: "—"` → `"not_run"`; `qc_run_at: "—"` → `null`; `qc_owner: "—"` → `null`; `qc_blocked_by: "—"` → `null`
|
|
913
|
-
- **Backward-compat:** TSV cũ có thể thiếu cột mới hơn trong header — coi cột vắng nào là giá trị rỗng của nó (
|
|
1088
|
+
- **TSV `"—"` mapping**: khi đọc file TSV, map giá trị dash sang kiểu JSON: `implemented_by: "—"` → `null`; `test_count: "—"` → `0`; `test_classes: "—"` → `[]`; `tech_doc_revision: "—"` → `0`; `fe_tech_doc_revision: "—"` → `0`; `dev_selftest: "—"` → `"not_run"`; `dev_selftest_at: "—"` → `null`; `qc_status: "—"` → `"not_run"`; `qc_run_at: "—"` → `null`; `qc_owner: "—"` → `null`; `qc_blocked_by: "—"` → `null`; `service: "—"` → `null`; `design_spec_version: "—"` → `null`
|
|
1089
|
+
- **Backward-compat:** TSV cũ có thể thiếu cột mới hơn trong header — coi cột vắng nào là giá trị rỗng của nó (**đừng báo lỗi, đừng bỏ qua cả file**): `qc_owner`/`qc_blocked_by` (pre-19-col) → `null`; `fe_tech_doc_revision` (pre-22-col) → `0`; `service`/`design_spec_version` (pre-24-col) → `null`. Lần `/generate-bdd` gen lại tiếp theo nâng header lên layout **24 cột** hiện tại.
|
|
1090
|
+
> **Đọc theo TÊN CỘT ở header row, KHÔNG theo vị trí.** Header là dòng đầu mỗi `.tsv` — parse nó rồi tra theo tên. Đếm vị trí sẽ vỡ ở đúng file cũ mà luật này sinh ra để đỡ. Header thiếu hoàn toàn (file hỏng) → mới báo lỗi cho file đó và đi tiếp, không abort cả lệnh.
|
|
1091
|
+
> **Cột `service` = `null` không bằng "không có đội".** Nó nghĩa là *chưa biết* (TSV cũ hơn cột 23). Gom vào một nhóm `"(chưa xác định)"` trong `by_service` thay vì bỏ khỏi thống kê — bỏ đi thì tổng của `by_service` nhỏ hơn `total_scs` mà không ai giải thích được vì sao.
|
|
914
1092
|
|
|
915
1093
|
### Step 8b — Living Docs Sync *(chỉ umbrella mode)*
|
|
916
1094
|
|
|
@@ -918,18 +1096,19 @@ Schema:
|
|
|
918
1096
|
|
|
919
1097
|
**Với `spec_source` được set,** các trace TSV authoritative đã sống ở **một** chỗ —
|
|
920
1098
|
`{spec_source}/.trace/` (committed trong spec repo). **Không có merge theo service**:
|
|
921
|
-
mỗi scenario row mang service sở hữu
|
|
922
|
-
(re)generate report và làm mới panel local.
|
|
1099
|
+
mỗi scenario row mang service sở hữu ở **cột `service`** (cột 23, do `/generate-bdd` ghi từ
|
|
1100
|
+
`@trace.service`). Step này chỉ (re)generate report và làm mới panel local.
|
|
923
1101
|
|
|
924
1102
|
1. **Ghi report** vào `{living_docs_dir}/trace-report.json` (`mkdir -p` trước) — dựng
|
|
925
1103
|
trực tiếp từ `{spec_source}/.trace/*.tsv`, với field `"service"` mỗi scenario row và
|
|
926
1104
|
các summary aggregate. *(Umbrella legacy không-`spec_source` vẫn merge mọi `trace-report.json`
|
|
927
1105
|
theo service thành một document, namespace theo service.)*
|
|
928
1106
|
|
|
929
|
-
2. **Mirror tới panel location** `{panel_mirror}` (`./.trace` ở gốc workspace hiện tại)
|
|
1107
|
+
2. **Mirror tới panel location** `{panel_mirror}` (`./.trace-mirror` ở gốc workspace hiện tại)
|
|
930
1108
|
để dev mở *repo này* thấy data ngay: copy
|
|
931
1109
|
`{living_docs_dir}/trace-report.json` (+ các file `{UC-ID}-{platform}.tsv`) → `{panel_mirror}/`.
|
|
932
|
-
|
|
1110
|
+
**Skip nếu `{paths.trace_dir}` đã nằm trong workspace hiện tại** (dev đang đứng trong spec repo —
|
|
1111
|
+
panel đọc thẳng ở đó). **KHÔNG** copy `trace-history.jsonl` sang mirror (xem Step 8c).
|
|
933
1112
|
|
|
934
1113
|
3. **In sync summary:**
|
|
935
1114
|
```
|
|
@@ -938,10 +1117,49 @@ mỗi scenario row mang service sở hữu qua `@trace.service`. Step này chỉ
|
|
|
938
1117
|
Panel mirror → {panel_mirror}/trace-report.json (current workspace)
|
|
939
1118
|
```
|
|
940
1119
|
|
|
941
|
-
> **
|
|
942
|
-
>
|
|
943
|
-
>
|
|
944
|
-
>
|
|
1120
|
+
> **Ranh giới git — tuyệt đối, không có ngoại lệ:**
|
|
1121
|
+
>
|
|
1122
|
+
> | Đường dẫn | Vai trò | Git |
|
|
1123
|
+
> |---|---|---|
|
|
1124
|
+
> | `{paths.trace_dir}/*.tsv` + `trace-history.jsonl` | **AUTHORITATIVE**, không regenerate được | **PHẢI commit** |
|
|
1125
|
+
> | `{living_docs_dir}/` (`.living-docs/`) | report sinh ra | gitignore |
|
|
1126
|
+
> | `{panel_mirror}/` (`.trace-mirror/`) | bản sao tiện cho panel | gitignore |
|
|
1127
|
+
>
|
|
1128
|
+
> Hai cái dưới được `/validate-traces` hoặc `/sync` dựng lại bất cứ lúc nào. Cái trên thì không —
|
|
1129
|
+
> mất là mất vĩnh viễn. Từ v0.4.3 mirror đổi tên thành `.trace-mirror` chính vì lý do này:
|
|
1130
|
+
> khi cả hai cùng tên `.trace`, một luật gitignore theo tên có thể xoá sổ gốc mà không ai biết.
|
|
1131
|
+
|
|
1132
|
+
### Step 8c — Ghi nhật ký lịch sử *(mọi mode)*
|
|
1133
|
+
|
|
1134
|
+
*`trace-report.json` bị **ghi đè** mỗi lần chạy (Step 8), và cột `last_updated` của TSV chỉ là một ngày bị 8 lệnh cùng ghi đè. Nên framework đo được **trạng thái** rất tốt nhưng không đo được **tốc độ** — không trả lời được "từ bao giờ", "đang lên hay xuống", "case này hỏng đi hỏng lại mấy lần". Step này thêm chiều thời gian với chi phí gần bằng 0.*
|
|
1135
|
+
|
|
1136
|
+
**Append** một dòng JSON (một bản ghi trọn vẹn trên một dòng) vào `{paths.trace_dir}/trace-history.jsonl`. Tạo file nếu chưa có.
|
|
1137
|
+
|
|
1138
|
+
**Chỉ ghi DELTA, không chép lại snapshot** — snapshot đầy đủ đã ở `trace-report.json`:
|
|
1139
|
+
|
|
1140
|
+
```json
|
|
1141
|
+
{"at":"<ISO-8601>","domain":"<domain hoặc all>",
|
|
1142
|
+
"summary":{ …nguyên khối summary của Step 7… },
|
|
1143
|
+
"changed":[{"sc_id":"PAY-UC1-SC2","platform":"web","from":"OK","to":"DRIFT"},
|
|
1144
|
+
{"sc_id":"PAY-UC1-SC7","platform":"web","from":null,"to":"UNTRACKED"}],
|
|
1145
|
+
"flags_opened":["SEAM_UNWIRED:ScoreAccumulationPort"],
|
|
1146
|
+
"flags_closed":["STUB_UNRESOLVED:SegmentService#calculateSegment"]}
|
|
1147
|
+
```
|
|
1148
|
+
|
|
1149
|
+
**Cách tính `changed` / `flags_opened` / `flags_closed`:** đọc **dòng cuối cùng** của chính file này (đọc ngược từ cuối — không parse cả file) và so với kết quả lần này. `from: null` = row mới xuất hiện. Nếu file chưa tồn tại → đây là baseline: ghi `summary`, để `changed`/`flags_*` là `[]`.
|
|
1150
|
+
|
|
1151
|
+
**Rotate:** file vượt **2000 dòng** → đổi tên thành `trace-history.{YYYY-MM}.jsonl` rồi bắt đầu file mới. Đừng xoá.
|
|
1152
|
+
|
|
1153
|
+
**Bốn ràng buộc — đây là phần dễ làm sai:**
|
|
1154
|
+
|
|
1155
|
+
| Ràng buộc | Vì sao |
|
|
1156
|
+
|---|---|
|
|
1157
|
+
| Ghi **CHỈ** vào `{paths.trace_dir}` (nơi authoritative). **KHÔNG** copy sang `{panel_mirror}` hay `{living_docs_dir}` | Nó là dữ liệu tích luỹ, không phải thứ regenerate được. Nhân bản nó ra chỗ sinh-ra là tạo hai lịch sử lệch nhau. |
|
|
1158
|
+
| File này **PHẢI được commit** cùng TSV | Nó là **dữ liệu**, không phải mirror. Regenerate lại không được — mất là mất vĩnh viễn. ⚠️ Đừng để nó dính vào luật gitignore của `.living-docs/` hay panel mirror; hai cái đó là bản sinh ra, cái này thì không. |
|
|
1159
|
+
| **Không đụng** TSV và `trace-report.json` | TSV là bảng **trạng thái** — giữ nó phẳng. Lịch sử là file riêng, format riêng, vòng đời riêng. `trace-report.json` là contract với panel VS Code. |
|
|
1160
|
+
| **Không lệnh nào được ra quyết định dựa trên file này** | Nó để **quan sát**, không phải để gác cổng. Một cái cổng phụ thuộc file có thể bị xoá là cổng dở. Cổng chặn PR vẫn chỉ là 4 cờ 🔴. |
|
|
1161
|
+
|
|
1162
|
+
Ghi thất bại (không có quyền, đĩa đầy) → **cảnh báo mềm một dòng rồi đi tiếp**. Nhật ký hỏng không được làm hỏng lệnh audit.
|
|
945
1163
|
|
|
946
1164
|
## Output
|
|
947
1165
|
|
|
@@ -981,7 +1199,7 @@ Tìm lệnh hiện tại trong bảng phase dưới đây và đánh dấu **pha
|
|
|
981
1199
|
| Phase | Commands |
|
|
982
1200
|
|-------|----------|
|
|
983
1201
|
| Discovery | `/define-product` |
|
|
984
|
-
| PRD | `/generate-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
1202
|
+
| PRD | `/generate-prd` · `/extend-prd` · `/refine-prd` · `/review-context` (PRD) |
|
|
985
1203
|
| Design Spec | `/generate-design-spec` |
|
|
986
1204
|
| BDD | `/generate-bdd` · `/review-context` (BDD) |
|
|
987
1205
|
| Tech Design | `/generate-tech-docs` · `/map-testids` · `/review-tech-docs` |
|
|
@@ -1006,6 +1224,7 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
1006
1224
|
| /setup-ai-first | `/define-product` để bắt đầu feature đầu tiên |
|
|
1007
1225
|
| /define-product | `/generate-prd {product-definition-file}` |
|
|
1008
1226
|
| /generate-prd | `/refine-prd {prd-file}` rồi `/review-context {prd-file}` |
|
|
1227
|
+
| /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}` |
|
|
1009
1228
|
| /refine-prd | Mở Review Board → cập nhật PRD → `/review-context {prd-file}` |
|
|
1010
1229
|
| /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) |
|
|
1011
1230
|
| /generate-design-spec | Designer review → xác nhận link Figma → PO + Designer sign-off → `/generate-bdd {prd-file}` |
|
|
@@ -1031,7 +1250,7 @@ Gợi ý lệnh kế tiếp hợp lý theo phase của workflow:
|
|
|
1031
1250
|
| /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 |
|
|
1032
1251
|
| /debug | `/fix-bug {ticket-id}` nếu cần sửa |
|
|
1033
1252
|
| /report-bug | Gửi cho dev (`/fix-bug {BUG-ID}`); nếu thiếu coverage → `/propose-scenario {UC-ID}` |
|
|
1034
|
-
| /propose-scenario |
|
|
1253
|
+
| /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` |
|
|
1035
1254
|
| /learn | Tiếp tục làm việc — lesson áp dụng ở lệnh kế tiếp |
|
|
1036
1255
|
| /sync | `/validate-traces` để xem độ phủ đầy đủ; xử lý mọi `📥 tester feedback` được nêu |
|
|
1037
1256
|
| /update-framework | Review `git diff .agent/`, commit; `/sync` để đồng bộ nội dung dự án |
|
|
@@ -1063,6 +1282,15 @@ Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
|
1063
1282
|
· {orphaned_count} ORPHANED · {trace_orphan_count} TRACE_ORPHAN
|
|
1064
1283
|
Build xanh, test từng-UC xanh, coverage đẹp — nhưng luồng ghép chạy vào no-op,
|
|
1065
1284
|
hoặc code đang trỏ vào scenario đã bị xoá. KHÔNG coi là pass tới khi CẢ BỐN = 0.
|
|
1285
|
+
{in dòng ⓘ dưới đây chỉ khi drift_count + bdd_drift_count > 0 — để hai loại cờ đứng cạnh nhau thay vì ở hai đầu report}
|
|
1286
|
+
ⓘ Ngoài cổng: {drift_count} DRIFT · {bdd_drift_count} BDD_DRIFT — "code CHƯA theo kịp spec".
|
|
1287
|
+
KHÔNG chặn PR (khác 4 cờ trên), nhưng cũng chưa xong.
|
|
1288
|
+
|
|
1289
|
+
{khối 📈 CHỈ in khi trace-history.jsonl đã có ≥1 dòng trước lần chạy này (Step 8c) — lần chạy
|
|
1290
|
+
đầu tiên là baseline, không có gì để so, bỏ cả khối. Dấu +/− lấy theo hướng thực tế.}
|
|
1291
|
+
📈 So lần chạy trước ({ngày dòng cuối}): code {+2}% · test {−1}% · DRIFT {+3} · UNTRACKED {−5}
|
|
1292
|
+
Đèn mới bật: {SEAM_UNWIRED × 1} · Đèn đã tắt: {STUB_UNRESOLVED × 2}
|
|
1293
|
+
{n} scenario đổi trạng thái — chi tiết: {paths.trace_dir}/trace-history.jsonl
|
|
1066
1294
|
|
|
1067
1295
|
| UC-ID | SC | Title (truncated) | Spec | Gen | Code | Tests | Status |
|
|
1068
1296
|
|-------------|------|------------------------------|-------|-------|----------------------|----------------|----------|
|
|
@@ -1087,6 +1315,20 @@ Tech-doc lỗi thời so với BDD:
|
|
|
1087
1315
|
"đã chốt" và lấy shape NGUYÊN VĂN → contract từ BDD cũ lan thẳng vào code.
|
|
1088
1316
|
→ /generate-tech-docs {feature-file} → /review-tech-docs (cổng T-BDD)
|
|
1089
1317
|
|
|
1318
|
+
Design-spec Drift (chỉ FE/App — designer sửa thiết kế SAU KHI BDD/code đã sinh):
|
|
1319
|
+
{UC}-UC1 (web) — code dựng từ design-spec v1.2, design-spec giờ v1.5
|
|
1320
|
+
→ /generate-code {feature-file}
|
|
1321
|
+
{UC}-UC4 (app) — BDD dựng từ design-spec v2.0, design-spec giờ v2.3
|
|
1322
|
+
⚠️ BDD có thể THIẾU Screen State / AC-UI vừa thêm — không phải chỉ lỗi thời nhãn.
|
|
1323
|
+
→ /generate-bdd {prd-file}
|
|
1324
|
+
⚠️ {n} file FE thiếu tag @trace.design_spec_version → drift detection mù ở các file này
|
|
1325
|
+
|
|
1326
|
+
{khối by_service CHỈ in ở umbrella mode (có section `services`) — bỏ ở single-service}
|
|
1327
|
+
Theo đội (cột `service`):
|
|
1328
|
+
user-service 12/15 SC có code · 10 test · 2 DRIFT
|
|
1329
|
+
web-app 8/8 SC có code · 8 test · 0 DRIFT
|
|
1330
|
+
(chưa xác định) 3/3 SC có code · 3 test · 0 DRIFT ← TSV cũ hơn cột 23, chạy /generate-bdd để điền
|
|
1331
|
+
|
|
1090
1332
|
FE còn dùng mock (fe_phase = ui — có UI + test nhưng CHƯA nối API thật):
|
|
1091
1333
|
{UC}-UC1 (web) — {n} SC ở fe_phase=ui
|
|
1092
1334
|
→ /generate-code {feature-file} --phase=integration (hoặc để trống --phase cho fe_full)
|
|
@@ -1107,16 +1349,30 @@ Trace orphan (tag trỏ vào SC không tồn tại, KHÔNG có row .tsv nào):
|
|
|
1107
1349
|
(Không lệnh nào khác bắt được cái này — row .tsv đã bị xoá bởi version cũ,
|
|
1108
1350
|
hoặc tag ghi sai id ngay từ đầu.)
|
|
1109
1351
|
|
|
1110
|
-
PRD Version Drift:
|
|
1111
|
-
{UC}-UC2 — code ở PRD v1.0, PRD giờ ở v1.2
|
|
1352
|
+
PRD Version Drift (changelog CÓ nêu UC này — nội dung đổi thật):
|
|
1353
|
+
{UC}-UC2 — code ở PRD v1.0, PRD giờ ở v1.2 [lệch: tsv, code]
|
|
1112
1354
|
Thay đổi kể từ v1.0:
|
|
1113
1355
|
v1.1: {changelog entry}
|
|
1114
1356
|
v1.2: {changelog entry}
|
|
1115
1357
|
→ /generate-bdd {prd-file} then /generate-code {UC-ID}
|
|
1116
1358
|
|
|
1117
|
-
|
|
1359
|
+
{khối ⓘ dưới CHỈ in khi prd_stale_ref_count > 0}
|
|
1360
|
+
ⓘ PRD_STALE_REF — {n} UC mang con trỏ PRD cũ nhưng changelog KHÔNG nêu chúng:
|
|
1361
|
+
{UC}-UC1, {UC}-UC3, {UC}-UC4 — PRD v1.4 → v2.0 vì "thêm UC7", không đụng các UC này
|
|
1362
|
+
Nội dung KHÔNG đổi → không cần sinh lại code. Chỉ là nhãn version cũ.
|
|
1363
|
+
→ /validate-traces --realign-prd-version {UC-ID} (chỉ sửa dòng @trace.*, KHÔNG đụng logic)
|
|
1364
|
+
⚠️ Đây KHÔNG phải lỗi. Nó tồn tại vì version PRD là MỘT số cho cả tài liệu nhiều UC —
|
|
1365
|
+
thêm một UC làm mọi UC cũ lệch số. Trước khi có bộ lọc này, cả {n} UC đều ăn cờ đỏ oan,
|
|
1366
|
+
và làm theo hướng dẫn cũng không tắt được (generate-code skip row đang OK).
|
|
1367
|
+
|
|
1368
|
+
Tech-Doc Revision Drift (changelog CÓ nêu UC này):
|
|
1118
1369
|
{UC}-UC3 — code sinh từ tech-doc revision 2, giờ ở revision 4
|
|
1119
|
-
→
|
|
1370
|
+
→ /generate-code {UC-ID} --force
|
|
1371
|
+
|
|
1372
|
+
{khối ⓘ dưới CHỈ in khi techdoc_stale_ref_count > 0}
|
|
1373
|
+
ⓘ TECHDOC_STALE_REF — {n} UC mang revision tech-doc cũ nhưng changelog KHÔNG nêu chúng:
|
|
1374
|
+
{UC}-UC5, {UC}-UC6 — revision 2 → 4 vì UC8 được APPEND vào doc gộp
|
|
1375
|
+
→ /validate-traces --realign-techdoc-revision {UC-ID}
|
|
1120
1376
|
|
|
1121
1377
|
Seam & Stub Audit (mồ côi khi ghép luồng):
|
|
1122
1378
|
🔴 SEAM_UNWIRED — {port}: {consumer_uc} còn gọi {stub_class} rỗng,
|
|
@@ -1128,11 +1384,27 @@ Seam & Stub Audit (mồ côi khi ghép luồng):
|
|
|
1128
1384
|
→ /generate-code {owner_uc} lấp logic vào {ClassName#method} tại chỗ, xoá hàm song song, build lại
|
|
1129
1385
|
ⓘ STUB_PENDING — {ClassName#method} ({stub_for}): owner {owner_uc} chưa gen (chưa phải lỗi)
|
|
1130
1386
|
|
|
1387
|
+
{khối dưới CHỈ in khi Step 7b tìm thấy ≥1 request Status: Open — else bỏ cả khối}
|
|
1388
|
+
📥 Yêu cầu đổi PRD đang chờ ({n} — chưa ai xử lý):
|
|
1389
|
+
{UC-ID} — "{title}" chờ {days_waiting} ngày
|
|
1390
|
+
{UC-ID} — "{title}" chờ {days_waiting} ngày
|
|
1391
|
+
Đây KHÔNG phải coverage gap: nó là requirement chưa có AC nào phủ, nên KHÔNG cờ
|
|
1392
|
+
trace nào bắt được — theo mọi thước đo coverage thì nó không tồn tại. Chỉ hết khi
|
|
1393
|
+
PO đưa vào PRD.
|
|
1394
|
+
→ PO đọc request, đặt Status: accepted, rồi /extend-prd {prd-file}
|
|
1395
|
+
(nó tự nhặt request, chốt AC/BR, đánh số nối tiếp, bump version + changelog,
|
|
1396
|
+
và đóng dấu incorporated + archived/ — không phải làm tay bước nào).
|
|
1397
|
+
|
|
1131
1398
|
Recommendations:
|
|
1132
1399
|
- /generate-code {UC-ID} cho scenario DRIFT và UNTRACKED
|
|
1133
1400
|
- /dev-gen-test {UC-ID} cho GAP (thiếu test)
|
|
1134
|
-
- /generate-bdd {prd-file} cho
|
|
1401
|
+
- /generate-bdd {prd-file} cho PRD_DRIFT 🟠 (changelog CÓ nêu UC này)
|
|
1402
|
+
- /validate-traces --realign-prd-version {UC-ID} cho PRD_STALE_REF ⓘ
|
|
1403
|
+
- /validate-traces --realign-techdoc-revision {UC-ID} cho TECHDOC_STALE_REF ⓘ
|
|
1404
|
+
↳ Hai cái này chỉ sửa dòng @trace.*, KHÔNG đụng logic. Đừng /generate-code cho
|
|
1405
|
+
chúng — version bump không đụng UC này, sinh lại code là rủi ro không đáng.
|
|
1135
1406
|
- /generate-code {feature-file} cho BDD_DRIFT (code sinh từ .feature cũ hơn)
|
|
1407
|
+
- /generate-code {feature-file} cho DESIGNSPEC_DRIFT · /generate-bdd cho DESIGNSPEC_STALE_VS_BDD
|
|
1136
1408
|
- /generate-tech-docs + /review-tech-docs cho tech-doc lỗi thời so với BDD
|
|
1137
1409
|
- Nối binding thủ công cho mỗi SEAM_UNWIRED 🔴 (hàng thật đã có, còn kẹt stub)
|
|
1138
1410
|
- /generate-code {owner_uc} cho mỗi STUB_UNRESOLVED 🔴 (lấp method trắng tại chỗ + xoá hàm song song)
|
|
@@ -1140,11 +1412,24 @@ Recommendations:
|
|
|
1140
1412
|
scenario trở lại .feature, hoặc sửa sc_id của tag.
|
|
1141
1413
|
KHÔNG có lệnh tự xử: cần người xác nhận behavior còn cần hay không.
|
|
1142
1414
|
|
|
1143
|
-
⚠️
|
|
1415
|
+
⚠️ CỔNG TẠO PR = 4 cờ 🔴 đều = 0 (SEAM_UNWIRED · STUB_UNRESOLVED · ORPHANED · TRACE_ORPHAN).
|
|
1416
|
+
Đây là cổng "code đang HỎNG" — luồng ghép chạy vào hàm rỗng, hoặc code trỏ vào
|
|
1417
|
+
scenario đã bị xoá. Bốn cái này build xanh và test xanh vẫn không phát hiện được.
|
|
1418
|
+
|
|
1419
|
+
Cổng này KHÔNG bao gồm DRIFT · BDD_DRIFT · PRD_DRIFT · TECHDOC_DRIFT — đó là
|
|
1420
|
+
"code CHƯA theo kịp spec", một loại nợ khác: nó không làm hỏng luồng đang chạy.
|
|
1421
|
+
{dòng dưới CHỈ in khi (drift_count + bdd_drift_count + prd_drift + techdoc_drift) > 0}
|
|
1422
|
+
Hiện có {n} scenario/UC đang ở trạng thái đó — không chặn PR, nhưng xử trước khi
|
|
1423
|
+
coi tính năng là xong. "Hết cờ 🔴" ≠ "sạch".
|
|
1424
|
+
|
|
1425
|
+
📜 Lịch sử → {paths.trace_dir}/trace-history.jsonl (+1 dòng — {n} lần chạy đã ghi)
|
|
1426
|
+
Đây là DỮ LIỆU, không phải mirror: regenerate lại không được, mất là mất vĩnh viễn.
|
|
1427
|
+
PHẢI commit cùng TSV.
|
|
1144
1428
|
|
|
1145
1429
|
[Chỉ umbrella mode]
|
|
1146
1430
|
Living Docs canonical → {living_docs_dir}/ (specs module — shared, gitignored)
|
|
1147
|
-
Panel mirror → {panel_mirror}/trace-report.json (
|
|
1431
|
+
Panel mirror → {panel_mirror}/trace-report.json (.trace-mirror/, gitignored)
|
|
1148
1432
|
Tip: chạy /validate-traces (hoặc /sync) sau mỗi phiên codegen để làm mới panel.
|
|
1149
|
-
|
|
1433
|
+
✅ Commit : {paths.trace_dir}/ (*.tsv + trace-history.jsonl — authoritative)
|
|
1434
|
+
🚫 Gitignore : .living-docs/ và .trace-mirror/ (sinh ra, dựng lại được)
|
|
1150
1435
|
```
|