La manera correcta d'obrir CLAUDE.md

CLAUDE.md és un fitxer especial que es col·loca al directori arrel del projecte, utilitzat per informar a l'assistent d'IA (com Claude) sobre la informació clau del teu projecte. Escriure bé aquest fitxer pot ajudar a la IA a entendre i ajudar-te millor.

Per què necessites CLAUDE.md?

Imagina't que tens un nou company de feina, quant de temps necessites per fer-li entendre el teu projecte? CLAUDE.md és aquell "manual d'instruccions del projecte", que permet a la IA començar ràpidament.

Els cinc continguts principals de CLAUDE.md

1. Visió general del projecte

Descriu breument què fa aquest projecte, quin problema resol i a quins usuaris s'adreça.

# Visió general del projecte Aquest és un sistema de gestió de backend de comerç electrònic, utilitzat per gestionar productes, comandes i usuaris.

2. Pila tecnològica

Enumera les principals tecnologies i frameworks utilitzats pel projecte.

`# Pila tecnològica

Frontend: React + TypeScript
Backend: Node.js + Express
Base de dades: PostgreSQL
Implementació: Docker + Kubernetes`

3. Estructura de fitxers

Explica la funció dels directoris principals.

# Estructura de fitxers /src /components - Components de la IU /pages - Pàgines /utils - Funcions d'utilitat /api - Crides a l'API

4. Ordres d'ús comú

Enumera les ordres d'ús comú en el desenvolupament.

# Ordres d'ús comú npm run dev - Inicia el servidor de desenvolupament npm run build - Construeix la versió de producció npm run test - Executa les proves

5. Regles

Defineix les regles que la IA ha de seguir quan t'ajuda a escriure codi.

`# Regles de codificació

Utilitza components funcionals
Segueix la configuració d'ESLint
Utilitza PascalCase per als noms dels components
Utilitza camelCase per als noms de les variables`

Un exemple complet

`# Nom del projecte: Task Manager

Visió general del projecte

Una senzilla aplicació de gestió de tasques que admet la creació, edició, eliminació i classificació de tasques.

Pila tecnològica

React 18
TypeScript
Tailwind CSS
Vite

Estructura de fitxers

/src /components - Components de la IU /hooks - Hooks personalitzats /types - Definicions de tipus de TypeScript /utils - Funcions d'utilitat

Ordres d'ús comú

npm run dev: Inicia el servidor de desenvolupament
npm run build: Construeix la versió de producció
npm run lint: Comprovació de codi

Normes de codificació

Utilitza la sintaxi funcional per als components
Utilitza Tailwind CSS per a l'estil
Col·loca cada component en una carpeta separada`

Consells

Mantingues-ho concís: no escriguis massa, la IA també es "cansarà de llegir"
Actualitza-ho regularment: recorda actualitzar CLAUDE.md quan el projecte canviï
Prioritza els exemples: donar exemples de codi concrets és més efectiu que les descripcions abstractes
Centra't en els punts febles: explica amb detall les àrees propenses a errors

Escriu bé CLAUDE.md i converteix la IA en el teu ajudant indispensable!