promptgarten 🌱
🌍 ZH
Guide●○○4 min · +20 XP

Maintenir la documentation avec l'IA

L'IA peut générer des README et des commentaires – et des fichiers comme CLAUDE.md, AGENTS.md et llms.txt rendent ta doc lisible pour les agents.

Faire écrire la doc – et la vérifier

L'IA est douée pour produire de la documentation : sections de README, commentaires de fonctions, descriptions d'API. La doc de Claude Code décrit pour cela un déroulé simple : faire trouver les endroits non documentés, faire générer la doc, puis vérifier et affiner. La dernière étape est obligatoire : la doc générée sonne toujours convaincante – même quand elle est fausse. Lis-la avant de la commit.

Doc pour les agents : CLAUDE.md et AGENTS.md

La documentation a aujourd'hui deux publics : les humains et les agents. CLAUDE.md est un fichier que Claude Code lit au début de chaque session – avec les commandes de build, les règles de style et les particularités du projet. AGENTS.md est un format ouvert et transversal aux outils, avec la même idée : un « README pour agents », lu par plus de 20 outils de coding (en date de juillet 2026).

Éviter la dérive documentaire

La doc devient obsolète quand le code change et que personne n'y touche. Une doc fausse est pire que pas de doc du tout – surtout pour les agents, qui lui font confiance. Règle pratique : mettre à jour la doc dans le même lot de changements que le code, et demander régulièrement à l'IA : « Le README correspond-il encore à l'état actuel ? »

llms.txt pour les lecteurs IA

Si ta doc est un site web, un fichier /llms.txt aide : un aperçu Markdown avec des liens, pour que les systèmes d'IA trouvent le contenu sans avoir à se battre avec du HTML plein de navigation et de pub.

EXEMPLE

Prompt : « Trouve toutes les fonctions sans commentaire JSDoc dans src/auth/, génère des commentaires dans le style des existants, et marque chaque endroit où tu n'es pas sûr du comportement. »

QUIZ RAPIDE

À quoi sert un fichier llms.txt ?

SOURCES

SUJETS LIÉS

CLAUDE.md / AGENTS.md : mémoire et règles pour ton agent ●●○Pattern : donner du contexte plutôt que poser une question vague ●○○Claude Code : l'agent CLI d'Anthropic ●●○