@educa-corp/fw 0.6.1 → 0.7.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/CHANGELOG.md +13 -0
- package/bin/fw.js +16 -0
- package/commands/prd.md +7 -6
- package/docs/guide/01-bat-dau.md +99 -0
- package/docs/guide/02-khai-niem.md +66 -0
- package/docs/guide/README.md +60 -0
- package/docs/guide/lenh/fw.md +51 -0
- package/docs/guide/lenh/prd-refine.md +83 -0
- package/docs/guide/lenh/prd.md +80 -0
- package/docs/guide/lenh/product.md +66 -0
- package/docs/guide/vai-tro/po-ba.md +28 -0
- package/docs/guide/xu-ly-su-co.md +34 -0
- package/package.json +2 -1
- package/ref/prd/lenses.md +78 -0
- package/ref/prd/refine.md +44 -0
- package/templates/prd-refine.md +29 -0
- package/templates/prd.md +1 -0
- package/tools/spec_edit.py +80 -7
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,19 @@
|
|
|
3
3
|
> `fw install` in các mục của những version mới hơn bản đang cài trong dự án.
|
|
4
4
|
> Mỗi lần sửa lệnh, khuôn, bộ câu hỏi hay công cụ đều phải tăng version và thêm một mục ở đây. Test sẽ báo lỗi nếu version chưa có mục.
|
|
5
5
|
|
|
6
|
+
## 0.7.0 — 2026-10-01
|
|
7
|
+
|
|
8
|
+
- Chế độ mới **`/prd <EPIC-ID> refine`**: rà nội dung PRD qua 4 lăng kính (QA · DEV · SA · Phạm vi). Mỗi lăng kính là một sub-agent **Opus**, sau đó một agent **kiểm chứng** loại bỏ finding không đứng vững. Bạn quyết từng finding: nhận, sửa, bác hoặc hoãn.
|
|
9
|
+
- Chống vòng lặp rà không dứt: **tối đa 2 lượt** cho mỗi version. Lượt 2 chỉ soi phần vừa sửa, chỉ báo critical hoặc lỗi do bản sửa. File `review/prd-refine.md` là **sổ quyết định**, điểm đã quyết không bị nêu lại.
|
|
10
|
+
- **Bắt buộc refine trước khi duyệt PRD**: `status=approved` bị chặn khi `refined` khác `version`, hoặc còn critical/major chưa quyết. Sau `/prd change` thì refine lại, và chỉ rà phần vừa đổi.
|
|
11
|
+
- `spec_edit upgrade` bổ sung các trường frontmatter còn thiếu so với khuôn mới (ví dụ `refined`).
|
|
12
|
+
- Lệnh rà hình thức (chính tả, trình bày) sẽ là `/review <file>`, bỏ tên `/review-context`.
|
|
13
|
+
|
|
14
|
+
## 0.6.2 — 2026-09-30
|
|
15
|
+
|
|
16
|
+
- **Hướng dẫn sử dụng** được cài vào dự án ở `.fw/guide/`, đúng với version đang dùng và đọc được khi không có mạng. Bắt đầu từ `.fw/guide/README.md`. Có thể hỏi Claude, ví dụ *"Đọc .fw/guide và cho biết cách đổi PRD"*.
|
|
17
|
+
- `fw install` tự thêm `.fw/backup/` vào `.gitignore`, để các bản sao file đã sửa không bị commit nhầm.
|
|
18
|
+
|
|
6
19
|
## 0.6.1 — 2026-09-30
|
|
7
20
|
|
|
8
21
|
- Thuật ngữ: **Acceptance Criteria (điều kiện nghiệm thu)**, viết tắt AC, thay cho "tiêu chí chấp nhận". **Business Rule (BR)** thay cho "rule". Cột "Logic" của bảng BR đổi thành **Business Logic**.
|
package/bin/fw.js
CHANGED
|
@@ -26,11 +26,13 @@ const SOURCES = [
|
|
|
26
26
|
{ from: 'templates', to: '.fw/core/templates' },
|
|
27
27
|
{ from: 'tools', to: '.fw/core/tools' },
|
|
28
28
|
{ from: 'bin/fw.js', to: '.fw/core/bin/fw.js' },
|
|
29
|
+
{ from: 'docs/guide', to: '.fw/guide' },
|
|
29
30
|
];
|
|
30
31
|
// Mọi file gói npm phải mang theo để fw.js chạy được — test đối chiếu với `files` của package.json.
|
|
31
32
|
const RUNTIME_FILES = ['package.json', 'CHANGELOG.md', 'bin/config.template.yaml', ...SOURCES.map((s) => s.from)];
|
|
32
33
|
const CONFIG = '.fw/config.yaml';
|
|
33
34
|
const SETTINGS = '.claude/settings.json';
|
|
35
|
+
const GITIGNORE_LINE = '.fw/backup/';
|
|
34
36
|
|
|
35
37
|
// Lệnh AI dùng để sửa file spec (xem tools/spec_edit.py). Cho phép sẵn để PO không bị hỏi quyền mỗi lần.
|
|
36
38
|
const SPEC_EDIT = '.fw/core/tools/spec_edit.py';
|
|
@@ -98,6 +100,18 @@ function allowSpecEdit(target) {
|
|
|
98
100
|
return { added };
|
|
99
101
|
}
|
|
100
102
|
|
|
103
|
+
// .fw/backup/ chứa bản sao file người dùng đã sửa, giữ lại khi nâng cấp — không nên vào git.
|
|
104
|
+
function ignoreBackup(target) {
|
|
105
|
+
const p = path.join(target, '.gitignore');
|
|
106
|
+
const text = fs.existsSync(p) ? fs.readFileSync(p, 'utf8') : '';
|
|
107
|
+
const lines = text.split(/\r?\n/).map((l) => l.trim());
|
|
108
|
+
if (lines.includes(GITIGNORE_LINE) || lines.includes('/' + GITIGNORE_LINE)) return false;
|
|
109
|
+
const sep = text && !text.endsWith('\n') ? '\n' : '';
|
|
110
|
+
const block = '\n# @educa-corp/fw — bản sao file đã sửa, tạo khi nâng cấp\n' + GITIGNORE_LINE + '\n';
|
|
111
|
+
fs.writeFileSync(p, text + sep + block);
|
|
112
|
+
return true;
|
|
113
|
+
}
|
|
114
|
+
|
|
101
115
|
function install(target) {
|
|
102
116
|
const old = readManifest(target);
|
|
103
117
|
const stamp = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
|
|
@@ -163,6 +177,7 @@ function install(target) {
|
|
|
163
177
|
changes: changesSince(old.version),
|
|
164
178
|
python: findPython(),
|
|
165
179
|
permissions: allowSpecEdit(target),
|
|
180
|
+
gitignore: ignoreBackup(target),
|
|
166
181
|
};
|
|
167
182
|
}
|
|
168
183
|
|
|
@@ -193,6 +208,7 @@ function printReport(r) {
|
|
|
193
208
|
}
|
|
194
209
|
console.log(` thêm ${r.added.length} · cập nhật ${r.updated.length} · gỡ ${r.removed.length}`);
|
|
195
210
|
if (r.configCreated) console.log(` tạo ${CONFIG} — hãy mở file này và khai specs, tracker, units`);
|
|
211
|
+
if (r.gitignore) console.log(` thêm ${GITIGNORE_LINE} vào .gitignore`);
|
|
196
212
|
if (r.permissions.error) console.log(` ⚠ ${r.permissions.error}`);
|
|
197
213
|
else if (r.permissions.added.length) console.log(` thêm ${r.permissions.added.length} luật cho phép vào ${SETTINGS} (AI sửa spec không phải hỏi quyền)`);
|
|
198
214
|
if (r.python) {
|
package/commands/prd.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
-
description: Viết PRD
|
|
3
|
-
argument-hint: "<EPIC-ID> [change <mô tả thay đổi>] [--force]"
|
|
2
|
+
description: Viết PRD từ epic đã làm rõ (EPIC-ID), rà nội dung PRD (EPIC-ID refine), hoặc đổi PRD (EPIC-ID change)
|
|
3
|
+
argument-hint: "<EPIC-ID> [refine | change <mô tả thay đổi>] [--force]"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# /prd
|
|
@@ -29,9 +29,10 @@ Nếu **trước lệnh này** phiên đã có hội thoại khác, dòng đầu
|
|
|
29
29
|
|---|---|
|
|
30
30
|
| Không có `change`, chưa có `D`, epic `ready` | Chế độ **tạo**: đọc `.fw/core/ref/prd/new.md` |
|
|
31
31
|
| Không có `change`, chưa có `D`, epic **chưa** `ready` | Dừng: *"EP-xx chưa làm rõ xong. Chạy `/product EP-xx` trước."* Có `--force` thì làm tiếp, nhưng in cảnh báo, ghi vào mục 4 của PRD dòng *"Tạo khi epic chưa ready (--force)"*, và không cho `approved` khi epic còn câu hỏi mở |
|
|
32
|
-
| Không có `change`, **đã có** `D` | Dừng: *"PRD đã có.
|
|
32
|
+
| Không có `change` / `refine`, **đã có** `D` | Dừng: *"PRD đã có. Rà nội dung: `/prd EP-xx refine` · Đổi: `/prd EP-xx change <mô tả>`."* Không ghi đè |
|
|
33
|
+
| Có `refine`, đã có `D` | Chế độ **rà nội dung**: đọc `.fw/core/ref/prd/refine.md` |
|
|
33
34
|
| Có `change`, đã có `D` | Chế độ **đổi**: đọc `.fw/core/ref/prd/change.md` |
|
|
34
|
-
| Có `change`, chưa có `D` | Dừng: *"Chưa có PRD. Chạy `/prd EP-xx` trước."* |
|
|
35
|
+
| Có `change` hoặc `refine`, chưa có `D` | Dừng: *"Chưa có PRD. Chạy `/prd EP-xx` trước."* |
|
|
35
36
|
|
|
36
37
|
## Bước 3 — Luật chung
|
|
37
38
|
|
|
@@ -46,7 +47,7 @@ Nếu **trước lệnh này** phiên đã có hội thoại khác, dòng đầu
|
|
|
46
47
|
- `SE pending <file>` · `SE confirm <file> UC-003-BR02 UC-003-AC01` · `SE next-uc {specs}` · `SE coverage <epic> <prd>`
|
|
47
48
|
- Đọc **một mục**: `SE section <file> <mã>`. Mã mục là `<!-- sec:… -->` ở tiêu đề (vd `constraints`, `usecases`, `open`). **Luôn tìm mục theo mã**, không theo số hay tên tiêu đề, không tự cắt file bằng `sed`/`grep`. Khi sửa, giữ nguyên `<!-- sec:… -->`.
|
|
48
49
|
- `SE` báo lỗi thì **không có gì được ghi**. Đọc lại file, sửa lệnh rồi chạy lại. Không bỏ qua lỗi. Lỗi mà **không in dòng nào** là Python chưa kịp chạy: chạy lại đúng lệnh đó một lần.
|
|
49
|
-
7. **Duyệt.** `status=approved` chỉ đặt được khi không còn `🤖`, `open_questions=0`, và có người duyệt. Hỏi PO *"Ai duyệt PRD này?"* (mặc định là PO của epic), rồi đặt trong **một** lệnh: `SE set D status=approved approved_by=<tên> approved_at=YYYY-MM-DD`. `SE` tự chặn nếu chưa đủ. Không tìm cách lách.
|
|
50
|
+
7. **Duyệt.** `status=approved` chỉ đặt được khi không còn `🤖`, `open_questions=0`, **đã refine đúng version này** (`refined` = `version`, không còn critical/major chưa quyết), và có người duyệt. Chưa refine thì báo *"Chạy `/prd EP-xx refine` trước khi duyệt."* Hỏi PO *"Ai duyệt PRD này?"* (mặc định là PO của epic), rồi đặt trong **một** lệnh: `SE set D status=approved approved_by=<tên> approved_at=YYYY-MM-DD`. `SE` tự chặn nếu chưa đủ. Không tìm cách lách.
|
|
50
51
|
|
|
51
52
|
## Bước 4 — Kết thúc
|
|
52
53
|
|
|
@@ -58,5 +59,5 @@ Trạng thái : {✅ Đã duyệt v{version} | 🟡 Nháp v{version} — còn {n
|
|
|
58
59
|
Đã ghi : {D} {· epic → handed-off · product.md nếu có}
|
|
59
60
|
Kiểm : coverage {đủ | thiếu …} · {số UC} UC · {số BR} BR · {số AC} AC
|
|
60
61
|
Luồng : Product → [PRD ◀ bạn ở đây] → BDD → TDD · Design-spec → Code → Test → QC
|
|
61
|
-
Bước tiếp : {/bdd UC-xxx | trả lời / xác nhận các mục trên
|
|
62
|
+
Bước tiếp : {`/clear` rồi `/prd {id} refine` | /bdd UC-xxx | trả lời / xác nhận các mục trên}
|
|
62
63
|
```
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
[← Hướng dẫn](README.md)
|
|
2
|
+
|
|
3
|
+
# Bắt đầu
|
|
4
|
+
|
|
5
|
+
## 1. Máy cần có
|
|
6
|
+
|
|
7
|
+
| Phần mềm | Bản | Kiểm tra | Cài |
|
|
8
|
+
|---|---|---|---|
|
|
9
|
+
| Node.js | 18 trở lên | `node --version` | https://nodejs.org |
|
|
10
|
+
| Python | 3.8 trở lên | `python --version` | Windows: `winget install Python.Python.3.12` · macOS: `brew install python` |
|
|
11
|
+
| Claude Code | — | `claude --version` | https://claude.com/claude-code |
|
|
12
|
+
|
|
13
|
+
**Vì sao cần Python:** AI sửa tài liệu spec qua một công cụ viết bằng Python. Công cụ này chặn các lỗi như sửa không trúng chỗ, hỏng chữ có dấu. Thiếu Python thì mọi lệnh AI sẽ dừng ngay và báo cài.
|
|
14
|
+
|
|
15
|
+
**Windows:** nên cài Python bằng `winget` như trên (bản python.org). Bản cài từ Microsoft Store thỉnh thoảng thoát lỗi mà không chạy. Lệnh AI tự chạy lại được, nhưng bản python.org ổn định hơn.
|
|
16
|
+
|
|
17
|
+
## 2. Cài vào dự án
|
|
18
|
+
|
|
19
|
+
Mở terminal **ở thư mục gốc của dự án**. Với dự án kiểu umbrella, đó là thư mục chứa các repo con.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx @educa-corp/fw install
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Kết quả mẫu:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
fw 0.6.2 — đã cài
|
|
29
|
+
thêm 20 · cập nhật 0 · gỡ 0
|
|
30
|
+
tạo .fw/config.yaml — hãy mở file này và khai specs, tracker, units
|
|
31
|
+
thêm .fw/backup/ vào .gitignore
|
|
32
|
+
thêm 3 luật cho phép vào .claude/settings.json (AI sửa spec không phải hỏi quyền)
|
|
33
|
+
Python: python
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Lệnh tạo ra:
|
|
37
|
+
|
|
38
|
+
| Thư mục / file | Là gì | Commit vào git? |
|
|
39
|
+
|---|---|---|
|
|
40
|
+
| `.claude/commands/` | Các lệnh `/product`, `/prd`… | ✅ Có |
|
|
41
|
+
| `.claude/settings.json` | Quyền cho AI sửa spec mà không hỏi mỗi lần | ✅ Có |
|
|
42
|
+
| `.fw/core/` | Bộ câu hỏi, khuôn tài liệu, công cụ sửa spec, bản `fw` chạy offline | ✅ Có |
|
|
43
|
+
| `.fw/config.yaml` | **Cấu hình của dự án. Bạn được sửa** | ✅ Có |
|
|
44
|
+
| `.fw/guide/` | Bộ hướng dẫn này, đúng với version đang cài | ✅ Có |
|
|
45
|
+
| `.fw/backup/` | Bản sao file bạn đã tự sửa, được giữ lại khi nâng cấp | ❌ Không. `fw install` đã tự thêm vào `.gitignore` |
|
|
46
|
+
|
|
47
|
+
Commit xong, đồng đội clone về là **có ngay**, không cần tự cài.
|
|
48
|
+
|
|
49
|
+
## 3. Khai cấu hình
|
|
50
|
+
|
|
51
|
+
Mở `.fw/config.yaml`:
|
|
52
|
+
|
|
53
|
+
```yaml
|
|
54
|
+
workspace: LMS
|
|
55
|
+
|
|
56
|
+
# Thư mục chứa mọi tài liệu (product, PRD, …). Umbrella: trỏ vào repo spec, ví dụ spec-repo/specs
|
|
57
|
+
specs: specs
|
|
58
|
+
|
|
59
|
+
# [jira] | [builtin] | [jira, builtin]
|
|
60
|
+
tracker: [builtin]
|
|
61
|
+
|
|
62
|
+
# Mỗi unit là một codebase build/deploy độc lập
|
|
63
|
+
units: []
|
|
64
|
+
# - { name: web-phuhuynh, path: apps/parent-web, stack: react }
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
| Trường | Cần khai lúc nào |
|
|
68
|
+
|---|---|
|
|
69
|
+
| `specs` | **Ngay.** Mọi tài liệu sẽ được ghi vào thư mục này |
|
|
70
|
+
| `tracker` | **Ngay.** `builtin` thì AI tự đánh mã epic `EP-01`, `EP-02`…. `jira` thì AI hỏi Jira key (ví dụ `EDU-100`) |
|
|
71
|
+
| `units` | Chưa cần. Các lệnh hiện có chưa dùng tới trường này. Khai sẵn cũng được |
|
|
72
|
+
|
|
73
|
+
## 4. Chạy lần đầu
|
|
74
|
+
|
|
75
|
+
Mở Claude Code ở thư mục gốc dự án rồi gõ:
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
/product
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
AI sẽ hỏi về sản phẩm theo từng lượt, tối đa 4 câu mỗi lượt. Có sẵn tài liệu (BRD, đề án, slide) thì dán vào, AI sẽ trích trước để bạn chỉ cần xác nhận. Chi tiết xem [hướng dẫn /product](lenh/product.md).
|
|
82
|
+
|
|
83
|
+
Một vòng làm việc đầy đủ:
|
|
84
|
+
|
|
85
|
+
| # | Gõ | Kết quả |
|
|
86
|
+
|---|---|---|
|
|
87
|
+
| 1 | `/product` | `specs/product/product.md`: nhóm người dùng, danh sách epic |
|
|
88
|
+
| 2 | `/clear` → `/product EP-01` | File làm rõ yêu cầu của EP-01 |
|
|
89
|
+
| 3 | `/clear` → `/prd EP-01` | `specs/{domain}/{slug}/prd.md` |
|
|
90
|
+
| 4 | Khi cần đổi: `/clear` → `/prd EP-01 change khoá tài khoản sau 3 lần sai` | PRD lên version mới |
|
|
91
|
+
|
|
92
|
+
## 5. Nâng cấp
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
npx @educa-corp/fw upgrade # lên bản mới nhất
|
|
96
|
+
npx @educa-corp/fw upgrade 0.7.0 # lên đúng một version
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
Lệnh in ra version cũ → mới kèm danh sách thay đổi. File bạn đã tự sửa trong `.claude/commands/` hay `.fw/core/` sẽ được **sao lưu vào `.fw/backup/`** trước khi bị thay. `config.yaml` **không bao giờ** bị ghi đè. Chi tiết: [fw](lenh/fw.md).
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
[← Hướng dẫn](README.md)
|
|
2
|
+
|
|
3
|
+
# Khái niệm
|
|
4
|
+
|
|
5
|
+
Chỉ những khái niệm bạn **gặp khi dùng** các lệnh hiện có.
|
|
6
|
+
|
|
7
|
+
## Ba tầng tài liệu
|
|
8
|
+
|
|
9
|
+
| Tầng | Trả lời câu hỏi | Lệnh | File |
|
|
10
|
+
|---|---|---|---|
|
|
11
|
+
| **Sản phẩm** | Sản phẩm cho ai, gồm những tính năng lớn nào? | `/product` | `specs/product/product.md` |
|
|
12
|
+
| **Epic** (làm rõ yêu cầu) | Tính năng này thật ra cần gì? Còn chỗ nào chưa rõ? | `/product EP-01` | `specs/product/epics/EP-01-….md` |
|
|
13
|
+
| **PRD** | Đặc tả chính thức để làm BDD, thiết kế và code | `/prd EP-01` | `specs/{domain}/{slug}/prd.md` |
|
|
14
|
+
|
|
15
|
+
**Epic là nháp, PRD là bản chính thức.** Khi PRD được tạo, epic chuyển sang `handed-off` và chỉ còn là lịch sử quyết định. Muốn đổi yêu cầu thì sửa PRD, **không sửa epic**.
|
|
16
|
+
|
|
17
|
+
## Thuật ngữ
|
|
18
|
+
|
|
19
|
+
| Thuật ngữ | Nghĩa | Ví dụ |
|
|
20
|
+
|---|---|---|
|
|
21
|
+
| **Actor** (nhóm người dùng) | Nhóm người trực tiếp dùng hệ thống, mã `ACT-01`… | ACT-01 Admin |
|
|
22
|
+
| **Epic** | Một nhóm tính năng lớn của sản phẩm | EP-01 Quản trị tài khoản và phân quyền |
|
|
23
|
+
| **UC** (Use case) | Một mục tiêu của một actor, xong trong một lần tương tác | UC-005 Đổi mật khẩu và quên mật khẩu |
|
|
24
|
+
| **BR** (Business Rule) | Luật nghiệp vụ hệ thống phải tuân theo, dạng *"Hệ thống PHẢI / KHÔNG ĐƯỢC …"* | UC-001-BR01: Email PHẢI bắt buộc và duy nhất |
|
|
25
|
+
| **Business Logic** | Cách luật được thực hiện: rẽ nhánh, công thức, thông báo khi lỗi | Email trống hoặc đã có tài khoản → từ chối, báo lý do |
|
|
26
|
+
| **AC** (Acceptance Criteria, điều kiện nghiệm thu) | Điều kiện kiểm được là đạt hay không đạt, dạng *"Khi … thì …"* | UC-002-AC01: Khi tài khoản mới quá 7 ngày chưa đăng nhập thì bị chuyển inactive, đăng nhập bị từ chối |
|
|
27
|
+
| **Ràng buộc** | Điều kiện áp cho **mọi epic**, mã `CON-01`… | CON-01: Audit log không được xoá hay sửa |
|
|
28
|
+
| **Checkpoint** | Một điểm dừng để bạn chốt. `/product` có 2 (sản phẩm) hoặc 3 (epic) checkpoint | — |
|
|
29
|
+
|
|
30
|
+
## Mã ổn định
|
|
31
|
+
|
|
32
|
+
| Đối tượng | Mã | Đánh số |
|
|
33
|
+
|---|---|---|
|
|
34
|
+
| UC | `UC-001` | Toàn sản phẩm, mọi epic dùng chung một dãy |
|
|
35
|
+
| Business Rule trong PRD | `UC-003-BR02` | Trong từng UC |
|
|
36
|
+
| AC trong PRD | `UC-003-AC04` | Trong từng UC |
|
|
37
|
+
| Business Rule / AC trong epic | `BR1.`, `AC1.` | Trong epic. Chèn giữa thì dùng `BR8a.` |
|
|
38
|
+
|
|
39
|
+
**Mã đã cấp không bao giờ đổi và không dùng lại.** Mục bỏ đi được giữ lại, gạch ngang và ghi *"Đã bỏ (v1.1)"*. Nhờ vậy BDD, code và test sau này luôn trỏ đúng mục.
|
|
40
|
+
|
|
41
|
+
## Dấu 🤖 và ✅
|
|
42
|
+
|
|
43
|
+
| Dấu | Nghĩa |
|
|
44
|
+
|---|---|
|
|
45
|
+
| 🤖 | AI trích hoặc tự thêm, **chờ bạn chốt** |
|
|
46
|
+
| ✅ | Bạn đã xác nhận |
|
|
47
|
+
|
|
48
|
+
Cách xác nhận: trả lời như bình thường (*"Đúng"*, *"OK"*), hoặc xác nhận theo mã (*"OK UC-003-BR04, UC-003-AC02"*).
|
|
49
|
+
|
|
50
|
+
Tài liệu chỉ được đặt trạng thái "xong" (`ready` hoặc `approved`) khi **không còn 🤖**, **không còn câu hỏi mở**, và **đã ghi người duyệt**. Công cụ sẽ tự chặn nếu chưa đủ, AI không lách được.
|
|
51
|
+
|
|
52
|
+
## Nguồn của từng mục trong PRD
|
|
53
|
+
|
|
54
|
+
Mỗi Business Rule và AC trong PRD ghi rõ nó lấy từ đâu, và **chỉ ghi mã**:
|
|
55
|
+
|
|
56
|
+
| Ghi | Nghĩa |
|
|
57
|
+
|---|---|
|
|
58
|
+
| `(nguồn: BR3, AC1)` | Lấy từ BR3 và AC1 của epic |
|
|
59
|
+
| `(nguồn: CON-02)` | Lấy từ ràng buộc CON-02 của tầng sản phẩm |
|
|
60
|
+
| `(nguồn: PRD)` | Thêm trong lúc viết PRD, bạn đã duyệt |
|
|
61
|
+
|
|
62
|
+
Nhờ vậy công cụ kiểm được **mọi BR và AC của epic đều đã vào PRD**, không rơi mục nào.
|
|
63
|
+
|
|
64
|
+
## Vì sao phải `/clear`
|
|
65
|
+
|
|
66
|
+
Mỗi lượt hỏi-đáp, AI đọc lại **toàn bộ** hội thoại từ đầu phiên. Phiên càng dài thì mỗi lượt càng đắt. Đo thực tế: chạy tiếp trong phiên cũ đắt hơn khoảng **56%** mỗi lượt. Mọi thứ đã chốt đều nằm trong file, nên mở phiên mới **không mất gì**. Lệnh sẽ nhắc bạn đúng lúc nên `/clear`.
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Hướng dẫn sử dụng `@educa-corp/fw`
|
|
2
|
+
|
|
3
|
+
> Framework làm việc với Claude Code: đưa một tính năng đi từ **ý tưởng → làm rõ yêu cầu → PRD → …**, AI hỏi và viết, con người xác nhận ở mỗi bước.
|
|
4
|
+
> Hướng dẫn này viết cho **bản 0.7.0**. Chỉ mô tả những lệnh **đã có**. Lệnh mới có thì hướng dẫn mới được bổ sung.
|
|
5
|
+
> Trong dự án đã cài framework, bản hướng dẫn đúng với version đang dùng nằm ở **`.fw/guide/`**. Có thể hỏi Claude: *"Đọc .fw/guide và cho biết cách đổi PRD"*.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Bạn muốn…
|
|
10
|
+
|
|
11
|
+
| Bạn muốn | Đọc |
|
|
12
|
+
|---|---|
|
|
13
|
+
| Cài vào dự án và chạy lần đầu | [Bắt đầu](01-bat-dau.md) |
|
|
14
|
+
| Hiểu vài khái niệm trước khi dùng (UC, BR, AC, 🤖/✅…) | [Khái niệm](02-khai-niem.md) |
|
|
15
|
+
| Biết **vai trò của mình** dùng lệnh nào | [PO / BA](vai-tro/po-ba.md) · *Dev, QC: sắp có* |
|
|
16
|
+
| Tra cứu một lệnh cụ thể | Bảng lệnh ngay bên dưới |
|
|
17
|
+
| Gặp lỗi | [Xử lý sự cố](xu-ly-su-co.md) |
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Pipeline hiện có
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
cài framework ──► /product ──► /product EP-xx ──► /prd EP-xx ──► /prd EP-xx refine ──► duyệt ┄┄► (/bdd — sắp có)
|
|
25
|
+
tầng làm rõ một viết PRD rà nội dung
|
|
26
|
+
sản phẩm tính năng ▲ │ (bắt buộc)
|
|
27
|
+
└── /prd EP-xx change ◄──┘ đổi PRD thì refine lại
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Mỗi lệnh kết thúc bằng một khối giống nhau. Bạn chỉ cần đọc dòng **Bước tiếp**:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
---
|
|
34
|
+
Trạng thái : 🟡 Đang làm rõ — checkpoint 1/3, còn 2 câu hỏi mở
|
|
35
|
+
Đã ghi : specs/product/epics/EP-01-quan-tri-tai-khoan-va-phan-quyen.md
|
|
36
|
+
Luồng : [Product ◀ bạn ở đây] → PRD → BDD → TDD · Design-spec → Code → Test → QC
|
|
37
|
+
Bước tiếp : `/clear` rồi `/product EP-01`
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Bảng lệnh
|
|
43
|
+
|
|
44
|
+
| Lệnh | Ai | Làm gì | Hướng dẫn |
|
|
45
|
+
|---|---|---|---|
|
|
46
|
+
| `npx @educa-corp/fw install` | Người cài dự án | Cài framework vào dự án (một lần) | [fw](lenh/fw.md) |
|
|
47
|
+
| `npx @educa-corp/fw upgrade [version]` | Người phụ trách dự án | Nâng cấp framework | [fw](lenh/fw.md) |
|
|
48
|
+
| `/product` | PO / BA | Làm rõ **tầng sản phẩm**: tầm nhìn, nhóm người dùng, danh sách epic, ràng buộc | [/product](lenh/product.md) |
|
|
49
|
+
| `/product <EPIC-ID>` | PO / BA | **Làm rõ yêu cầu** một tính năng trước khi viết PRD | [/product](lenh/product.md) |
|
|
50
|
+
| `/prd <EPIC-ID>` | PO / BA | Viết **PRD chính thức** từ epic đã làm rõ | [/prd](lenh/prd.md) |
|
|
51
|
+
| `/prd <EPIC-ID> refine` | PO / BA | **Rà nội dung** PRD qua 4 lăng kính. **Bắt buộc** trước khi duyệt | [/prd refine](lenh/prd-refine.md) |
|
|
52
|
+
| `/prd <EPIC-ID> change <mô tả>` | PO / BA | Thêm, sửa hoặc bỏ nội dung PRD | [/prd](lenh/prd.md) |
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Ba điều nên nhớ
|
|
57
|
+
|
|
58
|
+
1. **AI đề xuất, bạn xác nhận.** Mục AI tự trích hoặc tự thêm mang dấu 🤖. Chỉ khi bạn đồng ý thì nó mới thành ✅. Không có gì được coi là "đã chốt" nếu bạn chưa xác nhận.
|
|
59
|
+
2. **Mọi thứ đã chốt đều nằm trong file.** Vì vậy bạn dừng lúc nào cũng được, và nên **`/clear` giữa các bước** để phiên mới rẻ hơn.
|
|
60
|
+
3. **Mã không bao giờ đổi.** `UC-003-BR02` hôm nay và sau 10 lần sửa vẫn là cùng một Business Rule. Mục bỏ đi thì gạch ngang, không bị xoá.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
[← Hướng dẫn](../README.md) · [Bảng lệnh](../README.md#bảng-lệnh)
|
|
2
|
+
|
|
3
|
+
# `fw` — cài và nâng cấp framework
|
|
4
|
+
|
|
5
|
+
> Lệnh chạy ở **terminal**, không chạy trong Claude Code, và không tốn token.
|
|
6
|
+
|
|
7
|
+
| Lệnh | Làm gì |
|
|
8
|
+
|---|---|
|
|
9
|
+
| `npx @educa-corp/fw install` | Cài framework vào dự án. Chạy **một lần**, ở thư mục gốc dự án |
|
|
10
|
+
| `npx @educa-corp/fw upgrade` | Nâng cấp lên bản mới nhất |
|
|
11
|
+
| `npx @educa-corp/fw upgrade 0.7.0` | Nâng cấp (hoặc quay về) đúng một version |
|
|
12
|
+
| `node .fw/core/bin/fw.js --version` | Xem dự án đang dùng bản nào |
|
|
13
|
+
|
|
14
|
+
> ⚠️ Luôn gõ **tên đầy đủ** `@educa-corp/fw`. Trên npm có một gói khác tên `fw` của người khác, gõ `npx fw` sẽ tải nhầm gói đó.
|
|
15
|
+
|
|
16
|
+
## `install` làm những gì
|
|
17
|
+
|
|
18
|
+
1. Tải framework từ npm.
|
|
19
|
+
2. Chép vào dự án: lệnh vào `.claude/commands/`; bộ câu hỏi, khuôn, công cụ sửa spec và **một bản `fw` chạy offline** vào `.fw/core/`; **hướng dẫn sử dụng** vào `.fw/guide/`.
|
|
20
|
+
3. Tạo `.fw/config.yaml` nếu chưa có. File này **không bao giờ** bị ghi đè.
|
|
21
|
+
4. Thêm quyền vào `.claude/settings.json` để AI sửa file spec mà không hỏi mỗi lần. Cấu hình khác trong file giữ nguyên.
|
|
22
|
+
5. Thêm `.fw/backup/` vào `.gitignore` (nếu chưa có).
|
|
23
|
+
6. Kiểm Python. Thiếu thì báo ❌ kèm lệnh cài.
|
|
24
|
+
|
|
25
|
+
Bản `fw` chạy offline trong `.fw/core/bin/` có hai tác dụng: các việc tự động sau này (hook khi commit, CI) chạy **không cần mạng**, và luôn **đúng version** đã commit trong repo.
|
|
26
|
+
|
|
27
|
+
## `upgrade` làm những gì
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
fw 0.6.0 → 0.6.1 — đã nâng cấp
|
|
31
|
+
Có gì mới:
|
|
32
|
+
- Thuật ngữ: Acceptance Criteria (điều kiện nghiệm thu) …
|
|
33
|
+
thêm 0 · cập nhật 9 · gỡ 0
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
| Tình huống | Kết quả |
|
|
37
|
+
|---|---|
|
|
38
|
+
| File framework bạn **chưa** sửa | Thay bằng bản mới |
|
|
39
|
+
| File framework bạn **đã tự sửa** | Sao lưu vào `.fw/backup/<ngày giờ>/` rồi mới thay, và báo tên file |
|
|
40
|
+
| File bản mới **bỏ đi** | Gỡ, nếu bạn chưa sửa. Đã sửa thì giữ lại và báo |
|
|
41
|
+
| Lệnh có sẵn trong dự án **trùng tên** lệnh framework | Sao lưu trước khi thay |
|
|
42
|
+
| `.fw/config.yaml` | Không đụng tới |
|
|
43
|
+
|
|
44
|
+
Nâng cấp xong, commit các thay đổi để cả team cùng dùng bản mới.
|
|
45
|
+
|
|
46
|
+
## Muốn giữ thay đổi riêng của dự án
|
|
47
|
+
|
|
48
|
+
Đừng sửa file trong `.claude/commands/` hay `.fw/core/`, vì lần nâng cấp sau sẽ thay chúng (dù có sao lưu). Chỗ đúng để đặt thay đổi riêng:
|
|
49
|
+
- `.fw/config.yaml`: cấu hình dự án.
|
|
50
|
+
- `specs/product/glossary.md`: thuật ngữ của dự án.
|
|
51
|
+
- Góp ý để sửa trong chính framework, rồi nâng cấp.
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
[← Hướng dẫn](../README.md) · [Bảng lệnh](../README.md#bảng-lệnh) · [/prd](prd.md)
|
|
2
|
+
|
|
3
|
+
# `/prd EP-01 refine` — rà nội dung PRD
|
|
4
|
+
|
|
5
|
+
> AI rà PRD qua **4 lăng kính** để tìm chỗ nghiệp vụ còn thiếu, mơ hồ hoặc mâu thuẫn, tức những chỗ sẽ làm dev hay QC làm sai hoặc phải đoán. **Bắt buộc**: chưa refine thì không duyệt được PRD.
|
|
6
|
+
> Không rà chính tả hay cách trình bày. Việc đó là của `/review` *(sắp có)*.
|
|
7
|
+
|
|
8
|
+
| | |
|
|
9
|
+
|---|---|
|
|
10
|
+
| **Gõ** | `/prd EP-01 refine` |
|
|
11
|
+
| **Ai** | PO / BA |
|
|
12
|
+
| **Cần có trước** | PRD đã có |
|
|
13
|
+
| **Số lượt rà** | Tối đa **2** cho mỗi version PRD |
|
|
14
|
+
| **Ghi ra** | `specs/{domain}/{slug}/review/prd-refine.md` · PRD nhận các bản sửa bạn đã chấp nhận |
|
|
15
|
+
| **Bước tiếp** | Duyệt PRD |
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## 4 lăng kính
|
|
20
|
+
|
|
21
|
+
| Lăng kính | Soi | Ví dụ finding |
|
|
22
|
+
|---|---|---|
|
|
23
|
+
| **QA** | AC có kiểm được là đạt hay không? AC có lặp lại BR không? | *"UC-002-AC03 nói 'hiển thị thông báo phù hợp' — không kiểm được"* |
|
|
24
|
+
| **DEV** | BR và Business Logic có đủ để làm mà không phải đoán? Nhánh thiếu, điều kiện biên, xử lý khi lỗi, BR mâu thuẫn | *"Gửi email đặt lại mật khẩu thất bại thì sao?"* |
|
|
25
|
+
| **SA** | Các UC có thông suốt, nhất quán? Trạng thái, vòng đời của đối tượng; ai được làm gì | *"UC-002 cho Admin khoá tài khoản, nhưng UC-009 tự tạo tài khoản không nói trạng thái ban đầu"* |
|
|
26
|
+
| **Phạm vi** | PRD có vượt ngoài phạm vi epic, đi ngược ràng buộc `CON-xx`, hay giẫm lên epic khác không? | *"UC-009 xử lý đơn hàng CRM — thuộc EP-03"* |
|
|
27
|
+
|
|
28
|
+
*(Các ví dụ trên là ví dụ minh hoạ.)*
|
|
29
|
+
|
|
30
|
+
Mỗi lăng kính là một agent riêng, chạy song song, **bắt buộc dùng model Opus**. Sau đó có thêm **một agent kiểm chứng**, nhiệm vụ duy nhất là **cố chứng minh từng finding là sai** bằng cách tra lại PRD. Finding nào không đứng vững thì bị bỏ. Đây là lớp chặn chính đối với các finding do AI ảo giác.
|
|
31
|
+
|
|
32
|
+
## Mức độ
|
|
33
|
+
|
|
34
|
+
| Mức | Nghĩa | Có chặn duyệt không |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| `critical` | Không sửa thì sẽ **làm sai** hoặc không làm được | Có, cho tới khi bạn quyết |
|
|
37
|
+
| `major` | Không sửa thì người làm **phải đoán** | Có, cho tới khi bạn quyết |
|
|
38
|
+
| `minor` | Làm rõ thêm cho dễ đọc, không đổi hành vi | Không |
|
|
39
|
+
|
|
40
|
+
## Bạn quyết thế nào
|
|
41
|
+
|
|
42
|
+
AI trình bảng tóm tắt. Chi tiết từng finding nằm trong `review/prd-refine.md`. Bạn trả lời bằng mã:
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
nhận F01, F03 · bác F02 vì đã có ở UC-002 · F04 sửa thành "khoá 30 phút" · hoãn F05
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
| Quyết định | Kết quả |
|
|
49
|
+
|---|---|
|
|
50
|
+
| `nhận` | AI sửa PRD theo đề xuất |
|
|
51
|
+
| `sửa: …` | AI sửa PRD theo nội dung bạn đưa |
|
|
52
|
+
| `bác: <lý do>` | Không sửa. Lần rà sau **không nêu lại** điểm này |
|
|
53
|
+
| `hoãn` | Không sửa lúc này. Được ghi vào "Câu hỏi còn mở" của PRD để bước QC xử lý |
|
|
54
|
+
|
|
55
|
+
Bác hay hoãn đều tính là **đã quyết**. Chỉ cần mọi critical và major đều đã có quyết định là đi tiếp được.
|
|
56
|
+
|
|
57
|
+
## Vì sao chỉ có 2 lượt
|
|
58
|
+
|
|
59
|
+
Kinh nghiệm cho thấy: rà → sửa → rà lại thì lần nào cũng ra vấn đề mới, nhiều cái là ảo giác, và vòng lặp không dứt. Vì vậy:
|
|
60
|
+
|
|
61
|
+
| Lượt | Soi gì | Được báo gì |
|
|
62
|
+
|---|---|---|
|
|
63
|
+
| **1** | Toàn bộ PRD | Mọi mức độ |
|
|
64
|
+
| **2** (chỉ khi lượt 1 có bản sửa) | **Chỉ phần vừa sửa**, và các mục tham chiếu tới nó | **Chỉ** critical, hoặc lỗi do chính bản sửa gây ra |
|
|
65
|
+
| 3 | **Không có** | — |
|
|
66
|
+
|
|
67
|
+
Thêm vào đó, file refine là **sổ quyết định**: lần rà sau đọc lại sổ và không nêu lại những điểm bạn đã quyết.
|
|
68
|
+
|
|
69
|
+
Sau mỗi lượt có sửa, lệnh sẽ nhắc *"`/clear` rồi `/prd EP-01 refine`"* để chạy lượt 2.
|
|
70
|
+
|
|
71
|
+
## Sau khi đổi PRD
|
|
72
|
+
|
|
73
|
+
`/prd EP-01 change …` tăng version, nên bạn phải refine lại trước khi duyệt. Lần đó **chỉ rà các mục vừa đổi** (theo dòng Lịch sử thay đổi), nên nhanh và rẻ.
|
|
74
|
+
|
|
75
|
+
## Duyệt PRD
|
|
76
|
+
|
|
77
|
+
PRD chỉ được đặt `approved` khi đủ cả 4 điều kiện:
|
|
78
|
+
1. Không còn 🤖.
|
|
79
|
+
2. Không còn câu hỏi mở.
|
|
80
|
+
3. **Đã refine đúng version này** (`refined` = `version`), và không còn critical/major chưa quyết.
|
|
81
|
+
4. Đã ghi người duyệt.
|
|
82
|
+
|
|
83
|
+
Công cụ tự chặn nếu thiếu điều kiện nào.
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
[← Hướng dẫn](../README.md) · [Bảng lệnh](../README.md#bảng-lệnh)
|
|
2
|
+
|
|
3
|
+
# `/prd` — viết PRD chính thức
|
|
4
|
+
|
|
5
|
+
> Biến epic đã làm rõ thành **PRD**: chia thành các use case, mỗi UC có Business Rule và AC riêng với **mã ổn định**. PRD là nguồn cho BDD, thiết kế và code ở các bước sau.
|
|
6
|
+
|
|
7
|
+
| | Tạo PRD | Đổi PRD |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| **Gõ** | `/prd EP-01` | `/prd EP-01 change <mô tả thay đổi>` |
|
|
10
|
+
| **Ai** | PO / BA | PO / BA |
|
|
11
|
+
| **Cần có trước** | Epic `ready` (xem [/product](product.md)) | PRD đã có |
|
|
12
|
+
| **Số lượt** | 2 | 2 |
|
|
13
|
+
| **Ghi ra** | `specs/{domain}/{slug}/prd.md` · epic chuyển `handed-off` | `prd.md`, version tăng (1.0 → 1.1) |
|
|
14
|
+
| **Bước tiếp** | [`/prd EP-01 refine`](prd-refine.md) → duyệt PRD → `/bdd UC-xxx` *(sắp có)* | [`/prd EP-01 refine`](prd-refine.md) (chỉ rà phần vừa đổi) → duyệt lại |
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Tạo PRD: `/prd EP-01`
|
|
19
|
+
|
|
20
|
+
**Lượt 1: chia use case.** AI đề xuất danh sách UC, mỗi UC lấy những BR và AC nào của epic. Ví dụ thật với EP-01 của LMS (21 BR, 21 AC, chia thành 10 UC):
|
|
21
|
+
|
|
22
|
+
| UC | Tên | Lấy từ epic |
|
|
23
|
+
|---|---|---|
|
|
24
|
+
| UC-001 | Tạo tài khoản nhân sự | BR1, BR2, BR3, BR4, BR8a, BR8b, BR19, AC1, AC21 |
|
|
25
|
+
| UC-005 | Đổi mật khẩu và quên mật khẩu | BR4, BR6, BR12, AC15 |
|
|
26
|
+
| … | … *(10 UC)* | … |
|
|
27
|
+
|
|
28
|
+
Một BR có thể thuộc nhiều UC, ví dụ BR4 (mật khẩu mặc định) nằm ở cả UC-001 và UC-005.
|
|
29
|
+
|
|
30
|
+
Bạn đồng ý, gộp hoặc tách UC.
|
|
31
|
+
|
|
32
|
+
**Lượt 2: viết và duyệt.**
|
|
33
|
+
1. AI ghi toàn bộ PRD trong một lần.
|
|
34
|
+
2. Công cụ **kiểm độ phủ**: mọi BR và AC của epic đều phải có trong PRD. Thiếu thì AI bổ sung cho tới khi đủ. AI không được tự bỏ mục nào; muốn bỏ thì phải hỏi bạn.
|
|
35
|
+
3. AI **chỉ in các mục 🤖**, tức những chỗ AI tự thêm, tách hoặc suy ra khi viết PRD. Không in lại cả PRD.
|
|
36
|
+
4. Bạn mở file để đọc toàn bộ, rồi trả lời hoặc xác nhận theo mã: *"OK UC-003-BR04, UC-003-AC02"*.
|
|
37
|
+
5. Tiếp theo **bắt buộc rà nội dung**: `/clear` rồi [`/prd EP-01 refine`](prd-refine.md). Rà xong, hết 🤖 và hết câu hỏi mở thì mới duyệt được. AI hỏi *"Ai duyệt PRD này?"* rồi đặt `status: approved`.
|
|
38
|
+
|
|
39
|
+
## PRD trông như thế nào
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
## 2. Use case
|
|
43
|
+
### UC-001 — Tạo tài khoản nhân sự
|
|
44
|
+
- Actor · Điều kiện trước · Kết quả sau · Luồng chính
|
|
45
|
+
|
|
46
|
+
Business Rule (BR)
|
|
47
|
+
| Mã | Business Rule | Business Logic | Nguồn |
|
|
48
|
+
| UC-001-BR01 | Email PHẢI bắt buộc và duy nhất trên toàn hệ … | Email trống hoặc đã có tài khoản → từ chối, báo lý do | (nguồn: BR1) |
|
|
49
|
+
|
|
50
|
+
Acceptance Criteria (điều kiện nghiệm thu)
|
|
51
|
+
- UC-001-AC01. Khi Admin import file 10 dòng, trong đó 2 dòng trùng email thì 8 tài khoản được tạo, 2 dòng được báo lỗi kèm lý do. (nguồn: AC1)
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Gồm 5 mục: **Tổng quan** (mục tiêu, actor, phạm vi, ràng buộc áp dụng) · **Use case** · **Màn hình** · **Câu hỏi còn mở** · **Lịch sử thay đổi**. Cột `Nguồn` chỉ ghi mã (xem [Khái niệm](../02-khai-niem.md#nguồn-của-từng-mục-trong-prd)).
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Đổi PRD: `/prd EP-01 change <mô tả>`
|
|
59
|
+
|
|
60
|
+
Dùng cho **mọi** thay đổi: thêm, sửa, bỏ.
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
/prd EP-01 change khoá tài khoản sau 3 lần đăng nhập sai
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
**Lượt 1: kế hoạch.** AI tìm mọi mục bị ảnh hưởng, kể cả những mục kéo theo, rồi trình bảng *(ví dụ minh hoạ)*:
|
|
67
|
+
|
|
68
|
+
| Mã | Loại | Hiện tại | Sẽ thành |
|
|
69
|
+
|---|---|---|---|
|
|
70
|
+
| UC-001-BR05 | sửa | Khoá sau 5 lần sai | Khoá sau 3 lần sai |
|
|
71
|
+
| UC-001-AC07 | thêm | — | Khi sai 3 lần thì … |
|
|
72
|
+
| UC-001-BR06 | bỏ | … | ~~…~~ Đã bỏ (v1.1) |
|
|
73
|
+
|
|
74
|
+
**Lượt 2: áp dụng.** AI sửa đúng các mục đó, thêm dòng vào Lịch sử thay đổi, tăng version. PRD đang `approved` thì quay về `draft`, và phải **refine lại** (chỉ rà phần vừa đổi) rồi **duyệt lại**.
|
|
75
|
+
|
|
76
|
+
## Lưu ý
|
|
77
|
+
|
|
78
|
+
- **Bạn được tự sửa tay PRD.** Nhưng giữ nguyên mã, dấu ✅ / 🤖 và đoạn `<!-- sec:… -->`. Sửa nhiều thì nên dùng `change`, để AI tìm giúp các mục bị kéo theo.
|
|
79
|
+
- **Không sửa epic sau khi đã có PRD.** Epic lúc này chỉ còn là lịch sử.
|
|
80
|
+
- PRD tạo bằng bản framework cũ (trước 0.6.1) có thể còn ghi nguồn bằng lời, ví dụ *"(nguồn: PO chốt khi viết PRD)"*. Lần sửa đầu tiên AI sẽ được yêu cầu đổi các chỗ đó thành mã, thường là `PRD`.
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
[← Hướng dẫn](../README.md) · [Bảng lệnh](../README.md#bảng-lệnh)
|
|
2
|
+
|
|
3
|
+
# `/product` — làm rõ yêu cầu
|
|
4
|
+
|
|
5
|
+
> AI **hỏi ngược lại** để bạn nói ra những điều đã biết nhưng chưa viết: phạm vi, trường hợp đặc biệt, luật nghiệp vụ. Làm việc này **trước** khi viết PRD, để AI không phải đoán.
|
|
6
|
+
|
|
7
|
+
| | Tầng sản phẩm | Một epic |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| **Gõ** | `/product` | `/product EP-01` (hoặc tên tính năng) |
|
|
10
|
+
| **Ai** | PO / BA | PO / BA |
|
|
11
|
+
| **Cần có trước** | Đã cài framework | Nên có tầng sản phẩm `ready` |
|
|
12
|
+
| **Số checkpoint** | 2 | 3 |
|
|
13
|
+
| **Ghi ra** | `specs/product/product.md`, `glossary.md` | `specs/product/epics/EP-01-….md` |
|
|
14
|
+
| **Bước tiếp** | `/product <epic ưu tiên cao nhất>` | `/prd EP-01` |
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Tầng sản phẩm: `/product`
|
|
19
|
+
|
|
20
|
+
| Checkpoint | AI hỏi | Bạn chốt |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| 1. Tầm nhìn và người dùng | Sản phẩm giải quyết gì, cho ai · khác cách làm hiện tại ở đâu · có những nhóm người dùng nào · đo thành công bằng gì · những gì **không** làm | Tầm nhìn, nhóm người dùng `ACT-xx`, mục tiêu, ngoài phạm vi |
|
|
23
|
+
| 2. Epic và ràng buộc | Các nhóm tính năng lớn · ưu tiên · chia **giai đoạn** (MVP, Phase 2…) · **ràng buộc** áp cho mọi epic (pháp lý, bảo mật, vận hành, dữ liệu) | Bảng epic, ràng buộc `CON-xx` |
|
|
24
|
+
|
|
25
|
+
Cuối cùng AI hỏi **ai duyệt** tầng sản phẩm, mặc định là bạn.
|
|
26
|
+
|
|
27
|
+
**Có sẵn tài liệu (BRD, đề án…)?** Dán vào ngay lượt đầu. AI trích trước và gắn 🤖, bạn chỉ cần xác nhận hoặc sửa. Các mục **Stakeholders, Giả định, Rủi ro** chỉ được điền khi tài liệu có, AI không hỏi riêng.
|
|
28
|
+
|
|
29
|
+
## Một epic: `/product EP-01`
|
|
30
|
+
|
|
31
|
+
| Checkpoint | AI hỏi | Ví dụ thật (dự án LMS, EP-01) |
|
|
32
|
+
|---|---|---|
|
|
33
|
+
| 1. Hiểu đúng vấn đề | Bối cảnh · vấn đề · mục tiêu · actor · trong và ngoài phạm vi · phụ thuộc | "Học sinh, phụ huynh có đăng nhập không?" → chỉ có tài khoản ở hệ thống đăng nhập tập trung, chưa dùng LMS |
|
|
34
|
+
| 2. Luồng và chỗ hở | Điểm vào, luồng chính, màn hình · **soi chỗ hở**: lỗi, ranh giới phạm vi, phụ thuộc ngầm, mâu thuẫn, trường hợp nhiều | "Một phụ huynh có 2 con thì sao?" → mỗi con một email riêng |
|
|
35
|
+
| 3. Chốt để sang PRD | AI **đề xuất** Business Rule (`BR1.`…) và AC (`AC1.`…), tự kiểm độ phủ trước khi trình | 21 Business Rule, 21 AC |
|
|
36
|
+
|
|
37
|
+
Bước soi chỗ hở **luôn chạy ít nhất một vòng**, kể cả khi tài liệu bạn đưa rất dày. Tài liệu càng dày thì càng dễ tạo cảm giác "đã đủ".
|
|
38
|
+
|
|
39
|
+
**Khi bạn đổi ý giữa chừng:** nếu điều mới trái với tầng sản phẩm (ví dụ `product.md` ghi "học sinh không đăng nhập"), AI sẽ báo, mở lại các mục liên quan (về 🤖), hạ checkpoint, và đưa phương án để bạn chọn.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Trong một lượt hỏi-đáp
|
|
44
|
+
|
|
45
|
+
- **Tối đa 4 câu hỏi**, tính cả câu phụ. Câu chưa trả lời được lưu vào mục "Câu hỏi còn mở" và được hỏi lại ở lượt sau.
|
|
46
|
+
- File được **ghi ngay sau mỗi lượt**, nên bạn dừng lúc nào cũng được.
|
|
47
|
+
- Thuật ngữ mới lặp từ 2 lần trở lên: AI hỏi nghĩa, và hỏi có thêm vào `glossary.md` không.
|
|
48
|
+
|
|
49
|
+
## Dừng và chạy tiếp
|
|
50
|
+
|
|
51
|
+
- Muốn dừng: nói *"dừng"*. AI lưu lại và báo cách chạy tiếp.
|
|
52
|
+
- Chạy tiếp: `/clear` rồi gõ lại **đúng lệnh cũ**. AI đọc file và tiếp tục từ checkpoint đang dở, hỏi các câu còn mở trước.
|
|
53
|
+
- Sau mỗi checkpoint, lệnh sẽ gợi ý `/clear`. Nên làm theo, vì phiên mới rẻ hơn và không mất gì.
|
|
54
|
+
|
|
55
|
+
## Trạng thái của file
|
|
56
|
+
|
|
57
|
+
| `status` | Nghĩa | Chạy lại lệnh thì |
|
|
58
|
+
|---|---|---|
|
|
59
|
+
| `in-progress` | Đang làm rõ | Tiếp từ checkpoint đang dở |
|
|
60
|
+
| `ready` | Đã chốt hết, không còn 🤖, không còn câu hỏi mở, đã có người duyệt | Chỉ sửa khi bạn nói rõ mục cần sửa |
|
|
61
|
+
| `handed-off` | *(chỉ epic)* Đã có PRD | **Dừng.** Muốn đổi yêu cầu thì dùng `/prd EP-01 change …` |
|
|
62
|
+
|
|
63
|
+
## Lưu ý
|
|
64
|
+
|
|
65
|
+
- **Đừng xoá dấu ✅ / 🤖 hay đoạn `<!-- sec:… -->`** khi tự sửa file. Đoạn `<!-- sec:… -->` là mã của từng mục, lệnh dùng nó để tìm mục (khi xem trên GitLab hay VS Code thì không thấy).
|
|
66
|
+
- File tạo từ bản framework cũ hơn sẽ được **tự bổ sung** các mục và cột còn thiếu khi chạy lại lệnh. Nội dung đã chốt giữ nguyên.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[← Hướng dẫn](../README.md)
|
|
2
|
+
|
|
3
|
+
# PO / BA
|
|
4
|
+
|
|
5
|
+
> Bạn quyết định **làm cái gì**. Mọi bước sau (BDD, thiết kế, code, test) đều dựa trên những gì bạn chốt ở đây.
|
|
6
|
+
|
|
7
|
+
## Đường đi của bạn
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
/product ──► /product EP-xx ──► /prd EP-xx ──► /prd EP-xx refine ──► duyệt PRD ──► (giao cho BDD — sắp có)
|
|
11
|
+
▲ │
|
|
12
|
+
└─ /prd EP-xx change ◄┘ khi yêu cầu thay đổi
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
| Bước | Lệnh | Bạn làm gì | Hướng dẫn |
|
|
16
|
+
|---|---|---|---|
|
|
17
|
+
| 1 | `/product` | Trả lời về sản phẩm, nhóm người dùng, epic, ràng buộc. Chốt từng mục | [/product](../lenh/product.md) |
|
|
18
|
+
| 2 | `/product EP-xx` | Trả lời AI hỏi về tính năng. Đây là chỗ **quan trọng nhất**: câu trả lời càng rõ thì PRD càng ít phải sửa | [/product](../lenh/product.md#một-epic-product-ep-01) |
|
|
19
|
+
| 3 | `/prd EP-xx` | Duyệt cách chia UC, xác nhận các mục 🤖 | [/prd](../lenh/prd.md) |
|
|
20
|
+
| 4 | `/prd EP-xx refine` | Quyết từng finding: nhận, sửa, bác hay hoãn. Tối đa 2 lượt. Xong thì duyệt PRD | [/prd refine](../lenh/prd-refine.md) |
|
|
21
|
+
| 5 | `/prd EP-xx change …` | Khi yêu cầu đổi. Duyệt kế hoạch thay đổi, refine lại phần vừa đổi, rồi duyệt lại PRD | [/prd](../lenh/prd.md#đổi-prd-prd-ep-01-change-mô-tả) |
|
|
22
|
+
|
|
23
|
+
## Mẹo
|
|
24
|
+
|
|
25
|
+
- **Có tài liệu thì dán vào ngay lượt đầu.** AI trích trước, bạn chỉ xác nhận. Nhưng AI vẫn sẽ hỏi những gì tài liệu **chưa nói**.
|
|
26
|
+
- **Chưa biết câu trả lời thì nói "chưa biết".** Câu đó được lưu vào "Câu hỏi còn mở" và hỏi lại lần sau. Không nên trả lời đại cho xong.
|
|
27
|
+
- **`/clear` sau mỗi checkpoint.** Rẻ hơn, và không mất gì.
|
|
28
|
+
- Một epic thường cần **2–3 buổi**. Bạn dừng lúc nào cũng được.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[← Hướng dẫn](README.md)
|
|
2
|
+
|
|
3
|
+
# Xử lý sự cố
|
|
4
|
+
|
|
5
|
+
## Khi cài và nâng cấp
|
|
6
|
+
|
|
7
|
+
| Bạn thấy | Nguyên nhân | Làm gì |
|
|
8
|
+
|---|---|---|
|
|
9
|
+
| `npm error 404 … @educa-corp/fw` ngay sau khi có bản mới | Registry npm cần vài phút mới đọc được bản vừa phát hành | Đợi 3–5 phút. Vẫn lỗi thì chạy `npm cache clean --force` rồi thử lại |
|
|
10
|
+
| `❌ KHÔNG TÌM THẤY PYTHON 3.8+` | Máy chưa có Python, hoặc có nhưng chưa nằm trong PATH | Cài Python (xem [Bắt đầu](01-bat-dau.md#1-máy-cần-có)), **mở terminal mới**, chạy lại lệnh |
|
|
11
|
+
| `⚠ Python này cài từ Microsoft Store` | Bản Store thỉnh thoảng thoát lỗi mà không chạy | Vẫn dùng được. Nên cài bản python.org: `winget install Python.Python.3.12` |
|
|
12
|
+
| `⚠ … file bạn đã sửa bị ghi đè, bản cũ ở .fw/backup/…` | Bạn từng sửa file của framework | Mở bản sao để lấy lại phần đã sửa nếu cần. Xem [fw](lenh/fw.md#muốn-giữ-thay-đổi-riêng-của-dự-án) |
|
|
13
|
+
| `Đây là bản fw đã cài trong dự án …` | Bạn chạy `install` từ `.fw/core/bin/fw.js` | Dùng `npx @educa-corp/fw upgrade` |
|
|
14
|
+
|
|
15
|
+
## Khi chạy lệnh trong Claude Code
|
|
16
|
+
|
|
17
|
+
| Bạn thấy | Nghĩa là | Làm gì |
|
|
18
|
+
|---|---|---|
|
|
19
|
+
| Dòng bắt đầu bằng `spec_edit: …` | Công cụ sửa spec vừa **chặn** một chỗ sửa sai (không tìm thấy đoạn cần sửa, giá trị không hợp lệ…). **Không có gì bị ghi** | Không cần làm gì. AI đọc lại file rồi sửa đúng |
|
|
20
|
+
| AI chạy lại cùng một lệnh `spec_edit` | Lần trước Python thoát mà không chạy (thường gặp với bản Store) | Bình thường, AI được dặn chạy lại một lần |
|
|
21
|
+
| `không đặt được status=approved: còn 3 dòng 🤖` | Còn mục chưa được bạn xác nhận | Xác nhận các mục AI liệt kê |
|
|
22
|
+
| `… chưa có approved_by` | Chưa ghi người duyệt | Trả lời câu *"Ai duyệt?"* |
|
|
23
|
+
| `… bản v1.2 chưa refine` | PRD chưa được rà nội dung ở version này | Chạy `/prd EP-xx refine` |
|
|
24
|
+
| `… còn finding critical/major chưa có quyết định: F01, F04` | Bạn chưa quyết các finding đó | Trả lời: nhận, sửa, bác (kèm lý do) hay hoãn |
|
|
25
|
+
| `Bản v1.1 đã refine xong` | Gọi refine lại khi PRD chưa đổi | Không cần làm gì. Thật sự muốn rà lại từ đầu thì thêm `--full` |
|
|
26
|
+
| `chưa được PRD dùng tới: BR7, AC12` | Có BR hoặc AC của epic chưa được đưa vào PRD | AI sẽ bổ sung. Nếu bạn muốn bỏ thì nói rõ |
|
|
27
|
+
| `(nguồn: …) chỉ được ghi mã …` | PRD đang ghi nguồn bằng lời (thường là PRD tạo bằng bản trước 0.6.1) | AI sẽ đổi thành mã, thường là `PRD` |
|
|
28
|
+
| `💡 Phiên này đã dài. Nên /clear …` | Phiên đang mang theo hội thoại cũ | Gõ `/clear` rồi gọi lại lệnh |
|
|
29
|
+
| `EP-xx chưa làm rõ xong. Chạy /product EP-xx trước` | Epic chưa `ready` | Chạy tiếp `/product EP-xx`. Thật sự cần PRD sớm thì thêm `--force`, PRD sẽ được ghi chú là tạo khi epic chưa xong |
|
|
30
|
+
| `PRD đã có …` | Gọi `/prd EP-xx` khi PRD đã tồn tại | Rà nội dung: `/prd EP-xx refine` · Đổi: `/prd EP-xx change <mô tả>` |
|
|
31
|
+
|
|
32
|
+
## Vẫn chưa được?
|
|
33
|
+
|
|
34
|
+
Ghi lại **lệnh đã gõ** và **dòng lỗi**, rồi gửi cho người phụ trách framework.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@educa-corp/fw",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.7.0",
|
|
4
4
|
"description": "Framework làm việc với Claude Code cho phòng PTPM",
|
|
5
5
|
"bin": {
|
|
6
6
|
"fw": "bin/fw.js"
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
"ref/",
|
|
19
19
|
"templates/",
|
|
20
20
|
"tools/",
|
|
21
|
+
"docs/guide/",
|
|
21
22
|
"CHANGELOG.md"
|
|
22
23
|
],
|
|
23
24
|
"engines": {
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Lăng kính rà nội dung PRD — dành cho sub-agent
|
|
2
|
+
|
|
3
|
+
Bạn là **một** lăng kính. Chỉ soi đúng phần của lăng kính mình, trong đúng **phạm vi** và **ngưỡng báo** được giao. Tìm ít nhưng đúng còn hơn tìm nhiều mà sai.
|
|
4
|
+
|
|
5
|
+
## Luật chung
|
|
6
|
+
|
|
7
|
+
1. **Viết bằng ngôn ngữ nghiệp vụ.** Mắt nhìn có thể là kỹ thuật, nhưng finding và đề xuất phải nói *nghiệp vụ còn thiếu hay chưa rõ điều gì*. Không đề xuất API, bảng dữ liệu, retry, timeout hay thư viện.
|
|
8
|
+
2. **Có trích dẫn.** Mỗi finding trích **nguyên văn** đoạn PRD liên quan (≤ 120 ký tự) kèm mã mục (`UC-003-BR02`, `UC-003`, hoặc `Tổng quan`). Finding dạng *"PRD thiếu X"* thì nêu mục lẽ ra phải chứa X.
|
|
9
|
+
3. **Không nêu lại** những gì đã có quyết định trong file refine (`R`), dù là `nhận`, `bác` hay `hoãn`.
|
|
10
|
+
4. **Không hỏi những gì bước sau sẽ trả lời**: giao diện chi tiết (thuộc design-spec), kịch bản kiểm thử (thuộc BDD), cách làm kỹ thuật (thuộc TDD).
|
|
11
|
+
5. **Mức độ:**
|
|
12
|
+
|
|
13
|
+
| Mức | Khi nào | Ví dụ |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| `critical` | Không sửa thì dev hoặc QC **sẽ làm sai**, hoặc không làm được | Hai BR mâu thuẫn trực tiếp |
|
|
16
|
+
| `major` | Không sửa thì người làm **phải đoán** | Không nói chuyện gì xảy ra khi import có dòng sai định dạng |
|
|
17
|
+
| `minor` | Làm rõ thêm cho dễ đọc, không đổi hành vi | Tên trạng thái dùng hai cách gọi |
|
|
18
|
+
|
|
19
|
+
## QA — hình thức của AC
|
|
20
|
+
|
|
21
|
+
Cố ý hẹp. Chỉ hỏi:
|
|
22
|
+
- AC có nêu **kết quả nhìn thấy được**, kiểm được là đạt / không đạt không?
|
|
23
|
+
- AC có **lặp lại** nội dung BR không? Nếu lặp thì đề xuất làm mỏng AC và trỏ sang BR.
|
|
24
|
+
|
|
25
|
+
**Không** hỏi "AC đủ chi tiết chưa". Chi tiết cơ chế (số lần, thời hạn, nhánh lỗi) thuộc về BR / Business Logic. Nếu thiếu cơ chế thì đề xuất **thêm vào BR**, không phình AC.
|
|
26
|
+
|
|
27
|
+
## DEV — BR và Business Logic có đủ để làm không
|
|
28
|
+
|
|
29
|
+
Đọc như một dev sắp làm: đã đủ để làm **mà không phải đoán** chưa? Soi:
|
|
30
|
+
- nhánh nghiệp vụ còn thiếu;
|
|
31
|
+
- điều kiện biên chưa nói (0, rỗng, tối đa, trùng, đồng thời);
|
|
32
|
+
- xử lý khi có lỗi hay ngoại lệ bị bỏ ngỏ, ví dụ *"gửi email đặt lại mật khẩu thất bại thì sao?"*;
|
|
33
|
+
- BR mơ hồ, hoặc mâu thuẫn với BR khác.
|
|
34
|
+
|
|
35
|
+
## SA — thông suốt và nhất quán giữa các UC
|
|
36
|
+
|
|
37
|
+
Đọc như một architect: toàn bộ luồng có **thông suốt và nhất quán** không? Soi:
|
|
38
|
+
- tương tác giữa các UC đã được định nghĩa chưa (UC này tạo ra thứ mà UC kia cần);
|
|
39
|
+
- **trạng thái và vòng đời** của đối tượng nghiệp vụ có nhất quán không, ví dụ tài khoản: mới → active → inactive;
|
|
40
|
+
- **ai được làm gì, ai sở hữu gì**;
|
|
41
|
+
- cùng một khái niệm có bị gọi hoặc hiểu khác nhau ở hai UC không.
|
|
42
|
+
|
|
43
|
+
Không phán về kiến trúc hay mô hình dữ liệu kỹ thuật.
|
|
44
|
+
|
|
45
|
+
## Phạm vi — PRD có đi đúng đường đã chốt không
|
|
46
|
+
|
|
47
|
+
Đọc thêm file epic (mục checkpoint 1) và `product.md` (mục Ràng buộc, Danh sách epic). Soi:
|
|
48
|
+
- PRD có **vượt ra ngoài** phạm vi epic, hoặc làm điều epic ghi là "ngoài phạm vi" không;
|
|
49
|
+
- PRD có **đi ngược** một ràng buộc `CON-xx` không;
|
|
50
|
+
- PRD có **giẫm lên** phạm vi của epic khác không.
|
|
51
|
+
|
|
52
|
+
Không hỏi lại ưu tiên hay mục tiêu, vì đã chốt ở `/product`.
|
|
53
|
+
|
|
54
|
+
## Định dạng trả về
|
|
55
|
+
|
|
56
|
+
Trả về **chỉ** danh sách sau, không viết gì thêm:
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
- lens: DEV
|
|
60
|
+
severity: major
|
|
61
|
+
item: UC-003-BR02
|
|
62
|
+
quote: "…nguyên văn…"
|
|
63
|
+
finding: "…"
|
|
64
|
+
suggestion: "…"
|
|
65
|
+
if_accepted: "…" # chỉ critical / major: chốt đề xuất này thì phát sinh trường hợp gì
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Không tìm thấy gì thì trả về `[]`.
|
|
69
|
+
|
|
70
|
+
## Kiểm chứng — dành cho agent kiểm chứng
|
|
71
|
+
|
|
72
|
+
Bạn nhận danh sách finding của 4 lăng kính. Với **từng** finding, **cố chứng minh nó sai**:
|
|
73
|
+
1. Tra PRD: đoạn `quote` có đúng là nguyên văn không? Điều finding nói "thiếu" có thật là thiếu không, hay đã nằm ở mục khác (BR khác, Business Logic, UC khác, Tổng quan)?
|
|
74
|
+
2. Finding có hỏi điều thuộc bước sau (giao diện, kịch bản test, kỹ thuật) không?
|
|
75
|
+
3. Finding có đề xuất giải pháp kỹ thuật không?
|
|
76
|
+
4. Mức độ có đúng định nghĩa không?
|
|
77
|
+
|
|
78
|
+
Trả về cho mỗi finding một trong ba kết luận: `ĐÚNG` · `SAI: <lý do, kèm trích dẫn chứng minh>` · `HẠ MỨC: <mức mới, lý do>`.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# /prd — chế độ rà nội dung (refine)
|
|
2
|
+
|
|
3
|
+
Mục đích: tìm chỗ **nghiệp vụ còn thiếu, mơ hồ, mâu thuẫn** đến mức sẽ làm sai hoặc phải đoán ở các bước sau. **Không** rà chính tả hay trình bày, vì đó là việc của `/review`.
|
|
4
|
+
|
|
5
|
+
File refine: `R = {specs}/{domain}/{slug}/review/prd-refine.md` (khuôn `.fw/core/templates/prd-refine.md`).
|
|
6
|
+
|
|
7
|
+
## Bước A — Xác định lượt
|
|
8
|
+
|
|
9
|
+
Chạy `SE upgrade D` trước. Lệnh này bổ sung trường `refined` cho PRD tạo bằng bản cũ, và đổi mã nguồn `R…` thành `BR…`.
|
|
10
|
+
|
|
11
|
+
Đọc frontmatter của `D` (`version`, `refined`) và của `R` (nếu có: `prd_version`, `round`).
|
|
12
|
+
|
|
13
|
+
| Tình huống | Lượt | Phạm vi |
|
|
14
|
+
|---|---|---|
|
|
15
|
+
| `refined` = `version` | **Dừng.** Báo *"Bản v{version} đã refine xong."* Có `--full` thì chạy lượt 1 trên toàn PRD | — |
|
|
16
|
+
| Chưa có `R`, hoặc chưa từng refine | **1** | Toàn bộ PRD |
|
|
17
|
+
| `R` có `round: 1` **đã áp** bản sửa, `prd_version` < `version` | **2** | Chỉ các mục mà lượt 1 đã sửa hoặc thêm (đọc từ quyết định `nhận` / `sửa` trong `R`), cộng các mục tham chiếu tới chúng |
|
|
18
|
+
| `refined` có giá trị nhưng < `version` (PRD đã qua `/prd change`) | **1** | Chỉ các mục trong dòng Lịch sử thay đổi từ sau `refined` tới nay |
|
|
19
|
+
|
|
20
|
+
**Không có lượt 3.** Sau lượt 2 thì luôn đặt `refined` (Bước D).
|
|
21
|
+
|
|
22
|
+
## Bước B — Rà (sub-agent, bắt buộc model Opus)
|
|
23
|
+
|
|
24
|
+
1. Dùng công cụ **Agent**, `model: "opus"`, gọi **4 agent song song trong cùng một lượt**: QA · DEV · SA · Phạm vi. Mỗi agent nhận:
|
|
25
|
+
- đường dẫn `D`, `R` (nếu có), `.fw/core/ref/prd/lenses.md`, và tên lăng kính của nó;
|
|
26
|
+
- **phạm vi** của lượt (Bước A), và **ngưỡng báo**: lượt 1 báo mọi mức · lượt 2 chỉ báo critical hoặc lỗi do chính bản sửa gây ra;
|
|
27
|
+
- riêng lăng kính Phạm vi: thêm đường dẫn file epic và `{specs}/product/product.md`.
|
|
28
|
+
2. Gom kết quả, rồi gọi **1 agent kiểm chứng** (`model: "opus"`) với danh sách finding, `D`, và phần "Kiểm chứng" trong `lenses.md`. Chỉ giữ finding nào được kết luận **ĐÚNG**.
|
|
29
|
+
3. Gộp các finding trùng nhau (cùng mục, cùng vấn đề), giữ bản rõ nhất. Hai đề xuất trái ngược nhau thì giữ cả hai trong **một** finding, và nêu rõ là cần PO chọn.
|
|
30
|
+
|
|
31
|
+
## Bước C — Ghi và trình
|
|
32
|
+
|
|
33
|
+
1. Chưa có `R`: `SE create R` theo khuôn. Đã có: `SE edit` thêm một mục `## Lượt {n} — v{version}` ở **cuối**. Không sửa các lượt cũ, vì chúng là sổ quyết định.
|
|
34
|
+
2. Mã finding đánh **nối tiếp** qua mọi lượt (F01…), không đánh lại.
|
|
35
|
+
3. `SE set R prd_version={version} round={n} status=pending`.
|
|
36
|
+
4. Trình cho PO: **một bảng tóm tắt** (mã · mức · lăng kính · mục · một dòng vấn đề), sắp theo mức độ. Kèm số finding bị bỏ ở bước kiểm chứng, để PO thấy bước này có tác dụng. Nhắc PO: *"Chi tiết xem {R}. Quyết bằng mã: 'nhận F01, F03 · bác F02 vì … · F04 sửa thành … · hoãn F05'."*
|
|
37
|
+
5. Không có finding nào: báo, rồi sang Bước D luôn.
|
|
38
|
+
|
|
39
|
+
## Bước D — Áp quyết định
|
|
40
|
+
|
|
41
|
+
1. Ghi quyết định của PO vào `R` (`- Quyết định: …`). **Mọi** finding critical / major đều phải có quyết định khác `chờ`. Còn thiếu thì hỏi lại, tối đa 4 mã mỗi lượt.
|
|
42
|
+
2. Finding `nhận` hoặc `sửa`: áp vào `D` trong **một** lần `SE edit`, theo đúng luật của `.fw/core/ref/prd/change.md` (mã mới lấy số kế tiếp, mục bỏ thì gạch ngang, `(nguồn: PRD)`). Thêm một dòng Lịch sử thay đổi nêu mã finding, ví dụ *"v1.1 — refine lượt 1: F01, F03, F04"*.
|
|
43
|
+
3. Có áp bản sửa: tăng version phụ (`SE set D version=… status=draft approved_by=— approved_at=—`), rồi `SE set R status=applied`. Nếu đây là **lượt 1**, báo *"`/clear` rồi `/prd {id} refine` để chạy lượt 2, chỉ soi phần vừa sửa."*
|
|
44
|
+
4. Không áp gì (mọi finding đều bác / hoãn), **hoặc** vừa xong **lượt 2**: `SE set D refined={version hiện tại}` và `SE set R status=done`. Finding `hoãn` thì ghi thêm vào mục **Câu hỏi còn mở** của `D`, kèm chú thích *"(để bước QC)"*.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
type: prd-refine
|
|
3
|
+
prd: {đường dẫn prd.md}
|
|
4
|
+
prd_version: {version PRD lúc rà}
|
|
5
|
+
round: 1 # 1 | 2
|
|
6
|
+
status: pending # pending | applied | done
|
|
7
|
+
updated: {YYYY-MM-DD}
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Refine PRD — {EPIC-ID}
|
|
11
|
+
|
|
12
|
+
> Rà **nội dung** PRD qua 4 lăng kính: QA · DEV · SA · Phạm vi. Finding nào cũng đã qua bước **kiểm chứng**.
|
|
13
|
+
> File này cũng là **sổ quyết định**: lần rà sau đọc lại để không nêu lại những điểm đã quyết. **Không xoá finding cũ.**
|
|
14
|
+
> Quyết định: `chờ` · `nhận` · `sửa: <nội dung PO muốn>` · `bác: <lý do>` · `hoãn` (để bước QC).
|
|
15
|
+
|
|
16
|
+
## Tóm tắt <!-- sec:summary -->
|
|
17
|
+
|
|
18
|
+
| Lượt | Version | Tìm thấy | Bỏ sau kiểm chứng | critical | major | minor | Kết luận |
|
|
19
|
+
|---|---|---|---|---|---|---|---|
|
|
20
|
+
| 1 | {v} | {n} | {n} | {n} | {n} | {n} | {BLOCKED · NEEDS_REVISION · APPROVED_WITH_MINOR_CHANGES} |
|
|
21
|
+
|
|
22
|
+
## Lượt 1 — v{version} <!-- sec:round-1 -->
|
|
23
|
+
|
|
24
|
+
### F01 · {QA · DEV · SA · Phạm vi} · {critical · major · minor} · {mã mục}
|
|
25
|
+
- Trích: "{nguyên văn trong PRD}"
|
|
26
|
+
- Vấn đề: {…}
|
|
27
|
+
- Đề xuất: {…}
|
|
28
|
+
- Nếu chốt đề xuất này: {… — chỉ critical / major}
|
|
29
|
+
- Quyết định: chờ
|
package/templates/prd.md
CHANGED
|
@@ -6,6 +6,7 @@ status: draft # draft | approved
|
|
|
6
6
|
open_questions: 0
|
|
7
7
|
approved_by: — # người duyệt PRD; bắt buộc có khi status: approved
|
|
8
8
|
approved_at: — # YYYY-MM-DD
|
|
9
|
+
refined: — # version đã refine xong (/prd <EPIC-ID> refine); bắt buộc = version khi duyệt
|
|
9
10
|
updated: {YYYY-MM-DD}
|
|
10
11
|
---
|
|
11
12
|
|
package/tools/spec_edit.py
CHANGED
|
@@ -35,9 +35,10 @@ FRONTMATTER = {
|
|
|
35
35
|
"product": {"status": ["in-progress", "ready"], "checkpoint": (0, 2)},
|
|
36
36
|
"epic": {"status": ["in-progress", "ready", "handed-off"], "checkpoint": (0, 3)},
|
|
37
37
|
"prd": {"status": ["draft", "approved"]},
|
|
38
|
+
"prd-refine": {"status": ["pending", "applied", "done"], "round": (1, 2)},
|
|
38
39
|
}
|
|
39
40
|
# Trạng thái "đã xong": chỉ đặt được khi không còn 🤖 và không còn câu hỏi mở.
|
|
40
|
-
DONE_STATUS = {"product": "ready", "epic": "ready", "prd": "approved"}
|
|
41
|
+
DONE_STATUS = {"product": "ready", "epic": "ready", "prd": "approved", "prd-refine": "done"}
|
|
41
42
|
COMMON_INT = {"open_questions": (0, 999)}
|
|
42
43
|
DATE = re.compile(r"^\d{4}-\d{2}-\d{2}$")
|
|
43
44
|
VERSION = re.compile(r"^\d+\.\d+$")
|
|
@@ -128,7 +129,7 @@ def validate(ftype, key, value):
|
|
|
128
129
|
fail("type `%s` chưa được khai trong spec_edit.py" % ftype)
|
|
129
130
|
if key == "status" and value not in rules["status"]:
|
|
130
131
|
fail("status=%s không hợp lệ với type %s. Chỉ nhận: %s" % (value, ftype, ", ".join(rules["status"])))
|
|
131
|
-
rng = rules.get(key) if key
|
|
132
|
+
rng = rules.get(key) if isinstance(rules.get(key), tuple) else COMMON_INT.get(key)
|
|
132
133
|
if rng:
|
|
133
134
|
if not value.isdigit() or not rng[0] <= int(value) <= rng[1]:
|
|
134
135
|
fail("%s=%s không hợp lệ. Phải là số nguyên từ %d đến %d" % (key, value, rng[0], rng[1]))
|
|
@@ -136,11 +137,50 @@ def validate(ftype, key, value):
|
|
|
136
137
|
fail("updated=%s không hợp lệ. Định dạng YYYY-MM-DD" % value)
|
|
137
138
|
if key == "approved_at" and value != "—" and not DATE.match(value):
|
|
138
139
|
fail("approved_at=%s không hợp lệ. Định dạng YYYY-MM-DD, hoặc — nếu chưa duyệt" % value)
|
|
139
|
-
if key
|
|
140
|
-
fail("
|
|
140
|
+
if key in ("version", "prd_version") and not VERSION.match(value):
|
|
141
|
+
fail("%s=%s không hợp lệ. Định dạng số.số, ví dụ 1.0, 1.1" % (key, value))
|
|
142
|
+
if key == "refined" and value != "—" and not VERSION.match(value):
|
|
143
|
+
fail("refined=%s không hợp lệ. Là version PRD đã refine xong (vd 1.1), hoặc —" % value)
|
|
141
144
|
|
|
142
145
|
|
|
143
|
-
|
|
146
|
+
# ── Refine: finding critical / major chưa có quyết định thì chưa được đi tiếp ──────────────
|
|
147
|
+
FINDING = re.compile(r"^### (F\d+) · [^·\n]+ · (critical|major|minor) ·", re.M)
|
|
148
|
+
DECISION = re.compile(r"^- Quyết định:\s*(.*)$", re.M)
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
def undecided_findings(text):
|
|
152
|
+
"""Mã các finding critical / major còn `chờ` (hoặc chưa ghi quyết định)."""
|
|
153
|
+
out = []
|
|
154
|
+
heads = list(FINDING.finditer(text))
|
|
155
|
+
for n, h in enumerate(heads):
|
|
156
|
+
end = heads[n + 1].start() if n + 1 < len(heads) else len(text)
|
|
157
|
+
block = text[h.end():end]
|
|
158
|
+
block = re.split(r"^##\s", block, maxsplit=1, flags=re.M)[0]
|
|
159
|
+
d = DECISION.search(block)
|
|
160
|
+
if h.group(2) in ("critical", "major") and (not d or d.group(1).strip().startswith("chờ")):
|
|
161
|
+
out.append(h.group(1))
|
|
162
|
+
return out
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
def refine_path(prd_path):
|
|
166
|
+
return os.path.join(os.path.dirname(os.path.abspath(prd_path)), "review", "prd-refine.md")
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
def guard_refined(path, block):
|
|
170
|
+
"""PRD chỉ được duyệt khi đã refine đúng version đang có và không còn critical/major chưa quyết."""
|
|
171
|
+
ver = re.search(r"^version:\s*(\S+)", block, re.M)
|
|
172
|
+
ref = re.search(r"^refined:\s*(\S+)", block, re.M)
|
|
173
|
+
if not ref or not ver or ref.group(1) != ver.group(1):
|
|
174
|
+
fail("không đặt được status=approved: bản v%s chưa refine (refined=%s). Chạy `/prd <EPIC-ID> refine` trước."
|
|
175
|
+
% (ver.group(1) if ver else "?", ref.group(1) if ref else "chưa có"))
|
|
176
|
+
rp = refine_path(path)
|
|
177
|
+
pending = undecided_findings(read(rp)) if os.path.isfile(rp) else []
|
|
178
|
+
if pending:
|
|
179
|
+
fail("không đặt được status=approved: còn finding critical/major chưa có quyết định: %s (xem %s)"
|
|
180
|
+
% (", ".join(pending), rp))
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
def guard_done(ftype, block, body, path):
|
|
144
184
|
"""Chặn đặt trạng thái 'đã xong' khi còn mục chờ PO — AI không được tự khẳng định."""
|
|
145
185
|
done = DONE_STATUS.get(ftype)
|
|
146
186
|
sm = re.search(r"^status:\s*(\S+)", block, re.M)
|
|
@@ -159,6 +199,11 @@ def guard_done(ftype, block, body):
|
|
|
159
199
|
if fm and fm.group(1) == "—":
|
|
160
200
|
fail("không đặt được status=%s: chưa có %s. Đặt cùng lệnh, ví dụ: "
|
|
161
201
|
"set <file> status=%s approved_by=<tên> approved_at=YYYY-MM-DD" % (done, field, done))
|
|
202
|
+
if ftype == "prd":
|
|
203
|
+
guard_refined(path, block)
|
|
204
|
+
if ftype == "prd-refine" and undecided_findings(body):
|
|
205
|
+
fail("không đặt được status=done: còn finding critical/major chưa có quyết định: %s"
|
|
206
|
+
% ", ".join(undecided_findings(body)))
|
|
162
207
|
|
|
163
208
|
|
|
164
209
|
def cmd_set(path, pairs):
|
|
@@ -182,7 +227,7 @@ def cmd_set(path, pairs):
|
|
|
182
227
|
# Giữ nguyên comment đi kèm ở cuối dòng, chỉ đổi giá trị.
|
|
183
228
|
block = line.sub(lambda mm: mm.group(1) + value + (mm.group(3) or ""), block, count=1)
|
|
184
229
|
|
|
185
|
-
guard_done(ftype, block, text[m.end():])
|
|
230
|
+
guard_done(ftype, block, text[m.end():], path)
|
|
186
231
|
write(path, text[: m.start(1)] + block + text[m.end(1):])
|
|
187
232
|
print("đã đặt %s trong %s" % (", ".join(pairs), path))
|
|
188
233
|
|
|
@@ -191,7 +236,8 @@ def cmd_set(path, pairs):
|
|
|
191
236
|
# Số và tên tiêu đề là cho người đọc, được đổi tự do. Script và AI tìm mục theo mã `sec:`.
|
|
192
237
|
SEC_KEY = re.compile(r"<!--\s*sec:([a-z0-9-]+)\s*-->")
|
|
193
238
|
HEADING = re.compile(r"^(#{2,6})\s+(.*)$")
|
|
194
|
-
TEMPLATE_OF = {"product": "product.md", "epic": "product-epic.md", "prd": "prd.md"
|
|
239
|
+
TEMPLATE_OF = {"product": "product.md", "epic": "product-epic.md", "prd": "prd.md",
|
|
240
|
+
"prd-refine": "prd-refine.md"}
|
|
195
241
|
TEMPLATES_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "templates")
|
|
196
242
|
|
|
197
243
|
|
|
@@ -286,6 +332,26 @@ def cmd_section(path, key):
|
|
|
286
332
|
"" if have else ". File theo khuôn cũ: chạy `upgrade <file>` trước."))
|
|
287
333
|
|
|
288
334
|
|
|
335
|
+
def missing_frontmatter(ftype, text):
|
|
336
|
+
"""Các dòng frontmatter có trong khuôn mà file chưa có. Giá trị mẫu dạng {…} đổi thành —."""
|
|
337
|
+
name = TEMPLATE_OF.get(ftype)
|
|
338
|
+
tpath = os.path.join(TEMPLATES_DIR, name) if name else None
|
|
339
|
+
if not tpath or not os.path.isfile(tpath):
|
|
340
|
+
return []
|
|
341
|
+
tm = re.match(r"^---\r?\n(.*?)\r?\n---", read(tpath), re.S)
|
|
342
|
+
fm = re.match(r"^---\r?\n(.*?)\r?\n---", text, re.S)
|
|
343
|
+
if not tm or not fm:
|
|
344
|
+
return []
|
|
345
|
+
have = set(re.findall(r"^([a-z_]+):", fm.group(1), re.M))
|
|
346
|
+
out = []
|
|
347
|
+
for line in tm.group(1).split("\n"):
|
|
348
|
+
k = re.match(r"^([a-z_]+):\s*(\S*)(.*)$", line)
|
|
349
|
+
if k and k.group(1) not in have:
|
|
350
|
+
value = "—" if k.group(2).startswith("{") else k.group(2)
|
|
351
|
+
out.append("%s: %s%s" % (k.group(1), value, k.group(3)))
|
|
352
|
+
return out
|
|
353
|
+
|
|
354
|
+
|
|
289
355
|
def cmd_upgrade(path):
|
|
290
356
|
"""Gắn mã sec: cho file theo khuôn cũ, bằng cách khớp tiêu đề với khuôn. Chỉ cần chạy một lần."""
|
|
291
357
|
text = read(path)
|
|
@@ -308,6 +374,11 @@ def cmd_upgrade(path):
|
|
|
308
374
|
else:
|
|
309
375
|
unknown.append(title)
|
|
310
376
|
new_text = "\n".join(lines)
|
|
377
|
+
# Trường frontmatter khuôn mới có mà file cũ chưa có (vd refined, approved_by) → thêm với giá trị —.
|
|
378
|
+
add_fm = missing_frontmatter(ftype, new_text)
|
|
379
|
+
if add_fm:
|
|
380
|
+
fm = re.match(r"^---\r?\n(.*?)(\r?\n)---", new_text, re.S)
|
|
381
|
+
new_text = new_text[:fm.end(1)] + "".join(fm.group(2) + l for l in add_fm) + new_text[fm.end(1):]
|
|
311
382
|
# Mã Business Rule: R3 → BR3 (khuôn từ 0.6.1). Epic: đổi mọi chỗ. PRD: chỉ trong (nguồn: …).
|
|
312
383
|
renamed = [0]
|
|
313
384
|
if ftype == "epic":
|
|
@@ -322,6 +393,8 @@ def cmd_upgrade(path):
|
|
|
322
393
|
write(path, new_text)
|
|
323
394
|
missing = [(k, orig) for k, _, orig in tpl if k not in used]
|
|
324
395
|
print("đã gắn mã: %s" % (", ".join(added) or "không có gì mới"))
|
|
396
|
+
if add_fm:
|
|
397
|
+
print("đã thêm trường frontmatter: " + ", ".join(l.split(":")[0] for l in add_fm))
|
|
325
398
|
if renamed[0]:
|
|
326
399
|
print("đã đổi mã Business Rule R… → BR…: %d chỗ" % renamed[0])
|
|
327
400
|
if unknown:
|