@edupia-tutor/spec-driven-docs 0.14.3 → 0.14.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commands/debug.md +1 -0
- package/commands/define-product.md +70 -5
- package/commands/define-product.tmpl +33 -5
- package/commands/dev-gen-test.md +1 -0
- package/commands/dev-run-test.md +1 -0
- package/commands/dev-smoke-test.md +1 -0
- package/commands/fix-bug.md +1 -0
- package/commands/generate-bdd.md +15 -11
- package/commands/generate-bdd.tmpl +14 -11
- package/commands/generate-code.md +1 -0
- package/commands/generate-design-spec.md +1 -0
- package/commands/generate-prd.md +111 -10
- package/commands/generate-prd.tmpl +61 -7
- package/commands/generate-spec-manifest.md +1 -0
- package/commands/generate-tech-docs.md +1 -0
- package/commands/learn.md +1 -0
- package/commands/map-testids.md +1 -0
- package/commands/propose-scenario.md +1 -0
- package/commands/qc-analyze.md +1 -0
- package/commands/qc-design-test.md +1 -0
- package/commands/qc-plan.md +1 -0
- package/commands/qc-report.md +1 -0
- package/commands/qc-review.md +1 -0
- package/commands/qc-run-test.md +1 -0
- package/commands/refine-prd.md +172 -18
- package/commands/refine-prd.tmpl +114 -13
- package/commands/report-bug.md +1 -0
- package/commands/review-code.md +1 -0
- package/commands/review-context.md +22 -5
- package/commands/review-tech-docs.md +1 -0
- package/commands/setup-ai-first.md +1 -0
- package/commands/validate-traces.md +1 -0
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +1 -0
- package/core/commands/define-product.md +70 -5
- package/core/commands/dev-gen-test.md +1 -0
- package/core/commands/dev-run-test.md +1 -0
- package/core/commands/dev-smoke-test.md +1 -0
- package/core/commands/fix-bug.md +1 -0
- package/core/commands/generate-bdd.md +15 -11
- package/core/commands/generate-code.md +1 -0
- package/core/commands/generate-design-spec.md +1 -0
- package/core/commands/generate-prd.md +111 -10
- package/core/commands/generate-spec-manifest.md +1 -0
- package/core/commands/generate-tech-docs.md +1 -0
- package/core/commands/learn.md +1 -0
- package/core/commands/map-testids.md +1 -0
- package/core/commands/propose-scenario.md +1 -0
- package/core/commands/qc-analyze.md +1 -0
- package/core/commands/qc-design-test.md +1 -0
- package/core/commands/qc-plan.md +1 -0
- package/core/commands/qc-report.md +1 -0
- package/core/commands/qc-review.md +1 -0
- package/core/commands/qc-run-test.md +1 -0
- package/core/commands/refine-prd.md +172 -18
- package/core/commands/report-bug.md +1 -0
- package/core/commands/review-code.md +1 -0
- package/core/commands/review-context.md +22 -5
- package/core/commands/review-tech-docs.md +1 -0
- package/core/commands/setup-ai-first.md +1 -0
- package/core/commands/validate-traces.md +1 -0
- package/core/skills/code/SKILL.md +1 -0
- package/core/skills/design-spec/SKILL.md +1 -0
- package/core/skills/prd/SKILL.md +14 -3
- package/core/skills/spec/SKILL.md +1 -0
- package/core/skills/test/SKILL.md +1 -0
- package/core/steps/business-language.md +36 -0
- package/core/steps/gate.md +1 -0
- package/core/steps/review-fanout.md +21 -5
- package/core/templates/prd.template.md +13 -3
- package/core/templates/product-definition.template.md +8 -1
- package/package.json +1 -1
- package/skills/code/SKILL.md +1 -0
- package/skills/design-spec/SKILL.md +1 -0
- package/skills/prd/SKILL.md +14 -3
- package/skills/spec/SKILL.md +1 -0
- package/skills/test/SKILL.md +1 -0
- package/steps/business-language.md +36 -0
- package/steps/gate.md +1 -0
- package/steps/review-fanout.md +21 -5
- package/templates/prd.template.md +13 -3
- package/templates/product-definition.template.md +8 -1
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
|
@@ -92,6 +93,19 @@ Chờ người dùng trả lời rõ ràng "Y" hoặc "N" rồi mới tiếp t
|
|
|
92
93
|
|
|
93
94
|
*Lưu ý: Với lệnh này, target file ở Bước 1 là một file PRD (`{TICKET-ID}-{prd-slug}.md` — file `.md` duy nhất ở gốc feature folder) dưới `{paths.specs_dir}/{domain}/{prd-slug}/`. Đọc toàn bộ PRD sau khi phân giải file.*
|
|
94
95
|
|
|
96
|
+
### Bước 0-C — Resume mode routing *(riêng /refine-prd, chạy ngay sau Bước 0 của Gate)*
|
|
97
|
+
|
|
98
|
+
Nếu `$ARGUMENTS` chứa `--resume`:
|
|
99
|
+
- Tách `--resume` ra, phần còn lại là `raw_target` (file path hoặc prd-slug).
|
|
100
|
+
- **Nạp minimal context:** đọc `.agent/project-context.yaml`, trích xuất `paths.refinement_dir`
|
|
101
|
+
(default: `.agent/review` nếu không có hoặc file không tồn tại).
|
|
102
|
+
- Chạy **Bước 1** với `raw_target` để phân giải `prd-slug` và `target_file`.
|
|
103
|
+
Nếu `raw_target` rỗng → liệt kê các file `*.yaml` trong `{paths.refinement_dir}/` và hỏi user chọn findings file nào.
|
|
104
|
+
- **Bỏ qua Bước 0-B, 2, 3** — apply findings là tác vụ cơ học, không cần model check hay load full context.
|
|
105
|
+
- → Nhảy thẳng tới **Resume Mode** ở cuối lệnh này.
|
|
106
|
+
|
|
107
|
+
Nếu `$ARGUMENTS` không chứa `--resume` → tiếp tục luồng review bình thường bên dưới.
|
|
108
|
+
|
|
95
109
|
## Context
|
|
96
110
|
# Context Loader — Nạp toàn bộ context dự án
|
|
97
111
|
|
|
@@ -402,6 +416,47 @@ Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
|
402
416
|
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
403
417
|
|
|
404
418
|
|
|
419
|
+
---
|
|
420
|
+
|
|
421
|
+
## Ngôn ngữ nghiệp vụ *(áp khi viết/áp fix — gồm cả Resume Mode Phase 2)*
|
|
422
|
+
# Business Language Guard — chặn thuật ngữ kỹ thuật rò vào tài liệu nghiệp vụ
|
|
423
|
+
|
|
424
|
+
Tài liệu nghiệp vụ (PRD, product-definition) mô tả **WHAT** — chỉ ngôn ngữ nghiệp vụ. Guard này chạy **mỗi khi viết hoặc sửa** prose (gen mới, áp fix `--resume`, hiệu chỉnh): **quét và xử lý** các thuật ngữ kỹ thuật/UI phổ thông bên dưới **trước khi ghi**.
|
|
425
|
+
|
|
426
|
+
> Guard này là **baseline framework**, chạy **song song** với Banned Terms của `business-dictionary.md` (cơ chế dictionary giữ nguyên; project vẫn bổ sung term đặc thù vào đó). Khi cả hai cùng áp, ưu tiên bản chuẩn của dictionary nếu có.
|
|
427
|
+
|
|
428
|
+
## Bản đồ xử lý (3 nhóm)
|
|
429
|
+
|
|
430
|
+
**Nhóm 1 — Tương tác/triển khai → DIỄN ĐẠT LẠI sang nghiệp vụ (giữ nguyên nghĩa):**
|
|
431
|
+
|
|
432
|
+
| Kỹ thuật/UI | Cách nói nghiệp vụ |
|
|
433
|
+
|---|---|
|
|
434
|
+
| re-render / render lại / reload / refresh (màn) | "hiển thị lại {tên màn}" |
|
|
435
|
+
| timeout | "quá thời gian chờ" |
|
|
436
|
+
| lỗi mạng / network error | "lỗi kết nối" |
|
|
437
|
+
| UI / giao diện (khi chỉ một màn) | "màn" / "màn hình" |
|
|
438
|
+
| click / tap | "bấm" / "chọn" |
|
|
439
|
+
| popup / modal (nếu chỉ là khái niệm hiển thị) | "hộp thoại" / "thông báo" |
|
|
440
|
+
| disable / enable (nút) | "khoá" / "mở" thao tác |
|
|
441
|
+
| redirect / navigate | "chuyển tới {màn}" |
|
|
442
|
+
|
|
443
|
+
**Nhóm 2 — Visual thuần → CHUYỂN Design Spec (bỏ khỏi PRD, ghi nhận lại):**
|
|
444
|
+
`spinner`, `loading indicator`, `animation`, `fade/slide`, màu sắc, font, layout pixel, micro-interaction → *"Chi tiết visual này thuộc Design Spec — ghi nhận để tạo Design Spec sau."*
|
|
445
|
+
|
|
446
|
+
**Nhóm 3 — Backend/contract thuần → BỎ khỏi PRD (thuộc Tech Docs):**
|
|
447
|
+
`API`, `endpoint`, `token/JWT`, `HTTP status`, tên class/bảng/cột DB, query, payload, header.
|
|
448
|
+
*(Ngoại lệ DUY NHẤT: Appendix "Existing API Contract" khi `API Source: existing` — xem Platform Strategy.)*
|
|
449
|
+
|
|
450
|
+
## Quy tắc áp dụng
|
|
451
|
+
- Quét toàn bộ text sắp ghi (User Story, AC, BR, Business Logic, Scope, Edge Cases, Assumptions…).
|
|
452
|
+
- Nhóm 1 → thay tại chỗ, giữ nguyên nghĩa nghiệp vụ. **Đồng bộ cách diễn đạt** với chỗ đã có sẵn trong cùng tài liệu (vd nếu "quá thời gian chờ" đã dùng ở một BR → dùng nhất quán ở mọi nơi).
|
|
453
|
+
- Nhóm 2 → gỡ khỏi prose nghiệp vụ + nhắc chuyển Design Spec.
|
|
454
|
+
- Nhóm 3 → gỡ khỏi PRD (trừ ngoại lệ brownfield).
|
|
455
|
+
- Nếu term không có trong bản đồ nhưng rõ ràng là tên kỹ thuật/triển khai → vẫn diễn đạt lại theo tinh thần Nhóm 1, đừng để lọt.
|
|
456
|
+
|
|
457
|
+
**Checklist (dùng ở Quality Checklist của lệnh):** 0 thuật ngữ kỹ thuật/UI (re-render, UI, timeout, spinner, API/endpoint/token…) trong prose nghiệp vụ — đã diễn đạt lại (Nhóm 1) / chuyển Design Spec (Nhóm 2) / bỏ về Tech Docs (Nhóm 3).
|
|
458
|
+
|
|
459
|
+
|
|
405
460
|
---
|
|
406
461
|
|
|
407
462
|
## Quy trình Review
|
|
@@ -413,10 +468,12 @@ dừng ở mức "đủ" findings, nên mỗi vòng review sau lại lòi ra v
|
|
|
413
468
|
fan out song song theo các chiều review, rồi lặp một critic độ-đầy-đủ cho tới khi một
|
|
414
469
|
vòng không sinh thêm gì mới, *trước khi* ghi file findings.
|
|
415
470
|
|
|
416
|
-
Lệnh gọi cung cấp hai
|
|
471
|
+
Lệnh gọi cung cấp hai thứ bắt buộc + hai tuỳ chọn:
|
|
417
472
|
- **DIMENSIONS** — danh sách các chiều review để fan out
|
|
418
473
|
(`/refine-prd` → 4 lăng kính; `/review-context` → các P-check hoặc B-check).
|
|
419
474
|
- **FINDINGS SCHEMA** — dạng YAML mà mỗi finding phải theo (định nghĩa trong lệnh).
|
|
475
|
+
- **GRANULARITY** *(tuỳ chọn, mặc định `auto`)* — `auto`: chọn độ mịn fan-out theo bảng ngưỡng kích thước ở Phase 1 (hành vi cũ). `per-uc`: **LUÔN** fan-out theo từng UC, **bỏ qua ngưỡng** — dùng cho review cần độ đầy đủ cao (`/refine-prd` truyền cái này để lần đầu đã quét sâu). Lệnh không truyền → `auto` → hành vi không đổi.
|
|
476
|
+
- **CHANGED_SCOPE** *(tuỳ chọn)* — danh sách UC/section đã thay đổi (review **delta**). Nếu được truyền, Phase 1 chỉ fan-out trên các phạm vi này + PRD-global; Phase 2 critic vẫn quét **toàn doc** làm lưới an toàn. Không truyền → quét toàn bộ như thường.
|
|
420
477
|
|
|
421
478
|
> **Bỏ qua ở chế độ sub-agent:** Nếu Gate Bước 0 đã set `_agent_mode: true`, toàn bộ
|
|
422
479
|
> quy trình này bị **bỏ qua** — orchestrator đã chạy sẵn một dimension/UC cho mỗi
|
|
@@ -428,8 +485,11 @@ Lệnh gọi cung cấp hai thứ:
|
|
|
428
485
|
|
|
429
486
|
**Bao nhiêu sub-agent:** *số lượng* agent không phải là đòn bẩy độ đầy đủ — bề rộng được
|
|
430
487
|
cố định bởi taxonomy DIMENSION (thêm agent vào cùng một dimension chỉ tìm lại cùng vấn đề),
|
|
431
|
-
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
432
|
-
|
|
488
|
+
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
489
|
+
|
|
490
|
+
**Nếu `GRANULARITY = per-uc`:** **bỏ qua bảng ngưỡng dưới đây**, luôn dùng độ mịn **DIMENSION × phạm vi UC** (kể cả PRD nhỏ) — đảm bảo quét sâu, không bỏ sót ngay lần đầu. (Cái giá: nhiều agent hơn cho PRD nhỏ — chấp nhận để lần đầu đầy đủ.)
|
|
491
|
+
|
|
492
|
+
**Nếu `GRANULARITY = auto`** (mặc định): chọn **độ mịn fan-out** theo kích thước target, tái dùng ngưỡng của `steps/spawn-agent.md`:
|
|
433
493
|
|
|
434
494
|
| Kích thước target | Độ mịn | Số agent |
|
|
435
495
|
|-------------|-------------|-------------|
|
|
@@ -452,6 +512,7 @@ UC duy nhất — chính là điều ngăn bỏ sót trên các PRD lớn.
|
|
|
452
512
|
agent). Giới hạn mỗi wave ở **`AGENT_CAP = 12`** agent và gom batch các phạm vi UC cho vừa:
|
|
453
513
|
|
|
454
514
|
1. Dựng danh sách phạm vi = `[UC1, UC2, …, UCn, PRD-global]` (độ dài `UCs + 1`).
|
|
515
|
+
- **Nếu `CHANGED_SCOPE` được truyền (review delta):** danh sách phạm vi = `[các UC trong CHANGED_SCOPE] + [PRD-global]` (chỉ các UC đã đổi + global), KHÔNG phải tất cả UC. Số agent tụt theo đó.
|
|
455
516
|
2. Tính số-phạm-vi-mỗi-bucket: `groups = max(1, floor(AGENT_CAP / dimensions))`.
|
|
456
517
|
- Nếu `groups ≥ UCs + 1` → không cần batch, chạy một agent cho mỗi `DIMENSION × scope`.
|
|
457
518
|
- Else chia danh sách phạm vi thành `groups` bucket liền kề kích thước xấp xỉ bằng nhau
|
|
@@ -493,10 +554,20 @@ Gom mảng findings của mọi sub-agent vào một danh sách hợp nhất `AL
|
|
|
493
554
|
Đây là bước chống đập-chuột-chũi. Lặp cho tới khi **hai vòng liên tiếp thêm 0 finding
|
|
494
555
|
mới**, hoặc tới cap cứng **3 vòng**, cái nào đến trước:
|
|
495
556
|
|
|
557
|
+
> **Lưu ý delta:** kể cả khi `CHANGED_SCOPE` giới hạn Phase 1 vào các UC đã đổi, completeness-critic ở Phase 2 **vẫn đọc TOÀN bộ doc** — đây là lưới an toàn bắt các vấn đề mà một fix ở UC đã đổi có thể làm lộ ra ở chỗ khác.
|
|
558
|
+
|
|
496
559
|
1. Spawn một sub-agent **completeness-critic** bằng Agent tool. Cho nó:
|
|
497
560
|
- toàn bộ target file (`{target_file}`),
|
|
498
|
-
- danh sách
|
|
499
|
-
|
|
561
|
+
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
|
562
|
+
đủ để critic nhận ra trùng lặp (không cần `quote`, `suggestion`, `auto_fixable`, `severity`):
|
|
563
|
+
```json
|
|
564
|
+
[
|
|
565
|
+
{ "uc_id": "...", "section": "...", "finding": "..." },
|
|
566
|
+
...
|
|
567
|
+
]
|
|
568
|
+
```
|
|
569
|
+
Nếu `ALL_FINDINGS` vượt 60 items, rút gọn `finding` xuống còn 80 ký tự đầu mỗi item.
|
|
570
|
+
- cùng slim context (banned terms, canonical entities, layer order, domains).
|
|
500
571
|
Prompt nó:
|
|
501
572
|
```
|
|
502
573
|
Here is a document and a list of issues already found. Read the WHOLE document.
|
|
@@ -549,6 +620,19 @@ Convergence: {convergence_rounds} vòng critic — file findings đã đầy đ
|
|
|
549
620
|
|
|
550
621
|
Chạy review qua **Quy trình Review** ở trên (`steps/review-fanout.md`).
|
|
551
622
|
|
|
623
|
+
**Tham số truyền vào Quy trình Review:**
|
|
624
|
+
- `GRANULARITY = per-uc` — LUÔN fan-out theo từng UC (bỏ ngưỡng cả-file), để **ngay lần đầu đã lòi phần nhiều issue**, không dồn sang lần sau.
|
|
625
|
+
- `CHANGED_SCOPE` — xác định theo chế độ full/delta ngay dưới đây.
|
|
626
|
+
|
|
627
|
+
**Chọn full vs delta** *(mặc định: lần đầu FULL, lần sau DELTA)*:
|
|
628
|
+
1. Tách `--full` khỏi `$ARGUMENTS` nếu có.
|
|
629
|
+
2. Kiểm tra `{paths.refinement_dir}/{prd-slug}-findings.yaml`:
|
|
630
|
+
- **Không tồn tại** (lần đầu review PRD này) → **FULL**: KHÔNG truyền `CHANGED_SCOPE`.
|
|
631
|
+
- **Tồn tại** + có `--full` → **FULL**: bỏ qua findings cũ, không truyền `CHANGED_SCOPE` (ép quét lại toàn bộ).
|
|
632
|
+
- **Tồn tại** + KHÔNG có `--full` → so `prd_version` trong findings cũ với `| **Version** |` của PRD hiện tại:
|
|
633
|
+
- **Bằng nhau** (PRD chưa đổi từ lần review trước) → DỪNG, báo: `"PRD chưa đổi từ v{X} (lần review gần nhất). Không có gì để review lại — dùng --full nếu vẫn muốn quét toàn bộ."`
|
|
634
|
+
- **Khác** (đã có `--resume` bump version) → **DELTA**: `CHANGED_SCOPE` = { `uc_id`/`section` của các finding `status: applied` trong findings cũ } ∪ { UC có trong PRD hiện tại nhưng chưa từng xuất hiện ở findings cũ }. Truyền `CHANGED_SCOPE` này vào Quy trình Review.
|
|
635
|
+
|
|
552
636
|
**DIMENSIONS** = 4 lăng kính dưới đây — fan out một sub-agent cho mỗi lăng kính, mỗi cái quét
|
|
553
637
|
toàn bộ PRD qua đúng lăng kính của nó:
|
|
554
638
|
|
|
@@ -567,10 +651,18 @@ Suy ra tên file output từ PRD slug:
|
|
|
567
651
|
- File PRD: `{paths.specs_dir}/payment/create-invoice/PAY01-create-invoice.md` → output: `{paths.refinement_dir}/create-invoice-findings.yaml`
|
|
568
652
|
- Quy tắc: lấy tên folder cha của PRD (prd-slug), thêm hậu tố `-findings.yaml`
|
|
569
653
|
|
|
654
|
+
Trước khi ghi file, xác định `recommendation` từ findings đã dedup và sắp xếp:
|
|
655
|
+
- `by_severity.critical ≥ 1` → `BLOCKED`
|
|
656
|
+
- `by_severity.critical = 0` và `by_severity.major ≥ 1` → `NEEDS_REVISION`
|
|
657
|
+
- `by_severity.critical = 0` và `by_severity.major = 0` → `APPROVED_WITH_MINOR_CHANGES`
|
|
658
|
+
|
|
659
|
+
Đảm bảo `{paths.refinement_dir}/` tồn tại — tạo thư mục nếu chưa có trước khi ghi file.
|
|
660
|
+
|
|
570
661
|
Ghi `{paths.refinement_dir}/{prd-slug}-findings.yaml`:
|
|
571
662
|
|
|
572
663
|
```yaml
|
|
573
664
|
prd_source: "{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md"
|
|
665
|
+
prd_version: "{đọc | **Version** | từ metadata PRD lúc sinh findings — dùng để chọn full/delta lần chạy sau}"
|
|
574
666
|
generated_at: "{ISO datetime}"
|
|
575
667
|
status: "pending_review"
|
|
576
668
|
|
|
@@ -583,14 +675,32 @@ findings:
|
|
|
583
675
|
quote: "{trích đoạn nguyên văn copy CHÍNH XÁC từ PRD tại vị trí lỗi, ≤120 ký tự}"
|
|
584
676
|
finding: "{mô tả gap hoặc vấn đề}"
|
|
585
677
|
suggestion: "{đề xuất cải thiện cụ thể, hành động được}"
|
|
586
|
-
|
|
587
|
-
|
|
678
|
+
resolution_edge_cases: # CHỈ điền cho critical/major; minor → để [] (bỏ qua)
|
|
679
|
+
# Phân tích bậc-hai (advisory, KHÔNG chặn): nếu áp `suggestion` này thì có thể đẻ ra
|
|
680
|
+
# edge case / side-effect gì — path lỗi mới, va chạm với BR/UC khác, trạng thái biên,
|
|
681
|
+
# hệ luỵ cross-section. PO đọc để cân nhắc trước khi accept; nếu muốn xử lý → tạo finding mới.
|
|
682
|
+
- "{edge case có thể phát sinh nếu chốt phương án này}"
|
|
683
|
+
auto_fixable: false
|
|
684
|
+
# true = AI tự tin cao vào suggestion này; Review Board có thể hiển thị nút "quick accept"
|
|
685
|
+
# false = cần human đọc kỹ và ghi quyết định trước khi accept
|
|
686
|
+
# Resume Mode luôn áp dụng theo status (accepted|modified), bất kể auto_fixable.
|
|
687
|
+
status: "pending"
|
|
688
|
+
# Lifecycle finding-level:
|
|
689
|
+
# pending → finding mới, chưa được review
|
|
690
|
+
# accepted → reviewer chấp nhận suggestion gốc → Resume sẽ apply
|
|
691
|
+
# modified → reviewer đã sửa suggestion trong Review Board → Resume dùng suggestion đã sửa
|
|
692
|
+
# rejected → reviewer bác bỏ, không apply
|
|
693
|
+
# needs_discussion → hai suggestion xung đột, cần con người quyết định trước khi --resume
|
|
694
|
+
# applied → đã được Resume Mode apply vào PRD
|
|
588
695
|
|
|
589
696
|
summary:
|
|
590
697
|
total_findings: {N}
|
|
591
698
|
by_severity: { critical: {N}, major: {N}, minor: {N} }
|
|
592
699
|
by_lens: { QA: {N}, DEV: {N}, SA: {N}, PO: {N} }
|
|
593
700
|
recommendation: "APPROVED_WITH_MINOR_CHANGES | NEEDS_REVISION | BLOCKED"
|
|
701
|
+
# Rule: critical ≥ 1 → BLOCKED
|
|
702
|
+
# critical = 0, major ≥ 1 → NEEDS_REVISION
|
|
703
|
+
# critical = 0, major = 0 → APPROVED_WITH_MINOR_CHANGES
|
|
594
704
|
```
|
|
595
705
|
|
|
596
706
|
> **Field định vị (`quote` + `uc_id`) — bắt buộc cho source-jump của Review Board.**
|
|
@@ -599,6 +709,14 @@ summary:
|
|
|
599
709
|
> `uc_id` là Use Case sở hữu (hoặc `""` cho finding PRD-global). Hai field này cho phép reviewer click một
|
|
600
710
|
> finding trong Review Board và nhảy thẳng tới đúng vị trí trong PRD nguồn.
|
|
601
711
|
|
|
712
|
+
> **`resolution_edge_cases` — phân tích bậc-hai (chỉ critical/major).**
|
|
713
|
+
> Với mỗi finding `critical`/`major`, sau khi viết `suggestion`, nghĩ tiếp: *nếu PO chốt phương án này thì
|
|
714
|
+
> đẻ ra edge case / side-effect gì?* (path lỗi mới, va chạm BR/UC khác, trạng thái biên, hệ luỵ cross-section).
|
|
715
|
+
> Ghi vào `resolution_edge_cases` để PO **thấy trước khi accept**. Đây là **advisory** — KHÔNG chặn, KHÔNG tự
|
|
716
|
+
> tạo finding; PO đọc rồi quyết. Finding `minor` → để `[]`.
|
|
717
|
+
> *(Phần phản hồi cho phương án PO **tự sửa** (`modified`) đến ở vòng sau: sau `--resume`, lần `/refine-prd`
|
|
718
|
+
> kế chạy delta sẽ quét lại UC đã đổi + critic toàn-doc → tự lòi edge case mà phương án đó tạo ra.)*
|
|
719
|
+
|
|
602
720
|
## Report
|
|
603
721
|
|
|
604
722
|
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
@@ -703,32 +821,64 @@ Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
|
703
821
|
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
704
822
|
|
|
705
823
|
|
|
824
|
+
Dùng footer chuẩn với hai field bổ sung `Findings` và `Review` đặt ngay sau `Status`:
|
|
825
|
+
|
|
826
|
+
```
|
|
827
|
+
---
|
|
828
|
+
Status : {badge}
|
|
829
|
+
Findings : {total} | 🔴 Critical: {N} | 🟡 Major: {N} | 🟢 Minor: {N}
|
|
830
|
+
Review : {paths.refinement_dir}/{prd-slug}-findings.yaml
|
|
831
|
+
Output Artifacts:
|
|
832
|
+
created {paths.refinement_dir}/{prd-slug}-findings.yaml (findings từ 4-lens review)
|
|
833
|
+
Pipeline : Discovery → [PRD ◀ bạn ở đây] → Design Spec → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
834
|
+
Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
|
|
835
|
+
Next : Mở trong Review Board (chuột phải vào file) → Cập nhật PRD
|
|
836
|
+
→ /review-context {prd-file} ← kiểm tra chất lượng PRD trước khi sinh BDD
|
|
837
|
+
→ /generate-bdd {prd-file}
|
|
838
|
+
```
|
|
839
|
+
|
|
840
|
+
Nếu có finding nào có `status: "needs_discussion"`, thêm warning block sau footer:
|
|
841
|
+
|
|
706
842
|
```
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
843
|
+
⚠️ {N} finding(s) cần quyết định của bạn trước khi --resume:
|
|
844
|
+
Mở {paths.refinement_dir}/{prd-slug}-findings.yaml
|
|
845
|
+
Với mỗi finding có status "needs_discussion":
|
|
846
|
+
1. Đọc cả hai phương án trong `suggestion`
|
|
847
|
+
2. Chọn một (hoặc viết phương án khác) vào `suggestion`
|
|
848
|
+
3. Đổi `status` → "accepted"
|
|
849
|
+
Sau đó chạy: /refine-prd {prd-file} --resume
|
|
713
850
|
```
|
|
851
|
+
*(Bỏ warning block này nếu không có `needs_discussion` finding nào.)*
|
|
714
852
|
|
|
715
853
|
---
|
|
716
854
|
|
|
717
855
|
## Resume Mode — Áp dụng Findings & Bump Version
|
|
718
856
|
|
|
719
|
-
|
|
857
|
+
*Được route tới từ Bước 0-C — Resume mode routing. `prd-slug` và `target_file` đã được phân giải ở Bước 1 trước khi nhảy vào đây.*
|
|
720
858
|
|
|
721
859
|
### Phase 1 — Đọc các finding được chấp nhận
|
|
722
860
|
|
|
723
|
-
1.
|
|
724
|
-
|
|
725
|
-
|
|
861
|
+
1. Kiểm tra `{paths.refinement_dir}/{prd-slug}-findings.yaml` có tồn tại không.
|
|
862
|
+
Nếu không → báo lỗi rõ ràng và dừng:
|
|
863
|
+
```
|
|
864
|
+
❌ Không tìm thấy findings file tại {paths.refinement_dir}/{prd-slug}-findings.yaml
|
|
865
|
+
Hãy chạy /refine-prd {prd-file} trước để tạo findings, rồi mới --resume.
|
|
866
|
+
```
|
|
867
|
+
2. Đọc file findings.
|
|
868
|
+
3. Gom tất cả finding có `status: "accepted"` hoặc `status: "modified"`.
|
|
869
|
+
4. Nếu không có finding nào được chấp nhận → báo "No accepted findings. PRD unchanged." và dừng.
|
|
870
|
+
5. Nếu còn finding nào có `status: "needs_discussion"` → cảnh báo (không dừng):
|
|
871
|
+
```
|
|
872
|
+
⚠️ {N} finding(s) chưa được giải quyết (needs_discussion) — sẽ bị bỏ qua lần apply này.
|
|
873
|
+
Giải quyết chúng trong Review Board rồi chạy lại --resume để apply.
|
|
874
|
+
```
|
|
726
875
|
|
|
727
876
|
### Phase 2 — Áp dụng thay đổi vào PRD
|
|
728
877
|
|
|
729
878
|
Với mỗi finding được chấp nhận, theo thứ tự severity (critical → major → minor):
|
|
730
879
|
- Đi tới section PRD được chỉ định bởi `finding.section`.
|
|
731
880
|
- Áp dụng `finding.suggestion`. Với finding `status: "modified"`, người đã sửa sẵn `finding.suggestion` trong Review Board — giá trị đã sửa đó CHÍNH LÀ bản fix cần áp dụng.
|
|
881
|
+
- **Chạy Business Language Guard trên text mới TRƯỚC khi ghi** (xem section "Ngôn ngữ nghiệp vụ"): diễn đạt lại / gỡ thuật ngữ kỹ thuật-UI để fix không tự kéo theo term kỹ thuật vào PRD.
|
|
732
882
|
- Không thay đổi bất kỳ section nào không được tham chiếu bởi một finding được chấp nhận.
|
|
733
883
|
|
|
734
884
|
### Phase 2.5 — Cập nhật file findings
|
|
@@ -736,7 +886,9 @@ Với mỗi finding được chấp nhận, theo thứ tự severity (critical
|
|
|
736
886
|
Với mỗi finding đã áp dụng (status là `accepted` hoặc `modified`):
|
|
737
887
|
- Đặt `status: "applied"` trong `{paths.refinement_dir}/{prd-slug}-findings.yaml`.
|
|
738
888
|
|
|
739
|
-
Cập nhật `
|
|
889
|
+
Cập nhật `status: "applied"` ở **root level** của file findings (không phải `summary.status`).
|
|
890
|
+
# Lifecycle file-level: pending_review → applied | partially_applied
|
|
891
|
+
# partially_applied khi có finding bị rejected hoặc needs_discussion còn sót lại.
|
|
740
892
|
|
|
741
893
|
### Phase 3 — Bump version & ghi entry changelog
|
|
742
894
|
|
|
@@ -764,6 +916,8 @@ Changes :
|
|
|
764
916
|
- {change 1}
|
|
765
917
|
- {change 2}
|
|
766
918
|
|
|
919
|
+
💡 Vừa áp {N} phương án (gồm bản PO tự sửa) → chạy lại /refine-prd {prd-file}
|
|
920
|
+
(delta tự động) để lòi edge case mà các phương án vừa áp có thể tạo ra.
|
|
767
921
|
⚠️ BDD có thể đã lỗi thời. Chạy:
|
|
768
922
|
/review-context {prd-file} ← kiểm tra chất lượng PRD trước
|
|
769
923
|
→ /generate-bdd {prd-file}
|
|
@@ -27,6 +27,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
27
27
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
28
28
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
29
29
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
30
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
30
31
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
31
32
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
32
33
|
|
|
@@ -18,6 +18,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
18
18
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
19
19
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
20
20
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
21
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
21
22
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
22
23
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
23
24
|
|
|
@@ -19,6 +19,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
19
19
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
20
20
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
21
21
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
22
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
22
23
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
23
24
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
24
25
|
|
|
@@ -437,10 +438,12 @@ dừng ở mức "đủ" findings, nên mỗi vòng review sau lại lòi ra v
|
|
|
437
438
|
fan out song song theo các chiều review, rồi lặp một critic độ-đầy-đủ cho tới khi một
|
|
438
439
|
vòng không sinh thêm gì mới, *trước khi* ghi file findings.
|
|
439
440
|
|
|
440
|
-
Lệnh gọi cung cấp hai
|
|
441
|
+
Lệnh gọi cung cấp hai thứ bắt buộc + hai tuỳ chọn:
|
|
441
442
|
- **DIMENSIONS** — danh sách các chiều review để fan out
|
|
442
443
|
(`/refine-prd` → 4 lăng kính; `/review-context` → các P-check hoặc B-check).
|
|
443
444
|
- **FINDINGS SCHEMA** — dạng YAML mà mỗi finding phải theo (định nghĩa trong lệnh).
|
|
445
|
+
- **GRANULARITY** *(tuỳ chọn, mặc định `auto`)* — `auto`: chọn độ mịn fan-out theo bảng ngưỡng kích thước ở Phase 1 (hành vi cũ). `per-uc`: **LUÔN** fan-out theo từng UC, **bỏ qua ngưỡng** — dùng cho review cần độ đầy đủ cao (`/refine-prd` truyền cái này để lần đầu đã quét sâu). Lệnh không truyền → `auto` → hành vi không đổi.
|
|
446
|
+
- **CHANGED_SCOPE** *(tuỳ chọn)* — danh sách UC/section đã thay đổi (review **delta**). Nếu được truyền, Phase 1 chỉ fan-out trên các phạm vi này + PRD-global; Phase 2 critic vẫn quét **toàn doc** làm lưới an toàn. Không truyền → quét toàn bộ như thường.
|
|
444
447
|
|
|
445
448
|
> **Bỏ qua ở chế độ sub-agent:** Nếu Gate Bước 0 đã set `_agent_mode: true`, toàn bộ
|
|
446
449
|
> quy trình này bị **bỏ qua** — orchestrator đã chạy sẵn một dimension/UC cho mỗi
|
|
@@ -452,8 +455,11 @@ Lệnh gọi cung cấp hai thứ:
|
|
|
452
455
|
|
|
453
456
|
**Bao nhiêu sub-agent:** *số lượng* agent không phải là đòn bẩy độ đầy đủ — bề rộng được
|
|
454
457
|
cố định bởi taxonomy DIMENSION (thêm agent vào cùng một dimension chỉ tìm lại cùng vấn đề),
|
|
455
|
-
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
456
|
-
|
|
458
|
+
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
459
|
+
|
|
460
|
+
**Nếu `GRANULARITY = per-uc`:** **bỏ qua bảng ngưỡng dưới đây**, luôn dùng độ mịn **DIMENSION × phạm vi UC** (kể cả PRD nhỏ) — đảm bảo quét sâu, không bỏ sót ngay lần đầu. (Cái giá: nhiều agent hơn cho PRD nhỏ — chấp nhận để lần đầu đầy đủ.)
|
|
461
|
+
|
|
462
|
+
**Nếu `GRANULARITY = auto`** (mặc định): chọn **độ mịn fan-out** theo kích thước target, tái dùng ngưỡng của `steps/spawn-agent.md`:
|
|
457
463
|
|
|
458
464
|
| Kích thước target | Độ mịn | Số agent |
|
|
459
465
|
|-------------|-------------|-------------|
|
|
@@ -476,6 +482,7 @@ UC duy nhất — chính là điều ngăn bỏ sót trên các PRD lớn.
|
|
|
476
482
|
agent). Giới hạn mỗi wave ở **`AGENT_CAP = 12`** agent và gom batch các phạm vi UC cho vừa:
|
|
477
483
|
|
|
478
484
|
1. Dựng danh sách phạm vi = `[UC1, UC2, …, UCn, PRD-global]` (độ dài `UCs + 1`).
|
|
485
|
+
- **Nếu `CHANGED_SCOPE` được truyền (review delta):** danh sách phạm vi = `[các UC trong CHANGED_SCOPE] + [PRD-global]` (chỉ các UC đã đổi + global), KHÔNG phải tất cả UC. Số agent tụt theo đó.
|
|
479
486
|
2. Tính số-phạm-vi-mỗi-bucket: `groups = max(1, floor(AGENT_CAP / dimensions))`.
|
|
480
487
|
- Nếu `groups ≥ UCs + 1` → không cần batch, chạy một agent cho mỗi `DIMENSION × scope`.
|
|
481
488
|
- Else chia danh sách phạm vi thành `groups` bucket liền kề kích thước xấp xỉ bằng nhau
|
|
@@ -517,10 +524,20 @@ Gom mảng findings của mọi sub-agent vào một danh sách hợp nhất `AL
|
|
|
517
524
|
Đây là bước chống đập-chuột-chũi. Lặp cho tới khi **hai vòng liên tiếp thêm 0 finding
|
|
518
525
|
mới**, hoặc tới cap cứng **3 vòng**, cái nào đến trước:
|
|
519
526
|
|
|
527
|
+
> **Lưu ý delta:** kể cả khi `CHANGED_SCOPE` giới hạn Phase 1 vào các UC đã đổi, completeness-critic ở Phase 2 **vẫn đọc TOÀN bộ doc** — đây là lưới an toàn bắt các vấn đề mà một fix ở UC đã đổi có thể làm lộ ra ở chỗ khác.
|
|
528
|
+
|
|
520
529
|
1. Spawn một sub-agent **completeness-critic** bằng Agent tool. Cho nó:
|
|
521
530
|
- toàn bộ target file (`{target_file}`),
|
|
522
|
-
- danh sách
|
|
523
|
-
|
|
531
|
+
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
|
532
|
+
đủ để critic nhận ra trùng lặp (không cần `quote`, `suggestion`, `auto_fixable`, `severity`):
|
|
533
|
+
```json
|
|
534
|
+
[
|
|
535
|
+
{ "uc_id": "...", "section": "...", "finding": "..." },
|
|
536
|
+
...
|
|
537
|
+
]
|
|
538
|
+
```
|
|
539
|
+
Nếu `ALL_FINDINGS` vượt 60 items, rút gọn `finding` xuống còn 80 ký tự đầu mỗi item.
|
|
540
|
+
- cùng slim context (banned terms, canonical entities, layer order, domains).
|
|
524
541
|
Prompt nó:
|
|
525
542
|
```
|
|
526
543
|
Here is a document and a list of issues already found. Read the WHOLE document.
|
|
@@ -19,6 +19,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
19
19
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
20
20
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
21
21
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
22
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
22
23
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
23
24
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
24
25
|
|
|
@@ -18,6 +18,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
18
18
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
19
19
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
20
20
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
21
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
21
22
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
22
23
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
23
24
|
|
|
@@ -18,6 +18,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
18
18
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
19
19
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
20
20
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
21
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
21
22
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
22
23
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
23
24
|
|
|
@@ -28,6 +28,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
28
28
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
29
29
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
30
30
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
31
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
31
32
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
32
33
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
33
34
|
|
|
@@ -31,6 +31,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
31
31
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
32
32
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
33
33
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
34
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
34
35
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
35
36
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
36
37
|
|
package/core/skills/prd/SKILL.md
CHANGED
|
@@ -28,6 +28,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
28
28
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
29
29
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
30
30
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
31
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
31
32
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
32
33
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
33
34
|
|
|
@@ -186,7 +187,7 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
186
187
|
| **Domain** | {domain} |
|
|
187
188
|
| **Created** | {date} |
|
|
188
189
|
| **Updated** | {date} |
|
|
189
|
-
| **
|
|
190
|
+
| **Ticket** | {TICKET}-{N}{ — nếu PO có link tracker thật, thêm bên cạnh: `{TICKET}-{N} ([Jira]({tracker_url}))`} |
|
|
190
191
|
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
191
192
|
|
|
192
193
|
---
|
|
@@ -216,13 +217,21 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
216
217
|
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
217
218
|
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
218
219
|
|
|
220
|
+
## c. Phụ thuộc liên service *(mức nghiệp vụ — KHÔNG mô tả API/event/kỹ thuật)*
|
|
221
|
+
|
|
222
|
+
> Kế thừa từ Product Definition Phase 1 ("Phụ thuộc liên service"). Nếu contract do đối tác phát triển song song (xem `API Source`), ghi phụ thuộc partner vào đây.
|
|
223
|
+
|
|
224
|
+
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
225
|
+
|
|
219
226
|
---
|
|
220
227
|
|
|
221
228
|
# 2. Acceptance Criteria
|
|
222
229
|
|
|
223
|
-
|
|
230
|
+
> Mỗi AC kế thừa liên kết "Bắt nguồn từ BR" của Product Definition (Phase 6), remap sang BR ID của PRD. Vì BR ID đã chứa số UC nên ref BR truy ngược được tới đúng UC.
|
|
224
231
|
|
|
225
|
-
**
|
|
232
|
+
**AC1:** {Tiêu chí nghiệm thu, văn xuôi, kiểm chứng được.} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
233
|
+
|
|
234
|
+
**AC2:** {…} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
226
235
|
|
|
227
236
|
---
|
|
228
237
|
|
|
@@ -240,6 +249,8 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
240
249
|
**Post-condition:**
|
|
241
250
|
- {kết quả sau 1}
|
|
242
251
|
|
|
252
|
+
**AC liên quan:** AC{x}, AC{y} *(các AC mà UC này thoả — phải đúng bằng tập AC có ref BR trỏ về UC này ở §2)*
|
|
253
|
+
|
|
243
254
|
**Business Rule**
|
|
244
255
|
|
|
245
256
|
| ID | Business Rule | Business Logic |
|
|
@@ -28,6 +28,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
28
28
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
29
29
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
30
30
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
31
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
31
32
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
32
33
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
33
34
|
|
|
@@ -28,6 +28,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
28
28
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
29
29
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
30
30
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
31
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
31
32
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
32
33
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
33
34
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Business Language Guard — chặn thuật ngữ kỹ thuật rò vào tài liệu nghiệp vụ
|
|
2
|
+
|
|
3
|
+
Tài liệu nghiệp vụ (PRD, product-definition) mô tả **WHAT** — chỉ ngôn ngữ nghiệp vụ. Guard này chạy **mỗi khi viết hoặc sửa** prose (gen mới, áp fix `--resume`, hiệu chỉnh): **quét và xử lý** các thuật ngữ kỹ thuật/UI phổ thông bên dưới **trước khi ghi**.
|
|
4
|
+
|
|
5
|
+
> Guard này là **baseline framework**, chạy **song song** với Banned Terms của `business-dictionary.md` (cơ chế dictionary giữ nguyên; project vẫn bổ sung term đặc thù vào đó). Khi cả hai cùng áp, ưu tiên bản chuẩn của dictionary nếu có.
|
|
6
|
+
|
|
7
|
+
## Bản đồ xử lý (3 nhóm)
|
|
8
|
+
|
|
9
|
+
**Nhóm 1 — Tương tác/triển khai → DIỄN ĐẠT LẠI sang nghiệp vụ (giữ nguyên nghĩa):**
|
|
10
|
+
|
|
11
|
+
| Kỹ thuật/UI | Cách nói nghiệp vụ |
|
|
12
|
+
|---|---|
|
|
13
|
+
| re-render / render lại / reload / refresh (màn) | "hiển thị lại {tên màn}" |
|
|
14
|
+
| timeout | "quá thời gian chờ" |
|
|
15
|
+
| lỗi mạng / network error | "lỗi kết nối" |
|
|
16
|
+
| UI / giao diện (khi chỉ một màn) | "màn" / "màn hình" |
|
|
17
|
+
| click / tap | "bấm" / "chọn" |
|
|
18
|
+
| popup / modal (nếu chỉ là khái niệm hiển thị) | "hộp thoại" / "thông báo" |
|
|
19
|
+
| disable / enable (nút) | "khoá" / "mở" thao tác |
|
|
20
|
+
| redirect / navigate | "chuyển tới {màn}" |
|
|
21
|
+
|
|
22
|
+
**Nhóm 2 — Visual thuần → CHUYỂN Design Spec (bỏ khỏi PRD, ghi nhận lại):**
|
|
23
|
+
`spinner`, `loading indicator`, `animation`, `fade/slide`, màu sắc, font, layout pixel, micro-interaction → *"Chi tiết visual này thuộc Design Spec — ghi nhận để tạo Design Spec sau."*
|
|
24
|
+
|
|
25
|
+
**Nhóm 3 — Backend/contract thuần → BỎ khỏi PRD (thuộc Tech Docs):**
|
|
26
|
+
`API`, `endpoint`, `token/JWT`, `HTTP status`, tên class/bảng/cột DB, query, payload, header.
|
|
27
|
+
*(Ngoại lệ DUY NHẤT: Appendix "Existing API Contract" khi `API Source: existing` — xem Platform Strategy.)*
|
|
28
|
+
|
|
29
|
+
## Quy tắc áp dụng
|
|
30
|
+
- Quét toàn bộ text sắp ghi (User Story, AC, BR, Business Logic, Scope, Edge Cases, Assumptions…).
|
|
31
|
+
- Nhóm 1 → thay tại chỗ, giữ nguyên nghĩa nghiệp vụ. **Đồng bộ cách diễn đạt** với chỗ đã có sẵn trong cùng tài liệu (vd nếu "quá thời gian chờ" đã dùng ở một BR → dùng nhất quán ở mọi nơi).
|
|
32
|
+
- Nhóm 2 → gỡ khỏi prose nghiệp vụ + nhắc chuyển Design Spec.
|
|
33
|
+
- Nhóm 3 → gỡ khỏi PRD (trừ ngoại lệ brownfield).
|
|
34
|
+
- Nếu term không có trong bản đồ nhưng rõ ràng là tên kỹ thuật/triển khai → vẫn diễn đạt lại theo tinh thần Nhóm 1, đừng để lọt.
|
|
35
|
+
|
|
36
|
+
**Checklist (dùng ở Quality Checklist của lệnh):** 0 thuật ngữ kỹ thuật/UI (re-render, UI, timeout, spinner, API/endpoint/token…) trong prose nghiệp vụ — đã diễn đạt lại (Nhóm 1) / chuyển Design Spec (Nhóm 2) / bỏ về Tech Docs (Nhóm 3).
|
package/core/steps/gate.md
CHANGED
|
@@ -13,6 +13,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
13
13
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
14
14
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
15
15
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
16
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
16
17
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
17
18
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
18
19
|
|
|
@@ -6,10 +6,12 @@ dừng ở mức "đủ" findings, nên mỗi vòng review sau lại lòi ra v
|
|
|
6
6
|
fan out song song theo các chiều review, rồi lặp một critic độ-đầy-đủ cho tới khi một
|
|
7
7
|
vòng không sinh thêm gì mới, *trước khi* ghi file findings.
|
|
8
8
|
|
|
9
|
-
Lệnh gọi cung cấp hai
|
|
9
|
+
Lệnh gọi cung cấp hai thứ bắt buộc + hai tuỳ chọn:
|
|
10
10
|
- **DIMENSIONS** — danh sách các chiều review để fan out
|
|
11
11
|
(`/refine-prd` → 4 lăng kính; `/review-context` → các P-check hoặc B-check).
|
|
12
12
|
- **FINDINGS SCHEMA** — dạng YAML mà mỗi finding phải theo (định nghĩa trong lệnh).
|
|
13
|
+
- **GRANULARITY** *(tuỳ chọn, mặc định `auto`)* — `auto`: chọn độ mịn fan-out theo bảng ngưỡng kích thước ở Phase 1 (hành vi cũ). `per-uc`: **LUÔN** fan-out theo từng UC, **bỏ qua ngưỡng** — dùng cho review cần độ đầy đủ cao (`/refine-prd` truyền cái này để lần đầu đã quét sâu). Lệnh không truyền → `auto` → hành vi không đổi.
|
|
14
|
+
- **CHANGED_SCOPE** *(tuỳ chọn)* — danh sách UC/section đã thay đổi (review **delta**). Nếu được truyền, Phase 1 chỉ fan-out trên các phạm vi này + PRD-global; Phase 2 critic vẫn quét **toàn doc** làm lưới an toàn. Không truyền → quét toàn bộ như thường.
|
|
13
15
|
|
|
14
16
|
> **Bỏ qua ở chế độ sub-agent:** Nếu Gate Bước 0 đã set `_agent_mode: true`, toàn bộ
|
|
15
17
|
> quy trình này bị **bỏ qua** — orchestrator đã chạy sẵn một dimension/UC cho mỗi
|
|
@@ -21,8 +23,11 @@ Lệnh gọi cung cấp hai thứ:
|
|
|
21
23
|
|
|
22
24
|
**Bao nhiêu sub-agent:** *số lượng* agent không phải là đòn bẩy độ đầy đủ — bề rộng được
|
|
23
25
|
cố định bởi taxonomy DIMENSION (thêm agent vào cùng một dimension chỉ tìm lại cùng vấn đề),
|
|
24
|
-
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
25
|
-
|
|
26
|
+
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
27
|
+
|
|
28
|
+
**Nếu `GRANULARITY = per-uc`:** **bỏ qua bảng ngưỡng dưới đây**, luôn dùng độ mịn **DIMENSION × phạm vi UC** (kể cả PRD nhỏ) — đảm bảo quét sâu, không bỏ sót ngay lần đầu. (Cái giá: nhiều agent hơn cho PRD nhỏ — chấp nhận để lần đầu đầy đủ.)
|
|
29
|
+
|
|
30
|
+
**Nếu `GRANULARITY = auto`** (mặc định): chọn **độ mịn fan-out** theo kích thước target, tái dùng ngưỡng của `steps/spawn-agent.md`:
|
|
26
31
|
|
|
27
32
|
| Kích thước target | Độ mịn | Số agent |
|
|
28
33
|
|-------------|-------------|-------------|
|
|
@@ -45,6 +50,7 @@ UC duy nhất — chính là điều ngăn bỏ sót trên các PRD lớn.
|
|
|
45
50
|
agent). Giới hạn mỗi wave ở **`AGENT_CAP = 12`** agent và gom batch các phạm vi UC cho vừa:
|
|
46
51
|
|
|
47
52
|
1. Dựng danh sách phạm vi = `[UC1, UC2, …, UCn, PRD-global]` (độ dài `UCs + 1`).
|
|
53
|
+
- **Nếu `CHANGED_SCOPE` được truyền (review delta):** danh sách phạm vi = `[các UC trong CHANGED_SCOPE] + [PRD-global]` (chỉ các UC đã đổi + global), KHÔNG phải tất cả UC. Số agent tụt theo đó.
|
|
48
54
|
2. Tính số-phạm-vi-mỗi-bucket: `groups = max(1, floor(AGENT_CAP / dimensions))`.
|
|
49
55
|
- Nếu `groups ≥ UCs + 1` → không cần batch, chạy một agent cho mỗi `DIMENSION × scope`.
|
|
50
56
|
- Else chia danh sách phạm vi thành `groups` bucket liền kề kích thước xấp xỉ bằng nhau
|
|
@@ -86,10 +92,20 @@ Gom mảng findings của mọi sub-agent vào một danh sách hợp nhất `AL
|
|
|
86
92
|
Đây là bước chống đập-chuột-chũi. Lặp cho tới khi **hai vòng liên tiếp thêm 0 finding
|
|
87
93
|
mới**, hoặc tới cap cứng **3 vòng**, cái nào đến trước:
|
|
88
94
|
|
|
95
|
+
> **Lưu ý delta:** kể cả khi `CHANGED_SCOPE` giới hạn Phase 1 vào các UC đã đổi, completeness-critic ở Phase 2 **vẫn đọc TOÀN bộ doc** — đây là lưới an toàn bắt các vấn đề mà một fix ở UC đã đổi có thể làm lộ ra ở chỗ khác.
|
|
96
|
+
|
|
89
97
|
1. Spawn một sub-agent **completeness-critic** bằng Agent tool. Cho nó:
|
|
90
98
|
- toàn bộ target file (`{target_file}`),
|
|
91
|
-
- danh sách
|
|
92
|
-
|
|
99
|
+
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
|
100
|
+
đủ để critic nhận ra trùng lặp (không cần `quote`, `suggestion`, `auto_fixable`, `severity`):
|
|
101
|
+
```json
|
|
102
|
+
[
|
|
103
|
+
{ "uc_id": "...", "section": "...", "finding": "..." },
|
|
104
|
+
...
|
|
105
|
+
]
|
|
106
|
+
```
|
|
107
|
+
Nếu `ALL_FINDINGS` vượt 60 items, rút gọn `finding` xuống còn 80 ký tự đầu mỗi item.
|
|
108
|
+
- cùng slim context (banned terms, canonical entities, layer order, domains).
|
|
93
109
|
Prompt nó:
|
|
94
110
|
```
|
|
95
111
|
Here is a document and a list of issues already found. Read the WHOLE document.
|