Đến nội dung chính
CafeJS Docs
Trên trang này 2 mục
  1. 1.4.1 Bảng các file
  2. 1.4.2 Giữ tài liệu đúng với code

Các file tài liệu

Mỗi mẫu có một bộ file tài liệu ở thư mục gốc. Mỗi file dành cho một người đọc; AI đọc AGENTS.md trước tiên.

Bảng các file

FileNội dungDành cho
README.mdTổng quan, chạy trên máy, đưa lên mạngMọi người
HUONG-DAN-SU-DUNG.mdCác trang của site, sửa nội dung trong admin, việc thường làm, SEO và tracker, xử lý sự cốChủ site, người sửa nội dung
FEATURES.mdTính năng có, chưa có, có một phầnChủ site, developer
DEPLOY.mdLệnh build, biến môi trường, những gì chưa sẵn sàng, checklist trước khi go-liveDeveloper
PRODUCT.mdViệc kinh doanh của site: thương hiệu, khách hàng, sản phẩm, chính sáchChủ site, người viết nội dung, AI
DESIGN.mdMàu, font, khoảng cách, quy tắc giao diện (bản máy đọc: .impeccable/design.json)Designer, developer, AI
CONTEXT.mdTình trạng hiện tại, quyết định còn mở, thiếu sót đã biếtDeveloper, AI
CREDITS.mdNguồn và giấy phép của ảnh, font, icon, code bên thứ baChủ site, developer
AGENTS.mdCách làm việc trong code (tiếng Anh): cấu trúc, lệnh, quy ướcDeveloper, AI
CLAUDE.mdChỉ trỏ tới AGENTS.md để Claude Code tự đọcAI

Giữ tài liệu đúng với code

Thêm hay bỏ một tính năng thì sửa FEATURES.md trong cùng lần commit; thêm ảnh hay font của bên thứ ba thì ghi vào CREDITS.md; quyết định còn bỏ ngỏ thì ghi vào CONTEXT.md. Nhờ AI làm việc này cũng được (xem 4 Làm việc với AI).

Cảnh báo

Trước khi go-live, mọi ảnh và tài nguyên trong CREDITS.md phải ở trạng thái "được dùng". Cái nào chưa thì thay.