Tổng quan
VNexus Requirement là gì?
Đây là nguồn requirement tập trung cho dự án VNexus — gồm 3 nhánh source code: Frontend, Backend, Mobile. Mọi yêu cầu nghiệp vụ (chức năng làm gì, luồng nào, ràng buộc gì) được viết một lần ở đây, render thành site này để xem, và cho cả Boss, Dev, AI agent đọc cùng một bản.
Repo này không chứa code, plan thực thi, task breakdown hay tech stack chi tiết. Đó là việc của repo source FE/BE/Mobile riêng. Repo này chỉ trả lời: “Sản phẩm cần làm gì?”
Ai dùng tài liệu này?
Boss / PO — đọc để biết tiến độ feature, comment khi cần sửa scope hoặc business rule.
Hướng dẫn cho Boss →
Bên trong có gì?
| Mục | Mô tả |
|---|---|
| Danh sách Feature | Toàn bộ feature dạng bảng có filter theo status, priority, platform. Mỗi feature có spec đầy đủ 9 section: Mục tiêu, Phạm vi, User Stories, Luồng chức năng, Acceptance Criteria, Quy tắc nghiệp vụ, Dữ liệu & Trạng thái, Câu hỏi mở, Liên quan. |
| Bản đồ phụ thuộc | Đồ thị hiển thị các feature liên quan nhau (depends_on / impacts) — biết trước khi đụng feature A có thể ảnh hưởng feature B, C. |
| Thuật ngữ | Glossary các từ nghiệp vụ chung. |
Workflow status (Dev-driven)
Status mỗi feature do Dev tự cập nhật — không phụ thuộc Boss “duyệt”. Dev báo cáo qua status, Boss xem và comment nếu cần feedback.
draft → ready → in-development → shipped| Status | Ý nghĩa |
|---|---|
draft | Spec đang viết, chưa hoàn chỉnh |
ready | Spec đầy đủ, Dev có thể bắt đầu impl |
in-development | Đang code ở repo FE/BE/Mobile |
shipped | Đã release production |
on-hold | Tạm hoãn (đổi ưu tiên, chờ phụ thuộc, …) |
deprecated | Không còn áp dụng |
Tổng feature
4
Đang draft
0
Đã approved
0
Đang dev / Đã ship
4
Cần chú ý
Không có feature nào cần chú ý ngay.
Mới cập nhật
| Feature | Status | Owner | Cập nhật |
|---|---|---|---|
| Đăng nhập bằng Google (OAuth 2.0)auth-login-google | shipped | team-identity | |
| Đăng nhập bằng số điện thoạiauth-login-phone | shipped | team-identity | |
| Đăng ký tài khoản với số điện thoại (OTP)auth-register-otp | shipped | team-identity | |
| Đăng xuất (revoke refresh token)auth-logout | shipped | team-identity |
Liên kết nhanh
- Toàn bộ feature — bảng có search + filter
- Bản đồ phụ thuộc — graph deps + impacts
- Thuật ngữ — glossary nghiệp vụ
- /llms.txt — index cho AI agent (chuẩn llmstxt.org)
Quy ước viết spec
- Mỗi feature = 1 folder ở
docs/features/<feature-id>/với 2 file:spec.md(nội dung) +meta.json(metadata). spec.mdcó 9 heading##cố định cả tên lẫn thứ tự — agent pattern-match dựa trên cấu trúc này.meta.jsonvalidate theo JSON Schema — sai field/enum sẽ fail CI.- Không viết implementation plan, task code, tech stack chi tiết, DB schema, API endpoint signature vào spec. Những thứ đó thuộc về repo source.
Xem PLAN.md ở repo gốc để biết kiến trúc đầy đủ.