Skip to content

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 ​

MảngBắt đầu từGồm
Luyện thiValue Stream IELTS · SAT · APIELTS: learner model, SDD-035, SDD-038, Journey Engine PRD-005 + SDD-045 · app di động PRD-010 NEMO IELTS + SDD-055 · Customer understanding: PRD-007 Gull + SDD-047 · SAT: PRD-004, SDD-044 · ngân hàng đề, dashboard chương trình
Học sinh & trí tuệ học tậpPRD-002Trải nghiệm học, năm dạng câu hỏi, mô hình và engine (SDD-002), luồng người dùng WF
Gia đình & mentorParent JTBDMarlins, Dolphins, PRD-003 Dory & Anchor, lịch, slot, sự kiện
Web công khaiPublic Web IASDD-029, DS-001 Design System
Nội dung & chương trìnhSDD-004Coral, Foundry, lab, sửa nội dung AI Teen trong Dolphin (SDD-056), chương trình theo môn, tri thức theo môn
Nền tảngPRD-001Kiến trúc (SDD-001), tham chiếu hệ thống đang chạy
Chất lượngHệ tiêu chuẩnQuality Gates, audit, độ phủ, rà soát yêu cầu
Kỹ thuật & vận hànhCoding conventionssổ sự cố · runbook: rollback, migration-order, dlq-replay, automerge · tốc độ tích hợp · cloud-dev · chi phí hạ tầng · mm · ui · danh mục skill của agent
Sổ sáchintaketraceability, open-questions, backlog
Chiến lượcCapital MapStrategic Focus, Media Capital

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ạiThư mụcMã
Yêu cầu sản phẩmproduct/PRD-xxx, REQ-<nhóm>-nn (bảng REQ chuẩn nằm ở PRD-001 §5)
Thiết kế hệ thốngarchitecture/SDD-xxx
Luồng người dùngworkflows/WF-xx
Tham chiếu hệ thống đang chạyreference/(một phần sinh tự động từ mã)
Chất lượngquality/QG-xxx, AS, CS
Kỹ thuật, vận hànhengineering/, ops/
Nội dungcurriculum/, knowledge/
Di sản chuyenchonlegacy/RISK, FEAT, CC

Đọc theo vai trò ​

Bạn làĐọc theo thứ tự
Người rà soát yêu cầuPRD-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ượngquality-gates → traceability
AI agentconventions → reference/ → skill /intake, /trace-check → frontmatter satisfies/verified_by

Bốn nguyên tắc lõi ​

  1. 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.
  2. 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.
  3. One World, One Learner, One Platform: school là domain context, không phải hệ thống riêng.
  4. 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 ​

  1. Đặt file vào thư mục theo loại (bảng trên), frontmatter theo conventions §3.
  2. Nếu là PRD, SDD hoặc file trong product/, thêm một dòng vào FILE_AREA trong apps/docs/.vitepress/structure.mjs. Thư mục khác tự có chỗ.
  3. Dời hay đổi tên file: thêm một dòng vào docs/public/_redirects để link cũ không gãy.
  4. npm run check:docs (cổng check-docs-structure) đỏ nếu quên bước 2 hoặc 3.