Passer au contenu principal
Claude Code est un outil en ligne de commande agentique qui vous aide à maintenir votre documentation. Il peut créer de nouveaux contenus, relire des pages existantes et garder la documentation à jour. Vous pouvez entraîner Claude Code à comprendre vos standards et vos processus de documentation en ajoutant un fichier CLAUDE.md à votre projet et en le peaufinant au fil du temps.

​
Pour commencer

Prérequis :
  • Abonnement Claude actif (Pro, Max ou accès à l’API)
Configuration :
  1. Installez Claude Code :
npm install -g @anthropic-ai/claude-code
  1. Accédez à votre répertoire de documentation.
  2. (Facultatif) Ajoutez le fichier CLAUDE.md ci-dessous à votre projet.
  3. Exécutez claude pour démarrer.

​
Modèle CLAUDE.md

Enregistrez un fichier CLAUDE.md à la racine de votre répertoire de documentation pour aider Claude Code à comprendre votre projet. Ce fichier entraîne Claude Code sur vos normes de documentation, vos préférences et vos flux de travail. Consultez la page Gérer la mémoire de Claude dans la documentation d’Anthropic pour en savoir plus. Copiez ce modèle d’exemple ou adaptez-le selon les spécifications de votre documentation : 
# Documentation Mintlify

## Collaboration
- Vous pouvez contester des idées — cela peut aboutir à une meilleure documentation. Citez vos sources et expliquez votre raisonnement lorsque vous le faites
- DEMANDEZ TOUJOURS des précisions plutôt que de faire des suppositions
- NE mentez JAMAIS, ne devinez pas et n’inventez aucune information

## Contexte du projet
- Format : fichiers MDX avec frontmatter YAML
- Config : docs.json pour la navigation, le thème et les paramètres
- Composants : composants Mintlify

## Stratégie de contenu
- Documentez juste ce qu’il faut pour la réussite de l’utilisateur — ni trop ni trop peu
- Priorisez l’exactitude et l’utilisabilité des informations
- Rendez le contenu pérenne lorsque possible
- Recherchez d’abord l’existant avant d’ajouter du nouveau contenu. Évitez les doublons sauf pour une raison stratégique
- Vérifiez la cohérence avec les modèles/patterns existants
- Commencez par apporter les plus petits changements raisonnables

## docs.json

- Reportez-vous au [schéma docs.json](https://mintlify.com/docs.json) pour créer le fichier docs.json et la navigation du site

## Exigences de frontmatter pour les pages
- title : Titre de page clair et descriptif
- description : Résumé concis pour le SEO/la navigation

## Normes de rédaction
- Voix à la deuxième personne (« vous »)
- Prérequis en début de contenu procédural
- Testez tous les exemples de code avant publication
- Adoptez le style et le formatage des pages existantes
- Incluez des cas d’usage à la fois basiques et avancés
- Balises de langue sur tous les blocs de code
- Texte alternatif sur toutes les images
- Chemins relatifs pour les liens internes

## Flux de travail Git
- N’UTILISEZ JAMAIS --no-verify lors des commits
- Demandez comment gérer les modifications non validées avant de commencer
- Créez une nouvelle branche lorsqu’il n’existe pas de branche clairement dédiée aux changements
- Validez (commit) fréquemment tout au long du développement
- NE sautez JAMAIS et ne désactivez jamais les hooks de pré-commit

## À ne pas faire
- Omettre le frontmatter dans un fichier MDX
- Utiliser des URL absolues pour les liens internes
- Inclure des exemples de code non testés
- Faire des suppositions — demandez toujours des précisions

​
Exemples de prompts

Une fois Claude Code configuré, essayez ces prompts pour voir comment il peut aider dans des tâches de documentation courantes. Vous pouvez copier-coller ces exemples directement ou les adapter à vos besoins spécifiques.

​
Convertir des notes en documentation soignée

Transformez des brouillons en véritables pages Markdown avec composants et frontmatter. Exemple de prompt :
mettre en forme
Convertissez ce texte en une page MDX correctement mise en forme : [collez votre texte ici]

​
Réviser la documentation pour assurer la cohérence

Obtenez des suggestions pour améliorer le style, la mise en forme et l’utilisation des composants. Exemple de demande :
retour à la ligne
Passez en revue les fichiers de docs/ et proposez des améliorations pour la cohérence et la clarté

​
Mettre à jour la documentation lorsque les fonctionnalités évoluent

Maintenez votre documentation à jour au rythme de l’évolution de votre produit. Exemple de prompt :
renvoyer à la ligne
Notre API requiert désormais un paramètre de version. Mettez à jour notre documentation pour inclure version=2024-01 dans tous les exemples

​
Générer des exemples de code complets

Créez des exemples multilingues avec gestion des erreurs. Exemple d’invite :
renvoyer à la ligne
Créer des exemples de code pour [votre endpoint d’API] en JavaScript, Python et cURL, avec gestion des erreurs

​
Étendre Claude Code

Au-delà des invites manuelles avec Claude Code, vous pouvez l’intégrer à vos flux de travail existants.

​
Automatisation avec GitHub Actions

Exécutez Claude Code automatiquement lors des modifications de code pour garder la documentation à jour. Vous pouvez déclencher des revues de documentation sur les pull requests ou mettre à jour les exemples lorsque des changements d’API sont détectés.

​
Flux de travail multi‑instances

Utilisez des sessions Claude Code distinctes selon les tâches — l’une pour la rédaction de nouveau contenu, l’autre pour la relecture et l’assurance qualité. Cela permet de maintenir la cohérence et de détecter des problèmes qu’une seule session pourrait manquer.

​
Collaboration en équipe

Partagez votre fichier CLAUDE.md amélioré avec votre équipe afin de garantir des standards de documentation cohérents entre tous les contributeurs. Les équipes élaborent souvent des invites et des flux de travail propres au projet qui deviennent partie intégrante de leur processus de documentation.

​
Commandes personnalisées

Créez des commandes slash réutilisables dans .claude/commands/ pour les tâches de documentation fréquemment utilisées, propres à votre projet ou à votre équipe.