CLAUDE.md:n oikea käyttötapa

CLAUDE.md on projektin juurihakemistoon sijoitettava erityinen tiedosto, jonka avulla kerrot tekoälyavustajalle (kuten Claude) projektisi keskeisistä tiedoista. Hyvin kirjoitettu tiedosto auttaa tekoälyä ymmärtämään ja auttamaan sinua paremmin.

Miksi CLAUDE.md tarvitaan?

Kuvittele, että saat uuden työkaverin. Kuinka kauan sinulla kestää saada hänet ymmärtämään projektisi? CLAUDE.md on kuin "projektin käyttöohje", jonka avulla tekoäly pääsee nopeasti alkuun.

CLAUDE.md:n viisi ydinsisältöä

1. Projektin yleiskatsaus

Kuvaile lyhyesti, mitä projekti tekee, mitä ongelmaa se ratkaisee ja kenelle se on suunnattu.

# Projektin yleiskatsaus Tämä on verkkokaupan hallintajärjestelmä, jota käytetään tuotteiden, tilausten ja käyttäjien hallintaan.

2. Teknologiapino

Luettele projektissa käytetyt tärkeimmät teknologiat ja kehykset.

`# Teknologiapino

Frontend: React + TypeScript
Backend: Node.js + Express
Tietokanta: PostgreSQL
Käyttöönotto: Docker + Kubernetes`

3. Tiedostorakenne

Selitä pääkansioiden tarkoitus.

# Tiedostorakenne /src /components - UI-komponentit /pages - Sivut /utils - Aputoiminnot /api - API-kutsut

4. Yleiset komennot

Luettele kehityksessä yleisesti käytetyt komennot.

# Yleiset komennot npm run dev - Käynnistä kehityspalvelin npm run build - Luo tuotantoversio npm run test - Suorita testit

5. Säännöt

Määrittele säännöt, joita tekoälyn tulisi noudattaa auttaessaan sinua kirjoittamaan koodia.

`# Koodausstandardit

Käytä funktionaalisia komponentteja
Noudata ESLint-määrityksiä
Komponenttien nimeämisessä käytetään PascalCasea
Muuttujien nimeämisessä käytetään camelCasea`

Täydellinen esimerkki

`# Projektin nimi: Task Manager

Projektin yleiskatsaus

Yksinkertainen tehtävienhallintasovellus, joka tukee tehtävien luomista, muokkaamista, poistamista ja luokittelua.

Teknologiapino

React 18
TypeScript
Tailwind CSS
Vite

Tiedostorakenne

/src /components - UI-komponentit /hooks - Mukautetut Hookit /types - TypeScript-tyyppimäärittelyt /utils - Aputoiminnot

Yleiset komennot

npm run dev: Käynnistä kehityspalvelin
npm run build: Luo tuotantoversio
npm run lint: Koodin tarkistus

Koodausstandardit

Komponentit kirjoitetaan funktionaalisesti
Käytä Tailwind CSS:ää tyylittelyyn
Jokainen komponentti sijoitetaan omaan kansioonsa`

Vinkkejä

Pidä se ytimekkäänä: Älä kirjoita liian pitkästi, tekoälykin "väsyy"
Päivitä säännöllisesti: Muista päivittää CLAUDE.md, kun projekti muuttuu
Esimerkit etusijalla: Konkreettiset koodiesimerkit ovat tehokkaampia kuin abstraktit kuvaukset
Keskity kipupisteisiin: Korosta alueita, joissa on helppo tehdä virheitä

Kirjoita hyvä CLAUDE.md, niin tekoälystä tulee arvokas apulaisesi!