Správný způsob použití CLAUDE.md

CLAUDE.md je speciální soubor umístěný v kořenovém adresáři projektu, který informuje AI asistenta (jako je Claude) o klíčových informacích o vašem projektu. Napsání tohoto souboru umožní AI lépe porozumět a pomoci vám.

Proč potřebujeme CLAUDE.md?

Představte si, že máte nového kolegu. Jak dlouho vám bude trvat, než pochopí váš projekt? CLAUDE.md je ten "manuál k projektu", který AI umožní rychle začít.

Pět hlavních obsahů CLAUDE.md

1. Přehled projektu

Jednoduše popište, co tento projekt dělá, jaké problémy řeší a pro jaké uživatele je určen.

# Přehled projektu Toto je systém pro správu e-commerce backendu, který se používá ke správě produktů, objednávek a uživatelů.

2. Technologický zásobník

Uveďte hlavní technologie a frameworky použité v projektu.

`# Technologický zásobník

• Frontend: React + TypeScript
• Backend: Node.js + Express
• Databáze: PostgreSQL
• Nasazení: Docker + Kubernetes`

3. Struktura souborů

Popište účel hlavních adresářů.

# Struktura souborů /src /components - UI komponenty /pages - Stránky /utils - Pomocné funkce /api - API volání

4. Běžné příkazy

Uveďte běžné příkazy používané při vývoji.

# Běžné příkazy npm run dev - Spuštění vývojového serveru npm run build - Sestavení produkční verze npm run test - Spuštění testů

5. Pravidla

Definujte pravidla, která by AI měla dodržovat při psaní kódu.

`# Pravidla kódování

• Používejte funkcionální komponenty
• Dodržujte konfiguraci ESLint
• Názvy komponent používejte PascalCase
• Názvy proměnných používejte camelCase`

Kompletní příklad

`# Název projektu: Task Manager

Přehled projektu

Jednoduchá aplikace pro správu úkolů, která podporuje vytváření, úpravy, mazání a kategorizaci úkolů.

Technologický zásobník

• React 18
• TypeScript
• Tailwind CSS
• Vite

Struktura souborů

/src /components - UI komponenty /hooks - Vlastní Hooks /types - Definice typů TypeScript /utils - Pomocné funkce

Běžné příkazy

• npm run dev: Spuštění vývojového serveru
• npm run build: Sestavení produkční verze
• npm run lint: Kontrola kódu

Kódovací standardy

• Komponenty používají funkcionální zápis
• Pro stylování se používá Tailwind CSS
• Každá komponenta je umístěna v samostatné složce`

Tipy

• Buďte struční: Nepište příliš dlouhé texty, AI se také "unaví"
• Pravidelně aktualizujte: Nezapomeňte aktualizovat CLAUDE.md, když se projekt změní
• Upřednostňujte příklady: Konkrétní příklady kódu jsou efektivnější než abstraktní popisy
• Zaměřte se na bolestivá místa: Zvláště zdůrazněte místa, kde se snadno dělají chyby

Napište dobrý CLAUDE.md a nechte AI, aby se stala vaším cenným pomocníkem!