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 сіздің сенімді көмекшіңіз болсын!
