@educa-corp/sdd-framework 0.5.0 → 0.7.0

package/commands/refine-prd.tmpl

@@ -1,278 +0,0 @@
-# /refine-prd — Phân tích PRD qua 3 lăng kính review
-
-## Gate
-{{include:steps/gate.md}}
-
-*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.*
-
-### Bước 0-C — Resume mode routing *(riêng /refine-prd, chạy ngay sau Bước 0 của Gate)*
-
-Nếu `$ARGUMENTS` chứa `--resume`:
-- Tách `--resume` ra, phần còn lại là `raw_target` (file path hoặc prd-slug).
-- **Nạp minimal context:** đọc `.agent/project-context.yaml`, trích xuất `paths.refinement_dir`
-  (default: `.agent/review` nếu không có hoặc file không tồn tại).
-- Chạy **Bước 1** với `raw_target` để phân giải `prd-slug` và `target_file`.
-  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.
-- **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.
-- → Nhảy thẳng tới **Resume Mode** ở cuối lệnh này.
-
-Nếu `$ARGUMENTS` không chứa `--resume` → tiếp tục luồng review bình thường bên dưới.
-
-## Context
-{{include:steps/context-loader.md}}
-
----
-
-## Ngôn ngữ nghiệp vụ *(áp khi viết/áp fix — gồm cả Resume Mode Phase 2)*
-{{include:steps/business-language.md}}
-
----
-
-## Quy trình Review
-{{include:steps/review-fanout.md}}
-
----
-
-## Phân tích — 3 lăng kính (fan out cả ba, rồi hội tụ)
-
-Chạy review qua **Quy trình Review** ở trên (`steps/review-fanout.md`).
-
-**Tham số truyền vào Quy trình Review:**
-- `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.
-- `CHANGED_SCOPE` — xác định theo chế độ full/delta ngay dưới đây.
-
-**Chọn full vs delta** *(mặc định: lần đầu FULL, lần sau DELTA)*:
-1. Tách `--full` khỏi `$ARGUMENTS` nếu có.
-2. Kiểm tra `{paths.refinement_dir}/{prd-slug}-findings.yaml`:
-   - **Không tồn tại** (lần đầu review PRD này) → **FULL**: KHÔNG truyền `CHANGED_SCOPE`.
-   - **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ộ).
-   - **Tồn tại** + KHÔNG có `--full` → so `prd_version` trong findings cũ với `| **Version** |` của PRD hiện tại:
-     - **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ộ."`
-     - **Khác** → kiểm tra `applied_to_version` trong findings cũ (version mà lần `--resume` gần nhất của CHÍNH lệnh này đã bump PRD tới) để biết ai gây ra thay đổi:
-       - **`applied_to_version` có mặt VÀ `==` version PRD hiện tại** → PRD đổi đúng bằng phần lệnh này tự áp, không actor khác động vào → **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.
-       - **`applied_to_version` vắng mặt HOẶC `≠` version hiện tại** → PRD đã bị sửa bởi **actor khác** (lệnh `/review-context`, sửa tay…) sau lần resume này → KHÔNG tin được phạm vi hẹp → **FULL** (KHÔNG truyền `CHANGED_SCOPE`), kèm cảnh báo: `"PRD đổi ngoài tầm theo dõi của findings (applied_to_version={A} ≠ hiện tại={C}); quét lại toàn bộ để khỏi sót UC do người/lệnh khác sửa."`
-
-**DIMENSIONS** = 3 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
-toàn bộ PRD qua đúng lăng kính của nó:
-
-<!-- ─────────────────────────────────────────────────────────────────────────────
-  LĂNG KÍNH BỊ TẮT (DISABLED — KHÔNG dùng, KHÔNG fan-out agent cho lăng kính này):
-
-  - **Lăng kính QA (tầng nghiệm thu)**: AC có nêu **outcome quan sát/kiểm được** chưa? — **KHÔNG** hỏi "AC đủ chi tiết chưa" (câu đó kéo cơ chế vào AC). Chi tiết cơ chế (số lần retry, timeout, tên/chủ cờ, nhánh lỗi vụn) thuộc **BR/BL**: nếu gap là cơ chế → suggestion phải **route sang BR/BL + AC ref**, KHÔNG phình AC. AC có lặp lại nội dung BR (trùng tầng) không → nếu có, đề xuất làm mỏng AC.
-
-  CÁCH THÊM LẠI QA (khi cần bật lại giai đoạn sau):
-    1. Chuyển bullet QA ở trên ra khỏi block comment này, đặt lên đầu danh sách DIMENSIONS.
-    2. Đổi "3 lăng kính"/"cả ba" → "4 lăng kính"/"cả bốn" ở: dòng tiêu đề (# /refine-prd),
-       heading "## Phân tích", câu "DIMENSIONS = N lăng kính", và steps/review-fanout.md.
-    3. Thêm "QA" lại vào enum của `lens:` trong FINDINGS SCHEMA + vào `by_lens`.
-    4. Thêm "QA" lại vào ghi chú "phán đoán DEV/SA/PO" ở LƯU Ý của schema.
-    5. Rebuild: node bin/build.js
-───────────────────────────────────────────────────────────────────────────── -->
-
-> **Nguyên tắc chung cho DEV & SA — đọc bằng mắt kỹ thuật, VIẾT bằng lời nghiệp vụ.**
-> Hai lăng kính này dùng con mắt kỹ thuật để **phát hiện chỗ nghiệp vụ mô tả thiếu/mơ hồ/mâu thuẫn đến mức sẽ chặn triển khai** — mục tiêu là **làm rõ vấn đề nghiệp vụ để sau này xử lý được về mặt kỹ thuật**. **KHÔNG** đưa góc nhìn kỹ thuật vào PRD, **KHÔNG** đề xuất giải pháp/cơ chế kỹ thuật. Mọi `finding` và `suggestion` phải **thuần nghiệp vụ** (tuân Business Language Guard): mô tả *cái nghiệp vụ còn thiếu/chưa rõ* và *hỏi cần làm rõ gì*, chứ không nói *làm thế nào về kỹ thuật*.
-
-- **Lăng kính DEV (tầng cơ chế nghiệp vụ)**: Đọc luồng như một dev sắp build — BR (WHAT) + Business Logic (HOW nghiệp vụ) đã **đủ & không mơ hồ để triển khai mà không phải đoán** chưa? Soi: nhánh nghiệp vụ còn thiếu, điều kiện biên chưa nói, đường xử lý khi có lỗi/ngoại lệ bị bỏ ngỏ (vd: "khi thanh toán bị từ chối thì đơn hàng được xử lý ra sao?"), business rule mâu thuẫn hoặc mơ hồ. Diễn đạt gap bằng **ngôn ngữ nghiệp vụ + đặt câu hỏi làm rõ** — **KHÔNG** đề xuất cơ chế kỹ thuật (số lần thử lại, timeout, cấu trúc dữ liệu, API, thư viện) và **KHÔNG** nhồi chi tiết kỹ thuật vào PRD.
-- **Lăng kính SA (tính thông suốt & nhất quán nghiệp vụ)**: Đọc như một architect — toàn bộ luồng nghiệp vụ có **thông suốt & nhất quán** trên cả feature/domain không? Soi: tương tác nghiệp vụ giữa các UC/feature đã định nghĩa chưa, quan hệ giữa các thực thể nghiệp vụ (theo core-entities) có mâu thuẫn/bỏ trống không, trạng thái & vòng đời của đối tượng nghiệp vụ có nhất quán không, quy tắc **ai được làm gì / ai sở hữu gì** (nghiệp vụ đằng sau phân quyền) đã rõ chưa. **KHÔNG** phán về kiến trúc/security/mô hình dữ liệu kỹ thuật, **KHÔNG** đề xuất giải pháp kỹ thuật — chỉ nêu chỗ nghiệp vụ chưa nhất quán/chưa rõ bằng ngôn ngữ nghiệp vụ.
-- **Lăng kính PO**: Scope đã khoanh vùng? Priority rõ chưa? Success metric đã định nghĩa? Rủi ro scope creep?
-
-Vòng lặp completeness-critic (Phase 2) là cái đảm bảo file findings đầy đủ trong một lần chạy
-— chạy lại `/refine-prd` sẽ lòi ra **0 finding mới**. Map mỗi dimension vào field `lens`
-của schema dưới đây.
-
-## File Output
-
-Suy ra tên file output từ PRD slug:
-- File PRD: `{paths.specs_dir}/payment/create-invoice/PAY01-create-invoice.md` → output: `{paths.refinement_dir}/create-invoice-findings.yaml`
-- Quy tắc: lấy tên folder cha của PRD (prd-slug), thêm hậu tố `-findings.yaml`
-
-Trước khi ghi file, xác định `recommendation` từ findings đã dedup và sắp xếp:
-- `by_severity.critical ≥ 1` → `BLOCKED`
-- `by_severity.critical = 0` và `by_severity.major ≥ 1` → `NEEDS_REVISION`
-- `by_severity.critical = 0` và `by_severity.major = 0` → `APPROVED_WITH_MINOR_CHANGES`
-
-Đả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.
-
-Ghi `{paths.refinement_dir}/{prd-slug}-findings.yaml`:
-
-```yaml
-prd_source: "{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md"
-prd_version: "{đọc | **Version** | từ metadata PRD lúc sinh findings — dùng để chọn full/delta lần chạy sau}"
-applied_to_version: ""   # để trống lúc phân tích; --resume sẽ ghi version PRD vừa bump tới. Lần delta sau: nếu version PRD hiện tại ≠ giá trị này → PRD bị actor khác sửa → fallback FULL (xem "Chọn full vs delta")
-generated_at: "{ISO datetime}"
-status: "pending_review"
-
-findings:
-  - id: "F001"
-    lens: "DEV"          # DEV | SA | PO
-    severity: "major"    # critical | major | minor
-    section: "§2. Acceptance Criteria"   # nhãn heading/section dạng người đọc
-    uc_id: "{TICKET-ID}-UC{N}"           # UC mà finding thuộc về; "" nếu PRD-global (scope, metrics, problem statement)
-    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ự}"
-    finding: "{mô tả gap hoặc vấn đề}"
-    suggestion: "{đề xuất cải thiện cụ thể, hành động được}"
-    resolution_edge_cases:   # CHỈ điền cho critical/major; minor → để [] (bỏ qua)
-      # Phân tích bậc-hai (advisory, KHÔNG chặn): nếu áp `suggestion` này thì có thể đẻ ra
-      # 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,
-      # 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.
-      - "{edge case có thể phát sinh nếu chốt phương án này}"
-    auto_fixable: false
-    # true  = AI tự tin cao vào suggestion này; Review Board có thể hiển thị nút "quick accept"
-    # false = cần human đọc kỹ và ghi quyết định trước khi accept
-    # Resume Mode luôn áp dụng theo status (accepted|modified), bất kể auto_fixable.
-    # LƯU Ý: /refine-prd CỐ Ý không có `--fix` mode (khác /review-context) — finding 3 lăng kính
-    #   là phán đoán DEV/SA/PO, phải qua người duyệt ở Board; auto_fixable ở đây CHỈ là gợi ý
-    #   quick-accept cho Board, KHÔNG để máy tự áp.
-    status: "pending"
-    applied_via: ""
-    # Vòng đời finding-level (CHUNG với /review-context — Review Board đọc cả hai loại file nên enum phải khớp):
-    #   pending          → finding mới, chưa được review
-    #   accepted         → reviewer chấp nhận suggestion gốc → Resume sẽ apply
-    #   modified         → reviewer đã sửa suggestion trong Review Board → Resume dùng suggestion đã sửa
-    #   rejected         → reviewer bác bỏ, không apply
-    #   needs_discussion → hai suggestion xung đột, CHẶN --resume (bỏ qua + cảnh báo) tới khi con người quyết
-    #   deferred         → cố ý hoãn (không chặn), bỏ qua lượt này, xem lại sau
-    #   applied          → đã áp vào PRD; applied_via ghi cách áp: "resume" (qua --resume) — /review-context còn dùng "fix" (qua --fix)
-
-summary:
-  total_findings: {N}
-  by_severity: { critical: {N}, major: {N}, minor: {N} }
-  by_lens: { DEV: {N}, SA: {N}, PO: {N} }
-  recommendation: "APPROVED_WITH_MINOR_CHANGES | NEEDS_REVISION | BLOCKED"
-  # Rule: critical ≥ 1                       → BLOCKED
-  #       critical = 0, major ≥ 1            → NEEDS_REVISION
-  #       critical = 0, major = 0            → APPROVED_WITH_MINOR_CHANGES
-```
-
-> **Field định vị (`quote` + `uc_id`) — bắt buộc cho source-jump của Review Board.**
-> Với mỗi finding, copy một đoạn `quote` **nguyên văn** thẳng từ PRD tại đúng chỗ
-> lỗi xảy ra — KHÔNG diễn giải lại; nó được so khớp với tài liệu để định vị dòng. Đặt
-> `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
-> finding trong Review Board và nhảy thẳng tới đúng vị trí trong PRD nguồn.
-
-> **`resolution_edge_cases` — phân tích bậc-hai (chỉ critical/major).**
-> 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ì
-> đẻ 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).
-> Ghi vào `resolution_edge_cases` để PO **thấy trước khi accept**. Đây là **advisory** — KHÔNG chặn, KHÔNG tự
-> tạo finding; PO đọc rồi quyết. Finding `minor` → để `[]`.
-> *(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`
-> 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.)*
-
-## Report
-
-{{include:steps/report-footer.md}}
-
-Dùng footer chuẩn với hai field bổ sung `Findings` và `Review` đặt ngay sau `Status`:
-
-```
----
-Status   : {badge}
-Findings : {total} | 🔴 Critical: {N} | 🟡 Major: {N} | 🟢 Minor: {N}
-Review   : {paths.refinement_dir}/{prd-slug}-findings.yaml
-Output Artifacts:
-  created {paths.refinement_dir}/{prd-slug}-findings.yaml (findings từ 3-lens review)
-Pipeline : Discovery → [PRD ◀ bạn ở đây] → Design Spec → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
-           Vòng review: [① phân tích ◀] → ② Review Board → ③ --resume
-Next     : Mở trong Review Board (chuột phải vào file) → Cập nhật PRD
-           → /review-context {prd-file}   ← kiểm tra chất lượng PRD trước khi sinh BDD
-           → khi sạch critical, PO đặt | **Status** | approved | → /generate-bdd {prd-file}
-```
-
-Nếu có finding nào có `status: "needs_discussion"`, thêm warning block sau footer:
-
-```
-⚠️  {N} finding(s) cần quyết định của bạn trước khi --resume:
-   Mở {paths.refinement_dir}/{prd-slug}-findings.yaml
-   Với mỗi finding có status "needs_discussion":
-     1. Đọc cả hai phương án trong `suggestion`
-     2. Chọn một (hoặc viết phương án khác) vào `suggestion`
-     3. Đổi `status` → "accepted"
-   Sau đó chạy: /refine-prd {prd-file} --resume
-```
-*(Bỏ warning block này nếu không có `needs_discussion` finding nào.)*
-
----
-
-## Resume Mode — Áp dụng Findings & Bump Version
-
-*Đượ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.*
-
-### Phase 1 — Đọc các finding được chấp nhận
-
-1. Kiểm tra `{paths.refinement_dir}/{prd-slug}-findings.yaml` có tồn tại không.
-   Nếu không → báo lỗi rõ ràng và dừng:
-   ```
-   ❌ Không tìm thấy findings file tại {paths.refinement_dir}/{prd-slug}-findings.yaml
-      Hãy chạy /refine-prd {prd-file} trước để tạo findings, rồi mới --resume.
-   ```
-2. Đọc file findings.
-3. Gom tất cả finding có `status: "accepted"` hoặc `status: "modified"`.
-4. Nếu không có finding nào được chấp nhận → báo "No accepted findings. PRD unchanged." và dừng.
-5. Nếu còn finding nào có `status: "needs_discussion"` → cảnh báo (không dừng):
-   ```
-   ⚠️  {N} finding(s) chưa được giải quyết (needs_discussion) — sẽ bị bỏ qua lần apply này.
-      Giải quyết chúng trong Review Board rồi chạy lại --resume để apply.
-   ```
-
-### Phase 2 — Áp dụng thay đổi vào PRD
-
-Với mỗi finding được chấp nhận, theo thứ tự severity (critical → major → minor):
-- Đi tới section PRD được chỉ định bởi `finding.section`.
-- Á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.
-- **Giữ ĐÚNG TẦNG + gọn khi áp fix (altitude):** AC = **outcome quan sát được + ref BR**, KHÔNG chứa cơ chế. Nếu fix là **chi tiết cơ chế/rule** (retry N, timeout, tên/chủ cờ, nhánh lỗi) → **ghi vào bảng BR/BL của UC** (hoặc tạo BR mới), AC chỉ **ref**; KHÔNG inline vào câu AC. Nếu fix làm rõ **≥2 điều kiện/nhánh** ở đúng tầng của nó → **tách bullet con** (mỗi ý một dòng `  - …`) hoặc **AC/BR mới**, đừng nối mệnh đề vào câu cũ. Một AC = một tiêu chí kiểm chứng; đừng để AC lặp lại nội dung BR.
-- **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.
-- 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.
-
-### Phase 2.5 — Cập nhật file findings
-
-Với mỗi finding đã áp dụng (status là `accepted` hoặc `modified`):
-- Đặt `status: "applied"` + `applied_via: "resume"` trong `{paths.refinement_dir}/{prd-slug}-findings.yaml`.
-
-Cập nhật `status: "applied"` ở **root level** của file findings (không phải `summary.status`).
-# Lifecycle file-level: pending_review → applied | partially_applied
-# partially_applied khi có finding bị rejected hoặc needs_discussion còn sót lại.
-
-### Phase 3 — Bump version & ghi entry changelog
-
-1. Đọc giá trị `| **Version** |` hiện tại từ bảng metadata của PRD.
-2. Xác định loại bump từ tập finding được chấp nhận:
-   - **major** (X.0 → X+1.0 kế tiếp): thêm/xoá Use Case, tái cấu trúc scope, thay đổi BR breaking.
-   - **minor** (x.Y → x.Y+1): làm rõ, thêm edge case, tinh chỉnh wording AC/BR.
-3. Tính chuỗi version mới.
-4. Cập nhật metadata PRD:
-   - `| **Version** | {new_version} |`
-   - `| **Updated**  | {today YYYY-MM-DD} |`
-   - `| **Status**   | draft |` ← reset về draft, phải được duyệt lại
-5. Cập nhật `# Change Log` của PRD — **bảng phẳng 1 dòng/version, cửa sổ trượt 5 entry** (nếu gặp format cũ `### v{X}` block → chuẩn hoá sang bảng phẳng khi cập nhật):
-   - Thêm row mới lên **đầu** bảng:
-     ```
-     | {new_version} | {today} | {tóm tắt — KÈM UC/AC/BR bị ảnh hưởng, vd "UC2: sửa BR5; thêm AC7"} |
-     ```
-     *(Nêu rõ UC/AC/BR giúp `/generate-bdd` Version Check biết scenario nào cần cập nhật.)*
-   - Cập nhật dòng đầu section: `> Hiện tại: **v{new_version}** ({today}) · Lịch sử đầy đủ → [changelog](./changelog/{TICKET-ID}-{prd-slug}.changelog.md)`
-   - **Rollover (giữ PRD gọn — đây là chuẩn chung, /review-context cũng theo):** nếu bảng `# Change Log` có **> 5 row** → chuyển **mọi row vượt 5** (cũ nhất) sang **đầu** bảng của file kho `{paths.specs_dir}/{domain}/{prd-slug}/changelog/{TICKET-ID}-{prd-slug}.changelog.md` (giữ thứ tự mới→cũ); PRD chỉ giữ **5 row gần nhất**. Tạo thư mục `changelog/` + file kho nếu chưa có, theo skeleton:
-     ```
-     # Change Log (lịch sử) — {TICKET-ID}
-     > PRD: [../{TICKET-ID}-{prd-slug}.md](../{TICKET-ID}-{prd-slug}.md) — 5 version gần nhất nằm trong PRD; đây là phần cũ hơn.
-
-     | Version | Date | Changes |
-     |---------|------|---------|
-     ```
-6. Ghi `applied_to_version: "{new_version}"` ở **root level** của findings — đóng dấu "PRD đổi tới version này là do lệnh này áp", để lần review delta sau phân biệt được thay đổi của chính mình với thay đổi do actor khác (xem "Chọn full vs delta").
-
-### Phase 4 — Report
-
-```
-/refine-prd Đã áp dụng — {PRD name}
-Version  : {old_version} → {new_version}
-Applied  : {N} findings ({critical} critical, {major} major, {minor} minor)
-Changes  :
-  - {change 1}
-  - {change 2}
-
-💡 Vừa áp {N} phương án (gồm bản PO tự sửa) → chạy lại /refine-prd {prd-file}
-   (delta tự động) để lòi edge case mà các phương án vừa áp có thể tạo ra.
-⚠️  Status đã reset về draft (sửa rồi phải duyệt lại). BDD có thể đã lỗi thời. Chạy:
-    /review-context {prd-file}   ← kiểm tra chất lượng PRD trước
-    → PO đặt | **Status** | approved | khi hài lòng → /generate-bdd {prd-file}
-```