Rédiger de la documentation avec Claude Code

Claude Code est un outil en ligne de commande autonome qui peut vous aider à maintenir votre documentation. Il peut rédiger de nouveaux contenus, relire des pages existantes et garder la documentation à jour. Vous pouvez entraîner Claude Code à comprendre vos normes et vos flux de travail de documentation en ajoutant un fichier CLAUDE.md à votre projet et en le peaufinant au fil du temps.

Prise en main

Prérequis :

Abonnement Claude actif (Pro, Max ou accès à l’API)

Configuration :

Installez Claude Code :

  npm install -g @anthropic-ai/claude-code

Accédez à votre répertoire de docs.
(Facultatif) Ajoutez le fichier CLAUDE.md ci-dessous à votre projet.
Exécutez claude pour lancer.

Modèle pour 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 standards de documentation, vos préférences et vos flux de travail. Consultez Gérer la mémoire de Claude dans la documentation Anthropic pour plus d’informations. Copiez ce modèle ou adaptez-le selon les spécifications de votre documentation :

# Documentation Mintlify

## Relation de travail
- Vous pouvez remettre en question les idées - cela peut mener à une meilleure documentation. Citez vos sources et expliquez votre raisonnement quand vous le faites
- TOUJOURS demander des clarifications plutôt que de faire des suppositions
- NE JAMAIS mentir, deviner ou inventer quoi que ce soit

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

## Stratégie de contenu
- Documenter juste ce qu'il faut pour la réussite de l'utilisateur - ni trop, ni trop peu
- Prioriser la précision et l'utilisabilité
- Rendre le contenu pérenne quand c'est possible
- Rechercher le contenu existant avant d'ajouter quoi que ce soit de nouveau. Éviter la duplication sauf si c'est fait pour une raison stratégique
- Vérifier les modèles existants pour assurer la cohérence
- Commencer par apporter les plus petits changements raisonnables

## docs.json

- Se référer au [schéma docs.json](https://mintlify.com/docs.json) lors de la construction du fichier docs.json et de la navigation du site

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

## Standards de rédaction
- Voix à la deuxième personne (« vous »)
- Prérequis au début du contenu procédural
- Tester tous les exemples de code avant publication
- Respecter le style et le formatage des pages existantes
- Inclure les cas d'usage de base et avancés
- Balises de langage sur tous les code blocks
- Texte alternatif sur toutes les images
- Chemins relatifs pour les liens internes

## Flux de travail Git
- NE JAMAIS utiliser --no-verify lors du commit
- Demander comment gérer les changements non commités avant de commencer
- Créer une nouvelle branche quand aucune branche claire n'existe pour les changements
- Faire des commits fréquemment pendant le développement
- NE JAMAIS ignorer ou désactiver les hooks de pré-commit

## À ne pas faire
- Omettre le frontmatter sur tout fichier MDX
- Utiliser des URL absolues pour les liens internes
- Inclure des exemples de code non testés
- Faire des suppositions - toujours demander des clarifications

Exemples d’instructions

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

Transformer des notes en documentation soignée

Convertissez des brouillons en véritables pages Markdown avec des composants et du frontmatter. Exemple d’invite :

Convertissez ce texte en page MDX correctement formatée : [collez votre texte ici]

Passer en revue la documentation pour en assurer la cohérence

Obtenez des suggestions pour améliorer le style, la mise en forme et l’utilisation des composants. Exemple d’invite :

Examinez les fichiers dans docs/ et proposez des améliorations pour la cohérence et la clarté

Mettre à jour la documentation lors des évolutions de fonctionnalités

Maintenez la documentation à jour à mesure que votre produit évolue. Exemple d’invite :

Notre API nécessite 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 :

Créez des exemples de code pour [votre point de terminaison API] en JavaScript, Python et cURL avec gestion d'erreurs

Étendez Claude Code

Au-delà des invites manuelles, vous pouvez intégrer Claude Code à vos workflows existants.

Automatiser avec GitHub Actions

Exécutez Claude Code automatiquement lorsque le code évolue afin de garder la documentation à jour. Vous pouvez déclencher des revues de documentation sur les pull requests (demandes de fusion) ou mettre à jour des exemples lorsque les API évoluent.

Flux de travail multi‑instance

Utilisez des sessions Claude Code distinctes pour différentes tâches : l’une pour rédiger de nouveaux contenus et une 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 ne pas repérer.

Collaboration d’équipe

Partagez votre fichier CLAUDE.md finalisé avec votre équipe afin de garantir des normes de documentation cohérentes pour tous les contributeurs. Les équipes élaborent souvent des invites et des flux de travail propres au projet qui finissent par faire 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.

Questions fréquemment posées

Ai-je besoin d'un fichier CLAUDE.md pour utiliser Claude Code avec Mintlify ?

Non, mais cela améliore considérablement la qualité des résultats. Sans fichier CLAUDE.md, Claude Code fonctionne à partir du contexte général et peut ne pas respecter votre guide de style, vos préférences de composants ou votre terminologie. Un fichier CLAUDE.md entraîne Claude Code sur les standards de votre projet afin que vous n’ayez pas à les réexpliquer à chaque invite.

En quoi Claude Code diffère-t-il de Cursor ou Devin Desktop pour la documentation ?

Claude Code est un outil en ligne de commande conçu pour des tâches autonomes et multi-étapes à l’échelle d’un dépôt entier. Il est particulièrement adapté à des tâches comme l’audit de toutes les pages pour détecter les textes alternatifs manquants, la mise à jour d’un nom de paramètre dans tous les exemples de code, ou la vérification de la cohérence d’un ensemble de fichiers. Cursor et Devin Desktop sont des outils basés sur un IDE, mieux adaptés à l’édition de fichiers individuels avec des suggestions en ligne. Les deux approches fonctionnent — le bon choix dépend de si votre travail porte sur des fichiers individuels ou sur l’ensemble du dépôt.

Puis-je utiliser Claude Code pour générer automatiquement de la documentation à partir du code ?

Oui. Claude Code peut lire votre code source et générer la documentation correspondante. Pointez-le vers un endpoint d’API, un fichier de configuration ou un ensemble de fonctions et demandez-lui de produire la documentation correspondante en suivant les standards de votre CLAUDE.md. Relisez et affinez le résultat — la génération automatique fonctionne mieux lorsque vous considérez Claude Code comme un rédacteur de premier jet, et non comme un éditeur final.

Comment partager ma configuration CLAUDE.md avec mon équipe ?

Committez le fichier CLAUDE.md dans votre dépôt de documentation. Toute personne qui clone le dépôt et exécute Claude Code utilise automatiquement la configuration de votre projet. Cela rend les standards de documentation cohérents entre les contributeurs sans que chacun ait à configurer son propre contexte.

​Prise en main

​Modèle pour CLAUDE.md

​Exemples d’instructions

​Transformer des notes en documentation soignée

​Passer en revue la documentation pour en assurer la cohérence

​Mettre à jour la documentation lors des évolutions de fonctionnalités

​Générer des exemples de code complets

​Étendez Claude Code

​Automatiser avec GitHub Actions

​Flux de travail multi‑instance

​Collaboration d’équipe

​Commandes personnalisées

​Questions fréquemment posées