Правильний спосіб використання CLAUDE.md
Правильний спосіб використання 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 стане вашим цінним помічником!
