Claude Academy
Chargement

Le CLAUDE.md

Leçon 53 min

CLAUDE.md donne à Claude le contexte dont aurait besoin une nouvelle recrue, couvrant les conventions, les commandes, l'architecture et les erreurs que l'équipe rencontre le plus souvent. Les connaissances qui résidaient auparavant dans la tête des gens et sur des wikis deviennent un fichier que l'agent lit au début de chaque session, maintenu par toute l'équipe et affiné à chaque erreur commise.

Pour commencer

  • Prérequis : Aucun.
  • Infrastructure : Un dépôt, Claude Code installé, et un ingénieur qui connaît bien la base de code.

Comment l'exécuter

  1. Exécutez /init dans le dépôt. Claude génère un CLAUDE.md de départ à partir de ce qu'il trouve.
  2. Réduisez le fichier généré à ce dont une nouvelle recrue aurait besoin dès le premier jour. Conservez les commandes de build, de test et de lint, les conventions qui comptent, et les points sur lesquels Claude se trompe régulièrement.
  3. Ajoutez CLAUDE.md à Git à la racine du dépôt afin que toute l'équipe partage une seule version et que les modifications soient revues comme du code.
  4. Une règle de travail est utile ici. Lorsque Claude commet une erreur deux fois, la correction est ajoutée à CLAUDE.md.
  5. Gardez-le sous une page, car Claude le lit intégralement au début d'une session et tout ce qui est obsolète occupe du contexte sans aucun bénéfice.

À quoi cela ressemble

Ce CLAUDE.md appartient au dépôt du portail client d'un assureur. L'ancien système interne qui contient les sinistres est claims-core, et intent/ conserve les fichiers de planification pour chaque modification.

CLAUDE.md :

markdown
# Claims portal
## Commands
- Build: make build
- Test: make test (unit), make itest (integration, needs docker)
- Lint: make lint (runs in CI; fix before pushing)
- Run: make run (portal on :3000, claims-api on :8000)
## Conventions
- claims-api is Python 3.12 and FastAPI. portal is TypeScript and React.
- Every endpoint needs a test in claims-api/tests.
- Dates cross the API as ISO 8601, never as formatted text.
## Architecture
- portal/ is the customer site, claims-api/ is its backend, and
  intent/ holds the intent.md, spec.md and plan.md for each change.
- Only claims-api talks to claims-core. The portal never calls it.
- claims-core allows 50 requests a second. Cache reads; never poll it.
## Things Claude gets wrong
- Do not log request or response bodies in claims-api; they can hold PII.
- Do not bump dependency versions; the platform team owns them.

Considérations de gouvernance

CLAUDE.md est versionné, de sorte que les instructions suivies par l'agent sont vérifiables et auditables. Les conventions de l'équipe sont appliquées via le fichier, les modifications qui y sont apportées sont consignées dans l'historique Git, et les propriétaires du code approuvent ces modifications lors de la revue de PR.

Comment le mesurer

  • Indicateur avancé : La fréquence à laquelle Claude répète une erreur que CLAUDE.md aurait dû éviter. Les corrections ou modifications apportées au CLAUDE.md doivent être suivies dans l'historique Git.
  • Indicateur retardé : Le temps écoulé jusqu'à la première PR fusionnée pour un nouveau membre de l'équipe, d'après l'historique des PR.