Rätt sätt att använda CLAUDE.md

CLAUDE.md är en speciell fil som placeras i projektets rotkatalog och används för att berätta för AI-assistenter (som Claude) om viktig information om ditt projekt. Att skriva den här filen väl kan hjälpa AI att bättre förstå och hjälpa dig.

Varför behövs CLAUDE.md?

Tänk dig att du har en ny kollega, hur lång tid tar det för dig att få honom att förstå ditt projekt? CLAUDE.md är den "projektbeskrivningen" som låter AI komma igång snabbt.

CLAUDE.md:s fem kärninnehåll

1. Projektöversikt

Beskriv kortfattat vad projektet gör, vilka problem det löser och vilka användare det riktar sig till.

# Projektöversikt Detta är ett e-handels backend-hanteringssystem för att hantera produkter, beställningar och användare.

2. Teknikstack

Lista de viktigaste teknikerna och ramverken som används i projektet.

`# Teknikstack

Frontend: React + TypeScript
Backend: Node.js + Express
Databas: PostgreSQL
Deployment: Docker + Kubernetes`

3. Filstruktur

Beskriv syftet med huvudkatalogerna.

# Filstruktur /src /components - UI-komponenter /pages - Sidor /utils - Verktygsfunktioner /api - API-anrop

4. Vanliga kommandon

Lista de vanligaste kommandona under utveckling.

# Vanliga kommandon npm run dev - Starta utvecklingsservern npm run build - Bygg produktionsversionen npm run test - Kör tester

5. Regler

Definiera de regler som AI ska följa när den hjälper dig att skriva kod.

`# Kodningsregler

Använd funktionella komponenter
Följ ESLint-konfigurationen
Komponentnamn använder PascalCase
Variabelnamn använder camelCase`

Ett komplett exempel

`# Projektnamn: Task Manager

Projektöversikt

En enkel applikation för uppgiftshantering som stöder skapande, redigering, radering och kategorisering av uppgifter.

Teknikstack

React 18
TypeScript
Tailwind CSS
Vite

Filstruktur

/src /components - UI-komponenter /hooks - Anpassade Hooks /types - TypeScript-typdefinitioner /utils - Verktygsfunktioner

Vanliga kommandon

npm run dev: Starta utvecklingsservern
npm run build: Bygg produktionsversionen
npm run lint: Kodgranskning

Kodningsstandard

Komponenter använder funktionell syntax
Använd Tailwind CSS för styling
Varje komponent placeras i en separat mapp`

Tips

Håll det kortfattat: Skriv inte för långt, AI kommer också att bli "trött"
Uppdatera regelbundet: Kom ihåg att uppdatera CLAUDE.md när projektet ändras
Prioritera exempel: Att ge specifika kodexempel är mer effektivt än abstrakta beskrivningar
Fokusera på smärtpunkter: Förklara de områden där fel lätt uppstår

Skriv CLAUDE.md väl och låt AI bli din högra hand!