La bonne façon d'utiliser CLAUDE.md

CLAUDE.md est un fichier spécial placé dans le répertoire racine d'un projet, utilisé pour informer un assistant IA (tel que Claude) des informations clés concernant votre projet. Bien rédiger ce fichier permet à l'IA de mieux comprendre et de vous aider.

Pourquoi CLAUDE.md est-il nécessaire ?

Imaginez qu'un nouveau collègue arrive. Combien de temps vous faut-il pour qu'il comprenne votre projet ? CLAUDE.md est ce "manuel du projet", permettant à l'IA de démarrer rapidement.

Les cinq principaux contenus de CLAUDE.md

1. Aperçu du projet

Décrivez simplement ce que fait ce projet, quel problème il résout et à quels utilisateurs il s'adresse.

# Aperçu du projet Ceci est un système de gestion de back-end de commerce électronique, utilisé pour gérer les produits, les commandes et les utilisateurs.

2. Pile technologique

Énumérez les principales technologies et frameworks utilisés par le projet.

`# Pile technologique

• Frontend : React + TypeScript
• Backend : Node.js + Express
• Base de données : PostgreSQL
• Déploiement : Docker + Kubernetes`

3. Structure des fichiers

Expliquez le rôle des principaux répertoires.

# Structure des fichiers /src /components - Composants UI /pages - Pages /utils - Fonctions utilitaires /api - Appels API

4. Commandes courantes

Énumérez les commandes couramment utilisées lors du développement.

# Commandes courantes npm run dev - Démarrer le serveur de développement npm run build - Construire la version de production npm run test - Exécuter les tests

5. Règles

Définissez les règles que l'IA doit suivre lorsqu'elle vous aide à écrire du code.

`# Règles de codage

• Utiliser des composants fonctionnels
• Suivre la configuration ESLint
• Utiliser PascalCase pour nommer les composants
• Utiliser camelCase pour nommer les variables`

Un exemple complet

`# Nom du projet : Task Manager

Aperçu du projet

Une application simple de gestion des tâches qui prend en charge la création, la modification, la suppression et la catégorisation des tâches.

Pile technologique

• React 18
• TypeScript
• Tailwind CSS
• Vite

Structure des fichiers

/src /components - Composants UI /hooks - Hooks personnalisés /types - Définitions de types TypeScript /utils - Fonctions utilitaires

Commandes courantes

• npm run dev : Démarrer le serveur de développement
• npm run build : Construire la version de production
• npm run lint : Vérification du code

Normes de codage

• Utiliser une écriture fonctionnelle pour les composants
• Utiliser Tailwind CSS pour le style
• Placer chaque composant dans un dossier séparé`

Conseils

• Restez concis : n'écrivez pas trop long, l'IA sera également "fatiguée de lire"
• Mettez à jour régulièrement : n'oubliez pas de mettre à jour CLAUDE.md lorsque le projet change
• Priorité aux exemples : donner des exemples de code concrets est plus efficace que des descriptions abstraites
• Concentrez-vous sur les points sensibles : expliquez en détail les endroits où il est facile de faire des erreurs

Écrivez bien CLAUDE.md et faites de l'IA votre assistant compétent !