@edupia-tutor/spec-driven-docs 0.14.3 → 0.14.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/commands/debug.md +1 -0
- package/commands/define-product.md +70 -5
- package/commands/define-product.tmpl +33 -5
- package/commands/dev-gen-test.md +1 -0
- package/commands/dev-run-test.md +1 -0
- package/commands/dev-smoke-test.md +1 -0
- package/commands/fix-bug.md +1 -0
- package/commands/generate-bdd.md +15 -11
- package/commands/generate-bdd.tmpl +14 -11
- package/commands/generate-code.md +1 -0
- package/commands/generate-design-spec.md +1 -0
- package/commands/generate-prd.md +111 -10
- package/commands/generate-prd.tmpl +61 -7
- package/commands/generate-spec-manifest.md +1 -0
- package/commands/generate-tech-docs.md +1 -0
- package/commands/learn.md +1 -0
- package/commands/map-testids.md +1 -0
- package/commands/propose-scenario.md +1 -0
- package/commands/qc-analyze.md +1 -0
- package/commands/qc-design-test.md +1 -0
- package/commands/qc-plan.md +1 -0
- package/commands/qc-report.md +1 -0
- package/commands/qc-review.md +1 -0
- package/commands/qc-run-test.md +1 -0
- package/commands/refine-prd.md +172 -18
- package/commands/refine-prd.tmpl +114 -13
- package/commands/report-bug.md +1 -0
- package/commands/review-code.md +1 -0
- package/commands/review-context.md +22 -5
- package/commands/review-tech-docs.md +1 -0
- package/commands/setup-ai-first.md +1 -0
- package/commands/validate-traces.md +1 -0
- package/core/FRAMEWORK_VERSION +1 -1
- package/core/commands/debug.md +1 -0
- package/core/commands/define-product.md +70 -5
- package/core/commands/dev-gen-test.md +1 -0
- package/core/commands/dev-run-test.md +1 -0
- package/core/commands/dev-smoke-test.md +1 -0
- package/core/commands/fix-bug.md +1 -0
- package/core/commands/generate-bdd.md +15 -11
- package/core/commands/generate-code.md +1 -0
- package/core/commands/generate-design-spec.md +1 -0
- package/core/commands/generate-prd.md +111 -10
- package/core/commands/generate-spec-manifest.md +1 -0
- package/core/commands/generate-tech-docs.md +1 -0
- package/core/commands/learn.md +1 -0
- package/core/commands/map-testids.md +1 -0
- package/core/commands/propose-scenario.md +1 -0
- package/core/commands/qc-analyze.md +1 -0
- package/core/commands/qc-design-test.md +1 -0
- package/core/commands/qc-plan.md +1 -0
- package/core/commands/qc-report.md +1 -0
- package/core/commands/qc-review.md +1 -0
- package/core/commands/qc-run-test.md +1 -0
- package/core/commands/refine-prd.md +172 -18
- package/core/commands/report-bug.md +1 -0
- package/core/commands/review-code.md +1 -0
- package/core/commands/review-context.md +22 -5
- package/core/commands/review-tech-docs.md +1 -0
- package/core/commands/setup-ai-first.md +1 -0
- package/core/commands/validate-traces.md +1 -0
- package/core/skills/code/SKILL.md +1 -0
- package/core/skills/design-spec/SKILL.md +1 -0
- package/core/skills/prd/SKILL.md +14 -3
- package/core/skills/spec/SKILL.md +1 -0
- package/core/skills/test/SKILL.md +1 -0
- package/core/steps/business-language.md +36 -0
- package/core/steps/gate.md +1 -0
- package/core/steps/review-fanout.md +21 -5
- package/core/templates/prd.template.md +13 -3
- package/core/templates/product-definition.template.md +8 -1
- package/package.json +1 -1
- package/skills/code/SKILL.md +1 -0
- package/skills/design-spec/SKILL.md +1 -0
- package/skills/prd/SKILL.md +14 -3
- package/skills/spec/SKILL.md +1 -0
- package/skills/test/SKILL.md +1 -0
- package/steps/business-language.md +36 -0
- package/steps/gate.md +1 -0
- package/steps/review-fanout.md +21 -5
- package/templates/prd.template.md +13 -3
- package/templates/product-definition.template.md +8 -1
package/commands/debug.md
CHANGED
|
@@ -19,6 +19,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
19
19
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
20
20
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
21
21
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
22
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
22
23
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
23
24
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
24
25
|
|
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
|
@@ -402,6 +403,47 @@ Sau khi hoàn thành tất cả các bước, bạn đã nạp:
|
|
|
402
403
|
Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
403
404
|
|
|
404
405
|
|
|
406
|
+
---
|
|
407
|
+
|
|
408
|
+
## Ngôn ngữ nghiệp vụ *(áp khi viết BR / AC / Business Logic / Scope)*
|
|
409
|
+
# Business Language Guard — chặn thuật ngữ kỹ thuật rò vào tài liệu nghiệp vụ
|
|
410
|
+
|
|
411
|
+
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**.
|
|
412
|
+
|
|
413
|
+
> 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ó.
|
|
414
|
+
|
|
415
|
+
## Bản đồ xử lý (3 nhóm)
|
|
416
|
+
|
|
417
|
+
**Nhóm 1 — Tương tác/triển khai → DIỄN ĐẠT LẠI sang nghiệp vụ (giữ nguyên nghĩa):**
|
|
418
|
+
|
|
419
|
+
| Kỹ thuật/UI | Cách nói nghiệp vụ |
|
|
420
|
+
|---|---|
|
|
421
|
+
| re-render / render lại / reload / refresh (màn) | "hiển thị lại {tên màn}" |
|
|
422
|
+
| timeout | "quá thời gian chờ" |
|
|
423
|
+
| lỗi mạng / network error | "lỗi kết nối" |
|
|
424
|
+
| UI / giao diện (khi chỉ một màn) | "màn" / "màn hình" |
|
|
425
|
+
| click / tap | "bấm" / "chọn" |
|
|
426
|
+
| popup / modal (nếu chỉ là khái niệm hiển thị) | "hộp thoại" / "thông báo" |
|
|
427
|
+
| disable / enable (nút) | "khoá" / "mở" thao tác |
|
|
428
|
+
| redirect / navigate | "chuyển tới {màn}" |
|
|
429
|
+
|
|
430
|
+
**Nhóm 2 — Visual thuần → CHUYỂN Design Spec (bỏ khỏi PRD, ghi nhận lại):**
|
|
431
|
+
`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."*
|
|
432
|
+
|
|
433
|
+
**Nhóm 3 — Backend/contract thuần → BỎ khỏi PRD (thuộc Tech Docs):**
|
|
434
|
+
`API`, `endpoint`, `token/JWT`, `HTTP status`, tên class/bảng/cột DB, query, payload, header.
|
|
435
|
+
*(Ngoại lệ DUY NHẤT: Appendix "Existing API Contract" khi `API Source: existing` — xem Platform Strategy.)*
|
|
436
|
+
|
|
437
|
+
## Quy tắc áp dụng
|
|
438
|
+
- Quét toàn bộ text sắp ghi (User Story, AC, BR, Business Logic, Scope, Edge Cases, Assumptions…).
|
|
439
|
+
- 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).
|
|
440
|
+
- Nhóm 2 → gỡ khỏi prose nghiệp vụ + nhắc chuyển Design Spec.
|
|
441
|
+
- Nhóm 3 → gỡ khỏi PRD (trừ ngoại lệ brownfield).
|
|
442
|
+
- 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.
|
|
443
|
+
|
|
444
|
+
**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).
|
|
445
|
+
|
|
446
|
+
|
|
405
447
|
---
|
|
406
448
|
|
|
407
449
|
## Phase 0 — Knowledge Sync *(AI tự điền — bối cảnh hệ thống, KHÔNG phải yêu cầu nghiệp vụ; không cần input PO)*
|
|
@@ -412,6 +454,11 @@ AI quét dự án và ghi:
|
|
|
412
454
|
- **Phần hệ thống / feature liên quan** — liệt kê phần hệ thống/feature bị ảnh hưởng.
|
|
413
455
|
- **Rule / Logic có sẵn** — các rule từ PRD có sẵn mà feature này phải tôn trọng.
|
|
414
456
|
- **Chuẩn hoá thuật ngữ** — map mọi thuật ngữ trong input PO về thuật ngữ chuẩn từ business-dictionary.md.
|
|
457
|
+
- **NEW TERM DETECTION:** nếu một thuật ngữ trong input PO lặp ≥2 lần và KHÔNG có canonical tương ứng trong business-dictionary.md → KHÔNG để trống/bịa. Ghi nó thành một câu hỏi trong **Phase 3 (Clarification Log)** để hỏi PO ngay khi còn trong buổi discovery:
|
|
458
|
+
+ Thuật ngữ đó nghĩa gì trong ngữ cảnh hệ thống?
|
|
459
|
+
+ English canonical term nên dùng là gì?
|
|
460
|
+
+ Có bổ sung vào business-dictionary.md không?
|
|
461
|
+
Sau khi PO chốt → cập nhật business-dictionary.md (nếu đồng ý) + điền vào bảng map. *(Phase 0 chỉ phát hiện; việc hỏi dồn vào Phase 3 để không phá tính chất "không cần input PO" của Phase 0.)*
|
|
415
462
|
|
|
416
463
|
```
|
|
417
464
|
| Thuật ngữ trong input PO | Thuật ngữ chuẩn (business-dictionary) |
|
|
@@ -451,8 +498,12 @@ Hỏi:
|
|
|
451
498
|
```
|
|
452
499
|
| Bước | Hành động | Trạng thái/Kết quả nghiệp vụ | Ghi chú |
|
|
453
500
|
```
|
|
454
|
-
3. **
|
|
455
|
-
|
|
501
|
+
3. **Màn hình & thành phần chính** *(mức nghiệp vụ — KHÔNG pixel/layout/màu)*: Feature gồm những **màn hình / bước giao diện** chính nào? Mỗi màn có **thành phần & hành động chính** gì (vd: ô nhập, nút, danh sách → bấm ra kết quả gì)? Đây là nguồn cho Wireframe của PRD và độ phủ BDD — nếu PO không chắc, AI gợi ý rồi PO xác nhận.
|
|
502
|
+
```
|
|
503
|
+
| Màn hình | Thành phần chính | Hành động → kết quả nghiệp vụ |
|
|
504
|
+
```
|
|
505
|
+
4. **Exit Point**: Kết quả cuối khi flow hoàn thành là gì?
|
|
506
|
+
5. **Edge Cases**: Các kịch bản thất bại nghiệp vụ ngoài happy path? (input thiếu, điều kiện không thoả, thao tác đồng thời, phụ thuộc không sẵn sàng → kết quả nghiệp vụ kỳ vọng)
|
|
456
507
|
|
|
457
508
|
Xác nhận → ghi `✅ PO xác nhận: Có` → tiếp tục.
|
|
458
509
|
|
|
@@ -541,6 +592,15 @@ Nếu phát hiện GAP → cảnh báo PO và giải quyết trước khi đánh
|
|
|
541
592
|
|
|
542
593
|
Ghi `{paths.product_definitions_dir}/{TICKET-ID}-{slug}.md` theo `templates/product-definition.template.md`.
|
|
543
594
|
|
|
595
|
+
> **Quy ước `slug`:** `slug` = kebab-case của tên feature (vd "Loyalty Points" → `loyalty-points`),
|
|
596
|
+
> viết thường, chỉ a-z 0-9 và dấu `-`. Đây là định danh feature-package dùng xuyên suốt pipeline —
|
|
597
|
+
> PRD, BDD, tech-docs, design-spec, trace của feature này đều kế thừa **nguyên văn** `slug` này
|
|
598
|
+
> (`/generate-prd` đặt `prd-slug = slug`). Sinh một lần ở đây, các bước sau KHÔNG tái sinh.
|
|
599
|
+
>
|
|
600
|
+
> **Ranh giới tên file:** tên file = `{TICKET-ID}-{slug}.md`. TICKET-ID **được phép chứa `-`**
|
|
601
|
+
> (vd Jira key `LOYAL-29` → `LOYAL-29-loyalty-points.md`). Khi tách lại slug, các bước sau strip
|
|
602
|
+
> **đúng chuỗi TICKET-ID** ở đầu, KHÔNG tách theo dấu `-` đầu tiên.
|
|
603
|
+
|
|
544
604
|
Điền tất cả section bằng dữ liệu thu thập qua các phase.
|
|
545
605
|
|
|
546
606
|
**Cập nhật Metadata theo tiến độ (cho phép resume):**
|
|
@@ -650,8 +710,13 @@ Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
|
650
710
|
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
651
711
|
|
|
652
712
|
|
|
713
|
+
Ví dụ footer cho lệnh này:
|
|
714
|
+
|
|
653
715
|
```
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
716
|
+
---
|
|
717
|
+
Status : ✅ Complete
|
|
718
|
+
Output Artifacts:
|
|
719
|
+
created {paths.product_definitions_dir}/{TICKET-ID}-{slug}.md (product definition, Phase 1-7)
|
|
720
|
+
Pipeline : [Discovery ◀ bạn ở đây] → PRD → Design Spec → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
721
|
+
Next : /generate-prd {paths.product_definitions_dir}/{TICKET-ID}-{slug}.md
|
|
657
722
|
```
|
|
@@ -10,6 +10,11 @@
|
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
+
## Ngôn ngữ nghiệp vụ *(áp khi viết BR / AC / Business Logic / Scope)*
|
|
14
|
+
{{include:steps/business-language.md}}
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
13
18
|
## Phase 0 — Knowledge Sync *(AI tự điền — bối cảnh hệ thống, KHÔNG phải yêu cầu nghiệp vụ; không cần input PO)*
|
|
14
19
|
|
|
15
20
|
AI quét dự án và ghi:
|
|
@@ -18,6 +23,11 @@ AI quét dự án và ghi:
|
|
|
18
23
|
- **Phần hệ thống / feature liên quan** — liệt kê phần hệ thống/feature bị ảnh hưởng.
|
|
19
24
|
- **Rule / Logic có sẵn** — các rule từ PRD có sẵn mà feature này phải tôn trọng.
|
|
20
25
|
- **Chuẩn hoá thuật ngữ** — map mọi thuật ngữ trong input PO về thuật ngữ chuẩn từ business-dictionary.md.
|
|
26
|
+
- **NEW TERM DETECTION:** nếu một thuật ngữ trong input PO lặp ≥2 lần và KHÔNG có canonical tương ứng trong business-dictionary.md → KHÔNG để trống/bịa. Ghi nó thành một câu hỏi trong **Phase 3 (Clarification Log)** để hỏi PO ngay khi còn trong buổi discovery:
|
|
27
|
+
+ Thuật ngữ đó nghĩa gì trong ngữ cảnh hệ thống?
|
|
28
|
+
+ English canonical term nên dùng là gì?
|
|
29
|
+
+ Có bổ sung vào business-dictionary.md không?
|
|
30
|
+
Sau khi PO chốt → cập nhật business-dictionary.md (nếu đồng ý) + điền vào bảng map. *(Phase 0 chỉ phát hiện; việc hỏi dồn vào Phase 3 để không phá tính chất "không cần input PO" của Phase 0.)*
|
|
21
31
|
|
|
22
32
|
```
|
|
23
33
|
| Thuật ngữ trong input PO | Thuật ngữ chuẩn (business-dictionary) |
|
|
@@ -57,8 +67,12 @@ Hỏi:
|
|
|
57
67
|
```
|
|
58
68
|
| Bước | Hành động | Trạng thái/Kết quả nghiệp vụ | Ghi chú |
|
|
59
69
|
```
|
|
60
|
-
3. **
|
|
61
|
-
|
|
70
|
+
3. **Màn hình & thành phần chính** *(mức nghiệp vụ — KHÔNG pixel/layout/màu)*: Feature gồm những **màn hình / bước giao diện** chính nào? Mỗi màn có **thành phần & hành động chính** gì (vd: ô nhập, nút, danh sách → bấm ra kết quả gì)? Đây là nguồn cho Wireframe của PRD và độ phủ BDD — nếu PO không chắc, AI gợi ý rồi PO xác nhận.
|
|
71
|
+
```
|
|
72
|
+
| Màn hình | Thành phần chính | Hành động → kết quả nghiệp vụ |
|
|
73
|
+
```
|
|
74
|
+
4. **Exit Point**: Kết quả cuối khi flow hoàn thành là gì?
|
|
75
|
+
5. **Edge Cases**: Các kịch bản thất bại nghiệp vụ ngoài happy path? (input thiếu, điều kiện không thoả, thao tác đồng thời, phụ thuộc không sẵn sàng → kết quả nghiệp vụ kỳ vọng)
|
|
62
76
|
|
|
63
77
|
Xác nhận → ghi `✅ PO xác nhận: Có` → tiếp tục.
|
|
64
78
|
|
|
@@ -147,6 +161,15 @@ Nếu phát hiện GAP → cảnh báo PO và giải quyết trước khi đánh
|
|
|
147
161
|
|
|
148
162
|
Ghi `{paths.product_definitions_dir}/{TICKET-ID}-{slug}.md` theo `templates/product-definition.template.md`.
|
|
149
163
|
|
|
164
|
+
> **Quy ước `slug`:** `slug` = kebab-case của tên feature (vd "Loyalty Points" → `loyalty-points`),
|
|
165
|
+
> viết thường, chỉ a-z 0-9 và dấu `-`. Đây là định danh feature-package dùng xuyên suốt pipeline —
|
|
166
|
+
> PRD, BDD, tech-docs, design-spec, trace của feature này đều kế thừa **nguyên văn** `slug` này
|
|
167
|
+
> (`/generate-prd` đặt `prd-slug = slug`). Sinh một lần ở đây, các bước sau KHÔNG tái sinh.
|
|
168
|
+
>
|
|
169
|
+
> **Ranh giới tên file:** tên file = `{TICKET-ID}-{slug}.md`. TICKET-ID **được phép chứa `-`**
|
|
170
|
+
> (vd Jira key `LOYAL-29` → `LOYAL-29-loyalty-points.md`). Khi tách lại slug, các bước sau strip
|
|
171
|
+
> **đúng chuỗi TICKET-ID** ở đầu, KHÔNG tách theo dấu `-` đầu tiên.
|
|
172
|
+
|
|
150
173
|
Điền tất cả section bằng dữ liệu thu thập qua các phase.
|
|
151
174
|
|
|
152
175
|
**Cập nhật Metadata theo tiến độ (cho phép resume):**
|
|
@@ -156,8 +179,13 @@ Ghi `{paths.product_definitions_dir}/{TICKET-ID}-{slug}.md` theo `templates/prod
|
|
|
156
179
|
|
|
157
180
|
{{include:steps/report-footer.md}}
|
|
158
181
|
|
|
182
|
+
Ví dụ footer cho lệnh này:
|
|
183
|
+
|
|
159
184
|
```
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
185
|
+
---
|
|
186
|
+
Status : ✅ Complete
|
|
187
|
+
Output Artifacts:
|
|
188
|
+
created {paths.product_definitions_dir}/{TICKET-ID}-{slug}.md (product definition, Phase 1-7)
|
|
189
|
+
Pipeline : [Discovery ◀ bạn ở đây] → PRD → Design Spec → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
190
|
+
Next : /generate-prd {paths.product_definitions_dir}/{TICKET-ID}-{slug}.md
|
|
163
191
|
```
|
package/commands/dev-gen-test.md
CHANGED
|
@@ -22,6 +22,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
22
22
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
23
23
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
24
24
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
25
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
25
26
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
26
27
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
27
28
|
|
package/commands/dev-run-test.md
CHANGED
|
@@ -22,6 +22,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
22
22
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
23
23
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
24
24
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
25
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
25
26
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
26
27
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
27
28
|
|
|
@@ -18,6 +18,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
18
18
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
19
19
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
20
20
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
21
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
21
22
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
22
23
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
23
24
|
|
package/commands/fix-bug.md
CHANGED
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
package/commands/generate-bdd.md
CHANGED
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
|
@@ -566,17 +567,21 @@ Từ vựng step của System BDD (luôn dùng — bất kể từ vựng FE/App
|
|
|
566
567
|
|
|
567
568
|
*Bỏ qua section này nếu đang chạy spec repo mode.*
|
|
568
569
|
|
|
569
|
-
|
|
570
|
+
Routing service là **domain-keyed** và **context-loader (Bước 1.5) đã phân giải sẵn** từ `@trace.domain`/Domain của PRD — KHÔNG re-resolve ở đây, chỉ dùng lại các biến đã set:
|
|
571
|
+
- `active_service` = `services.{domain}.path` (path submodule, vd `user-service/`) — hoặc `"unresolved"` nếu domain không khớp entry nào, hoặc bỏ trống ở single-service.
|
|
572
|
+
- `active_module` = module của service (`services.{domain}.module`, đã override `tech_stack.module` ở Bước 1.5) — dùng cho từ vựng bên dưới.
|
|
570
573
|
|
|
571
|
-
|
|
574
|
+
Chỉ cần kiểm tra trạng thái đã phân giải:
|
|
575
|
+
|
|
576
|
+
| Trạng thái (từ context-loader) | Hành động |
|
|
572
577
|
|---|---|
|
|
573
|
-
|
|
|
574
|
-
|
|
|
575
|
-
|
|
|
578
|
+
| `active_service` đã phân giải thành path service | Tiếp tục với `active_module` đã set. |
|
|
579
|
+
| `active_service = "unresolved"` (có section `services` nhưng domain PRD không khớp entry nào) | **DỪNG**, báo: "Domain `{domain}` của PRD không khớp service nào trong `services:` của project-context.yaml — bổ sung mapping rồi chạy lại." (Không đoán/hỏi tay — domain là khoá định danh, lệch là lỗi cấu hình cần sửa ở SoT.) |
|
|
580
|
+
| Single-service (không có section `services`) | `active_module = tech_stack.module` (đã set ở Bước 6.5). Tiếp tục. |
|
|
581
|
+
|
|
582
|
+
**Output path (umbrella mode):** `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
576
583
|
|
|
577
|
-
|
|
578
|
-
- `active_service = "default"` → `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
579
|
-
- `active_service ≠ "default"` → `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_service}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
584
|
+
*(Không thêm subfolder theo service: feature-package đã domain-scoped sẵn ở `{domain}/`, mà service route 1-1 theo domain — nên thêm subfolder service sẽ chỉ lặp lại domain. `active_service` chỉ dùng cho `service_root`/từ vựng, KHÔNG vào path spec.)*
|
|
580
585
|
|
|
581
586
|
**Từ vựng theo platform** — điều chỉnh cách viết step BDD theo `active_module`:
|
|
582
587
|
|
|
@@ -626,7 +631,7 @@ Trước khi sinh, kiểm tra các file `.feature` có sẵn cho PRD này:
|
|
|
626
631
|
|
|
627
632
|
1. Phân giải search path theo mode:
|
|
628
633
|
- **Spec repo mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC*.feature`
|
|
629
|
-
- **Umbrella mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC*.feature`
|
|
634
|
+
- **Umbrella mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC*.feature`
|
|
630
635
|
2. Đọc `| **Version** |` hiện tại của PRD từ metadata (vd: `1.2`).
|
|
631
636
|
|
|
632
637
|
**Nếu không có file feature nào** → gen mới, tiếp tục bình thường. Dùng version PRD làm `@trace.prd_version`.
|
|
@@ -731,8 +736,7 @@ CHECKPOINT: "Outline này đúng chưa? Bạn muốn thêm hay bớt SC nào kh
|
|
|
731
736
|
|
|
732
737
|
**Output path theo mode:**
|
|
733
738
|
- **Spec repo mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
734
|
-
- **Umbrella mode
|
|
735
|
-
- **Umbrella mode (multi-service)**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_service}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
739
|
+
- **Umbrella mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC{N}-{slug}.feature` *(service route 1-1 theo domain → không thêm subfolder service)*
|
|
736
740
|
|
|
737
741
|
Với mỗi UC, ghi vào path đã phân giải ở trên. Dùng từ vựng cho active platform (từ Platform Selection hoặc Service Detection).
|
|
738
742
|
|
|
@@ -172,17 +172,21 @@ Từ vựng step của System BDD (luôn dùng — bất kể từ vựng FE/App
|
|
|
172
172
|
|
|
173
173
|
*Bỏ qua section này nếu đang chạy spec repo mode.*
|
|
174
174
|
|
|
175
|
-
|
|
175
|
+
Routing service là **domain-keyed** và **context-loader (Bước 1.5) đã phân giải sẵn** từ `@trace.domain`/Domain của PRD — KHÔNG re-resolve ở đây, chỉ dùng lại các biến đã set:
|
|
176
|
+
- `active_service` = `services.{domain}.path` (path submodule, vd `user-service/`) — hoặc `"unresolved"` nếu domain không khớp entry nào, hoặc bỏ trống ở single-service.
|
|
177
|
+
- `active_module` = module của service (`services.{domain}.module`, đã override `tech_stack.module` ở Bước 1.5) — dùng cho từ vựng bên dưới.
|
|
176
178
|
|
|
177
|
-
|
|
179
|
+
Chỉ cần kiểm tra trạng thái đã phân giải:
|
|
180
|
+
|
|
181
|
+
| Trạng thái (từ context-loader) | Hành động |
|
|
178
182
|
|---|---|
|
|
179
|
-
|
|
|
180
|
-
|
|
|
181
|
-
|
|
|
183
|
+
| `active_service` đã phân giải thành path service | Tiếp tục với `active_module` đã set. |
|
|
184
|
+
| `active_service = "unresolved"` (có section `services` nhưng domain PRD không khớp entry nào) | **DỪNG**, báo: "Domain `{domain}` của PRD không khớp service nào trong `services:` của project-context.yaml — bổ sung mapping rồi chạy lại." (Không đoán/hỏi tay — domain là khoá định danh, lệch là lỗi cấu hình cần sửa ở SoT.) |
|
|
185
|
+
| Single-service (không có section `services`) | `active_module = tech_stack.module` (đã set ở Bước 6.5). Tiếp tục. |
|
|
186
|
+
|
|
187
|
+
**Output path (umbrella mode):** `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
182
188
|
|
|
183
|
-
|
|
184
|
-
- `active_service = "default"` → `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
185
|
-
- `active_service ≠ "default"` → `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_service}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
189
|
+
*(Không thêm subfolder theo service: feature-package đã domain-scoped sẵn ở `{domain}/`, mà service route 1-1 theo domain — nên thêm subfolder service sẽ chỉ lặp lại domain. `active_service` chỉ dùng cho `service_root`/từ vựng, KHÔNG vào path spec.)*
|
|
186
190
|
|
|
187
191
|
**Từ vựng theo platform** — điều chỉnh cách viết step BDD theo `active_module`:
|
|
188
192
|
|
|
@@ -232,7 +236,7 @@ Trước khi sinh, kiểm tra các file `.feature` có sẵn cho PRD này:
|
|
|
232
236
|
|
|
233
237
|
1. Phân giải search path theo mode:
|
|
234
238
|
- **Spec repo mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC*.feature`
|
|
235
|
-
- **Umbrella mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC*.feature`
|
|
239
|
+
- **Umbrella mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC*.feature`
|
|
236
240
|
2. Đọc `| **Version** |` hiện tại của PRD từ metadata (vd: `1.2`).
|
|
237
241
|
|
|
238
242
|
**Nếu không có file feature nào** → gen mới, tiếp tục bình thường. Dùng version PRD làm `@trace.prd_version`.
|
|
@@ -337,8 +341,7 @@ CHECKPOINT: "Outline này đúng chưa? Bạn muốn thêm hay bớt SC nào kh
|
|
|
337
341
|
|
|
338
342
|
**Output path theo mode:**
|
|
339
343
|
- **Spec repo mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_platform}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
340
|
-
- **Umbrella mode
|
|
341
|
-
- **Umbrella mode (multi-service)**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{active_service}/{TICKET-ID}-UC{N}-{slug}.feature`
|
|
344
|
+
- **Umbrella mode**: `{paths.specs_dir}/{domain}/{prd-slug}/bdd/{TICKET-ID}-UC{N}-{slug}.feature` *(service route 1-1 theo domain → không thêm subfolder service)*
|
|
342
345
|
|
|
343
346
|
Với mỗi UC, ghi vào path đã phân giải ở trên. Dùng từ vựng cho active platform (từ Platform Selection hoặc Service Detection).
|
|
344
347
|
|
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
package/commands/generate-prd.md
CHANGED
|
@@ -16,6 +16,7 @@ Trước tiên, kiểm tra xem `$ARGUMENTS` có phải là payload JSON từ m
|
|
|
16
16
|
- Đặt loaded context = `payload.context` (KHÔNG chạy context-loader.md)
|
|
17
17
|
- Đặt phạm vi UC = `payload.uc_id` (chỉ xử lý UC này)
|
|
18
18
|
- Đặt line range = `payload.uc_section` (chỉ đọc đúng section đó của PRD)
|
|
19
|
+
- Đặt dimension = `payload.dimension` nếu có (lệnh review per-UC: chỉ review đúng lăng kính này)
|
|
19
20
|
- Đi thẳng tới phần logic riêng của lệnh.
|
|
20
21
|
3. Nếu `$ARGUMENTS` không phải JSON hoặc không có `_agent_mode` → tiếp tục sang Bước 1 (chế độ thường).
|
|
21
22
|
|
|
@@ -404,9 +405,46 @@ Tiếp tục sang bước kế tiếp của lệnh đang gọi.
|
|
|
404
405
|
|
|
405
406
|
*Context bổ sung cho lệnh này: Đọc toàn bộ file product-definition. Trích xuất: **TICKET-ID**, **domain**, **tên feature**, **tên PO** (field `PO` ở Metadata), dữ liệu Phase 1-7, và bảng **Chuẩn hoá thuật ngữ** (Terminology Map ở Phase 0 — các cặp `thuật ngữ PO → thuật ngữ chuẩn`). Lưu bản đồ này để áp dụng ở bước Quy tắc thuật ngữ. **Nếu Phase 7 (Validation Report) còn `Xung đột phát hiện` / `Mục còn thiếu` khác "None" → diễn đạt lại mỗi mục thành một câu hỏi theo format `Q… — [AI DRAFT]` của section "Giả định AI" (nêu rõ độ vênh + cần PO chốt điều gì), thay vì dán thô. AI không tự quyết thay PO.***
|
|
406
407
|
|
|
408
|
+
**Map "Phụ thuộc liên service"** (Phase 1 câu 8 của product-definition) → **§1c "Phụ thuộc liên service"** của PRD, giữ nguyên mức nghiệp vụ (cần dữ liệu/năng lực gì, từ ai, vì sao — KHÔNG thêm chi tiết API/kỹ thuật). Nếu discovery ghi "Không có" → §1c ghi "Không có".
|
|
409
|
+
|
|
410
|
+
**Map "Màn hình & thành phần chính"** (Phase 2 của product-definition) → **§4b Wireframe** của PRD: mỗi màn hình thành một Screen với Components/Actions tương ứng. Đây là nguồn coverage cho `/generate-bdd` (C.1). Nếu phải **suy thêm** Screen/component mà discovery chưa nêu → đánh dấu rõ `*(AI đề xuất — PO review)*` cạnh phần đó, đừng để âm thầm thành chân lý coverage.
|
|
411
|
+
|
|
407
412
|
**Phân giải PO** (đọc trước, hỏi sau): lấy `PO` từ Metadata của product-definition. Nếu đã có giá trị → dùng luôn, KHÔNG hỏi lại. Nếu trống/thiếu → hỏi PO ngay ở CHECKPOINT dưới. Điền giá trị này vào field `PO` của PRD Metadata.
|
|
408
413
|
|
|
409
|
-
|
|
414
|
+
**Phân giải link tracker (hỏi cho MỌI ticket):** `TICKET-ID` là **định danh nội bộ** PO tự đặt lúc discovery — **KHÔNG đảm bảo** là một Jira key có thật, nên **TUYỆT ĐỐI KHÔNG tự dựng URL** kiểu `{base}/browse/{TICKET-ID}` (sẽ ra link rác trỏ tới ticket không tồn tại). Field `Ticket` **luôn giữ TICKET-ID dạng plain text**; link Jira (nếu có) chỉ **đặt thêm bên cạnh**. **Luôn hỏi PO**: *"Ticket {TICKET-ID} có link tracker thật (Jira/khác) không? Nếu có, dán vào."*
|
|
415
|
+
- PO **có** link → điền field `Ticket` dạng: `{TICKET-ID} ([Jira]({tracker_url}))` — plain ID đứng trước, link trong ngoặc bên cạnh.
|
|
416
|
+
- PO **không** có / để trống → điền plain text `{TICKET-ID}` (KHÔNG link, KHÔNG placeholder `{...}` lủng lẳng).
|
|
417
|
+
|
|
418
|
+
**Phân giải `slug`** (kế thừa, KHÔNG tái sinh): đọc `TICKET-ID` từ Metadata `Ticket` của product-definition, rồi lấy `slug` = phần tên file **sau khi strip đúng chuỗi `{TICKET-ID}-` ở đầu**. **KHÔNG tách theo dấu `-` đầu tiên** — vì TICKET-ID có thể chứa `-` (vd Jira key `LOYAL-29`): `LOYAL-29-loyalty-points.md` với TICKET-ID `LOYAL-29` → `slug = loyalty-points` (KHÔNG phải `29-loyalty-points`). Đặt `prd-slug = slug` này cho feature-package PRD, để folder `{specs_dir}/{domain}/{prd-slug}/` khớp 1-1 với product-definition. KHÔNG tự bịa slug mới — nếu tên file không bắt đầu bằng `{TICKET-ID}-`, dừng và hỏi người dùng.
|
|
419
|
+
|
|
420
|
+
**Guard — discovery phải hoàn tất:** đọc `Status` và `Completed Phase` từ Metadata của product-definition.
|
|
421
|
+
- Nếu `Status: completed` (Completed Phase = 7) → tiếp tục bình thường.
|
|
422
|
+
- Nếu `Status: in-progress` (Completed Phase < 7) → **DỪNG**, KHÔNG sinh PRD, báo:
|
|
423
|
+
```
|
|
424
|
+
❌ Product-definition chưa hoàn tất (Status: in-progress, Completed Phase: {N}/7).
|
|
425
|
+
/generate-prd cần discovery đủ Phase 1-7 (BR, Business Logic, AC, Validation Report).
|
|
426
|
+
Chạy lại /define-product {file} để resume từ Phase {N+1}, rồi mới sinh PRD.
|
|
427
|
+
```
|
|
428
|
+
PRD là artifact ký duyệt — không sinh từ nguồn discovery chưa chốt.
|
|
429
|
+
|
|
430
|
+
**Phân giải `API Source` (brownfield / greenfield / partner song song):** hỏi PO **một** câu để chốt **loại** nguồn API — PO CHỈ chốt loại, **không bao giờ gõ chi tiết contract**:
|
|
431
|
+
|
|
432
|
+
> "API của feature này thuộc loại nào?
|
|
433
|
+
> 1. **existing** — API đã chạy production, contract cố định
|
|
434
|
+
> 2. **greenfield** — mình tự thiết kế contract mới
|
|
435
|
+
> 3. **partner** — đối tác đang phát triển song song, contract chưa có"
|
|
436
|
+
|
|
437
|
+
- **(1) existing** → set Metadata `API Source: existing`. Xin PO **con trỏ nguồn** contract (1 trong: file openapi/swagger, URL swagger, path service/repo BE, hoặc doc đính kèm). AI **trích as-is** vào Appendix "Existing API Contract" (ghi rõ nguồn từng row — KHÔNG bịa, KHÔNG thiết kế mới). *Người điền detail là AI từ artifact thật, KHÔNG phải PO.*
|
|
438
|
+
- Nếu con trỏ **không truy cập được** từ context hiện tại → KHÔNG fabricate: ghi block `⛔ PENDING: contract chưa trích — nguồn: {pointer}; phải trích as-is trước /generate-bdd` vào section đó, vẫn giữ `API Source: existing`. Coi phần contract của PRD chưa hoàn tất tới khi bảng đủ.
|
|
439
|
+
- **(2) greenfield** → để trống `API Source`. **Xoá** Appendix "Existing API Contract" (template đã dặn). Contract sẽ được thiết kế ở `/generate-tech-docs`.
|
|
440
|
+
- **(3) partner song song** → ĐI LUỒNG greenfield (`API Source` để trống, **xoá** section Existing API Contract), **KHÔNG** set `existing`. Thêm:
|
|
441
|
+
- Ghi phụ thuộc partner vào **§1c "Phụ thuộc liên service"** của PRD (mức nghiệp vụ): cần contract/năng lực gì từ partner nào, vì sao.
|
|
442
|
+
- Một mục trong "Giả định AI": *"Contract do partner {X} phát triển song song; bản tech-docs sinh sau là ĐỀ XUẤT của ta để đàm phán (qua cổng T7 cross-team sign-off), chốt khi partner confirm — có thể thay đổi."*
|
|
443
|
+
- Lý do KHÔNG dùng `existing`: `existing` làm `/review-tech-docs` **skip T7** — nhưng partner song song chính là lúc CẦN T7 để đàm phán contract.
|
|
444
|
+
|
|
445
|
+
> **`API Source` là field có vòng đời:** có thể bắt đầu greenfield/partner rồi **chuyển thành `existing`** khi contract được chốt (vd partner áp contract của họ và ta phải theo). Khi đó: chạy `/refine-prd` đổi `API Source → existing` + điền Existing API Contract từ nguồn partner (trích as-is) + bump Version; `/generate-bdd` (Version drift) và `/generate-tech-docs` (reverse-document) sẽ tự realign system BDD + tech-doc theo contract mới. FE/App BDD phần lớn không vỡ nhờ luật declarative (assert outcome quan sát được, không assert shape JSON).
|
|
446
|
+
|
|
447
|
+
CHECKPOINT trước khi sinh: "Sinh PRD cho **{TICKET-ID} — {feature}** (domain: {domain}), PO: **{tên PO — hoặc hỏi nếu product-definition để trống}**. API Source: **{existing — nguồn {pointer} | greenfield | partner song song}**. Link tracker: **{URL — hoặc 'không có, dùng plain ID'}**. Nguồn: discovery hoàn tất (Phase 7/7). Tiếp tục? (Y/N)"
|
|
410
448
|
|
|
411
449
|
---
|
|
412
450
|
|
|
@@ -415,13 +453,52 @@ CHECKPOINT trước khi sinh: "Sinh PRD cho **{TICKET-ID} — {feature}** (domai
|
|
|
415
453
|
- **Áp dụng Terminology Map từ product-definition**: với mỗi cặp `thuật ngữ PO → thuật ngữ chuẩn` trong bảng **Chuẩn hoá thuật ngữ** (Phase 0 của product-definition), dùng **thuật ngữ chuẩn** khi viết PRD. Đây là bản đồ PO đã xác nhận ở discovery — luôn ưu tiên áp dụng kể cả khi business-dictionary.md vắng mặt, để PRD nhất quán với product-definition. Nếu bảng trống/không có → bỏ qua âm thầm.
|
|
416
454
|
- **Thay banned term**: thay mọi banned term bằng bản chuẩn tương đương (xem dictionary § Banned Terms).
|
|
417
455
|
- **Dùng canonical term**: chỉ dùng các thuật ngữ được định nghĩa trong dictionary.
|
|
418
|
-
- **NEW TERM DETECTION**: Nếu
|
|
456
|
+
- **NEW TERM DETECTION (lưới an toàn — define-product lẽ ra đã bắt ở discovery Phase 3)**: Nếu vẫn còn thuật ngữ trong input PO xuất hiện ≥2 lần và KHÔNG có trong dictionary → **DỪNG** và hỏi PO:
|
|
419
457
|
- Thuật ngữ đó nghĩa là gì trong ngữ cảnh hệ thống?
|
|
420
458
|
- English canonical term nên dùng là gì?
|
|
421
459
|
- Có cần bổ sung vào business-dictionary.md không?
|
|
422
460
|
Sau khi PO confirm → cập nhật `business-dictionary.md` (nếu đồng ý) → tiếp tục sinh.
|
|
423
461
|
- Nếu không có banned term và tất cả thuật ngữ đều chuẩn → tiếp tục không gián đoạn.
|
|
424
462
|
|
|
463
|
+
## Ngôn ngữ nghiệp vụ
|
|
464
|
+
# Business Language Guard — chặn thuật ngữ kỹ thuật rò vào tài liệu nghiệp vụ
|
|
465
|
+
|
|
466
|
+
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**.
|
|
467
|
+
|
|
468
|
+
> 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ó.
|
|
469
|
+
|
|
470
|
+
## Bản đồ xử lý (3 nhóm)
|
|
471
|
+
|
|
472
|
+
**Nhóm 1 — Tương tác/triển khai → DIỄN ĐẠT LẠI sang nghiệp vụ (giữ nguyên nghĩa):**
|
|
473
|
+
|
|
474
|
+
| Kỹ thuật/UI | Cách nói nghiệp vụ |
|
|
475
|
+
|---|---|
|
|
476
|
+
| re-render / render lại / reload / refresh (màn) | "hiển thị lại {tên màn}" |
|
|
477
|
+
| timeout | "quá thời gian chờ" |
|
|
478
|
+
| lỗi mạng / network error | "lỗi kết nối" |
|
|
479
|
+
| UI / giao diện (khi chỉ một màn) | "màn" / "màn hình" |
|
|
480
|
+
| click / tap | "bấm" / "chọn" |
|
|
481
|
+
| popup / modal (nếu chỉ là khái niệm hiển thị) | "hộp thoại" / "thông báo" |
|
|
482
|
+
| disable / enable (nút) | "khoá" / "mở" thao tác |
|
|
483
|
+
| redirect / navigate | "chuyển tới {màn}" |
|
|
484
|
+
|
|
485
|
+
**Nhóm 2 — Visual thuần → CHUYỂN Design Spec (bỏ khỏi PRD, ghi nhận lại):**
|
|
486
|
+
`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."*
|
|
487
|
+
|
|
488
|
+
**Nhóm 3 — Backend/contract thuần → BỎ khỏi PRD (thuộc Tech Docs):**
|
|
489
|
+
`API`, `endpoint`, `token/JWT`, `HTTP status`, tên class/bảng/cột DB, query, payload, header.
|
|
490
|
+
*(Ngoại lệ DUY NHẤT: Appendix "Existing API Contract" khi `API Source: existing` — xem Platform Strategy.)*
|
|
491
|
+
|
|
492
|
+
## Quy tắc áp dụng
|
|
493
|
+
- Quét toàn bộ text sắp ghi (User Story, AC, BR, Business Logic, Scope, Edge Cases, Assumptions…).
|
|
494
|
+
- 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).
|
|
495
|
+
- Nhóm 2 → gỡ khỏi prose nghiệp vụ + nhắc chuyển Design Spec.
|
|
496
|
+
- Nhóm 3 → gỡ khỏi PRD (trừ ngoại lệ brownfield).
|
|
497
|
+
- 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.
|
|
498
|
+
|
|
499
|
+
**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).
|
|
500
|
+
|
|
501
|
+
|
|
425
502
|
## Quy tắc Cross-Reference
|
|
426
503
|
|
|
427
504
|
Bất kỳ chỗ nào nhắc tới một TICKET-ID khác trong PRD (pre-condition, BR, ghi chú, appendix) → **PHẢI** là inline link. Mỗi PRD sống trong feature-package riêng (`{paths.specs_dir}/{domain}/{prd-slug-khác}/`), nên link trỏ sang folder anh em:
|
|
@@ -436,6 +513,12 @@ Không bao giờ để TICKET-ID dạng plain text nếu file PRD tương ứng
|
|
|
436
513
|
- **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).
|
|
437
514
|
- Ví dụ: UC1 → BR1, BR2; UC2 → BR3, BR4 (KHÔNG phải BR1, BR2 lại từ đầu).
|
|
438
515
|
|
|
516
|
+
## Traceability AC ↔ BR ↔ UC
|
|
517
|
+
|
|
518
|
+
- **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.
|
|
519
|
+
- **Điền "AC liên quan" cho mỗi UC §3 (chiều ngược):** với mỗi UC, liệt kê các AC mà nó thoả.
|
|
520
|
+
- **Nhất quán 2 chiều (bắt buộc):** tập "AC liên quan" của UC{n} phải **đúng bằng** tập AC có ref BR trỏ về UC{n}. Vì BR ID đã chứa số UC, hai chiều này suy ra lẫn nhau — lệch là lỗi traceability, sửa trước khi ghi.
|
|
521
|
+
|
|
439
522
|
---
|
|
440
523
|
|
|
441
524
|
## Platform Strategy — PRD là tài liệu nghiệp vụ (không technical)
|
|
@@ -443,6 +526,8 @@ Không bao giờ để TICKET-ID dạng plain text nếu file PRD tương ứng
|
|
|
443
526
|
PRD mô tả **WHAT** (yêu cầu nghiệp vụ) — không nhét chi tiết **kỹ thuật** (API, token, endpoint, HTTP status, tên class/bảng/cột DB, query). Những thứ đó thuộc **Tech Docs**.
|
|
444
527
|
PRD **được phép** có User Flow + Wireframe ở mức nghiệp vụ (§4) để BA/QC/Dev cùng hình dung; chỉ **chi tiết visual** (màu sắc, layout pixel, animation, micro-interaction) mới thuộc **Design Spec**.
|
|
445
528
|
|
|
529
|
+
> **Ngoại lệ DUY NHẤT (brownfield):** khi `API Source: existing`, Appendix "Existing API Contract" ĐƯỢC PHÉP chứa chi tiết kỹ thuật (method, path, request/response shape, HTTP status, error code) — vì đó là contract **đã tồn tại**, AI chỉ **trích as-is** làm input cho trước, KHÔNG phải thiết kế mới. Ngoại lệ này CHỈ áp cho riêng section đó; AC, BR, và toàn bộ thân PRD vẫn thuần nghiệp vụ.
|
|
530
|
+
|
|
446
531
|
| ✅ Viết trong PRD (nghiệp vụ) | ❌ KHÔNG viết trong PRD |
|
|
447
532
|
|---|---|
|
|
448
533
|
| "Đăng nhập thành công → truy cập được tính năng" | "API trả về JWT token" ← Tech Docs |
|
|
@@ -516,7 +601,7 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
516
601
|
| **Domain** | {domain} |
|
|
517
602
|
| **Created** | {date} |
|
|
518
603
|
| **Updated** | {date} |
|
|
519
|
-
| **
|
|
604
|
+
| **Ticket** | {TICKET}-{N}{ — nếu PO có link tracker thật, thêm bên cạnh: `{TICKET}-{N} ([Jira]({tracker_url}))`} |
|
|
520
605
|
| **API Source** | *(để trống nếu greenfield — chỉ điền `existing` khi PRD bọc một API đã chạy production)* |
|
|
521
606
|
|
|
522
607
|
---
|
|
@@ -546,13 +631,21 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
546
631
|
**Out of Scope** *(chỉ thêm khi có ranh giới cần nói rõ)*
|
|
547
632
|
- {hạng mục ngoài phạm vi + lý do / chủ sở hữu}
|
|
548
633
|
|
|
634
|
+
## c. Phụ thuộc liên service *(mức nghiệp vụ — KHÔNG mô tả API/event/kỹ thuật)*
|
|
635
|
+
|
|
636
|
+
> 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.
|
|
637
|
+
|
|
638
|
+
- {Cần {dữ liệu/năng lực} từ {feature/team/partner} — vì {lý do nghiệp vụ}} — hoặc "Không có"
|
|
639
|
+
|
|
549
640
|
---
|
|
550
641
|
|
|
551
642
|
# 2. Acceptance Criteria
|
|
552
643
|
|
|
553
|
-
|
|
644
|
+
> 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.
|
|
554
645
|
|
|
555
|
-
**
|
|
646
|
+
**AC1:** {Tiêu chí nghiệm thu, văn xuôi, kiểm chứng được.} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
647
|
+
|
|
648
|
+
**AC2:** {…} _(BR: {TICKET}-{N}-UC{n}-BR{m})_
|
|
556
649
|
|
|
557
650
|
---
|
|
558
651
|
|
|
@@ -570,6 +663,8 @@ Ghi `{paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md` theo cấu
|
|
|
570
663
|
**Post-condition:**
|
|
571
664
|
- {kết quả sau 1}
|
|
572
665
|
|
|
666
|
+
**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)*
|
|
667
|
+
|
|
573
668
|
**Business Rule**
|
|
574
669
|
|
|
575
670
|
| ID | Business Rule | Business Logic |
|
|
@@ -680,10 +775,14 @@ _(Nếu không có độ vênh: ghi "Không có — toàn bộ nội dung đã
|
|
|
680
775
|
|
|
681
776
|
- [ ] Mọi AC đều testable (pass/fail rõ ràng), không có chi tiết kỹ thuật (API/token/DB) hay visual chi tiết (màu sắc, font, animation)
|
|
682
777
|
- [ ] Mỗi UC có Actor / Description / Pre-condition / Post-condition
|
|
778
|
+
- [ ] §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
|
|
683
779
|
- [ ] Business Rule (WHAT) và Business Logic (HOW) nằm chung bảng 3 cột `ID | Business Rule | Business Logic`
|
|
684
780
|
- [ ] BR ID tăng liên tục trên toàn PRD — không reset theo từng UC
|
|
781
|
+
- [ ] **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 đó)
|
|
685
782
|
- [ ] Mọi cross-reference TICKET-ID đều là inline link `[TICKET-ID](./file.md)`
|
|
686
783
|
- [ ] Không có banned term (nếu dictionary tồn tại)
|
|
784
|
+
- [ ] **Ngôn ngữ nghiệp vụ**: 0 thuật ngữ kỹ thuật/UI trong prose (re-render→hiển thị lại, UI→màn, timeout→quá thời gian chờ…) — xem Business Language Guard
|
|
785
|
+
- [ ] **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õ
|
|
687
786
|
- [ ] User Flow có cả luồng lỗi / luồng ngoại lệ
|
|
688
787
|
- [ ] Wireframe phủ tất cả màn hình liên quan tới Use Case
|
|
689
788
|
- [ ] **Đị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
|
|
@@ -792,12 +891,14 @@ Next : {lệnh gợi ý kèm ví dụ tham số}
|
|
|
792
891
|
*(Bỏ dòng `Pipeline` cho các lệnh xuyên suốt liệt kê ở trên.)*
|
|
793
892
|
|
|
794
893
|
|
|
894
|
+
Ví dụ footer cho lệnh này:
|
|
895
|
+
|
|
795
896
|
```
|
|
796
|
-
/generate-prd Hoàn tất — {TICKET-ID}
|
|
797
897
|
---
|
|
798
|
-
Status
|
|
898
|
+
Status : ✅ Complete
|
|
799
899
|
Output Artifacts:
|
|
800
|
-
created {paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md
|
|
801
|
-
|
|
802
|
-
|
|
900
|
+
created {paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md (PRD v1.0)
|
|
901
|
+
Pipeline : Discovery → [PRD ◀ bạn ở đây] → Design Spec → BDD → Tech Design → Code → Dev Self-Check → QC → Trace Audit
|
|
902
|
+
Next : /refine-prd {paths.specs_dir}/{domain}/{prd-slug}/{TICKET-ID}-{prd-slug}.md
|
|
903
|
+
→ rồi /review-context {prd-file} ← kiểm tra chất lượng PRD trước khi sinh BDD
|
|
803
904
|
```
|