Chuyển tới nội dung chính

Mẫu tài liệu cho một đợt làm

Sao chép thư mục này thành docs/phase-{N}-{slug}/ khi bắt đầu một đợt làm cần kế hoạch riêng; xong đợt thì gộp việc còn lại vào ../BACKLOG.md và xóa thư mục phase.

FileVai tròBắt buộc
00_OVERVIEW.mdVì sao làm, làm gì, phạm vi, kết quả đầu ra (Definition of Done)Có
01_PLAN.mdKế hoạch theo work package: hành vi đổi, phạm vi ảnh hưởng, hợp đồng API và schemaCó
02_CHECKLIST.mdViệc chi tiết theo lớp (BE, FE, Mobile, AI, Infra, Docs) để tickCó
03_TEST_PLAN.mdKế hoạch kiểm thử và tiêu chí đạtCó
04_TRADEOFFS_RISKS.mdTrade-off, rủi ro, phương án dự phòngChỉ khi có quyết định lớn, khó đảo ngược

Quy ước​

  • Mã work package WP{N}-{xx}, dòng checklist WP{N}-{xx}-{lớp}-{nn} (lớp: DOC, BE, FE, MB, AI, DATA, INFRA, TEST), test case T{N}-{xx}.
  • Phase xong khi mọi tiêu chí ở 00_OVERVIEW.md mục 6 đạt và mục "Đóng phase" của 02_CHECKLIST.md đã tick.
  • Chỉ ghi trạng thái cuối trong README.md và CHANGELOG.md; không ghi nhãn phase vào code, @Operation hay comment.
  • Viết ngắn, mỗi câu một dòng; hỏi người dùng chốt các quyết định ở mục "Câu hỏi mở" trước khi code.