@damphuquy/agent-init 1.4.0 → 1.4.2
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/README.md +8 -2
- package/README.vi.md +8 -2
- package/dist/cli.d.ts +4 -2
- package/dist/cli.d.ts.map +1 -1
- package/dist/cli.js +49 -5
- package/dist/cli.js.map +1 -1
- package/dist/config.d.ts +4 -1
- package/dist/config.d.ts.map +1 -1
- package/dist/config.js +67 -1
- package/dist/config.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/scaffolder.d.ts +2 -1
- package/dist/scaffolder.d.ts.map +1 -1
- package/dist/scaffolder.js +64 -12
- package/dist/scaffolder.js.map +1 -1
- package/dist/types.d.ts +5 -0
- package/dist/types.d.ts.map +1 -1
- package/dist/ui.d.ts +3 -1
- package/dist/ui.d.ts.map +1 -1
- package/dist/ui.js +71 -6
- package/dist/ui.js.map +1 -1
- package/package.json +2 -2
- package/templates/vi/.agents/README.md +29 -0
- package/templates/vi/.agents/behavior.md +72 -0
- package/templates/vi/.agents/conventions/naming.md +55 -0
- package/templates/vi/.agents/guardrails.md +113 -0
- package/templates/vi/AGENTS.md +133 -0
- package/templates/vi/process/.editorconfig +15 -0
- package/templates/vi/process/README.md +150 -0
- package/templates/vi/process/_seeds/_GUIDE.md +170 -0
- package/templates/vi/process/_seeds/cancellation-template.md.seed +79 -0
- package/templates/vi/process/_seeds/context-group.md.seed +154 -0
- package/templates/vi/process/_seeds/decision-template.md.seed +143 -0
- package/templates/vi/process/_seeds/handoff-template.md.seed +79 -0
- package/templates/vi/process/_seeds/plan-template.md.seed +135 -0
- package/templates/vi/process/_seeds/program-template.md.seed +56 -0
- package/templates/vi/process/_seeds/results-template.tsv.seed +5 -0
- package/templates/vi/process/_seeds/review-template.md.seed +149 -0
- package/templates/vi/process/_seeds/state-template.md.seed +149 -0
- package/templates/vi/process/_seeds/task-template.md.seed +196 -0
- package/templates/vi/process/context/all-context.md +53 -0
- package/templates/vi/process/context/planning/all-planning.md +31 -0
- package/templates/vi/process/context/tests/all-tests.md +56 -0
- package/templates/vi/process/development-protocols/all-development-protocols.md +27 -0
- package/templates/vi/process/development-protocols/implementation-standards.md +28 -0
- package/templates/vi/process/development-protocols/orchestration.md +24 -0
- package/templates/vi/process/features/active/.gitkeep +0 -0
- package/templates/vi/process/features/backlog/.gitkeep +0 -0
- package/templates/vi/process/features/completed/.gitkeep +0 -0
- package/templates/vi/process/general-plans/active/.gitkeep +0 -0
- package/templates/vi/process/general-plans/backlog/.gitkeep +0 -0
- package/templates/vi/process/general-plans/completed/.gitkeep +0 -0
- /package/templates/{.agents → en/.agents}/README.md +0 -0
- /package/templates/{.agents → en/.agents}/behavior.md +0 -0
- /package/templates/{.agents → en/.agents}/conventions/naming.md +0 -0
- /package/templates/{.agents → en/.agents}/guardrails.md +0 -0
- /package/templates/{AGENTS.md → en/AGENTS.md} +0 -0
- /package/templates/{process → en/process}/.editorconfig +0 -0
- /package/templates/{process → en/process}/README.md +0 -0
- /package/templates/{process → en/process}/_seeds/_GUIDE.md +0 -0
- /package/templates/{process → en/process}/_seeds/cancellation-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/context-group.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/decision-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/handoff-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/plan-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/program-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/results-template.tsv.seed +0 -0
- /package/templates/{process → en/process}/_seeds/review-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/state-template.md.seed +0 -0
- /package/templates/{process → en/process}/_seeds/task-template.md.seed +0 -0
- /package/templates/{process → en/process}/context/all-context.md +0 -0
- /package/templates/{process → en/process}/context/planning/all-planning.md +0 -0
- /package/templates/{process → en/process}/context/tests/all-tests.md +0 -0
- /package/templates/{process → en/process}/development-protocols/all-development-protocols.md +0 -0
- /package/templates/{process → en/process}/development-protocols/implementation-standards.md +0 -0
- /package/templates/{process → en/process}/development-protocols/orchestration.md +0 -0
- /package/templates/{process → en/process}/features/active/.gitkeep +0 -0
- /package/templates/{process → en/process}/features/backlog/.gitkeep +0 -0
- /package/templates/{process → en/process}/features/completed/.gitkeep +0 -0
- /package/templates/{process → en/process}/general-plans/active/.gitkeep +0 -0
- /package/templates/{process → en/process}/general-plans/backlog/.gitkeep +0 -0
- /package/templates/{process → en/process}/general-plans/completed/.gitkeep +0 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Quy Trình & Điều Phối Task (RIPER-5 Framework)
|
|
2
|
+
|
|
3
|
+
<process_orchestration version="3.0" framework="RIPER-5">
|
|
4
|
+
|
|
5
|
+
<overview>
|
|
6
|
+
Trung tâm điều phối vận hành và mẫu chuẩn để quản lý các tác vụ kỹ thuật, điều phối thực thi AI Agent trong subsystem/project này. Mỗi task đang active là một không gian kỹ thuật độc lập khép kín với đầy đủ chuỗi artifact RIPER-5.
|
|
7
|
+
</overview>
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 1. Cấu Trúc Thư Mục
|
|
12
|
+
|
|
13
|
+
```text
|
|
14
|
+
process/
|
|
15
|
+
├── README.md # Hướng dẫn vận hành (tệp này)
|
|
16
|
+
├── .editorconfig # Cấu hình định dạng chuẩn cho markdown, tsv, json
|
|
17
|
+
├── _seeds/ # Blueprints mẫu chuẩn (chỉ đọc)
|
|
18
|
+
│ ├── _GUIDE.md # Danh mục mẫu, chuỗi artifact và lệnh khởi tạo
|
|
19
|
+
│ ├── task-template.md.seed # Hợp đồng master & lưu vết trạng thái RIPER
|
|
20
|
+
│ ├── context-group.md.seed # Artifact giai đoạn Research (Khảo sát)
|
|
21
|
+
│ ├── decision-template.md.seed # Artifact giai đoạn Innovate (Lưu vết Gate 1)
|
|
22
|
+
│ ├── plan-template.md.seed # Artifact giai đoạn Plan (Hợp đồng thực thi, Gate 2)
|
|
23
|
+
│ ├── state-template.md.seed # Bộ nhớ bền vững trong vòng lặp Execute
|
|
24
|
+
│ ├── review-template.md.seed # Artifact giai đoạn Review (Gate 3)
|
|
25
|
+
│ ├── handoff-template.md.seed # Tóm tắt bàn giao cuối cùng (ngắn gọn)
|
|
26
|
+
│ ├── cancellation-template.md.seed # Biên bản hủy task lưu giữ tri thức
|
|
27
|
+
│ ├── results-template.tsv.seed # Bảng theo dõi số liệu benchmark & định lượng
|
|
28
|
+
│ └── program-template.md.seed # Bản thiết kế chương trình lớn nhiều giai đoạn
|
|
29
|
+
├── context/ # Cơ sở tri thức bền vững & router định tuyến
|
|
30
|
+
│ ├── all-context.md # Router định tuyến ngữ cảnh gốc
|
|
31
|
+
│ ├── planning/all-planning.md # Quy chuẩn lập kế hoạch & lát cắt dọc (vertical slice)
|
|
32
|
+
│ └── tests/all-tests.md # Kim tự tháp test, chính sách harness & quy ước mock
|
|
33
|
+
├── development-protocols/ # Quy tắc kỹ thuật & harness thực thi
|
|
34
|
+
│ ├── all-development-protocols.md # Mục lục protocols
|
|
35
|
+
│ ├── orchestration.md # Quy tắc phân công subagent
|
|
36
|
+
│ └── implementation-standards.md # Tiêu chuẩn kiểu dữ liệu, linting và kiểm thử
|
|
37
|
+
├── features/ # Tính năng theo domain (≥5 files / ≥3 phases)
|
|
38
|
+
│ ├── active/ # Thư mục task đang làm: {CHG-ID}-{task-slug}/
|
|
39
|
+
│ │ └── CHG-XXX-example/ # Mỗi task một thư mục riêng biệt
|
|
40
|
+
│ │ ├── task.md # Hợp đồng master & lưu vết trạng thái
|
|
41
|
+
│ │ ├── research.md # Kết quả khảo sát mã nguồn
|
|
42
|
+
│ │ ├── decision.md # Các phương án đề xuất (Innovate)
|
|
43
|
+
│ │ ├── plan.md # Kế hoạch lát cắt dọc chi tiết
|
|
44
|
+
│ │ ├── state.md # Bộ nhớ tiến độ vòng lặp thực thi
|
|
45
|
+
│ │ ├── review.md # Biên bản nghiệm thu kiểm thử
|
|
46
|
+
│ │ ├── handoff.md # Tóm tắt bàn giao
|
|
47
|
+
│ │ ├── results.tsv # (Tùy chọn) Theo dõi benchmark & metric
|
|
48
|
+
│ │ └── cancelled.md # (Nếu hủy) Lưu vết nguyên nhân & hoàn nguyên
|
|
49
|
+
│ ├── completed/ # Lưu trữ các task đã hoàn thành
|
|
50
|
+
│ └── backlog/ # Ghi chú task tồn đọng: {note_slug}_NOTE_{dd-mm-yy}.md
|
|
51
|
+
└── general-plans/ # Task độc lập, xuyên suốt, sửa bug nhanh (<5 files)
|
|
52
|
+
├── active/
|
|
53
|
+
├── completed/
|
|
54
|
+
└── backlog/
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 2. Chuỗi Artifact RIPER-5 & Quy Trình Thực Thi
|
|
60
|
+
|
|
61
|
+
Mỗi task tạo ra một chuỗi artifact tuần tự. Khởi tạo chúng từng bước khi task tiến triển:
|
|
62
|
+
|
|
63
|
+
```mermaid
|
|
64
|
+
flowchart TD
|
|
65
|
+
subgraph Init["0. Khởi tạo"]
|
|
66
|
+
Seed["task-template.md.seed"] -->|Khởi tạo| Task["task.md (Đặc tả & Tiêu chí AC)"]
|
|
67
|
+
end
|
|
68
|
+
subgraph R1["1. RESEARCH (Chỉ đọc)"]
|
|
69
|
+
Task --> Res["research.md"] --> G0{"Gate G0 (Tự động)"}
|
|
70
|
+
end
|
|
71
|
+
subgraph I2["2. INNOVATE (Chỉ đọc)"]
|
|
72
|
+
G0 --> Dec["decision.md (2-3 Phương án)"] --> G1{"Gate G1 (Kỹ sư duyệt)"}
|
|
73
|
+
end
|
|
74
|
+
subgraph P3["3. PLAN (Chỉ lập kế hoạch)"]
|
|
75
|
+
G1 --> Plan["plan.md (Lát cắt dọc)"] --> G2{"Gate G2 (Kỹ sư ký duyệt)"}
|
|
76
|
+
end
|
|
77
|
+
subgraph E4["4. EXECUTE (Đọc/Ghi theo phạm vi)"]
|
|
78
|
+
G2 --> Code["Thực thi từng Slice"] --> Test["Chạy Verifiers"] --> State["state.md (Bộ nhớ)"]
|
|
79
|
+
end
|
|
80
|
+
subgraph R5["5. REVIEW (Chỉ đọc)"]
|
|
81
|
+
State --> Rev["review.md (Kiểm toán diff)"] --> G3{"Gate G3 (Kỹ sư duyệt)"}
|
|
82
|
+
end
|
|
83
|
+
subgraph Done["6. HOÀN THÀNH"]
|
|
84
|
+
G3 --> Arch["Chuyển sang completed/"] --> Handoff["handoff.md"]
|
|
85
|
+
end
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
```text
|
|
89
|
+
task.md ← (luôn có) Hợp đồng master, trạng thái RIPER phase/gate, AC, decisions
|
|
90
|
+
research.md ← (Research) Luồng thực thi, bằng chứng, ranh giới hệ thống
|
|
91
|
+
decision.md ← (Innovate) Các phương án, bảng đánh đổi, Gate 1 — kỹ sư bắt buộc duyệt
|
|
92
|
+
plan.md ← (Plan) Các lát cắt, verifiers, hợp đồng phạm vi, Gate 2 — kỹ sư duyệt
|
|
93
|
+
state.md ← (Execute) Tiến độ từng slice, bộ nhớ lỗi, ngân sách thử lại
|
|
94
|
+
review.md ← (Review) Phát hiện kiểm toán, ma trận kiểm chứng, Gate 3
|
|
95
|
+
handoff.md ← (Complete) Tóm tắt bàn giao ngắn gọn
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Bảng Ánh Xạ Khái Niệm → Tệp Artifact
|
|
99
|
+
|
|
100
|
+
| Khái niệm | Artifact |
|
|
101
|
+
|---|---|
|
|
102
|
+
| Task / Đặc tả | `task.md` |
|
|
103
|
+
| Khảo sát / Ngữ cảnh | `research.md` |
|
|
104
|
+
| Đề xuất / Quyết định | `decision.md` |
|
|
105
|
+
| Kế hoạch lát cắt | `plan.md` |
|
|
106
|
+
| Trạng thái vòng lặp | `state.md` |
|
|
107
|
+
| Thực thi | mã nguồn + kiểm thử + `state.md` |
|
|
108
|
+
| Nghiệm thu | `review.md` |
|
|
109
|
+
| Bàn giao | `handoff.md` |
|
|
110
|
+
| Hủy task | `cancelled.md` (lưu giữ tri thức khi hủy bỏ) |
|
|
111
|
+
| Benchmark / Định lượng | `results.tsv` (theo dõi hiệu năng và số liệu đánh giá) |
|
|
112
|
+
| Gate 1 | Phê duyệt trong `decision.md` |
|
|
113
|
+
| Gate 2 | Phê duyệt trong `plan.md` |
|
|
114
|
+
| Gate 3 | Phê duyệt trong `review.md` |
|
|
115
|
+
| Harness / Chính sách | `AGENTS.md` + `development-protocols/` |
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## 3. Các Giai Đoạn Vận Hành RIPER-5
|
|
120
|
+
|
|
121
|
+
<operational_phases>
|
|
122
|
+
<phase order="1" name="Research">
|
|
123
|
+
CHỈ ĐỌC. Nạp đặc tả task; tuân theo `<information_priority>`; tạo `research.md`.
|
|
124
|
+
Phân loại bằng chứng: Confirmed (Đã xác nhận) / Observed (Quan sát) / Hypothesized (Giả thuyết).
|
|
125
|
+
Vượt qua Tiêu chí rời khỏi Khảo sát (Gate 0) trước khi chuyển tiếp.
|
|
126
|
+
</phase>
|
|
127
|
+
|
|
128
|
+
<phase order="2" name="Innovate">
|
|
129
|
+
CHỈ ĐỌC. Đề xuất 2–3 phương án kèm ma trận đánh đổi. Không tự ý đơn phương quyết định.
|
|
130
|
+
Tạo `decision.md`. Kỹ sư phê duyệt Gate 1.
|
|
131
|
+
</phase>
|
|
132
|
+
|
|
133
|
+
<phase order="3" name="Plan">
|
|
134
|
+
Chỉ tạo/sửa artifact kế hoạch — không sửa mã nguồn.
|
|
135
|
+
Phân rã thành các lát cắt dọc (vertical slices) kèm verifiers, điểm hoàn nguyên và hợp đồng phạm vi.
|
|
136
|
+
Tạo `plan.md`. Kỹ sư phê duyệt Gate 2.
|
|
137
|
+
</phase>
|
|
138
|
+
|
|
139
|
+
<phase order="4" name="Execute">
|
|
140
|
+
Chỉ đọc/ghi trong phạm vi đã duyệt từ `plan.md`.
|
|
141
|
+
Thực hiện từng lát cắt một. Chạy verifier sau mỗi slice. Cập nhật `state.md` sau mỗi slice.
|
|
142
|
+
</phase>
|
|
143
|
+
|
|
144
|
+
<phase order="5" name="Review">
|
|
145
|
+
CHỈ ĐỌC. Có thể chạy các lệnh kiểm thử xác minh. Không sửa mã nguồn.
|
|
146
|
+
Tạo `review.md` kèm các phát hiện. Gate 3 phải PASS trước khi bàn giao.
|
|
147
|
+
</phase>
|
|
148
|
+
</operational_phases>
|
|
149
|
+
|
|
150
|
+
</process_orchestration>
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# Cẩm Nang Blueprints & Seeds Mẫu (Seeds Guide)
|
|
2
|
+
|
|
3
|
+
<seeds_guide version="2.0" framework="RIPER-5">
|
|
4
|
+
|
|
5
|
+
<scope>
|
|
6
|
+
`_seeds/` là thư mục mẫu chuẩn chỉ đọc (read-only scaffolding).
|
|
7
|
+
Sao chép và khởi tạo các seed này khi tạo task mới, chương trình lớn hoặc nhóm ngữ cảnh.
|
|
8
|
+
Không bao giờ chỉnh sửa trực tiếp bên trong `_seeds/` — luôn luôn sao chép trước khi dùng.
|
|
9
|
+
</scope>
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## 1. Danh Mục Blueprints Mẫu
|
|
14
|
+
|
|
15
|
+
<catalog>
|
|
16
|
+
|
|
17
|
+
<seed type="task" path="task-template.md.seed">
|
|
18
|
+
Hợp đồng master và bản lưu vết trạng thái xuyên suốt toàn bộ vòng đời RIPER-5.
|
|
19
|
+
Bao gồm: Metadata kiểm soát task, Đặc tả (Spec), Ranh giới ngữ cảnh, Chiến lược kiểm chứng,
|
|
20
|
+
Quyết định kỹ thuật, Kế hoạch thực thi RIPER-5 (kèm Gates G0–G3), và Ranh giới an toàn (Guardrails).
|
|
21
|
+
</seed>
|
|
22
|
+
|
|
23
|
+
<seed type="research" path="context-group.md.seed">
|
|
24
|
+
Artifact của giai đoạn Khảo sát (Research). CHỈ ĐỌC trong lúc thực hiện.
|
|
25
|
+
Bao gồm: Hành vi hiện tại, Luồng thực thi, Các thành phần liên quan, Ranh giới hệ thống,
|
|
26
|
+
Test hiện có, Cấu hình/Runtime, Phân tích nguồn sự thật, Phân loại bằng chứng
|
|
27
|
+
(Confirmed / Observed / Hypothesized), Giả định, Danh sách file bị ảnh hưởng,
|
|
28
|
+
Quyết định mở, và Tiêu chí rời khỏi Khảo sát.
|
|
29
|
+
</seed>
|
|
30
|
+
|
|
31
|
+
<seed type="decision" path="decision-template.md.seed">
|
|
32
|
+
Artifact của giai đoạn Đề xuất giải pháp (Innovate). Bộ nhớ lưu vết Gate 1.
|
|
33
|
+
Bao gồm: Câu hỏi quyết định, Các phương án (A/B/C) kèm ma trận đánh đổi (Trade-off),
|
|
34
|
+
Khuyến nghị của Agent, Quyết định của Kỹ sư (bắt buộc con người điền), Ràng buộc phái sinh,
|
|
35
|
+
Bằng chứng còn cần xác minh, và Checklist Gate 1.
|
|
36
|
+
</seed>
|
|
37
|
+
|
|
38
|
+
<seed type="plan" path="plan-template.md.seed">
|
|
39
|
+
Artifact của giai đoạn Lập kế hoạch (Plan). Bản hợp đồng thực thi.
|
|
40
|
+
Bao gồm: Artifact đầu vào, Ràng buộc thực thi (file được phép/bị cấm, lệnh được phép),
|
|
41
|
+
Bảng tóm tắt lát cắt (Slice Summary), Chi tiết từng slice (mục tiêu, thay đổi cụ thể,
|
|
42
|
+
verifier, bằng chứng kỳ vọng, điểm hoàn nguyên rollback, điều kiện dừng),
|
|
43
|
+
Hợp đồng phạm vi (Scope Contract), Ma trận kiểm chứng, và Checklist Gate 2.
|
|
44
|
+
</seed>
|
|
45
|
+
|
|
46
|
+
<seed type="state" path="state-template.md.seed">
|
|
47
|
+
Bộ nhớ bền vững của vòng lặp Thực thi (Execute). Cập nhật ngay sau mỗi slice.
|
|
48
|
+
Bao gồm: Phase/Gate hiện tại, Tham chiếu task, Mục tiêu/Bất biến, Quyết định đã duyệt,
|
|
49
|
+
Các slice đã xong, Slice hiện tại, Git diff hiện tại, Bằng chứng kiểm chứng,
|
|
50
|
+
Bộ nhớ lỗi (failure memory: signature/hypothesis/experiment/result), Ngân sách thử lại,
|
|
51
|
+
Thay đổi phạm vi, Rủi ro mở, Hành động tiếp theo, và Kiểm tra độ tươi mới của ngữ cảnh.
|
|
52
|
+
</seed>
|
|
53
|
+
|
|
54
|
+
<seed type="review" path="review-template.md.seed">
|
|
55
|
+
Artifact của giai đoạn Nghiệm thu (Review). Tách biệt hoàn toàn với Handoff.
|
|
56
|
+
Bao gồm: Phạm vi review, Review hành vi, Review kiến trúc, Review dữ liệu,
|
|
57
|
+
Review bảo mật, Review hồi quy, Bảng phát hiện (findings: category/severity/type),
|
|
58
|
+
Ma trận kiểm chứng, Rủi ro tồn đọng (residual risk), Quyết định review, và Checklist Gate 3.
|
|
59
|
+
</seed>
|
|
60
|
+
|
|
61
|
+
<seed type="handoff" path="handoff-template.md.seed">
|
|
62
|
+
Artifact tóm tắt bàn giao cuối cùng. Cố tình thiết kế ngắn gọn.
|
|
63
|
+
Trả lời 4 câu hỏi: Đã thay đổi gì? Vì sao? Bằng chứng nào chứng minh? Còn rủi ro gì?
|
|
64
|
+
KHÔNG lặp lại chi tiết dài dòng từ các artifact research/plan/review.
|
|
65
|
+
</seed>
|
|
66
|
+
|
|
67
|
+
<seed type="program" path="program-template.md.seed">
|
|
68
|
+
Bản thiết kế chương trình lớn nhiều giai đoạn với kế hoạch tổng thể, phân rã phase,
|
|
69
|
+
danh mục bán kính ảnh hưởng (blast radius), và quy tắc cổng chuyển giao từng phase.
|
|
70
|
+
</seed>
|
|
71
|
+
|
|
72
|
+
<seed type="cancellation" path="cancellation-template.md.seed">
|
|
73
|
+
Biên bản hủy task. Lưu giữ kết quả khảo sát, lý do quyết định,
|
|
74
|
+
các prototype/test có thể tái sử dụng, và kiểm tra hoàn nguyên khi một task đang làm bị dừng giữa chừng.
|
|
75
|
+
</seed>
|
|
76
|
+
|
|
77
|
+
<seed type="results" path="results-template.tsv.seed">
|
|
78
|
+
Bảng đăng ký đánh giá số liệu benchmark và định lượng.
|
|
79
|
+
Dùng để theo dõi latency, throughput, bộ nhớ hoặc điểm đánh giá qua các vòng lặp và lát cắt dọc.
|
|
80
|
+
</seed>
|
|
81
|
+
|
|
82
|
+
</catalog>
|
|
83
|
+
|
|
84
|
+
---
|
|
85
|
+
|
|
86
|
+
## 2. Chuỗi Artifact Trong Mỗi Task
|
|
87
|
+
|
|
88
|
+
Mỗi task active đều tuân thủ chuỗi artifact sau:
|
|
89
|
+
|
|
90
|
+
```text
|
|
91
|
+
task.md ← Hợp đồng master & lưu vết trạng thái RIPER
|
|
92
|
+
research.md ← Đầu ra giai đoạn Research (chế độ CHỈ ĐỌC)
|
|
93
|
+
decision.md ← Đầu ra giai đoạn Innovate, lưu vết Gate 1
|
|
94
|
+
plan.md ← Đầu ra giai đoạn Plan, hợp đồng thực thi, Gate 2
|
|
95
|
+
state.md ← Bộ nhớ tiến độ vòng lặp Execute (cập nhật sau mỗi slice)
|
|
96
|
+
review.md ← Đầu ra giai đoạn Review, Gate 3
|
|
97
|
+
handoff.md ← Tóm tắt bàn giao cuối cùng (ngắn gọn)
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Bảng Ánh Xạ Khái Niệm → Tệp Artifact
|
|
101
|
+
|
|
102
|
+
| Khái niệm | Artifact |
|
|
103
|
+
|---|---|
|
|
104
|
+
| Task / Đặc tả | `task.md` |
|
|
105
|
+
| Khảo sát / Ngữ cảnh | `research.md` |
|
|
106
|
+
| Đề xuất / Quyết định | `decision.md` |
|
|
107
|
+
| Kế hoạch lát cắt | `plan.md` |
|
|
108
|
+
| Trạng thái vòng lặp | `state.md` |
|
|
109
|
+
| Thực thi | mã nguồn + kiểm thử + `state.md` |
|
|
110
|
+
| Nghiệm thu | `review.md` |
|
|
111
|
+
| Bàn giao | `handoff.md` |
|
|
112
|
+
| Gate 1 | Phê duyệt trong `decision.md` |
|
|
113
|
+
| Gate 2 | Phê duyệt trong `plan.md` |
|
|
114
|
+
| Gate 3 | Phê duyệt trong `review.md` |
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## 3. Cấu Trúc Thư Mục Task Được Khuyến Nghị
|
|
119
|
+
|
|
120
|
+
### Cấu Trúc Dự Án Đơn Chuẩn (Standard Single-Project)
|
|
121
|
+
```text
|
|
122
|
+
process/features/active/CHG-017-your-feature/
|
|
123
|
+
├── task.md ← khởi tạo từ task-template.md.seed (Đặc tả Master & AC)
|
|
124
|
+
├── research.md ← khởi tạo từ context-group.md.seed (Kết quả khảo sát)
|
|
125
|
+
├── decision.md ← khởi tạo từ decision-template.md.seed (Phương án Gate 1)
|
|
126
|
+
├── plan.md ← khởi tạo từ plan-template.md.seed (Hợp đồng thực thi Gate 2)
|
|
127
|
+
├── state.md ← khởi tạo từ state-template.md.seed (Bộ nhớ tiến độ)
|
|
128
|
+
├── review.md ← khởi tạo từ review-template.md.seed (Biên bản kiểm toán Gate 3)
|
|
129
|
+
├── handoff.md ← khởi tạo từ handoff-template.md.seed (Tóm tắt bàn giao)
|
|
130
|
+
├── results.tsv ← (Tùy chọn) khởi tạo từ results-template.tsv.seed (Metrics/Benchmarks)
|
|
131
|
+
└── cancelled.md ← (Nếu hủy task) khởi tạo từ cancellation-template.md.seed
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
### Cấu Trúc Monorepo / Đa Miền (Tùy Chọn)
|
|
135
|
+
Khi làm việc trong Monorepo với các domain độc lập (ví dụ: `mobile-app`, `billing-service`), phân chia features theo domain:
|
|
136
|
+
```text
|
|
137
|
+
process/features/{domain-slug}/
|
|
138
|
+
├── active/
|
|
139
|
+
│ └── CHG-XXX-your-feature/
|
|
140
|
+
├── backlog/
|
|
141
|
+
└── completed/
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
Không nhất thiết phải tạo tất cả các artifact ngay từ đầu. Hãy tạo dần dần khi task tiến triển qua các giai đoạn RIPER.
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## 4. Các Lệnh Khởi Tạo Mẫu (Copy Commands)
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
# Tạo thư mục task mới
|
|
152
|
+
mkdir -p process/features/active/CHG-XXX-your-feature
|
|
153
|
+
|
|
154
|
+
# Khởi tạo các seed cơ bản vào thư mục task
|
|
155
|
+
cp process/_seeds/task-template.md.seed process/features/active/CHG-XXX-your-feature/task.md
|
|
156
|
+
cp process/_seeds/context-group.md.seed process/features/active/CHG-XXX-your-feature/research.md
|
|
157
|
+
cp process/_seeds/decision-template.md.seed process/features/active/CHG-XXX-your-feature/decision.md
|
|
158
|
+
cp process/_seeds/plan-template.md.seed process/features/active/CHG-XXX-your-feature/plan.md
|
|
159
|
+
cp process/_seeds/state-template.md.seed process/features/active/CHG-XXX-your-feature/state.md
|
|
160
|
+
cp process/_seeds/review-template.md.seed process/features/active/CHG-XXX-your-feature/review.md
|
|
161
|
+
cp process/_seeds/handoff-template.md.seed process/features/active/CHG-XXX-your-feature/handoff.md
|
|
162
|
+
|
|
163
|
+
# (Tùy chọn) Khi cần theo dõi hiệu năng hoặc số liệu benchmark:
|
|
164
|
+
cp process/_seeds/results-template.tsv.seed process/features/active/CHG-XXX-your-feature/results.tsv
|
|
165
|
+
|
|
166
|
+
# (Khi cần hủy bỏ một task đang dang dở):
|
|
167
|
+
cp process/_seeds/cancellation-template.md.seed process/features/active/CHG-XXX-your-feature/cancelled.md
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
</seeds_guide>
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Biên Bản Hủy Task (Cancellation Record): [TASK-ID] [Tiêu Đề Task]
|
|
2
|
+
|
|
3
|
+
<cancellation_record task_id="[TASK-ID]" version="1.0" framework="RIPER-5">
|
|
4
|
+
|
|
5
|
+
<!--
|
|
6
|
+
QUY CHUẨN HỦY BỎ TASK:
|
|
7
|
+
- Mục đích: Lưu giữ tri thức khảo sát, phát hiện kỹ thuật và lý do quyết định khi một task bị hủy giữa chừng.
|
|
8
|
+
- Tuyệt đối không xóa thẳng thư mục task nếu đã diễn ra khảo sát hoặc lập kế hoạch một phần.
|
|
9
|
+
- Khởi tạo tệp này dưới dạng `cancelled.md` bên trong thư mục task.
|
|
10
|
+
- Hoàn thành checklist hoàn nguyên, sau đó chuyển thư mục task sang `completed/` (hoặc `cancelled/`).
|
|
11
|
+
-->
|
|
12
|
+
|
|
13
|
+
<status>
|
|
14
|
+
<phase_at_cancellation>[RESEARCH | INNOVATE | PLAN | EXECUTE | REVIEW]</phase_at_cancellation>
|
|
15
|
+
<cancelled_date>[YYYY-MM-DD hoặc DD-MM-YY]</cancelled_date>
|
|
16
|
+
<cancelled_by>[@engineer_or_product_lead]</cancelled_by>
|
|
17
|
+
<reversal_status>[CLEAN | ROLLBACK_APPLIED | DIRTY_NEEDS_MANUAL_CLEANUP]</reversal_status>
|
|
18
|
+
</status>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 1. Lý Do Hủy Bỏ (Rationale for Cancellation)
|
|
23
|
+
|
|
24
|
+
<cancellation_rationale>
|
|
25
|
+
<primary_reason>
|
|
26
|
+
<!-- [ví dụ: Thay đổi chiến lược sản phẩm / Rào cản kiến trúc / Bán kính ảnh hưởng quá lớn / Bị thay thế bởi CHG-YYY] -->
|
|
27
|
+
[Tóm tắt ngắn gọn vì sao task này bị dừng trước thời hạn.]
|
|
28
|
+
</primary_reason>
|
|
29
|
+
|
|
30
|
+
<decision_context>
|
|
31
|
+
[Ngữ cảnh chi tiết, các đánh đổi đã cân nhắc và chỉ đạo chính từ các bên liên quan dẫn đến quyết định hủy.]
|
|
32
|
+
</decision_context>
|
|
33
|
+
</cancellation_rationale>
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## 2. Phát Hiện Kỹ Thuật & Tri Thức Được Lưu Giữ (Preserved Knowledge)
|
|
38
|
+
|
|
39
|
+
<preserved_knowledge>
|
|
40
|
+
<codebase_discoveries>
|
|
41
|
+
<!-- Chúng ta đã học được gì về hệ thống, data models hoặc dependency tiềm ẩn trong lúc làm task này? -->
|
|
42
|
+
- [Phát hiện 1 — Hành vi của component, giới hạn API chưa có tài liệu hoặc ràng buộc legacy]
|
|
43
|
+
- [Phát hiện 2 — Các bài test hiện có hoặc ranh giới subsystem được khám phá]
|
|
44
|
+
</codebase_discoveries>
|
|
45
|
+
|
|
46
|
+
<invalidated_hypotheses>
|
|
47
|
+
<!-- Những giả định nào đã bị chứng minh là sai trong quá trình khảo sát? -->
|
|
48
|
+
- [Giả thuyết hóa ra không đúng hoặc không khả thi về mặt kỹ thuật]
|
|
49
|
+
</invalidated_hypotheses>
|
|
50
|
+
|
|
51
|
+
<reusable_assets>
|
|
52
|
+
<!-- Có bài test, bản nháp schema, benchmark hoặc prototype nào các task sau có thể tái sử dụng không? -->
|
|
53
|
+
- [Tài sản tái sử dụng 1: các ca test hoặc mô hình dữ liệu trong branch nháp / commit]
|
|
54
|
+
</reusable_assets>
|
|
55
|
+
</preserved_knowledge>
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## 3. Checklist Hoàn Nguyên Mã Nguồn & Dọn Dẹp (Cleanup Checklist)
|
|
60
|
+
|
|
61
|
+
<cleanup_checklist>
|
|
62
|
+
- [ ] Toàn bộ thay đổi chưa commit đã được rollback hoặc stash sạch sẽ (`git status` sạch hoàn toàn)
|
|
63
|
+
- [ ] Các dòng log debug tạm thời, script scratch hoặc dump dữ liệu test đã bị xóa
|
|
64
|
+
- [ ] Không còn migration ảo hoặc artifact schema tạm nào bị sót lại trong database nội bộ
|
|
65
|
+
- [ ] Thư mục task đã được chuyển vào lưu trữ trong `completed/` (hoặc `cancelled/`)
|
|
66
|
+
</cleanup_checklist>
|
|
67
|
+
|
|
68
|
+
---
|
|
69
|
+
|
|
70
|
+
## 4. Task Thay Thế Hoặc Kế Hoạch Tiếp Theo (Follow-Up)
|
|
71
|
+
|
|
72
|
+
<follow_up>
|
|
73
|
+
<superseded_by>[Liên kết tới thư mục task mới hoặc CHG-YYY, hoặc ghi NONE]</superseded_by>
|
|
74
|
+
<recommended_next_action>
|
|
75
|
+
[Khuyến nghị cụ thể nếu bài toán này được xem xét lại trong tương lai.]
|
|
76
|
+
</recommended_next_action>
|
|
77
|
+
</follow_up>
|
|
78
|
+
|
|
79
|
+
</cancellation_record>
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
# Khảo Sát (Research): [TASK-ID]
|
|
2
|
+
|
|
3
|
+
<research_context task_id="[TASK-ID]" version="2.0" framework="RIPER-5">
|
|
4
|
+
|
|
5
|
+
<!-- GIAI ĐOẠN CHỈ ĐỌC (READ-ONLY). Không sửa mã nguồn. Không tự ý ra quyết định triển khai. -->
|
|
6
|
+
<research_status>
|
|
7
|
+
<phase>RESEARCH</phase>
|
|
8
|
+
<mode>READ-ONLY</mode>
|
|
9
|
+
<research_owner></research_owner>
|
|
10
|
+
<last_updated></last_updated>
|
|
11
|
+
</research_status>
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## 1. Hành Vi Hiện Tại (Current Behavior)
|
|
16
|
+
|
|
17
|
+
<current_behavior>
|
|
18
|
+
[Hành vi quan sát được của hệ thống trước thay đổi này, dựa trên bằng chứng cụ thể.]
|
|
19
|
+
</current_behavior>
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## 2. Luồng Thực Thi (Execution Flow)
|
|
24
|
+
|
|
25
|
+
<execution_flow>
|
|
26
|
+
|
|
27
|
+
```text
|
|
28
|
+
Điểm vào (Entry)
|
|
29
|
+
→ ...
|
|
30
|
+
→ ...
|
|
31
|
+
→ Tác dụng phụ / Đầu ra (Side effect / output)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
</execution_flow>
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 3. Các Thành Phần Liên Quan (Relevant Components)
|
|
39
|
+
|
|
40
|
+
<components>
|
|
41
|
+
|
|
42
|
+
| File / Symbol | Vai trò | Bằng chứng | Độ tin cậy (Confidence) |
|
|
43
|
+
|---|---|---|---|
|
|
44
|
+
| | | | |
|
|
45
|
+
|
|
46
|
+
</components>
|
|
47
|
+
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## 4. Phụ Thuộc & Ranh Giới (Dependencies & Boundaries)
|
|
51
|
+
|
|
52
|
+
<boundaries>
|
|
53
|
+
<callers>[Ai gọi đến đoạn code mục tiêu này]</callers>
|
|
54
|
+
<callees>[Đoạn code mục tiêu gọi đến những thành phần nào]</callees>
|
|
55
|
+
<persistence>[Bảng cơ sở dữ liệu, cache keys, hàng đợi queues]</persistence>
|
|
56
|
+
<external_systems>[API bên thứ ba, message brokers bên ngoài]</external_systems>
|
|
57
|
+
<transaction_boundary>[Nơi transaction cơ sở dữ liệu bắt đầu và kết thúc]</transaction_boundary>
|
|
58
|
+
<security_boundary>[Ngữ cảnh xác thực auth, kiểm tra phân quyền, ranh giới tin cậy]</security_boundary>
|
|
59
|
+
</boundaries>
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 5. Các Bài Kiểm Thử Hiện Có (Existing Tests)
|
|
64
|
+
|
|
65
|
+
<existing_tests>
|
|
66
|
+
|
|
67
|
+
| Bài test | Hành vi được bao phủ | Lỗ hổng / Điểm thiếu (Gap) |
|
|
68
|
+
|---|---|---|
|
|
69
|
+
| | | |
|
|
70
|
+
|
|
71
|
+
</existing_tests>
|
|
72
|
+
|
|
73
|
+
---
|
|
74
|
+
|
|
75
|
+
## 6. Môi Trường Chạy & Cấu Hình (Runtime / Configuration)
|
|
76
|
+
|
|
77
|
+
<runtime_config>
|
|
78
|
+
[Biến môi trường, feature flags, tệp cấu hình liên quan đến thay đổi này.]
|
|
79
|
+
</runtime_config>
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## 7. Phân Tích Nguồn Sự Thật (Source-of-Truth Analysis)
|
|
84
|
+
|
|
85
|
+
<source_of_truth_analysis>
|
|
86
|
+
|
|
87
|
+
| Nguồn | Quy định điều gì | Thẩm quyền | Xung đột |
|
|
88
|
+
|---|---|---|---|
|
|
89
|
+
| | | | |
|
|
90
|
+
|
|
91
|
+
</source_of_truth_analysis>
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## 8. Phân Loại Bằng Chứng (Evidence Classification)
|
|
96
|
+
|
|
97
|
+
<!-- TUYỆT ĐỐI KHÔNG trộn lẫn sự thật thực tế, quan sát và giả định trong cùng một danh sách -->
|
|
98
|
+
<evidence>
|
|
99
|
+
<confirmed>
|
|
100
|
+
<!-- Đã xác minh trực tiếp từ mã nguồn, bài test hoặc tài liệu chuẩn -->
|
|
101
|
+
-
|
|
102
|
+
</confirmed>
|
|
103
|
+
|
|
104
|
+
<observed>
|
|
105
|
+
<!-- Suy luận từ hành vi, log hoặc đọc gián tiếp — chưa chứng minh trực tiếp -->
|
|
106
|
+
-
|
|
107
|
+
</observed>
|
|
108
|
+
|
|
109
|
+
<hypothesized>
|
|
110
|
+
<!-- Các giả định còn cần kiểm chứng trước khi thực hiện -->
|
|
111
|
+
-
|
|
112
|
+
</hypothesized>
|
|
113
|
+
</evidence>
|
|
114
|
+
|
|
115
|
+
---
|
|
116
|
+
|
|
117
|
+
## 9. Các Giả Định & Độ Không Chắc Chắn (Assumptions & Uncertainty)
|
|
118
|
+
|
|
119
|
+
<assumptions>
|
|
120
|
+
[Liệt kê bất kỳ giả định nào định hình kết luận khảo sát. Gắn cờ độ không chắc chắn: LOW / MEDIUM / HIGH.]
|
|
121
|
+
</assumptions>
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## 10. Danh Sách Tệp Bị Ảnh Hưởng (Impacted Files)
|
|
126
|
+
|
|
127
|
+
<impacted_files>
|
|
128
|
+
- `duong/dan/toi/file` — [Lý do bị ảnh hưởng]
|
|
129
|
+
</impacted_files>
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## 11. Các Quyết Định Đang Mở (Open Decisions)
|
|
134
|
+
|
|
135
|
+
<open_decisions>
|
|
136
|
+
<!-- Các câu hỏi chưa được giải quyết cần đưa vào giai đoạn Innovate (decision.md) -->
|
|
137
|
+
-
|
|
138
|
+
</open_decisions>
|
|
139
|
+
|
|
140
|
+
---
|
|
141
|
+
|
|
142
|
+
## 12. Tiêu Chí Rời Khỏi Khảo Sát (Research Exit Criteria)
|
|
143
|
+
|
|
144
|
+
<research_exit_criteria>
|
|
145
|
+
- [ ] Hành vi hiện tại đã được hiểu rõ và ghi nhận đầy đủ.
|
|
146
|
+
- [ ] Luồng thực thi đã được truy vết từ đầu đến cuối (end-to-end).
|
|
147
|
+
- [ ] Các ranh giới liên quan đã được xác định (callers, callees, persistence, security).
|
|
148
|
+
- [ ] Xung đột nguồn sự thật đã được làm rõ hoặc xác nhận không có xung đột.
|
|
149
|
+
- [ ] Danh sách các tệp bị ảnh hưởng đã được xác định rõ ràng.
|
|
150
|
+
- [ ] Bằng chứng đã được phân loại rõ ràng (Confirmed / Observed / Hypothesized).
|
|
151
|
+
- [ ] Không còn rào cản khảo sát nào chưa giải quyết.
|
|
152
|
+
</research_exit_criteria>
|
|
153
|
+
|
|
154
|
+
</research_context>
|