Правильный способ использования CLAUDE.md

CLAUDE.md - это специальный файл, размещенный в корневом каталоге проекта, который сообщает AI-помощнику (например, Claude) ключевую информацию о вашем проекте. Правильно написанный файл позволяет AI лучше понимать и помогать вам.

Зачем нужен CLAUDE.md?

Представьте, что к вам пришел новый коллега, и вам нужно время, чтобы он понял ваш проект. CLAUDE.md - это та самая "инструкция к проекту", которая позволяет AI быстро освоиться.

Пять основных разделов CLAUDE.md

1. Обзор проекта

Кратко опишите, что делает этот проект, какие проблемы решает и на какую аудиторию ориентирован.

# Обзор проекта Это система управления бэкэндом электронной коммерции для управления продуктами, заказами и пользователями.

2. Технологический стек

Перечислите основные технологии и фреймворки, используемые в проекте.

`# Технологический стек

• Фронтенд: React + TypeScript
• Бэкэнд: Node.js + Express
• База данных: PostgreSQL
• Развертывание: Docker + Kubernetes`

3. Структура файлов

Опишите назначение основных каталогов.

# Структура файлов /src /components - UI-компоненты /pages - Страницы /utils - Вспомогательные функции /api - Вызовы API

4. Общие команды

Перечислите команды, часто используемые при разработке.

# Общие команды npm run dev - Запуск сервера разработки npm run build - Сборка производственной версии npm run test - Запуск тестов

5. Правила

Определите правила, которым AI должен следовать при написании кода для вас.

`# Правила кодирования

• Использовать функциональные компоненты
• Следовать конфигурации ESLint
• Использовать PascalCase для именования компонентов
• Использовать camelCase для именования переменных`

Полный пример

`# Название проекта: Task Manager

Обзор проекта

Простое приложение для управления задачами, поддерживающее создание, редактирование, удаление и классификацию задач.

Технологический стек

• React 18
• TypeScript
• Tailwind CSS
• Vite

Структура файлов

/src /components - UI-компоненты /hooks - Пользовательские Hooks /types - Определения типов TypeScript /utils - Вспомогательные функции

Общие команды

• npm run dev: Запуск сервера разработки
• npm run build: Сборка производственной версии
• npm run lint: Проверка кода

Стандарты кодирования

• Использовать функциональный стиль для компонентов
• Использовать Tailwind CSS для стилей
• Размещать каждый компонент в отдельной папке`

Советы

• Будьте краткими: не пишите слишком длинно, AI тоже может "устать"
• Регулярно обновляйте: не забывайте обновлять CLAUDE.md при изменении проекта
• Пример в приоритете: конкретные примеры кода эффективнее абстрактных описаний
• Сосредоточьтесь на болевых точках: выделите области, где легко допустить ошибку

Напишите хороший CLAUDE.md и сделайте AI своим ценным помощником!