CLAUDE.md õige kasutamine

CLAUDE.md on spetsiaalne fail, mis asub projekti juurkataloogis ja mille eesmärk on anda teavet AI assistendile (nt Claude) sinu projekti kohta. Selle faili korralikult kirjutamine võimaldab AI-l sinu projekti paremini mõista ja sind aidata.

Miks on CLAUDE.md vajalik?

Kujuta ette, et sul on uus kolleeg. Kui kaua kulub tal sinu projekti mõistmiseks? CLAUDE.md on justkui "projekti juhend", mis aitab AI-l kiiresti alustada.

CLAUDE.md viis peamist sisu

1. Projekti ülevaade

Kirjelda lühidalt, millega see projekt tegeleb, milliseid probleeme lahendab ja millistele kasutajatele on suunatud.

# Projekti ülevaade See on e-kaubanduse haldussüsteem, mis on mõeldud toodete, tellimuste ja kasutajate haldamiseks.

2. Tehnoloogiapakk

Loetle projekti peamised tehnoloogiad ja raamistikud.

`# Tehnoloogiapakk

Esiosa: React + TypeScript
Tagumine osa: Node.js + Express
Andmebaas: PostgreSQL
Juurutamine: Docker + Kubernetes`

3. Failistruktuur

Selgita peamiste kataloogide otstarvet.

# Failistruktuur /src /components - UI komponendid /pages - Leheküljed /utils - Abifunktsioonid /api - API päringud

4. Levinud käsud

Loetle arenduses kõige sagedamini kasutatavad käsud.

# Levinud käsud npm run dev - Käivita arendusserver npm run build - Koosta tootmisversioon npm run test - Käivita testid

5. Reeglid

Määratle reeglid, mida AI peaks sinu jaoks koodi kirjutamisel järgima.

`# Kodeerimisreeglid

Kasuta funktsionaalseid komponente
Järgi ESLint konfiguratsiooni
Komponentide nimetamisel kasuta PascalCase'i
Muutujate nimetamisel kasuta camelCase'i`

Täielik näide

`# Projekti nimi: Task Manager

Projekti ülevaade

Lihtne ülesannete haldamise rakendus, mis toetab ülesannete loomist, redigeerimist, kustutamist ja kategoriseerimist.

Tehnoloogiapakk

React 18
TypeScript
Tailwind CSS
Vite

Failistruktuur

/src /components - UI komponendid /hooks - Kohandatud Hooks /types - TypeScript tüübimääratlused /utils - Abifunktsioonid

Levinud käsud

npm run dev: Käivita arendusserver
npm run build: Koosta tootmisversioon
npm run lint: Koodi kontroll

Kodeerimisstandardid

Komponentide kirjutamisel kasuta funktsionaalset lähenemist
Kasuta Tailwind CSS-i stiilide jaoks
Iga komponent paiguta eraldi kausta`

Näpunäited

Hoia see lühike: ära kirjuta liiga pikalt, AI võib "väsida"
Uuenda regulaarselt: kui projekt muutub, siis uuenda ka CLAUDE.md
Eelista näiteid: konkreetsed koodinäited on tõhusamad kui abstraktsed kirjeldused
Keskendu valupunktidele: too välja kohad, kus on lihtne vigu teha

Kirjuta korralik CLAUDE.md ja muuda AI oma väärtuslikuks abiliseks!