Nemo12 Documentation
Write once. Human-readable. Machine-readable. AI-readable.
Đây là mục lục DUY NHẤT của docs (SRC-1024, 24.09.2026). Thanh bên bên trái tự sinh từ cùng một nguồn (apps/docs/.vitepress/structure.mjs), xếp theo mảng sản phẩm; trang "Bản đồ tài liệu" cũ đã gộp vào đây.
Tìm theo mảng
Tìm theo loại
Mỗi loại tài liệu vẫn nằm ở thư mục riêng, vì các cổng kiểm và nhiều phiên đang chạy dùng đường dẫn ấy. Mảng là lớp XẾP để đọc, không phải một lần dời file.
| Loại | Thư mục | Mã |
|---|---|---|
| Yêu cầu sản phẩm | product/ | PRD-xxx, REQ-<nhóm>-nn (bảng REQ chuẩn nằm ở PRD-001 §5) |
| Thiết kế hệ thống | architecture/ | SDD-xxx |
| Luồng người dùng | workflows/ | WF-xx |
| Tham chiếu hệ thống đang chạy | reference/ | (một phần sinh tự động từ mã) |
| Chất lượng | quality/ | QG-xxx, AS, CS |
| Kỹ thuật, vận hành | engineering/, ops/ | |
| Nội dung | curriculum/, knowledge/ | |
| Di sản chuyenchon | legacy/ | RISK, FEAT, CC |
Đọc theo vai trò
| Bạn là | Đọc theo thứ tự |
|---|---|
| Người rà soát yêu cầu | PRD-001 → PRD của mảng → traceability → rà soát yêu cầu |
| Kỹ sư | SDD-001 → SDD của mảng → reference/ |
| Kiểm soát chất lượng | quality-gates → traceability |
| AI agent | conventions → reference/ → skill /intake, /trace-check → frontmatter satisfies/verified_by |
Bốn nguyên tắc lõi
- Một hệ tài liệu duy nhất: mọi nguồn qua intake.md; không hai phiên bản song song.
- Traceability 2 chiều bắt buộc (REQ-DOC-02): không REQ nào thiếu SDD/QG, không ý SDD nào thiếu REQ/US.
- One World, One Learner, One Platform: school là domain context, không phải hệ thống riêng.
- Quyết định chưa được chủ dự án duyệt mang ký hiệu ✍️ trong open-questions/index.md.
Thêm một tài liệu mới
- Đặt file vào thư mục theo loại (bảng trên), frontmatter theo conventions §3.
- Nếu là PRD, SDD hoặc file trong
product/, thêm một dòng vàoFILE_AREAtrongapps/docs/.vitepress/structure.mjs. Thư mục khác tự có chỗ. - Dời hay đổi tên file: thêm một dòng vào
docs/public/_redirectsđể link cũ không gãy. npm run check:docs(cổngcheck-docs-structure) đỏ nếu quên bước 2 hoặc 3.