The Correct Way to Use CLAUDE.md
The Correct Way to Use CLAUDE.md
CLAUDE.md is a special file placed in the root directory of a project, used to tell AI assistants (like Claude) about the key information of your project. Writing this file well allows the AI to better understand and help you.
Why is CLAUDE.md Needed?
Imagine you have a new colleague, how long would it take for them to understand your project? CLAUDE.md is that "project manual" that allows the AI to get started quickly.
The Five Core Contents of CLAUDE.md
1. Project Overview
Briefly describe what the project does, what problems it solves, and who it is for.
# Project Overview This is an e-commerce backend management system for managing products, orders, and users.
2. Technology Stack
List the main technologies and frameworks used by the project.
`# Technology Stack
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Database: PostgreSQL
- Deployment: Docker + Kubernetes`
3. File Structure
Explain the purpose of the main directories.
# File Structure /src /components - UI components /pages - Pages /utils - Utility functions /api - API calls
4. Common Commands
List commonly used commands in development.
# Common Commands npm run dev - Start the development server npm run build - Build the production version npm run test - Run tests
5. Rules
Define the rules that the AI should follow when helping you write code.
`# Coding Rules
- Use functional components
- Follow ESLint configuration
- Component naming uses PascalCase
- Variable naming uses camelCase`
A Complete Example
`# Project Name: Task Manager
Project Overview
A simple task management application that supports the creation, editing, deletion, and categorization of tasks.
Technology Stack
- React 18
- TypeScript
- Tailwind CSS
- Vite
File Structure
/src /components - UI components /hooks - Custom Hooks /types - TypeScript type definitions /utils - Utility functions
Common Commands
- npm run dev: Start the development server
- npm run build: Build the production version
- npm run lint: Code check
Coding Conventions
- Components use functional style
- Use Tailwind CSS for styling
- Each component is placed in a separate folder`
Tips
- Keep it concise: Don't write too long, the AI will also get "tired" of reading.
- Update regularly: Remember to update CLAUDE.md when the project changes.
- Examples first: Giving specific code examples is more effective than abstract descriptions.
- Focus on pain points: Highlight areas that are prone to errors.
Write CLAUDE.md well and let AI become your powerful assistant!
