@educa-corp/sdd-framework 0.2.9 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/commands/generate-prd.md
CHANGED
|
@@ -553,6 +553,34 @@ Không bao giờ để TICKET-ID dạng plain text nếu file PRD tương ứng
|
|
|
553
553
|
- **BR ID**: `{TICKET-ID}-UC{N}-BR{M}` — **M tăng liên tục trên toàn PRD** (KHÔNG reset theo từng UC).
|
|
554
554
|
- Ví dụ: UC1 → BR1, BR2; UC2 → BR3, BR4 (KHÔNG phải BR1, BR2 lại từ đầu).
|
|
555
555
|
|
|
556
|
+
## Hình dạng bảng Business Rule *(3 cột mặc định — mở cột khi nội dung là bản ghi lặp)*
|
|
557
|
+
|
|
558
|
+
Bảng 3 cột `ID | Business Rule | Business Logic` là **mặc định**, KHÔNG phải luật cứng. Nó hoạt động tốt khi Business Logic là **văn xuôi** (mô tả luật bằng câu). Nó **gãy** khi Business Logic là một **bản ghi có cấu trúc lặp** — lúc đó ép vào một ô buộc phải serialize bản ghi thành chuỗi, và bảng mất khả năng đọc lướt / đếm / diff.
|
|
559
|
+
|
|
560
|
+
**Điều kiện kích hoạt mở cột** — cả hai phải đúng:
|
|
561
|
+
1. **Mọi** BR trong một UC chia sẻ **cùng một bộ thuộc tính** lặp lại (vd `trigger` / `data` / `tần suất` / `nguồn`); VÀ
|
|
562
|
+
2. Bộ thuộc tính đó là **cấu trúc đều**, không phải văn xuôi tự do.
|
|
563
|
+
|
|
564
|
+
**Dấu hiệu tự phát hiện (dùng khi tự kiểm trước khi ghi):** đang phải dùng `<br/>` để nhồi **nhiều hơn một bản ghi cùng cấu trúc** vào một ô Business Logic. Một `<br/>` ngăn cách các ý của **cùng một** luật thì bình thường — nhiều `<br/>` ngăn cách các **bản ghi ngang hàng** là tín hiệu sai hình dạng.
|
|
565
|
+
|
|
566
|
+
**Khi kích hoạt:** promote thuộc tính thành **cột**, một bản ghi = một **dòng**. Giữ nguyên hai cột `ID` + `Business Rule` (traceability phụ thuộc chúng); chỉ cột `Business Logic` được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên **§1d Quy ước**, đừng lặp trong từng ô.
|
|
567
|
+
|
|
568
|
+
**Khi KHÔNG kích hoạt:** giữ nguyên 3 cột. Phần lớn PRD tính năng rơi vào đây — BR của chúng là văn xuôi ("coi Landing là không sẵn sàng khi dịch vụ gặp sự cố; quá 3 giây chưa trả nội dung; hoặc trả nội dung rỗng"), không có bộ thuộc tính nào lặp. **Luật này tự kích hoạt theo hình dạng nội dung — không phải một cờ người dùng phải nhớ bật.**
|
|
569
|
+
|
|
570
|
+
> **⚠️ Guard — BR ID churn (BẮT BUỘC kiểm khi mở cột trên PRD ĐÃ TỒN TẠI):**
|
|
571
|
+
> Mở cột đúng nghĩa = một bản ghi một dòng ⇒ **số BR tăng**. Vì BR ID tăng liên tục trên toàn PRD (xem "Quy ước đánh số"), chèn dòng ở giữa sẽ **đánh số lại mọi BR phía sau**. BDD mang tag `@trace.business_rules: {TICKET}-UC1-BR1, …` — nếu PRD đã có BDD, mọi tag sau điểm chèn sẽ trỏ **sai trong im lặng**.
|
|
572
|
+
> Trước khi mở cột trên một PRD đã tồn tại → kiểm tra `{paths.specs_dir}/{domain}/{prd-slug}/bdd/`:
|
|
573
|
+
> - **Chưa có BDD** → mở cột tự do, không cần hỏi.
|
|
574
|
+
> - **Đã có BDD** → **DỪNG**, báo người dùng: *"Mở cột sẽ đánh số lại {N} BR; {M} file BDD đang ref BR ID cũ. Chọn: (1) mở cột + re-gen BDD, (2) giữ hình dạng cũ."* Chờ chọn.
|
|
575
|
+
>
|
|
576
|
+
> PRD sinh **mới** không bị ảnh hưởng — chưa có downstream nào ref BR ID.
|
|
577
|
+
|
|
578
|
+
## Quy ước tài liệu (§1d) & Note block *(hai slot tuỳ chọn)*
|
|
579
|
+
|
|
580
|
+
- **§1d Quy ước** — khi tài liệu có quy ước áp dụng **xuyên suốt mọi BR** (giá trị mặc định dùng chung, cách đọc cột, định nghĩa cục bộ), khai báo **một lần** ở đây. BR **không** lặp lại; AC **trỏ tới** thay vì chép lại. Không có quy ước xuyên suốt → **xoá hẳn section** (như `Existing API Contract` khi greenfield). Phân biệt: §1b Phạm vi = ranh giới; business-dictionary = thuật ngữ cấp domain; §1d = quy ước **cục bộ của tài liệu này**.
|
|
581
|
+
- **Note block sau bảng BR** — cho phép `> **Note {BR ref}:** …` ngay sau bảng để giải thích **quyết định đã chốt** (vì sao luật như vậy, ràng buộc nào dẫn tới). Đặt cạnh nơi phát sinh, đừng dồn xuống cuối file.
|
|
582
|
+
**Ranh giới với "Giả định AI":** Note = quyết định **đã chốt**; Giả định AI = **độ vênh cần PO chốt**. Note KHÔNG được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI, vì đó là thứ PO phải đọc.
|
|
583
|
+
|
|
556
584
|
## Traceability AC ↔ BR ↔ UC
|
|
557
585
|
|
|
558
586
|
- **Giữ link AC→BR từ discovery (KHÔNG vứt khi flatten):** Product Definition Phase 6 có cột "Bắt nguồn từ BR-{N}". Khi viết AC §2, **remap** mỗi `BR-{N}` (số discovery) sang **BR ID của PRD** (`{TICKET-ID}-UC{n}-BR{m}` sau khi đã phân BR vào UC) và gắn vào cuối AC: `_(BR: {ids})_`. Mỗi AC PHẢI có ≥1 ref BR.
|
|
@@ -600,8 +628,13 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
600
628
|
AI Agent sẽ điền các section dựa trên input từ PO.
|
|
601
629
|
Các placeholder {…} cần được thay thế bằng nội dung thực tế.
|
|
602
630
|
|
|
603
|
-
FORMAT
|
|
604
|
-
|
|
631
|
+
FORMAT BR: MẶC ĐỊNH bảng 3 cột — ID | Business Rule | Business Logic
|
|
632
|
+
(KHÔNG tách Business Logic ra khối riêng).
|
|
633
|
+
NGOẠI LỆ — MỞ CỘT: nếu MỌI BR trong một UC chia sẻ cùng một bộ thuộc tính lặp lại
|
|
634
|
+
(vd trigger / data / tần suất), promote các thuộc tính đó thành CỘT RIÊNG —
|
|
635
|
+
một bản ghi = một DÒNG. Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi
|
|
636
|
+
NHIỀU HƠN MỘT bản ghi cùng cấu trúc vào một ô. Chi tiết + cảnh báo BR ID churn:
|
|
637
|
+
xem §3 "Business Rule" của template và mục "Hình dạng bảng Business Rule" của lệnh.
|
|
605
638
|
|
|
606
639
|
TERMINOLOGY:
|
|
607
640
|
- Tuân thủ 100% từ điển project: specs/domain-knowledge/business-dictionary.md
|
|
@@ -679,6 +712,18 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
679
712
|
|
|
680
713
|
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
681
714
|
|
|
715
|
+
## d. Quy ước *(TUỲ CHỌN — chỉ thêm khi tài liệu có quy ước áp dụng xuyên suốt; nếu không có → XOÁ HẲN section này)*
|
|
716
|
+
|
|
717
|
+
> Khai báo **MỘT LẦN** các quy ước áp dụng cho **mọi BR** ở §3. BR **KHÔNG** lặp lại nội dung đã khai ở đây,
|
|
718
|
+
> AC §2 **trỏ tới** quy ước thay vì chép lại. Đây là nơi chứa định nghĩa dùng chung, giá trị mặc định,
|
|
719
|
+
> và cách đọc các cột của bảng BR — những thứ trước đây bị xé nhỏ và lặp trong từng dòng.
|
|
720
|
+
>
|
|
721
|
+
> Phân biệt với **§1b Phạm vi** (ranh giới làm/không làm) và **business-dictionary** (định nghĩa thuật ngữ
|
|
722
|
+
> cấp domain, dùng chung nhiều PRD): §1d chỉ chứa quy ước **cục bộ của tài liệu này**.
|
|
723
|
+
|
|
724
|
+
- **{Tên quy ước}**: {nội dung áp dụng cho mọi BR bên dưới}
|
|
725
|
+
- **{Giá trị mặc định dùng chung}**: {…}
|
|
726
|
+
|
|
682
727
|
---
|
|
683
728
|
|
|
684
729
|
# 2. Acceptance Criteria
|
|
@@ -713,11 +758,47 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
713
758
|
|
|
714
759
|
**Business Rule**
|
|
715
760
|
|
|
761
|
+
> **Hình dạng bảng — mặc định 3 cột.** Dùng dạng này khi Business Logic là **văn xuôi** (mô tả luật bằng câu).
|
|
762
|
+
|
|
716
763
|
| ID | Business Rule | Business Logic |
|
|
717
764
|
|----|---------------|----------------|
|
|
718
765
|
| {TICKET}-{N}-UC1-BR1 | {luật ngắn gọn} | - {logic chi tiết, xuống dòng bằng `<br/>`}<br/>- {…} |
|
|
719
766
|
| {TICKET}-{N}-UC1-BR2 | {…} | - {…} |
|
|
720
767
|
|
|
768
|
+
<!--
|
|
769
|
+
NGOẠI LỆ — MỞ CỘT (dùng THAY cho bảng 3 cột ở trên, KHÔNG dùng cả hai):
|
|
770
|
+
|
|
771
|
+
Điều kiện kích hoạt: MỌI BR trong UC này chia sẻ CÙNG một bộ thuộc tính lặp lại.
|
|
772
|
+
Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi NHIỀU HƠN MỘT bản ghi cùng
|
|
773
|
+
cấu trúc vào một ô Business Logic.
|
|
774
|
+
|
|
775
|
+
Khi kích hoạt: promote thuộc tính thành CỘT, một bản ghi = một DÒNG:
|
|
776
|
+
|
|
777
|
+
| ID | Business Rule | {Thuộc tính 1} | {Thuộc tính 2} | {Thuộc tính 3} |
|
|
778
|
+
|-----|---------------|----------------|----------------|----------------|
|
|
779
|
+
| BR1 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
780
|
+
| BR2 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
781
|
+
|
|
782
|
+
Hai cột ID + Business Rule LUÔN giữ (traceability phụ thuộc chúng). Chỉ cột
|
|
783
|
+
Business Logic được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên
|
|
784
|
+
§1d Quy ước, ĐỪNG lặp trong từng ô.
|
|
785
|
+
|
|
786
|
+
⚠️ CẢNH BÁO BR ID CHURN — đọc trước khi mở cột trên PRD ĐÃ TỒN TẠI:
|
|
787
|
+
Mở cột đúng nghĩa = một bản ghi một dòng ⇒ số BR TĂNG. Vì BR ID tăng liên tục
|
|
788
|
+
trên toàn PRD, chèn dòng ở giữa sẽ ĐÁNH SỐ LẠI mọi BR phía sau. Nếu PRD này đã có
|
|
789
|
+
BDD downstream, mọi tag `@trace.business_rules` trong .feature sẽ trỏ SAI trong im lặng.
|
|
790
|
+
→ Trước khi mở cột trên PRD đã có: kiểm tra `{specs_dir}/{domain}/{prd-slug}/bdd/`.
|
|
791
|
+
- Chưa có BDD → mở cột tự do.
|
|
792
|
+
- ĐÃ có BDD → DỪNG, báo người dùng: cần re-gen BDD sau khi đổi, hoặc giữ nguyên hình dạng cũ.
|
|
793
|
+
PRD sinh MỚI không bị ảnh hưởng (chưa có downstream).
|
|
794
|
+
-->
|
|
795
|
+
|
|
796
|
+
> **Note {BR ref}:** *(TUỲ CHỌN)* {giải thích **quyết định đã chốt** — vì sao luật này như vậy, ràng buộc
|
|
797
|
+
> nào dẫn tới nó, biên nào đã cân nhắc}. Đặt ngay sau bảng, cạnh nơi phát sinh.
|
|
798
|
+
>
|
|
799
|
+
> **Ranh giới với "Giả định AI" (Appendix):** Note = quyết định **đã chốt**, giải thích cho người đọc sau.
|
|
800
|
+
> Giả định AI = **độ vênh CẦN PO chốt**. Note **KHÔNG** được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI.
|
|
801
|
+
|
|
721
802
|
---
|
|
722
803
|
|
|
723
804
|
#### {TICKET}-{N}-UC2: {Tên use case}
|
|
@@ -738,6 +819,12 @@ flowchart TD
|
|
|
738
819
|
|
|
739
820
|
## b. Wireframe
|
|
740
821
|
|
|
822
|
+
> **KHÔNG nhân bản §3.** Wireframe liệt kê **màn + thành phần + hành động** — nó là nguồn coverage màn hình
|
|
823
|
+
> cho `/generate-bdd` (C.1), KHÔNG phải bản sao thứ hai của bảng Business Rule.
|
|
824
|
+
> Nếu một dòng Wireframe không thêm thông tin nào ngoài BR đã có → **tham chiếu BR ID, đừng chép nội dung**.
|
|
825
|
+
> Nếu cả §4b không thêm gì mới so với §3 → **xoá hẳn §4b** (hai nguồn sự thật cho cùng một dữ liệu sẽ lệch nhau
|
|
826
|
+
> ngay lần sửa đầu tiên).
|
|
827
|
+
|
|
741
828
|
### Screen 1: {Tên màn}
|
|
742
829
|
|
|
743
830
|
| Thành phần | Chi tiết |
|
|
@@ -828,7 +915,10 @@ _(Nếu không có độ vênh: ghi "Không có — toàn bộ nội dung đã
|
|
|
828
915
|
- [ ] **Altitude (AC vs BR/BL)**: AC chỉ nêu **outcome quan sát/kiểm được + ref BR** — KHÔNG chứa cơ chế (số lần retry, timeout, tên/chủ cờ, nhánh lỗi chi tiết); cơ chế nằm ở **BR/BL** (§3). AC không lặp lại nội dung BR nó ref. **Scope** = ranh giới (KHÔNG định nghĩa thuật ngữ / KHÔNG cơ chế)
|
|
829
916
|
- [ ] Mỗi UC có Actor / Description / Pre-condition / Post-condition
|
|
830
917
|
- [ ] §1c "Phụ thuộc liên service" có mặt: kế thừa từ discovery Phase 1 câu 8 (hoặc "Không có" nếu discovery trống); case partner song song có ghi phụ thuộc partner ở đây
|
|
831
|
-
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung bảng
|
|
918
|
+
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung **một bảng** — KHÔNG tách Business Logic ra khối riêng
|
|
919
|
+
- [ ] **Hình dạng bảng BR đúng với nội dung**: 3 cột khi Business Logic là văn xuôi; **mở cột** (1 bản ghi = 1 dòng) khi mọi BR trong UC chia sẻ cùng bộ thuộc tính lặp. Kiểm cụ thể: **0 ô Business Logic chứa nhiều hơn một bản ghi cùng cấu trúc** (dấu hiệu: `<br/>` ngăn cách các bản ghi ngang hàng thay vì các ý của cùng một luật) — xem "Hình dạng bảng Business Rule"
|
|
920
|
+
- [ ] **Nếu mở cột trên PRD đã tồn tại**: đã kiểm `bdd/` và xử lý BR ID churn (chưa có BDD → tự do; đã có BDD → đã hỏi người dùng, không tự ý đổi)
|
|
921
|
+
- [ ] **§1d Quy ước**: nếu có quy ước xuyên suốt → khai báo MỘT LẦN ở §1d, 0 lần lặp lại trong ô BR, AC trỏ tới thay vì chép; nếu không có → section đã xoá hẳn (không để rỗng)
|
|
832
922
|
- [ ] BR ID tăng liên tục trên toàn PRD — không reset theo từng UC
|
|
833
923
|
- [ ] **Traceability AC↔BR↔UC**: mỗi AC §2 có ≥1 ref `_(BR: …)_`; mỗi UC §3 có dòng "AC liên quan"; và hai chiều khớp nhau (tập "AC liên quan" của UC = tập AC có ref BR trỏ về UC đó)
|
|
834
924
|
- [ ] Mọi cross-reference TICKET-ID đều là inline link `[TICKET-ID](./file.md)`
|
|
@@ -838,6 +928,7 @@ _(Nếu không có độ vênh: ghi "Không có — toàn bộ nội dung đã
|
|
|
838
928
|
- [ ] **API Source nhất quán**: nếu `existing` → bảng "Existing API Contract" đủ method/path/request/response (hoặc mang block ⛔ PENDING kèm con trỏ nguồn); nếu greenfield/partner → section "Existing API Contract" đã bị xoá hẳn (không để bảng rỗng), và case partner có dependency + assumption ghi rõ
|
|
839
929
|
- [ ] User Flow có cả luồng lỗi / luồng ngoại lệ
|
|
840
930
|
- [ ] Wireframe phủ tất cả màn hình liên quan tới Use Case
|
|
931
|
+
- [ ] **Wireframe không nhân bản §3**: 0 dòng §4b lặp lại nội dung đã có ở bảng Business Rule — không thêm thông tin thì ref BR ID; cả §4b không thêm gì mới thì xoá hẳn (tránh hai nguồn sự thật)
|
|
841
932
|
- [ ] **Định dạng (readability)**: User Story / AC / các field của UC (Actor, Description, Pre/Post-condition) viết dạng bullet `- **Label:** …` — mỗi ý MỘT dòng, KHÔNG viết các dòng liền nhau (sẽ bị dồn thành 1 đoạn khi render); có một dòng trống trước và sau mỗi bảng
|
|
842
933
|
|
|
843
934
|
## Output
|
|
@@ -82,6 +82,34 @@ Không bao giờ để TICKET-ID dạng plain text nếu file PRD tương ứng
|
|
|
82
82
|
- **BR ID**: `{TICKET-ID}-UC{N}-BR{M}` — **M tăng liên tục trên toàn PRD** (KHÔNG reset theo từng UC).
|
|
83
83
|
- Ví dụ: UC1 → BR1, BR2; UC2 → BR3, BR4 (KHÔNG phải BR1, BR2 lại từ đầu).
|
|
84
84
|
|
|
85
|
+
## Hình dạng bảng Business Rule *(3 cột mặc định — mở cột khi nội dung là bản ghi lặp)*
|
|
86
|
+
|
|
87
|
+
Bảng 3 cột `ID | Business Rule | Business Logic` là **mặc định**, KHÔNG phải luật cứng. Nó hoạt động tốt khi Business Logic là **văn xuôi** (mô tả luật bằng câu). Nó **gãy** khi Business Logic là một **bản ghi có cấu trúc lặp** — lúc đó ép vào một ô buộc phải serialize bản ghi thành chuỗi, và bảng mất khả năng đọc lướt / đếm / diff.
|
|
88
|
+
|
|
89
|
+
**Điều kiện kích hoạt mở cột** — cả hai phải đúng:
|
|
90
|
+
1. **Mọi** BR trong một UC chia sẻ **cùng một bộ thuộc tính** lặp lại (vd `trigger` / `data` / `tần suất` / `nguồn`); VÀ
|
|
91
|
+
2. Bộ thuộc tính đó là **cấu trúc đều**, không phải văn xuôi tự do.
|
|
92
|
+
|
|
93
|
+
**Dấu hiệu tự phát hiện (dùng khi tự kiểm trước khi ghi):** đang phải dùng `<br/>` để nhồi **nhiều hơn một bản ghi cùng cấu trúc** vào một ô Business Logic. Một `<br/>` ngăn cách các ý của **cùng một** luật thì bình thường — nhiều `<br/>` ngăn cách các **bản ghi ngang hàng** là tín hiệu sai hình dạng.
|
|
94
|
+
|
|
95
|
+
**Khi kích hoạt:** promote thuộc tính thành **cột**, một bản ghi = một **dòng**. Giữ nguyên hai cột `ID` + `Business Rule` (traceability phụ thuộc chúng); chỉ cột `Business Logic` được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên **§1d Quy ước**, đừng lặp trong từng ô.
|
|
96
|
+
|
|
97
|
+
**Khi KHÔNG kích hoạt:** giữ nguyên 3 cột. Phần lớn PRD tính năng rơi vào đây — BR của chúng là văn xuôi ("coi Landing là không sẵn sàng khi dịch vụ gặp sự cố; quá 3 giây chưa trả nội dung; hoặc trả nội dung rỗng"), không có bộ thuộc tính nào lặp. **Luật này tự kích hoạt theo hình dạng nội dung — không phải một cờ người dùng phải nhớ bật.**
|
|
98
|
+
|
|
99
|
+
> **⚠️ Guard — BR ID churn (BẮT BUỘC kiểm khi mở cột trên PRD ĐÃ TỒN TẠI):**
|
|
100
|
+
> Mở cột đúng nghĩa = một bản ghi một dòng ⇒ **số BR tăng**. Vì BR ID tăng liên tục trên toàn PRD (xem "Quy ước đánh số"), chèn dòng ở giữa sẽ **đánh số lại mọi BR phía sau**. BDD mang tag `@trace.business_rules: {TICKET}-UC1-BR1, …` — nếu PRD đã có BDD, mọi tag sau điểm chèn sẽ trỏ **sai trong im lặng**.
|
|
101
|
+
> Trước khi mở cột trên một PRD đã tồn tại → kiểm tra `{paths.specs_dir}/{domain}/{prd-slug}/bdd/`:
|
|
102
|
+
> - **Chưa có BDD** → mở cột tự do, không cần hỏi.
|
|
103
|
+
> - **Đã có BDD** → **DỪNG**, báo người dùng: *"Mở cột sẽ đánh số lại {N} BR; {M} file BDD đang ref BR ID cũ. Chọn: (1) mở cột + re-gen BDD, (2) giữ hình dạng cũ."* Chờ chọn.
|
|
104
|
+
>
|
|
105
|
+
> PRD sinh **mới** không bị ảnh hưởng — chưa có downstream nào ref BR ID.
|
|
106
|
+
|
|
107
|
+
## Quy ước tài liệu (§1d) & Note block *(hai slot tuỳ chọn)*
|
|
108
|
+
|
|
109
|
+
- **§1d Quy ước** — khi tài liệu có quy ước áp dụng **xuyên suốt mọi BR** (giá trị mặc định dùng chung, cách đọc cột, định nghĩa cục bộ), khai báo **một lần** ở đây. BR **không** lặp lại; AC **trỏ tới** thay vì chép lại. Không có quy ước xuyên suốt → **xoá hẳn section** (như `Existing API Contract` khi greenfield). Phân biệt: §1b Phạm vi = ranh giới; business-dictionary = thuật ngữ cấp domain; §1d = quy ước **cục bộ của tài liệu này**.
|
|
110
|
+
- **Note block sau bảng BR** — cho phép `> **Note {BR ref}:** …` ngay sau bảng để giải thích **quyết định đã chốt** (vì sao luật như vậy, ràng buộc nào dẫn tới). Đặt cạnh nơi phát sinh, đừng dồn xuống cuối file.
|
|
111
|
+
**Ranh giới với "Giả định AI":** Note = quyết định **đã chốt**; Giả định AI = **độ vênh cần PO chốt**. Note KHÔNG được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI, vì đó là thứ PO phải đọc.
|
|
112
|
+
|
|
85
113
|
## Traceability AC ↔ BR ↔ UC
|
|
86
114
|
|
|
87
115
|
- **Giữ link AC→BR từ discovery (KHÔNG vứt khi flatten):** Product Definition Phase 6 có cột "Bắt nguồn từ BR-{N}". Khi viết AC §2, **remap** mỗi `BR-{N}` (số discovery) sang **BR ID của PRD** (`{TICKET-ID}-UC{n}-BR{m}` sau khi đã phân BR vào UC) và gắn vào cuối AC: `_(BR: {ids})_`. Mỗi AC PHẢI có ≥1 ref BR.
|
|
@@ -133,7 +161,10 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
133
161
|
- [ ] **Altitude (AC vs BR/BL)**: AC chỉ nêu **outcome quan sát/kiểm được + ref BR** — KHÔNG chứa cơ chế (số lần retry, timeout, tên/chủ cờ, nhánh lỗi chi tiết); cơ chế nằm ở **BR/BL** (§3). AC không lặp lại nội dung BR nó ref. **Scope** = ranh giới (KHÔNG định nghĩa thuật ngữ / KHÔNG cơ chế)
|
|
134
162
|
- [ ] Mỗi UC có Actor / Description / Pre-condition / Post-condition
|
|
135
163
|
- [ ] §1c "Phụ thuộc liên service" có mặt: kế thừa từ discovery Phase 1 câu 8 (hoặc "Không có" nếu discovery trống); case partner song song có ghi phụ thuộc partner ở đây
|
|
136
|
-
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung bảng
|
|
164
|
+
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung **một bảng** — KHÔNG tách Business Logic ra khối riêng
|
|
165
|
+
- [ ] **Hình dạng bảng BR đúng với nội dung**: 3 cột khi Business Logic là văn xuôi; **mở cột** (1 bản ghi = 1 dòng) khi mọi BR trong UC chia sẻ cùng bộ thuộc tính lặp. Kiểm cụ thể: **0 ô Business Logic chứa nhiều hơn một bản ghi cùng cấu trúc** (dấu hiệu: `<br/>` ngăn cách các bản ghi ngang hàng thay vì các ý của cùng một luật) — xem "Hình dạng bảng Business Rule"
|
|
166
|
+
- [ ] **Nếu mở cột trên PRD đã tồn tại**: đã kiểm `bdd/` và xử lý BR ID churn (chưa có BDD → tự do; đã có BDD → đã hỏi người dùng, không tự ý đổi)
|
|
167
|
+
- [ ] **§1d Quy ước**: nếu có quy ước xuyên suốt → khai báo MỘT LẦN ở §1d, 0 lần lặp lại trong ô BR, AC trỏ tới thay vì chép; nếu không có → section đã xoá hẳn (không để rỗng)
|
|
137
168
|
- [ ] BR ID tăng liên tục trên toàn PRD — không reset theo từng UC
|
|
138
169
|
- [ ] **Traceability AC↔BR↔UC**: mỗi AC §2 có ≥1 ref `_(BR: …)_`; mỗi UC §3 có dòng "AC liên quan"; và hai chiều khớp nhau (tập "AC liên quan" của UC = tập AC có ref BR trỏ về UC đó)
|
|
139
170
|
- [ ] Mọi cross-reference TICKET-ID đều là inline link `[TICKET-ID](./file.md)`
|
|
@@ -143,6 +174,7 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
143
174
|
- [ ] **API Source nhất quán**: nếu `existing` → bảng "Existing API Contract" đủ method/path/request/response (hoặc mang block ⛔ PENDING kèm con trỏ nguồn); nếu greenfield/partner → section "Existing API Contract" đã bị xoá hẳn (không để bảng rỗng), và case partner có dependency + assumption ghi rõ
|
|
144
175
|
- [ ] User Flow có cả luồng lỗi / luồng ngoại lệ
|
|
145
176
|
- [ ] Wireframe phủ tất cả màn hình liên quan tới Use Case
|
|
177
|
+
- [ ] **Wireframe không nhân bản §3**: 0 dòng §4b lặp lại nội dung đã có ở bảng Business Rule — không thêm thông tin thì ref BR ID; cả §4b không thêm gì mới thì xoá hẳn (tránh hai nguồn sự thật)
|
|
146
178
|
- [ ] **Định dạng (readability)**: User Story / AC / các field của UC (Actor, Description, Pre/Post-condition) viết dạng bullet `- **Label:** …` — mỗi ý MỘT dòng, KHÔNG viết các dòng liền nhau (sẽ bị dồn thành 1 đoạn khi render); có một dòng trống trước và sau mỗi bảng
|
|
147
179
|
|
|
148
180
|
## Output
|
package/core/FRAMEWORK_VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.
|
|
1
|
+
0.3.0
|
|
@@ -553,6 +553,34 @@ Không bao giờ để TICKET-ID dạng plain text nếu file PRD tương ứng
|
|
|
553
553
|
- **BR ID**: `{TICKET-ID}-UC{N}-BR{M}` — **M tăng liên tục trên toàn PRD** (KHÔNG reset theo từng UC).
|
|
554
554
|
- Ví dụ: UC1 → BR1, BR2; UC2 → BR3, BR4 (KHÔNG phải BR1, BR2 lại từ đầu).
|
|
555
555
|
|
|
556
|
+
## Hình dạng bảng Business Rule *(3 cột mặc định — mở cột khi nội dung là bản ghi lặp)*
|
|
557
|
+
|
|
558
|
+
Bảng 3 cột `ID | Business Rule | Business Logic` là **mặc định**, KHÔNG phải luật cứng. Nó hoạt động tốt khi Business Logic là **văn xuôi** (mô tả luật bằng câu). Nó **gãy** khi Business Logic là một **bản ghi có cấu trúc lặp** — lúc đó ép vào một ô buộc phải serialize bản ghi thành chuỗi, và bảng mất khả năng đọc lướt / đếm / diff.
|
|
559
|
+
|
|
560
|
+
**Điều kiện kích hoạt mở cột** — cả hai phải đúng:
|
|
561
|
+
1. **Mọi** BR trong một UC chia sẻ **cùng một bộ thuộc tính** lặp lại (vd `trigger` / `data` / `tần suất` / `nguồn`); VÀ
|
|
562
|
+
2. Bộ thuộc tính đó là **cấu trúc đều**, không phải văn xuôi tự do.
|
|
563
|
+
|
|
564
|
+
**Dấu hiệu tự phát hiện (dùng khi tự kiểm trước khi ghi):** đang phải dùng `<br/>` để nhồi **nhiều hơn một bản ghi cùng cấu trúc** vào một ô Business Logic. Một `<br/>` ngăn cách các ý của **cùng một** luật thì bình thường — nhiều `<br/>` ngăn cách các **bản ghi ngang hàng** là tín hiệu sai hình dạng.
|
|
565
|
+
|
|
566
|
+
**Khi kích hoạt:** promote thuộc tính thành **cột**, một bản ghi = một **dòng**. Giữ nguyên hai cột `ID` + `Business Rule` (traceability phụ thuộc chúng); chỉ cột `Business Logic` được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên **§1d Quy ước**, đừng lặp trong từng ô.
|
|
567
|
+
|
|
568
|
+
**Khi KHÔNG kích hoạt:** giữ nguyên 3 cột. Phần lớn PRD tính năng rơi vào đây — BR của chúng là văn xuôi ("coi Landing là không sẵn sàng khi dịch vụ gặp sự cố; quá 3 giây chưa trả nội dung; hoặc trả nội dung rỗng"), không có bộ thuộc tính nào lặp. **Luật này tự kích hoạt theo hình dạng nội dung — không phải một cờ người dùng phải nhớ bật.**
|
|
569
|
+
|
|
570
|
+
> **⚠️ Guard — BR ID churn (BẮT BUỘC kiểm khi mở cột trên PRD ĐÃ TỒN TẠI):**
|
|
571
|
+
> Mở cột đúng nghĩa = một bản ghi một dòng ⇒ **số BR tăng**. Vì BR ID tăng liên tục trên toàn PRD (xem "Quy ước đánh số"), chèn dòng ở giữa sẽ **đánh số lại mọi BR phía sau**. BDD mang tag `@trace.business_rules: {TICKET}-UC1-BR1, …` — nếu PRD đã có BDD, mọi tag sau điểm chèn sẽ trỏ **sai trong im lặng**.
|
|
572
|
+
> Trước khi mở cột trên một PRD đã tồn tại → kiểm tra `{paths.specs_dir}/{domain}/{prd-slug}/bdd/`:
|
|
573
|
+
> - **Chưa có BDD** → mở cột tự do, không cần hỏi.
|
|
574
|
+
> - **Đã có BDD** → **DỪNG**, báo người dùng: *"Mở cột sẽ đánh số lại {N} BR; {M} file BDD đang ref BR ID cũ. Chọn: (1) mở cột + re-gen BDD, (2) giữ hình dạng cũ."* Chờ chọn.
|
|
575
|
+
>
|
|
576
|
+
> PRD sinh **mới** không bị ảnh hưởng — chưa có downstream nào ref BR ID.
|
|
577
|
+
|
|
578
|
+
## Quy ước tài liệu (§1d) & Note block *(hai slot tuỳ chọn)*
|
|
579
|
+
|
|
580
|
+
- **§1d Quy ước** — khi tài liệu có quy ước áp dụng **xuyên suốt mọi BR** (giá trị mặc định dùng chung, cách đọc cột, định nghĩa cục bộ), khai báo **một lần** ở đây. BR **không** lặp lại; AC **trỏ tới** thay vì chép lại. Không có quy ước xuyên suốt → **xoá hẳn section** (như `Existing API Contract` khi greenfield). Phân biệt: §1b Phạm vi = ranh giới; business-dictionary = thuật ngữ cấp domain; §1d = quy ước **cục bộ của tài liệu này**.
|
|
581
|
+
- **Note block sau bảng BR** — cho phép `> **Note {BR ref}:** …` ngay sau bảng để giải thích **quyết định đã chốt** (vì sao luật như vậy, ràng buộc nào dẫn tới). Đặt cạnh nơi phát sinh, đừng dồn xuống cuối file.
|
|
582
|
+
**Ranh giới với "Giả định AI":** Note = quyết định **đã chốt**; Giả định AI = **độ vênh cần PO chốt**. Note KHÔNG được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI, vì đó là thứ PO phải đọc.
|
|
583
|
+
|
|
556
584
|
## Traceability AC ↔ BR ↔ UC
|
|
557
585
|
|
|
558
586
|
- **Giữ link AC→BR từ discovery (KHÔNG vứt khi flatten):** Product Definition Phase 6 có cột "Bắt nguồn từ BR-{N}". Khi viết AC §2, **remap** mỗi `BR-{N}` (số discovery) sang **BR ID của PRD** (`{TICKET-ID}-UC{n}-BR{m}` sau khi đã phân BR vào UC) và gắn vào cuối AC: `_(BR: {ids})_`. Mỗi AC PHẢI có ≥1 ref BR.
|
|
@@ -600,8 +628,13 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
600
628
|
AI Agent sẽ điền các section dựa trên input từ PO.
|
|
601
629
|
Các placeholder {…} cần được thay thế bằng nội dung thực tế.
|
|
602
630
|
|
|
603
|
-
FORMAT
|
|
604
|
-
|
|
631
|
+
FORMAT BR: MẶC ĐỊNH bảng 3 cột — ID | Business Rule | Business Logic
|
|
632
|
+
(KHÔNG tách Business Logic ra khối riêng).
|
|
633
|
+
NGOẠI LỆ — MỞ CỘT: nếu MỌI BR trong một UC chia sẻ cùng một bộ thuộc tính lặp lại
|
|
634
|
+
(vd trigger / data / tần suất), promote các thuộc tính đó thành CỘT RIÊNG —
|
|
635
|
+
một bản ghi = một DÒNG. Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi
|
|
636
|
+
NHIỀU HƠN MỘT bản ghi cùng cấu trúc vào một ô. Chi tiết + cảnh báo BR ID churn:
|
|
637
|
+
xem §3 "Business Rule" của template và mục "Hình dạng bảng Business Rule" của lệnh.
|
|
605
638
|
|
|
606
639
|
TERMINOLOGY:
|
|
607
640
|
- Tuân thủ 100% từ điển project: specs/domain-knowledge/business-dictionary.md
|
|
@@ -679,6 +712,18 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
679
712
|
|
|
680
713
|
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
681
714
|
|
|
715
|
+
## d. Quy ước *(TUỲ CHỌN — chỉ thêm khi tài liệu có quy ước áp dụng xuyên suốt; nếu không có → XOÁ HẲN section này)*
|
|
716
|
+
|
|
717
|
+
> Khai báo **MỘT LẦN** các quy ước áp dụng cho **mọi BR** ở §3. BR **KHÔNG** lặp lại nội dung đã khai ở đây,
|
|
718
|
+
> AC §2 **trỏ tới** quy ước thay vì chép lại. Đây là nơi chứa định nghĩa dùng chung, giá trị mặc định,
|
|
719
|
+
> và cách đọc các cột của bảng BR — những thứ trước đây bị xé nhỏ và lặp trong từng dòng.
|
|
720
|
+
>
|
|
721
|
+
> Phân biệt với **§1b Phạm vi** (ranh giới làm/không làm) và **business-dictionary** (định nghĩa thuật ngữ
|
|
722
|
+
> cấp domain, dùng chung nhiều PRD): §1d chỉ chứa quy ước **cục bộ của tài liệu này**.
|
|
723
|
+
|
|
724
|
+
- **{Tên quy ước}**: {nội dung áp dụng cho mọi BR bên dưới}
|
|
725
|
+
- **{Giá trị mặc định dùng chung}**: {…}
|
|
726
|
+
|
|
682
727
|
---
|
|
683
728
|
|
|
684
729
|
# 2. Acceptance Criteria
|
|
@@ -713,11 +758,47 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
713
758
|
|
|
714
759
|
**Business Rule**
|
|
715
760
|
|
|
761
|
+
> **Hình dạng bảng — mặc định 3 cột.** Dùng dạng này khi Business Logic là **văn xuôi** (mô tả luật bằng câu).
|
|
762
|
+
|
|
716
763
|
| ID | Business Rule | Business Logic |
|
|
717
764
|
|----|---------------|----------------|
|
|
718
765
|
| {TICKET}-{N}-UC1-BR1 | {luật ngắn gọn} | - {logic chi tiết, xuống dòng bằng `<br/>`}<br/>- {…} |
|
|
719
766
|
| {TICKET}-{N}-UC1-BR2 | {…} | - {…} |
|
|
720
767
|
|
|
768
|
+
<!--
|
|
769
|
+
NGOẠI LỆ — MỞ CỘT (dùng THAY cho bảng 3 cột ở trên, KHÔNG dùng cả hai):
|
|
770
|
+
|
|
771
|
+
Điều kiện kích hoạt: MỌI BR trong UC này chia sẻ CÙNG một bộ thuộc tính lặp lại.
|
|
772
|
+
Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi NHIỀU HƠN MỘT bản ghi cùng
|
|
773
|
+
cấu trúc vào một ô Business Logic.
|
|
774
|
+
|
|
775
|
+
Khi kích hoạt: promote thuộc tính thành CỘT, một bản ghi = một DÒNG:
|
|
776
|
+
|
|
777
|
+
| ID | Business Rule | {Thuộc tính 1} | {Thuộc tính 2} | {Thuộc tính 3} |
|
|
778
|
+
|-----|---------------|----------------|----------------|----------------|
|
|
779
|
+
| BR1 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
780
|
+
| BR2 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
781
|
+
|
|
782
|
+
Hai cột ID + Business Rule LUÔN giữ (traceability phụ thuộc chúng). Chỉ cột
|
|
783
|
+
Business Logic được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên
|
|
784
|
+
§1d Quy ước, ĐỪNG lặp trong từng ô.
|
|
785
|
+
|
|
786
|
+
⚠️ CẢNH BÁO BR ID CHURN — đọc trước khi mở cột trên PRD ĐÃ TỒN TẠI:
|
|
787
|
+
Mở cột đúng nghĩa = một bản ghi một dòng ⇒ số BR TĂNG. Vì BR ID tăng liên tục
|
|
788
|
+
trên toàn PRD, chèn dòng ở giữa sẽ ĐÁNH SỐ LẠI mọi BR phía sau. Nếu PRD này đã có
|
|
789
|
+
BDD downstream, mọi tag `@trace.business_rules` trong .feature sẽ trỏ SAI trong im lặng.
|
|
790
|
+
→ Trước khi mở cột trên PRD đã có: kiểm tra `{specs_dir}/{domain}/{prd-slug}/bdd/`.
|
|
791
|
+
- Chưa có BDD → mở cột tự do.
|
|
792
|
+
- ĐÃ có BDD → DỪNG, báo người dùng: cần re-gen BDD sau khi đổi, hoặc giữ nguyên hình dạng cũ.
|
|
793
|
+
PRD sinh MỚI không bị ảnh hưởng (chưa có downstream).
|
|
794
|
+
-->
|
|
795
|
+
|
|
796
|
+
> **Note {BR ref}:** *(TUỲ CHỌN)* {giải thích **quyết định đã chốt** — vì sao luật này như vậy, ràng buộc
|
|
797
|
+
> nào dẫn tới nó, biên nào đã cân nhắc}. Đặt ngay sau bảng, cạnh nơi phát sinh.
|
|
798
|
+
>
|
|
799
|
+
> **Ranh giới với "Giả định AI" (Appendix):** Note = quyết định **đã chốt**, giải thích cho người đọc sau.
|
|
800
|
+
> Giả định AI = **độ vênh CẦN PO chốt**. Note **KHÔNG** được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI.
|
|
801
|
+
|
|
721
802
|
---
|
|
722
803
|
|
|
723
804
|
#### {TICKET}-{N}-UC2: {Tên use case}
|
|
@@ -738,6 +819,12 @@ flowchart TD
|
|
|
738
819
|
|
|
739
820
|
## b. Wireframe
|
|
740
821
|
|
|
822
|
+
> **KHÔNG nhân bản §3.** Wireframe liệt kê **màn + thành phần + hành động** — nó là nguồn coverage màn hình
|
|
823
|
+
> cho `/generate-bdd` (C.1), KHÔNG phải bản sao thứ hai của bảng Business Rule.
|
|
824
|
+
> Nếu một dòng Wireframe không thêm thông tin nào ngoài BR đã có → **tham chiếu BR ID, đừng chép nội dung**.
|
|
825
|
+
> Nếu cả §4b không thêm gì mới so với §3 → **xoá hẳn §4b** (hai nguồn sự thật cho cùng một dữ liệu sẽ lệch nhau
|
|
826
|
+
> ngay lần sửa đầu tiên).
|
|
827
|
+
|
|
741
828
|
### Screen 1: {Tên màn}
|
|
742
829
|
|
|
743
830
|
| Thành phần | Chi tiết |
|
|
@@ -828,7 +915,10 @@ _(Nếu không có độ vênh: ghi "Không có — toàn bộ nội dung đã
|
|
|
828
915
|
- [ ] **Altitude (AC vs BR/BL)**: AC chỉ nêu **outcome quan sát/kiểm được + ref BR** — KHÔNG chứa cơ chế (số lần retry, timeout, tên/chủ cờ, nhánh lỗi chi tiết); cơ chế nằm ở **BR/BL** (§3). AC không lặp lại nội dung BR nó ref. **Scope** = ranh giới (KHÔNG định nghĩa thuật ngữ / KHÔNG cơ chế)
|
|
829
916
|
- [ ] Mỗi UC có Actor / Description / Pre-condition / Post-condition
|
|
830
917
|
- [ ] §1c "Phụ thuộc liên service" có mặt: kế thừa từ discovery Phase 1 câu 8 (hoặc "Không có" nếu discovery trống); case partner song song có ghi phụ thuộc partner ở đây
|
|
831
|
-
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung bảng
|
|
918
|
+
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung **một bảng** — KHÔNG tách Business Logic ra khối riêng
|
|
919
|
+
- [ ] **Hình dạng bảng BR đúng với nội dung**: 3 cột khi Business Logic là văn xuôi; **mở cột** (1 bản ghi = 1 dòng) khi mọi BR trong UC chia sẻ cùng bộ thuộc tính lặp. Kiểm cụ thể: **0 ô Business Logic chứa nhiều hơn một bản ghi cùng cấu trúc** (dấu hiệu: `<br/>` ngăn cách các bản ghi ngang hàng thay vì các ý của cùng một luật) — xem "Hình dạng bảng Business Rule"
|
|
920
|
+
- [ ] **Nếu mở cột trên PRD đã tồn tại**: đã kiểm `bdd/` và xử lý BR ID churn (chưa có BDD → tự do; đã có BDD → đã hỏi người dùng, không tự ý đổi)
|
|
921
|
+
- [ ] **§1d Quy ước**: nếu có quy ước xuyên suốt → khai báo MỘT LẦN ở §1d, 0 lần lặp lại trong ô BR, AC trỏ tới thay vì chép; nếu không có → section đã xoá hẳn (không để rỗng)
|
|
832
922
|
- [ ] BR ID tăng liên tục trên toàn PRD — không reset theo từng UC
|
|
833
923
|
- [ ] **Traceability AC↔BR↔UC**: mỗi AC §2 có ≥1 ref `_(BR: …)_`; mỗi UC §3 có dòng "AC liên quan"; và hai chiều khớp nhau (tập "AC liên quan" của UC = tập AC có ref BR trỏ về UC đó)
|
|
834
924
|
- [ ] Mọi cross-reference TICKET-ID đều là inline link `[TICKET-ID](./file.md)`
|
|
@@ -838,6 +928,7 @@ _(Nếu không có độ vênh: ghi "Không có — toàn bộ nội dung đã
|
|
|
838
928
|
- [ ] **API Source nhất quán**: nếu `existing` → bảng "Existing API Contract" đủ method/path/request/response (hoặc mang block ⛔ PENDING kèm con trỏ nguồn); nếu greenfield/partner → section "Existing API Contract" đã bị xoá hẳn (không để bảng rỗng), và case partner có dependency + assumption ghi rõ
|
|
839
929
|
- [ ] User Flow có cả luồng lỗi / luồng ngoại lệ
|
|
840
930
|
- [ ] Wireframe phủ tất cả màn hình liên quan tới Use Case
|
|
931
|
+
- [ ] **Wireframe không nhân bản §3**: 0 dòng §4b lặp lại nội dung đã có ở bảng Business Rule — không thêm thông tin thì ref BR ID; cả §4b không thêm gì mới thì xoá hẳn (tránh hai nguồn sự thật)
|
|
841
932
|
- [ ] **Định dạng (readability)**: User Story / AC / các field của UC (Actor, Description, Pre/Post-condition) viết dạng bullet `- **Label:** …` — mỗi ý MỘT dòng, KHÔNG viết các dòng liền nhau (sẽ bị dồn thành 1 đoạn khi render); có một dòng trống trước và sau mỗi bảng
|
|
842
933
|
|
|
843
934
|
## Output
|
|
@@ -5,8 +5,13 @@
|
|
|
5
5
|
AI Agent sẽ điền các section dựa trên input từ PO.
|
|
6
6
|
Các placeholder {…} cần được thay thế bằng nội dung thực tế.
|
|
7
7
|
|
|
8
|
-
FORMAT
|
|
9
|
-
|
|
8
|
+
FORMAT BR: MẶC ĐỊNH bảng 3 cột — ID | Business Rule | Business Logic
|
|
9
|
+
(KHÔNG tách Business Logic ra khối riêng).
|
|
10
|
+
NGOẠI LỆ — MỞ CỘT: nếu MỌI BR trong một UC chia sẻ cùng một bộ thuộc tính lặp lại
|
|
11
|
+
(vd trigger / data / tần suất), promote các thuộc tính đó thành CỘT RIÊNG —
|
|
12
|
+
một bản ghi = một DÒNG. Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi
|
|
13
|
+
NHIỀU HƠN MỘT bản ghi cùng cấu trúc vào một ô. Chi tiết + cảnh báo BR ID churn:
|
|
14
|
+
xem §3 "Business Rule" của template và mục "Hình dạng bảng Business Rule" của lệnh.
|
|
10
15
|
|
|
11
16
|
TERMINOLOGY:
|
|
12
17
|
- Tuân thủ 100% từ điển project: specs/domain-knowledge/business-dictionary.md
|
|
@@ -84,6 +89,18 @@
|
|
|
84
89
|
|
|
85
90
|
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
86
91
|
|
|
92
|
+
## d. Quy ước *(TUỲ CHỌN — chỉ thêm khi tài liệu có quy ước áp dụng xuyên suốt; nếu không có → XOÁ HẲN section này)*
|
|
93
|
+
|
|
94
|
+
> Khai báo **MỘT LẦN** các quy ước áp dụng cho **mọi BR** ở §3. BR **KHÔNG** lặp lại nội dung đã khai ở đây,
|
|
95
|
+
> AC §2 **trỏ tới** quy ước thay vì chép lại. Đây là nơi chứa định nghĩa dùng chung, giá trị mặc định,
|
|
96
|
+
> và cách đọc các cột của bảng BR — những thứ trước đây bị xé nhỏ và lặp trong từng dòng.
|
|
97
|
+
>
|
|
98
|
+
> Phân biệt với **§1b Phạm vi** (ranh giới làm/không làm) và **business-dictionary** (định nghĩa thuật ngữ
|
|
99
|
+
> cấp domain, dùng chung nhiều PRD): §1d chỉ chứa quy ước **cục bộ của tài liệu này**.
|
|
100
|
+
|
|
101
|
+
- **{Tên quy ước}**: {nội dung áp dụng cho mọi BR bên dưới}
|
|
102
|
+
- **{Giá trị mặc định dùng chung}**: {…}
|
|
103
|
+
|
|
87
104
|
---
|
|
88
105
|
|
|
89
106
|
# 2. Acceptance Criteria
|
|
@@ -118,11 +135,47 @@
|
|
|
118
135
|
|
|
119
136
|
**Business Rule**
|
|
120
137
|
|
|
138
|
+
> **Hình dạng bảng — mặc định 3 cột.** Dùng dạng này khi Business Logic là **văn xuôi** (mô tả luật bằng câu).
|
|
139
|
+
|
|
121
140
|
| ID | Business Rule | Business Logic |
|
|
122
141
|
|----|---------------|----------------|
|
|
123
142
|
| {TICKET}-{N}-UC1-BR1 | {luật ngắn gọn} | - {logic chi tiết, xuống dòng bằng `<br/>`}<br/>- {…} |
|
|
124
143
|
| {TICKET}-{N}-UC1-BR2 | {…} | - {…} |
|
|
125
144
|
|
|
145
|
+
<!--
|
|
146
|
+
NGOẠI LỆ — MỞ CỘT (dùng THAY cho bảng 3 cột ở trên, KHÔNG dùng cả hai):
|
|
147
|
+
|
|
148
|
+
Điều kiện kích hoạt: MỌI BR trong UC này chia sẻ CÙNG một bộ thuộc tính lặp lại.
|
|
149
|
+
Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi NHIỀU HƠN MỘT bản ghi cùng
|
|
150
|
+
cấu trúc vào một ô Business Logic.
|
|
151
|
+
|
|
152
|
+
Khi kích hoạt: promote thuộc tính thành CỘT, một bản ghi = một DÒNG:
|
|
153
|
+
|
|
154
|
+
| ID | Business Rule | {Thuộc tính 1} | {Thuộc tính 2} | {Thuộc tính 3} |
|
|
155
|
+
|-----|---------------|----------------|----------------|----------------|
|
|
156
|
+
| BR1 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
157
|
+
| BR2 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
158
|
+
|
|
159
|
+
Hai cột ID + Business Rule LUÔN giữ (traceability phụ thuộc chúng). Chỉ cột
|
|
160
|
+
Business Logic được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên
|
|
161
|
+
§1d Quy ước, ĐỪNG lặp trong từng ô.
|
|
162
|
+
|
|
163
|
+
⚠️ CẢNH BÁO BR ID CHURN — đọc trước khi mở cột trên PRD ĐÃ TỒN TẠI:
|
|
164
|
+
Mở cột đúng nghĩa = một bản ghi một dòng ⇒ số BR TĂNG. Vì BR ID tăng liên tục
|
|
165
|
+
trên toàn PRD, chèn dòng ở giữa sẽ ĐÁNH SỐ LẠI mọi BR phía sau. Nếu PRD này đã có
|
|
166
|
+
BDD downstream, mọi tag `@trace.business_rules` trong .feature sẽ trỏ SAI trong im lặng.
|
|
167
|
+
→ Trước khi mở cột trên PRD đã có: kiểm tra `{specs_dir}/{domain}/{prd-slug}/bdd/`.
|
|
168
|
+
- Chưa có BDD → mở cột tự do.
|
|
169
|
+
- ĐÃ có BDD → DỪNG, báo người dùng: cần re-gen BDD sau khi đổi, hoặc giữ nguyên hình dạng cũ.
|
|
170
|
+
PRD sinh MỚI không bị ảnh hưởng (chưa có downstream).
|
|
171
|
+
-->
|
|
172
|
+
|
|
173
|
+
> **Note {BR ref}:** *(TUỲ CHỌN)* {giải thích **quyết định đã chốt** — vì sao luật này như vậy, ràng buộc
|
|
174
|
+
> nào dẫn tới nó, biên nào đã cân nhắc}. Đặt ngay sau bảng, cạnh nơi phát sinh.
|
|
175
|
+
>
|
|
176
|
+
> **Ranh giới với "Giả định AI" (Appendix):** Note = quyết định **đã chốt**, giải thích cho người đọc sau.
|
|
177
|
+
> Giả định AI = **độ vênh CẦN PO chốt**. Note **KHÔNG** được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI.
|
|
178
|
+
|
|
126
179
|
---
|
|
127
180
|
|
|
128
181
|
#### {TICKET}-{N}-UC2: {Tên use case}
|
|
@@ -143,6 +196,12 @@ flowchart TD
|
|
|
143
196
|
|
|
144
197
|
## b. Wireframe
|
|
145
198
|
|
|
199
|
+
> **KHÔNG nhân bản §3.** Wireframe liệt kê **màn + thành phần + hành động** — nó là nguồn coverage màn hình
|
|
200
|
+
> cho `/generate-bdd` (C.1), KHÔNG phải bản sao thứ hai của bảng Business Rule.
|
|
201
|
+
> Nếu một dòng Wireframe không thêm thông tin nào ngoài BR đã có → **tham chiếu BR ID, đừng chép nội dung**.
|
|
202
|
+
> Nếu cả §4b không thêm gì mới so với §3 → **xoá hẳn §4b** (hai nguồn sự thật cho cùng một dữ liệu sẽ lệch nhau
|
|
203
|
+
> ngay lần sửa đầu tiên).
|
|
204
|
+
|
|
146
205
|
### Screen 1: {Tên màn}
|
|
147
206
|
|
|
148
207
|
| Thành phần | Chi tiết |
|
package/package.json
CHANGED
|
@@ -5,8 +5,13 @@
|
|
|
5
5
|
AI Agent sẽ điền các section dựa trên input từ PO.
|
|
6
6
|
Các placeholder {…} cần được thay thế bằng nội dung thực tế.
|
|
7
7
|
|
|
8
|
-
FORMAT
|
|
9
|
-
|
|
8
|
+
FORMAT BR: MẶC ĐỊNH bảng 3 cột — ID | Business Rule | Business Logic
|
|
9
|
+
(KHÔNG tách Business Logic ra khối riêng).
|
|
10
|
+
NGOẠI LỆ — MỞ CỘT: nếu MỌI BR trong một UC chia sẻ cùng một bộ thuộc tính lặp lại
|
|
11
|
+
(vd trigger / data / tần suất), promote các thuộc tính đó thành CỘT RIÊNG —
|
|
12
|
+
một bản ghi = một DÒNG. Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi
|
|
13
|
+
NHIỀU HƠN MỘT bản ghi cùng cấu trúc vào một ô. Chi tiết + cảnh báo BR ID churn:
|
|
14
|
+
xem §3 "Business Rule" của template và mục "Hình dạng bảng Business Rule" của lệnh.
|
|
10
15
|
|
|
11
16
|
TERMINOLOGY:
|
|
12
17
|
- Tuân thủ 100% từ điển project: specs/domain-knowledge/business-dictionary.md
|
|
@@ -84,6 +89,18 @@
|
|
|
84
89
|
|
|
85
90
|
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
86
91
|
|
|
92
|
+
## d. Quy ước *(TUỲ CHỌN — chỉ thêm khi tài liệu có quy ước áp dụng xuyên suốt; nếu không có → XOÁ HẲN section này)*
|
|
93
|
+
|
|
94
|
+
> Khai báo **MỘT LẦN** các quy ước áp dụng cho **mọi BR** ở §3. BR **KHÔNG** lặp lại nội dung đã khai ở đây,
|
|
95
|
+
> AC §2 **trỏ tới** quy ước thay vì chép lại. Đây là nơi chứa định nghĩa dùng chung, giá trị mặc định,
|
|
96
|
+
> và cách đọc các cột của bảng BR — những thứ trước đây bị xé nhỏ và lặp trong từng dòng.
|
|
97
|
+
>
|
|
98
|
+
> Phân biệt với **§1b Phạm vi** (ranh giới làm/không làm) và **business-dictionary** (định nghĩa thuật ngữ
|
|
99
|
+
> cấp domain, dùng chung nhiều PRD): §1d chỉ chứa quy ước **cục bộ của tài liệu này**.
|
|
100
|
+
|
|
101
|
+
- **{Tên quy ước}**: {nội dung áp dụng cho mọi BR bên dưới}
|
|
102
|
+
- **{Giá trị mặc định dùng chung}**: {…}
|
|
103
|
+
|
|
87
104
|
---
|
|
88
105
|
|
|
89
106
|
# 2. Acceptance Criteria
|
|
@@ -118,11 +135,47 @@
|
|
|
118
135
|
|
|
119
136
|
**Business Rule**
|
|
120
137
|
|
|
138
|
+
> **Hình dạng bảng — mặc định 3 cột.** Dùng dạng này khi Business Logic là **văn xuôi** (mô tả luật bằng câu).
|
|
139
|
+
|
|
121
140
|
| ID | Business Rule | Business Logic |
|
|
122
141
|
|----|---------------|----------------|
|
|
123
142
|
| {TICKET}-{N}-UC1-BR1 | {luật ngắn gọn} | - {logic chi tiết, xuống dòng bằng `<br/>`}<br/>- {…} |
|
|
124
143
|
| {TICKET}-{N}-UC1-BR2 | {…} | - {…} |
|
|
125
144
|
|
|
145
|
+
<!--
|
|
146
|
+
NGOẠI LỆ — MỞ CỘT (dùng THAY cho bảng 3 cột ở trên, KHÔNG dùng cả hai):
|
|
147
|
+
|
|
148
|
+
Điều kiện kích hoạt: MỌI BR trong UC này chia sẻ CÙNG một bộ thuộc tính lặp lại.
|
|
149
|
+
Dấu hiệu tự phát hiện: đang phải dùng <br/> để nhồi NHIỀU HƠN MỘT bản ghi cùng
|
|
150
|
+
cấu trúc vào một ô Business Logic.
|
|
151
|
+
|
|
152
|
+
Khi kích hoạt: promote thuộc tính thành CỘT, một bản ghi = một DÒNG:
|
|
153
|
+
|
|
154
|
+
| ID | Business Rule | {Thuộc tính 1} | {Thuộc tính 2} | {Thuộc tính 3} |
|
|
155
|
+
|-----|---------------|----------------|----------------|----------------|
|
|
156
|
+
| BR1 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
157
|
+
| BR2 | {luật ngắn} | {giá trị} | {giá trị} | {giá trị} |
|
|
158
|
+
|
|
159
|
+
Hai cột ID + Business Rule LUÔN giữ (traceability phụ thuộc chúng). Chỉ cột
|
|
160
|
+
Business Logic được tách thành N cột. Giá trị dùng chung cho mọi dòng → đưa lên
|
|
161
|
+
§1d Quy ước, ĐỪNG lặp trong từng ô.
|
|
162
|
+
|
|
163
|
+
⚠️ CẢNH BÁO BR ID CHURN — đọc trước khi mở cột trên PRD ĐÃ TỒN TẠI:
|
|
164
|
+
Mở cột đúng nghĩa = một bản ghi một dòng ⇒ số BR TĂNG. Vì BR ID tăng liên tục
|
|
165
|
+
trên toàn PRD, chèn dòng ở giữa sẽ ĐÁNH SỐ LẠI mọi BR phía sau. Nếu PRD này đã có
|
|
166
|
+
BDD downstream, mọi tag `@trace.business_rules` trong .feature sẽ trỏ SAI trong im lặng.
|
|
167
|
+
→ Trước khi mở cột trên PRD đã có: kiểm tra `{specs_dir}/{domain}/{prd-slug}/bdd/`.
|
|
168
|
+
- Chưa có BDD → mở cột tự do.
|
|
169
|
+
- ĐÃ có BDD → DỪNG, báo người dùng: cần re-gen BDD sau khi đổi, hoặc giữ nguyên hình dạng cũ.
|
|
170
|
+
PRD sinh MỚI không bị ảnh hưởng (chưa có downstream).
|
|
171
|
+
-->
|
|
172
|
+
|
|
173
|
+
> **Note {BR ref}:** *(TUỲ CHỌN)* {giải thích **quyết định đã chốt** — vì sao luật này như vậy, ràng buộc
|
|
174
|
+
> nào dẫn tới nó, biên nào đã cân nhắc}. Đặt ngay sau bảng, cạnh nơi phát sinh.
|
|
175
|
+
>
|
|
176
|
+
> **Ranh giới với "Giả định AI" (Appendix):** Note = quyết định **đã chốt**, giải thích cho người đọc sau.
|
|
177
|
+
> Giả định AI = **độ vênh CẦN PO chốt**. Note **KHÔNG** được nuốt Giả định AI — nghi ngờ thì để ở Giả định AI.
|
|
178
|
+
|
|
126
179
|
---
|
|
127
180
|
|
|
128
181
|
#### {TICKET}-{N}-UC2: {Tên use case}
|
|
@@ -143,6 +196,12 @@ flowchart TD
|
|
|
143
196
|
|
|
144
197
|
## b. Wireframe
|
|
145
198
|
|
|
199
|
+
> **KHÔNG nhân bản §3.** Wireframe liệt kê **màn + thành phần + hành động** — nó là nguồn coverage màn hình
|
|
200
|
+
> cho `/generate-bdd` (C.1), KHÔNG phải bản sao thứ hai của bảng Business Rule.
|
|
201
|
+
> Nếu một dòng Wireframe không thêm thông tin nào ngoài BR đã có → **tham chiếu BR ID, đừng chép nội dung**.
|
|
202
|
+
> Nếu cả §4b không thêm gì mới so với §3 → **xoá hẳn §4b** (hai nguồn sự thật cho cùng một dữ liệu sẽ lệch nhau
|
|
203
|
+
> ngay lần sửa đầu tiên).
|
|
204
|
+
|
|
146
205
|
### Screen 1: {Tên màn}
|
|
147
206
|
|
|
148
207
|
| Thành phần | Chi tiết |
|