Thiết kế mẫu CLAUDE.md
Tệp CLAUDE.md cung cấp ngữ cảnh liên tục cho Claude Code, tích hợp vào mọi phiên như một phần của lời nhắc hệ thống để hướng dẫn mã hóa có sự hỗ trợ của AI mà không lặp lại. Nó ghi lại kiến trúc, tiêu chuẩn, quy trình làm việc và công cụ của dự án một cách ngắn gọn cho cả con người và AI.
Mục đích cốt lõi
Đặt CLAUDE.md tại thư mục gốc của kho lưu trữ để được hướng dẫn cụ thể cho dự án hoặc trong thư mục chính cho cài đặt chung. Sử dụng lệnh trong Claude Code để tự động tạo tệp khởi động bằng cách phân tích cơ sở mã của bạn. Giữ cho nó có thể đọc được, dưới 200 nghìn mã thông báo, tránh dữ liệu nhạy cảm như khóa API./init
Các phần chính
Cấu trúc với tiêu đề đánh dấu để có thể quét: tổng quan dự án, bản đồ thư mục, tiêu chuẩn, lệnh và quy trình làm việc.
-
Tổng quan về dự án: Tóm tắt kiến trúc, ngăn xếp công nghệ và mẫu (ví dụ: “FastAPI REST API với SQLAlchemy ORM”).
-
Cấu trúc thư mục: Sử dụng nghệ thuật ASCII giống cây để điều hướng (ví dụ: ).
app/models/ - DB schemas -
Tiêu chuẩn mã hóa: Liệt kê các quy ước như PEP 8, gợi ý loại, độ dài dòng.
-
Lệnh: Đoạn mã Bash cho máy chủ phát triển, kiểm thử (ví dụ: ).
pytest tests/ -v -
Quy trình làm việc: Quy trình từng bước (ví dụ: “1. Lập kế hoạch thay đổi; 2. Viết kiểm tra; 3. Triển khai; 4. Cam kết với định dạng thông thường”).
Mẫu mẫu
# Project Context
Prioritize readability. Ask before architectural changes.
## Overview
[Describe app, e.g., Node.js microservice with Express and MongoDB.]
## Structure
Bộ điều khiển SRC /
├── /
Mô hình ├── /
└── Tiện ích /
## Standards
- ESLint + Prettier
- 80-char lines
- JSDoc on exports
## Commands
```bash
npm run dev # Start server
npm test # Run tests
npm lint # Check style
```
## Workflows
For features: Explore → Plan → Test → Code → Review.
Test all changes with `npm test`.
Các phương pháp hay nhất
Bắt đầu đơn giản và lặp lại bằng cách thêm các hướng dẫn lặp lại; sử dụng cho ngữ cảnh mới giữa các tác vụ. Tích hợp các lệnh gạch chéo tùy chỉnh cho các lời nhắc lặp đi lặp lại như đánh giá hiệu suất. Tham khảo tài liệu bên ngoài hoặc công cụ MCP cho các tiện ích mở rộng như thông báo Slack./clear.claude/commands/

(St.)
Chia sẻ










CLAUDE.md không phải là một README.
Hầu hết mọi người chỉ cần đặt một tệp CLAUDE.md vào thư mục gốc và cho rằng như vậy là xong.
Một vài gạch đầu dòng. Có thể thêm một lệnh biên dịch. Chỉ vậy thôi.
Rồi họ tự hỏi tại sao Claude cứ liên tục bỏ qua các quy ước của họ, sử dụng các mẫu sai và viết mã không phù hợp với kiến trúc của họ.
Vấn đề không phải là Claude. Vấn đề là một tệp CLAUDE.md không được cấu trúc đúng cách.
Đây là khung sườn tôi sử dụng để thiết kế một cái hoạt động hiệu quả:
Bước 1 → Áp dụng cho 3 bước
→ ~/.claude/CLAUDE.md — Toàn cục. Các thiết lập mặc định cá nhân của bạn trên mọi dự án
→ ./CLAUDE.md — Dự án. Các quy tắc nhóm, lệnh xây dựng, quyết định kiến trúc
→ ./src/CLAUDE.md — Thư mục. Các thiết lập ghi đè ở cấp độ mô-đun cho các thư mục cụ thể
Thứ tự hợp nhất: Toàn cục → Dự án → Thư mục. Phạm vi cuối cùng sẽ thắng trong các xung đột.
Hầu hết mọi người chỉ sử dụng một. Hãy sử dụng cả ba.
Phần 2 → Xem xét CÁI GÌ / TẠI SAO / NHƯ THẾ NÀO
→ CÁI GÌ (Ngữ cảnh) — Tên dự án, công nghệ sử dụng, cấu trúc kho lưu trữ, các phụ thuộc
→ TẠI SAO (Nguyên tắc) — Các quyết định về kiến trúc, quy ước đặt tên, các mẫu phản tác dụng cần tránh
→ CÁCH THỨC (Quy trình làm việc) — Các lệnh xây dựng, các lệnh kiểm thử, các quy tắc kiểm tra cú pháp, định dạng commit, các bước triển khai
Nếu bạn bỏ qua bất kỳ phần nào trong ba phần này, Claude sẽ đoán. Và nó đoán sai.
Mục 3 → Hãy Cụ Thể
→ “Viết mã sạch” — mơ hồ. Claude bỏ qua.
→ “Sử dụng camelCase cho biến, PascalCase cho thành phần” — chính xác. Claude tuân theo.
→ “Kiểm tra mọi thứ” — mơ hồ. Không có ý nghĩa gì.
→ “npm test — –watch, độ phủ tối thiểu 80% cho utils/” — chính xác. Được thực thi.
Tính cụ thể là sự khác biệt giữa một CLAUDE.md hữu ích và một CLAUDE.md chỉ mang tính trang trí.
→ Bước 4 → Tuân thủ 5 quy tắc
→ Chạy lệnh `/init` trước — để Claude tạo khung sườn cơ bản, sau đó chỉnh sửa
→ Giữ dưới 500 dòng — quá dài sẽ khiến Claude mất tập trung
→ Các quy tắc của CLAUDE.md được tuân thủ khoảng 70% — sử dụng Hooks để đảm bảo tuân thủ 100%
→ Cập nhật hàng tháng — kiến trúc của bạn phát triển, CLAUDE.md cũng nên được cập nhật
→ Tham chiếu các tệp cấu hình, không sao chép chúng — trỏ đến `package.json`, không sao chép nó
Những kỹ sư tận dụng tối đa Claude Code không phải là những người viết lời nhắc tốt hơn.
Họ là những người thiết kế các tệp CLAUDE.md tốt hơn.