Správny spôsob použitia CLAUDE.md
Správny spôsob použitia CLAUDE.md
CLAUDE.md je špeciálny súbor umiestnený v koreňovom adresári projektu, ktorý slúži na poskytnutie kľúčových informácií o vašom projekte AI asistentom (ako je Claude). Správne napísanie tohto súboru umožní AI lepšie porozumieť a pomôcť vám.
Prečo potrebujeme CLAUDE.md?
Predstavte si, že máte nového kolegu. Koľko času vám zaberie, kým pochopí váš projekt? CLAUDE.md je ten "manuál projektu", ktorý umožní AI rýchlo sa zorientovať.
Päť hlavných častí CLAUDE.md
1. Prehľad projektu
Jednoducho popíšte, čo tento projekt robí, aký problém rieši a pre akých používateľov je určený.
# Prehľad projektu Toto je systém správy backendu pre e-commerce, ktorý slúži na správu produktov, objednávok a používateľov.
2. Technologický zásobník
Vypíšte hlavné technológie a frameworky použité v projekte.
`# Technologický zásobník
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Databáza: PostgreSQL
- Nasadenie: Docker + Kubernetes`
3. Štruktúra súborov
Popíšte účel hlavných adresárov.
# Štruktúra súborov /src /components - UI komponenty /pages - Stránky /utils - Pomocné funkcie /api - API volania
4. Bežné príkazy
Vypíšte bežne používané príkazy počas vývoja.
# Bežné príkazy npm run dev - Spustenie vývojového servera npm run build - Vytvorenie produkčnej verzie npm run test - Spustenie testov
5. Pravidlá
Definujte pravidlá, ktoré by mala AI dodržiavať pri písaní kódu pre vás.
`# Kódovacie pravidlá
- Používajte funkcionálne komponenty
- Dodržiavajte konfiguráciu ESLint
- Používajte PascalCase pre pomenovanie komponentov
- Používajte camelCase pre pomenovanie premenných`
Kompletný príklad
`# Názov projektu: Task Manager
Prehľad projektu
Jednoduchá aplikácia na správu úloh, ktorá podporuje vytváranie, úpravu, odstraňovanie a kategorizáciu úloh.
Technologický zásobník
- React 18
- TypeScript
- Tailwind CSS
- Vite
Štruktúra súborov
/src /components - UI komponenty /hooks - Vlastné Hooks /types - TypeScript definície typov /utils - Pomocné funkcie
Bežné príkazy
- npm run dev: Spustenie vývojového servera
- npm run build: Vytvorenie produkčnej verzie
- npm run lint: Kontrola kódu
Kódovacie štandardy
- Komponenty používajú funkcionálny zápis
- Používajte Tailwind CSS pre štýly
- Každý komponent umiestnite do samostatného priečinka`
Tipy
- Buďte struční: Nepíšte príliš dlho, AI sa tiež "unaví"
- Pravidelne aktualizujte: Nezabudnite aktualizovať CLAUDE.md, keď sa projekt zmení
- Uprednostňujte príklady: Konkrétne príklady kódu sú efektívnejšie ako abstraktné popisy
- Zamerajte sa na bolestivé body: Zamerajte sa na miesta, kde sa ľahko robia chyby
Napíšte dobrý CLAUDE.md a nechajte AI, aby sa stala vaším cenným pomocníkom!
