Giao diện
[TÊN FEATURE] - FS Overview ​
File tổng quan + index của FS. Mỗi User Story là 1 file riêng trong cùng thư mục (
US-XX-<slug>.md). Các phần dùng chung (tổng quan, flow tổng, related features, NFR, Open Questions, References) đặt tập trung tại đây — file US chỉ tham chiếu ID, không lặp lại.
| Field | Value |
|---|---|
| Doc ID | FS-XXX |
| Mode | A – New feature / B – As-built (viết từ code) / C – Enhancement (thay đổi tính năng đã có) |
| As-built tại commit | [git rev-parse --short HEAD lúc đọc code — chỉ Mode B/C; Mode A ghi N/A] |
| Last Updated | YYYY-MM-DD |
| Author | [Tên BA] |
| Reviewers | [Dev Lead / Designer / PM / QA] |
| Status | DRAFT / IN REVIEW / APPROVED / BLOCKED |
| Figma Project | [Link Figma project tổng] |
| Related BRD | [Link BRD nếu có] |
| Related Impact Matrix | [Link Impact Matrix nếu có] |
1. Tổng quan dự án ​
Mô tả ngắn 2-3 câu: tính năng làm gì, giải quyết vấn đề gì, nhóm người dùng nào bị ảnh hưởng.
1.1 Bối cảnh ​
[Pain point hiện tại, trigger từ nghiệp vụ/khách hàng/đối thủ, vấn đề vận hành hoặc giới hạn hệ thống hiện tại.]
1.2 Mục tiêu ​
[Mục tiêu dự án, KPI, kết quả kỳ vọng, ràng buộc thời gian/ngân sách nếu có.]
1.3 In Scope ​
- [Những chức năng/quy trình SẼ làm trong phase này.]
- [Những màn hình, dữ liệu, API, report, notification nằm trong scope nếu có.]
1.4 Out Of Scope ​
- [Những chức năng/quy trình KHÔNG làm trong phase này.]
- [Những phần sẽ xử lý ở phase sau nếu có.]
1.5 Roles And Permissions ​
| Role ID | Role Name | Description | Permission Summary |
|---|---|---|---|
| R1 | [End user] | [Mô tả role] | [Quyền chính] |
| R2 | [Admin] | [Mô tả role] | [Quyền chính] |
2. Luồng tổng quan của dự án ​
[Mô tả flow tổng: user/role đi qua các tính năng (US) nào theo thứ tự nào.]
text
[Entry point]
↓
[Tính năng A: US-01]
↓
[Tính năng B: US-02] ──→ [Tính năng C: US-03]
↓
[Exit / End state]Link flow nếu có:
- Mermaid / Excalidraw / Figma flow: [Link]
3. Các tính năng liên quan ​
Xét 2 loại liên quan:
Affects: tính năng khác ảnh hưởng đến tính năng hiện tại.Be Affected: tính năng hiện tại ảnh hưởng đến tính năng khác.
| Mã | Tính năng liên quan | Link tài liệu | Loại liên quan | Mục bị ảnh hưởng ở feature kia | Mục ảnh hưởng ở feature hiện tại | Mô tả ảnh hưởng |
|---|---|---|---|---|---|---|
| REL-01 | [Tên feature/module A] | [Link FS] | Affects | - | US-01.M1 - field X | [Feature A truyền state/data Y để hiển thị ở field X] |
| REL-02 | [Tên feature/module B] | [Link FS] | Be Affected | US-XX.M2 - list view | US-01.M3 - action Submit | [Khi US-01 submit thành công, list ở feature B phải refresh] |
Mã
REL-XXđược tham chiếu ở phần Cross-feature AC của từng file US bằng trườngMaps to.
4. User Story Index ​
Danh sách tất cả User Story của FS. Mỗi US là 1 file riêng trong thư mục này.
| US ID | Tên User Story | File | Role | Priority | Status |
|---|---|---|---|---|---|
| US-01 | [Tên] | US-01-xxx.md | R1 | P0 | Draft |
| US-02 | [Tên] | US-02-xxx.md | R2 | P1 | Draft |
Cập nhật cột Status khi viết xong từng file US (Draft → Ready → Approved).
5. Non-functional Requirements ​
Register NFR dùng chung cho toàn FS. File US tham chiếu bằng ID (không lặp lại).
| ID | Requirement | Applies To (US/màn/API) | Acceptance Criteria |
|---|---|---|---|
| NFR-01 | [Phân quyền/bảo mật] | [US/màn/API] | [Cách kiểm chứng] |
| NFR-02 | [Performance/SLA] | [US/màn/API] | [Cách kiểm chứng] |
| NFR-03 | [Logging/Audit/Monitoring] | [US/màn/API] | [Cách kiểm chứng] |
6. Open Questions ​
Register Open Question dùng chung cho toàn FS. File US tham chiếu bằng ID.
| ID | Question | Owner | Due Date | Status | Blocks (US) |
|---|---|---|---|---|---|
| OQ-001 | [Câu hỏi cần xác nhận] | [Owner] | [Date] | Open | US-02 |
6b. Drift: tài liệu ↔ code (Mode B/C — Mode A ghi N/A) ​
Chỗ tài liệu hiện có (API doc, map, FS cũ, Confluence) nói khác với code đang chạy. Không tự chọn bên đúng — mỗi dòng cần owner quyết.
| ID | Tài liệu nói | Code đang làm (bằng chứng file:dòng) | Ảnh hưởng | Owner quyết |
|---|---|---|---|---|
| DR-01 |
7. References ​
- BRD: [Link]
- Impact Matrix: [Link]
- Solution Decision: [Link]
- Figma: [Link]
- API Spec: [Link]
- Code đã đọc (Mode B/C): [danh sách file chính — chi tiết ở
working/ai-drafts/feature-inventory-*.md] - Meeting Notes / Q&A: [Link]