Tạo hoặc cập nhật các file CLAUDE.md theo các thực hành tốt nhất để onboarding tác nhân AI tối ưu
$ARGUMENTS
Bạn BẮT BUỘC phải xem xét đầu vào của người dùng trước khi tiếp tục (nếu không trống). Người dùng có thể chỉ định:
create - Tạo CLAUDE.md mới từ đầuupdate - Cải thiện CLAUDE.md hiện cóaudit - Phân tích và báo cáo về chất lượng CLAUDE.md hiện tạisrc/api/CLAUDE.md cho hướng dẫn cụ thể thư mục)LLMs là không trạng thái: CLAUDE.md là file duy nhất được bao gồm tự động trong mọi cuộc hội thoại. Nó phục vụ như tài liệu onboarding chính cho các tác nhân AI vào codebase của bạn.
Less is More: Các LLM biên giới có thể theo ~150-200 hướng dẫn. System prompt của Claude Code đã sử dụng ~50. Giữ CLAUDE.md của bạn tập trung và ngắn gọn.
Ứng Dụng Phổ Biến: Chỉ bao gồm thông tin liên quan đến MỌI phiên. Hướng dẫn cụ thể theo tác vụ thuộc về các file riêng.
Đừng Sử Dụng Claude như Linter: Hướng dẫn phong cách làm phình bối cảnh và làm giảm khả năng tuân theo hướng dẫn. Sử dụng các công cụ xác định (prettier, eslint, v.v.) thay thế.
Không Bao Giờ Tự Động Tạo: CLAUDE.md là điểm đòn bẩy cao nhất của hệ thống AI. Tạo nó thủ công với sự xem xét cẩn thận.
Đầu tiên, phân tích trạng thái dự án hiện tại:
Kiểm tra các file CLAUDE.md hiện có:
./CLAUDE.md hoặc .claude/CLAUDE.md**/CLAUDE.md~/.claude/CLAUDE.mdXác định cấu trúc dự án:
Xem lại tài liệu hiện có:
Cấu trúc CLAUDE.md xung quanh ba chiều:
Đối với các dự án lớn, khuyến nghị tạo thư mục agent_docs/:
agent_docs/
|- building_the_project.md
|- running_tests.md
|- code_conventions.md
|- architecture_decisions.md
Trong CLAUDE.md, tham khảo các file này với các hướng dẫn như:
Để có hướng dẫn build chi tiết, tham khảo `agent_docs/building_the_project.md`
Quan Trọng: Sử dụng các tham chiếu file:line thay vì các đoạn code để tránh bối cảnh lỗi thời.
Khi tạo hoặc cập nhật CLAUDE.md:
Một CLAUDE.md được cấu trúc tốt nên bao gồm:
# Tên Dự Án
Mô tả ngắn một dòng.
## Tech Stack
- Ngôn ngữ chính và phiên bản
- Frameworks/thư viện chính
- Database/lưu trữ (nếu có)
## Cấu Trúc Dự Án
[Chỉ cho monorepos hoặc cấu trúc phức tạp]
- `apps/` - Điểm vào ứng dụng
- `packages/` - Thư viện được chia sẻ
## Lệnh Phát Triển
- Install: `command`
- Test: `command`
- Build: `command`
## Quy Ước Quan Trọng
[Chỉ các quy ước không rõ ràng, tác động cao]
- Quy ước 1 với giải thích ngắn
- Quy ước 2 với giải thích ngắn
## Vấn Đế Đã Biết / Gotchas
[Những gì luôn làm các nhà phát triển vấp phải]
- Vấn đề 1
- Vấn đề 2
KHÔNG bao gồm:
Trước khi hoàn thành, xác minh:
create hoặc mặc định:update:audit:Nếu người dùng yêu cầu tạo/cập nhật AGENTS.md:
AGENTS.md được sử dụng để định nghĩa các hành vi tác nhân chuyên biệt. Không giống CLAUDE.md (dành cho bối cảnh dự án), AGENTS.md định nghĩa:
Áp dụng các nguyên tắc tương tự: