Правилният начин за използване на CLAUDE.md

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

Защо е необходим CLAUDE.md?

Представете си, че имате нов колега. Колко време ще ви отнеме, за да го накарате да разбере вашия проект? CLAUDE.md е тази „проектна спецификация“, която позволява на AI бързо да започне работа.

Петте основни съдържания на CLAUDE.md

1. Общ преглед на проекта

Опишете накратко какво прави този проект, какви проблеми решава и към какви потребители е насочен.

# Общ преглед на проекта Това е система за управление на електронна търговия, използвана за управление на продукти, поръчки и потребители.

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

Избройте основните технологии и рамки, използвани в проекта.

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

• Frontend: React + TypeScript
• Backend: 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 да стане ваш ценен помощник!