@edupia-tutor/spec-driven-docs 0.14.4 → 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/define-product.md +51 -2
- package/commands/define-product.tmpl +15 -2
- package/commands/generate-bdd.md +14 -11
- package/commands/generate-bdd.tmpl +14 -11
- package/commands/generate-prd.md +91 -5
- package/commands/generate-prd.tmpl +42 -2
- package/commands/refine-prd.md +82 -3
- package/commands/refine-prd.tmpl +35 -0
- package/commands/review-context.md +11 -3
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/define-product.md +51 -2
- package/core/commands/generate-bdd.md +14 -11
- package/core/commands/generate-prd.md +91 -5
- package/core/commands/refine-prd.md +82 -3
- package/core/commands/review-context.md +11 -3
- package/core/skills/prd/SKILL.md +13 -3
- package/core/steps/business-language.md +36 -0
- package/core/steps/review-fanout.md +11 -3
- package/core/templates/prd.template.md +13 -3
- package/core/templates/product-definition.template.md +8 -1
- package/package.json +1 -1
- package/skills/prd/SKILL.md +13 -3
- package/steps/business-language.md +36 -0
- package/steps/review-fanout.md +11 -3
- package/templates/prd.template.md +13 -3
- package/templates/product-definition.template.md +8 -1
|
@@ -416,6 +416,47 @@ Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
|
416
416
|
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
417
417
|
|
|
418
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
|
+
|
|
419
460
|
---
|
|
420
461
|
|
|
421
462
|
## Quy trình Review
|
|
@@ -427,10 +468,12 @@ dừng ở mức "đủ" findings, nên mỗi vòng review sau lại lòi ra v
|
|
|
427
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
|
|
428
469
|
vòng không sinh thêm gì mới, *trước khi* ghi file findings.
|
|
429
470
|
|
|
430
|
-
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:
|
|
431
472
|
- **DIMENSIONS** — danh sách các chiều review để fan out
|
|
432
473
|
(`/refine-prd` → 4 lăng kính; `/review-context` → các P-check hoặc B-check).
|
|
433
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.
|
|
434
477
|
|
|
435
478
|
> **Bỏ qua ở chế độ sub-agent:** Nếu Gate Bước 0 đã set `_agent_mode: true`, toàn bộ
|
|
436
479
|
> quy trình này bị **bỏ qua** — orchestrator đã chạy sẵn một dimension/UC cho mỗi
|
|
@@ -442,8 +485,11 @@ Lệnh gọi cung cấp hai thứ:
|
|
|
442
485
|
|
|
443
486
|
**Bao nhiêu sub-agent:** *số lượng* agent không phải là đòn bẩy độ đầy đủ — bề rộng được
|
|
444
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 đề),
|
|
445
|
-
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
446
|
-
|
|
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`:
|
|
447
493
|
|
|
448
494
|
| Kích thước target | Độ mịn | Số agent |
|
|
449
495
|
|-------------|-------------|-------------|
|
|
@@ -466,6 +512,7 @@ UC duy nhất — chính là điều ngăn bỏ sót trên các PRD lớn.
|
|
|
466
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:
|
|
467
513
|
|
|
468
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 đó.
|
|
469
516
|
2. Tính số-phạm-vi-mỗi-bucket: `groups = max(1, floor(AGENT_CAP / dimensions))`.
|
|
470
517
|
- Nếu `groups ≥ UCs + 1` → không cần batch, chạy một agent cho mỗi `DIMENSION × scope`.
|
|
471
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
|
|
@@ -507,6 +554,8 @@ Gom mảng findings của mọi sub-agent vào một danh sách hợp nhất `AL
|
|
|
507
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
|
|
508
555
|
mới**, hoặc tới cap cứng **3 vòng**, cái nào đến trước:
|
|
509
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
|
+
|
|
510
559
|
1. Spawn một sub-agent **completeness-critic** bằng Agent tool. Cho nó:
|
|
511
560
|
- toàn bộ target file (`{target_file}`),
|
|
512
561
|
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
|
@@ -571,6 +620,19 @@ Convergence: {convergence_rounds} vòng critic — file findings đã đầy đ
|
|
|
571
620
|
|
|
572
621
|
Chạy review qua **Quy trình Review** ở trên (`steps/review-fanout.md`).
|
|
573
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
|
+
|
|
574
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
|
|
575
637
|
toàn bộ PRD qua đúng lăng kính của nó:
|
|
576
638
|
|
|
@@ -600,6 +662,7 @@ Ghi `{paths.refinement_dir}/{prd-slug}-findings.yaml`:
|
|
|
600
662
|
|
|
601
663
|
```yaml
|
|
602
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}"
|
|
603
666
|
generated_at: "{ISO datetime}"
|
|
604
667
|
status: "pending_review"
|
|
605
668
|
|
|
@@ -612,6 +675,11 @@ findings:
|
|
|
612
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ự}"
|
|
613
676
|
finding: "{mô tả gap hoặc vấn đề}"
|
|
614
677
|
suggestion: "{đề xuất cải thiện cụ thể, hành động được}"
|
|
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}"
|
|
615
683
|
auto_fixable: false
|
|
616
684
|
# true = AI tự tin cao vào suggestion này; Review Board có thể hiển thị nút "quick accept"
|
|
617
685
|
# false = cần human đọc kỹ và ghi quyết định trước khi accept
|
|
@@ -641,6 +709,14 @@ summary:
|
|
|
641
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
|
|
642
710
|
> finding trong Review Board và nhảy thẳng tới đúng vị trí trong PRD nguồn.
|
|
643
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
|
+
|
|
644
720
|
## Report
|
|
645
721
|
|
|
646
722
|
# Report Footer — Định dạng output chuẩn cho mọi lệnh
|
|
@@ -802,6 +878,7 @@ Nếu có finding nào có `status: "needs_discussion"`, thêm warning block sau
|
|
|
802
878
|
Với mỗi finding được chấp nhận, theo thứ tự severity (critical → major → minor):
|
|
803
879
|
- Đi tới section PRD được chỉ định bởi `finding.section`.
|
|
804
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.
|
|
805
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.
|
|
806
883
|
|
|
807
884
|
### Phase 2.5 — Cập nhật file findings
|
|
@@ -839,6 +916,8 @@ Changes :
|
|
|
839
916
|
- {change 1}
|
|
840
917
|
- {change 2}
|
|
841
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.
|
|
842
921
|
⚠️ BDD có thể đã lỗi thời. Chạy:
|
|
843
922
|
/review-context {prd-file} ← kiểm tra chất lượng PRD trước
|
|
844
923
|
→ /generate-bdd {prd-file}
|
|
@@ -438,10 +438,12 @@ dừng ở mức "đủ" findings, nên mỗi vòng review sau lại lòi ra v
|
|
|
438
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
|
|
439
439
|
vòng không sinh thêm gì mới, *trước khi* ghi file findings.
|
|
440
440
|
|
|
441
|
-
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:
|
|
442
442
|
- **DIMENSIONS** — danh sách các chiều review để fan out
|
|
443
443
|
(`/refine-prd` → 4 lăng kính; `/review-context` → các P-check hoặc B-check).
|
|
444
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.
|
|
445
447
|
|
|
446
448
|
> **Bỏ qua ở chế độ sub-agent:** Nếu Gate Bước 0 đã set `_agent_mode: true`, toàn bộ
|
|
447
449
|
> quy trình này bị **bỏ qua** — orchestrator đã chạy sẵn một dimension/UC cho mỗi
|
|
@@ -453,8 +455,11 @@ Lệnh gọi cung cấp hai thứ:
|
|
|
453
455
|
|
|
454
456
|
**Bao nhiêu sub-agent:** *số lượng* agent không phải là đòn bẩy độ đầy đủ — bề rộng được
|
|
455
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 đề),
|
|
456
|
-
còn *độ sâu* thuộc về vòng lặp critic ở Phase 2.
|
|
457
|
-
|
|
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`:
|
|
458
463
|
|
|
459
464
|
| Kích thước target | Độ mịn | Số agent |
|
|
460
465
|
|-------------|-------------|-------------|
|
|
@@ -477,6 +482,7 @@ UC duy nhất — chính là điều ngăn bỏ sót trên các PRD lớn.
|
|
|
477
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:
|
|
478
483
|
|
|
479
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 đó.
|
|
480
486
|
2. Tính số-phạm-vi-mỗi-bucket: `groups = max(1, floor(AGENT_CAP / dimensions))`.
|
|
481
487
|
- Nếu `groups ≥ UCs + 1` → không cần batch, chạy một agent cho mỗi `DIMENSION × scope`.
|
|
482
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
|
|
@@ -518,6 +524,8 @@ Gom mảng findings của mọi sub-agent vào một danh sách hợp nhất `AL
|
|
|
518
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
|
|
519
525
|
mới**, hoặc tới cap cứng **3 vòng**, cái nào đến trước:
|
|
520
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
|
+
|
|
521
529
|
1. Spawn một sub-agent **completeness-critic** bằng Agent tool. Cho nó:
|
|
522
530
|
- toàn bộ target file (`{target_file}`),
|
|
523
531
|
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
package/core/skills/prd/SKILL.md
CHANGED
|
@@ -187,7 +187,7 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
187
187
|
| **Domain** | {domain} |
|
|
188
188
|
| **Created** | {date} |
|
|
189
189
|
| **Updated** | {date} |
|
|
190
|
-
| **
|
|
190
|
+
| **Ticket** | {TICKET}-{N}{ — nếu PO có link tracker thật, thêm bên cạnh: `{TICKET}-{N} ([Jira]({tracker_url}))`} |
|
|
191
191
|
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
192
192
|
|
|
193
193
|
---
|
|
@@ -217,13 +217,21 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
217
217
|
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
218
218
|
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
219
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
|
+
|
|
220
226
|
---
|
|
221
227
|
|
|
222
228
|
# 2. Acceptance Criteria
|
|
223
229
|
|
|
224
|
-
|
|
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.
|
|
225
231
|
|
|
226
|
-
**
|
|
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})_
|
|
227
235
|
|
|
228
236
|
---
|
|
229
237
|
|
|
@@ -241,6 +249,8 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
241
249
|
**Post-condition:**
|
|
242
250
|
- {kết quả sau 1}
|
|
243
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
|
+
|
|
244
254
|
**Business Rule**
|
|
245
255
|
|
|
246
256
|
| ID | Business Rule | Business Logic |
|
|
@@ -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).
|
|
@@ -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,6 +92,8 @@ 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
99
|
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
| **Domain** | {domain} |
|
|
47
47
|
| **Created** | {date} |
|
|
48
48
|
| **Updated** | {date} |
|
|
49
|
-
| **
|
|
49
|
+
| **Ticket** | {TICKET}-{N}{ — nếu PO có link tracker thật, thêm bên cạnh: `{TICKET}-{N} ([Jira]({tracker_url}))`} |
|
|
50
50
|
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
51
51
|
|
|
52
52
|
---
|
|
@@ -76,13 +76,21 @@
|
|
|
76
76
|
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
77
77
|
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
78
78
|
|
|
79
|
+
## c. Phụ thuộc liên service *(mức nghiệp vụ — KHÔNG mô tả API/event/kỹ thuật)*
|
|
80
|
+
|
|
81
|
+
> 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.
|
|
82
|
+
|
|
83
|
+
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
84
|
+
|
|
79
85
|
---
|
|
80
86
|
|
|
81
87
|
# 2. Acceptance Criteria
|
|
82
88
|
|
|
83
|
-
|
|
89
|
+
> 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.
|
|
84
90
|
|
|
85
|
-
**
|
|
91
|
+
**AC1:** {Tiêu chí nghiệm thu, văn xuôi, kiểm chứng được.} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
92
|
+
|
|
93
|
+
**AC2:** {…} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
86
94
|
|
|
87
95
|
---
|
|
88
96
|
|
|
@@ -100,6 +108,8 @@
|
|
|
100
108
|
**Post-condition:**
|
|
101
109
|
- {kết quả sau 1}
|
|
102
110
|
|
|
111
|
+
**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)*
|
|
112
|
+
|
|
103
113
|
**Business Rule**
|
|
104
114
|
|
|
105
115
|
| ID | Business Rule | Business Logic |
|
|
@@ -100,6 +100,13 @@
|
|
|
100
100
|
| 1 | {hành động} | {trạng thái/kết quả nghiệp vụ} | {ghi chú} |
|
|
101
101
|
| 2 | {hành động} | {trạng thái/kết quả nghiệp vụ} | {ghi chú} |
|
|
102
102
|
|
|
103
|
+
### Màn hình & thành phần chính
|
|
104
|
+
> Mức nghiệp vụ — nguồn cho Wireframe PRD (§4b) và độ phủ BDD (C.1). KHÔNG pixel/layout/màu.
|
|
105
|
+
|
|
106
|
+
| Màn hình | Thành phần chính | Hành động → kết quả nghiệp vụ |
|
|
107
|
+
|----------|------------------|-------------------------------|
|
|
108
|
+
| {màn 1} | {thành phần} | {hành động → kết quả} |
|
|
109
|
+
|
|
103
110
|
### Điểm ra (Exit Point)
|
|
104
111
|
{Kết quả cuối khi flow hoàn thành}
|
|
105
112
|
|
|
@@ -176,6 +183,6 @@
|
|
|
176
183
|
<!--
|
|
177
184
|
NEXT STEPS:
|
|
178
185
|
Khi Product Definition hoàn tất (Status: completed), chạy:
|
|
179
|
-
/generate-prd {path-to-this-file}
|
|
186
|
+
/generate-prd {path-to-this-file}
|
|
180
187
|
để sinh PRD từ Product Definition này.
|
|
181
188
|
-->
|
package/package.json
CHANGED
package/skills/prd/SKILL.md
CHANGED
|
@@ -187,7 +187,7 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
187
187
|
| **Domain** | {domain} |
|
|
188
188
|
| **Created** | {date} |
|
|
189
189
|
| **Updated** | {date} |
|
|
190
|
-
| **
|
|
190
|
+
| **Ticket** | {TICKET}-{N}{ — nếu PO có link tracker thật, thêm bên cạnh: `{TICKET}-{N} ([Jira]({tracker_url}))`} |
|
|
191
191
|
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
192
192
|
|
|
193
193
|
---
|
|
@@ -217,13 +217,21 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
217
217
|
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
218
218
|
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
219
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
|
+
|
|
220
226
|
---
|
|
221
227
|
|
|
222
228
|
# 2. Acceptance Criteria
|
|
223
229
|
|
|
224
|
-
|
|
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.
|
|
225
231
|
|
|
226
|
-
**
|
|
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})_
|
|
227
235
|
|
|
228
236
|
---
|
|
229
237
|
|
|
@@ -241,6 +249,8 @@ Template (cấu trúc đầu ra — single-source từ `templates/prd.template.m
|
|
|
241
249
|
**Post-condition:**
|
|
242
250
|
- {kết quả sau 1}
|
|
243
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
|
+
|
|
244
254
|
**Business Rule**
|
|
245
255
|
|
|
246
256
|
| ID | Business Rule | Business Logic |
|
|
@@ -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/steps/review-fanout.md
CHANGED
|
@@ -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,6 +92,8 @@ 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
99
|
- danh sách findings đã ghi nhận dưới dạng **slim JSON** — chỉ 3 fields cốt lõi
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
| **Domain** | {domain} |
|
|
47
47
|
| **Created** | {date} |
|
|
48
48
|
| **Updated** | {date} |
|
|
49
|
-
| **
|
|
49
|
+
| **Ticket** | {TICKET}-{N}{ — nếu PO có link tracker thật, thêm bên cạnh: `{TICKET}-{N} ([Jira]({tracker_url}))`} |
|
|
50
50
|
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
51
51
|
|
|
52
52
|
---
|
|
@@ -76,13 +76,21 @@
|
|
|
76
76
|
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
77
77
|
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
78
78
|
|
|
79
|
+
## c. Phụ thuộc liên service *(mức nghiệp vụ — KHÔNG mô tả API/event/kỹ thuật)*
|
|
80
|
+
|
|
81
|
+
> 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.
|
|
82
|
+
|
|
83
|
+
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
84
|
+
|
|
79
85
|
---
|
|
80
86
|
|
|
81
87
|
# 2. Acceptance Criteria
|
|
82
88
|
|
|
83
|
-
|
|
89
|
+
> 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.
|
|
84
90
|
|
|
85
|
-
**
|
|
91
|
+
**AC1:** {Tiêu chí nghiệm thu, văn xuôi, kiểm chứng được.} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
92
|
+
|
|
93
|
+
**AC2:** {…} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
86
94
|
|
|
87
95
|
---
|
|
88
96
|
|
|
@@ -100,6 +108,8 @@
|
|
|
100
108
|
**Post-condition:**
|
|
101
109
|
- {kết quả sau 1}
|
|
102
110
|
|
|
111
|
+
**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)*
|
|
112
|
+
|
|
103
113
|
**Business Rule**
|
|
104
114
|
|
|
105
115
|
| ID | Business Rule | Business Logic |
|
|
@@ -100,6 +100,13 @@
|
|
|
100
100
|
| 1 | {hành động} | {trạng thái/kết quả nghiệp vụ} | {ghi chú} |
|
|
101
101
|
| 2 | {hành động} | {trạng thái/kết quả nghiệp vụ} | {ghi chú} |
|
|
102
102
|
|
|
103
|
+
### Màn hình & thành phần chính
|
|
104
|
+
> Mức nghiệp vụ — nguồn cho Wireframe PRD (§4b) và độ phủ BDD (C.1). KHÔNG pixel/layout/màu.
|
|
105
|
+
|
|
106
|
+
| Màn hình | Thành phần chính | Hành động → kết quả nghiệp vụ |
|
|
107
|
+
|----------|------------------|-------------------------------|
|
|
108
|
+
| {màn 1} | {thành phần} | {hành động → kết quả} |
|
|
109
|
+
|
|
103
110
|
### Điểm ra (Exit Point)
|
|
104
111
|
{Kết quả cuối khi flow hoàn thành}
|
|
105
112
|
|
|
@@ -176,6 +183,6 @@
|
|
|
176
183
|
<!--
|
|
177
184
|
NEXT STEPS:
|
|
178
185
|
Khi Product Definition hoàn tất (Status: completed), chạy:
|
|
179
|
-
/generate-prd {path-to-this-file}
|
|
186
|
+
/generate-prd {path-to-this-file}
|
|
180
187
|
để sinh PRD từ Product Definition này.
|
|
181
188
|
-->
|