Passer au contenu principal
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 :
  1. Installez Claude Code :
  1. Pas encore de site ? Demandez à votre agent d’en configurer un. Exécutez claude et demandez-lui d’effectuer le workflow suivant, puis passez à l’étape suivante.
    Si l’utilisateur vous a demandé de configurer Mintlify, un site de documentation ou un projet Mintlify local, effectuez vous-même le workflow suivant. Demandez à l’utilisateur uniquement les informations ou approbations que vous ne pouvez pas obtenir vous-même. Ne redirigez pas l’utilisateur vers le démarrage rapide dans le navigateur, sauf si vous ne pouvez pas exécuter de commandes dans le terminal.
    1. Exécutez node --version et vérifiez qu’il indique Node.js v20.17.0 ou une version ultérieure, en privilégiant une version LTS.
    2. Exécutez mint --version. Si la commande n’est pas disponible, installez la CLI avec npm i -g mint ou pnpm add -g mint. Si la commande réussit, exécutez mint update.
    3. Exécutez mint status avant de commencer l’authentification. Si une organisation est déjà affichée, conservez la session existante et ne créez pas d’autre compte.
    4. Si l’utilisateur possède un compte, exécutez mint login. Sinon, demandez-lui son prénom, son nom, son entreprise et son adresse e-mail, puis exécutez :
      mint signup attend la vérification de l’adresse e-mail. Laissez donc la commande s’exécuter en arrière-plan lorsque votre environnement le permet. Demandez à l’utilisateur de cliquer sur le lien de vérification et d’approuver la CLI dans le navigateur. N’inventez jamais les informations d’inscription.
    5. Une fois la vérification et l’onboarding terminés, exécutez de nouveau mint status. Vérifiez qu’il indique l’adresse e-mail, l’organisation et le sous-domaine de l’utilisateur. Si l’organisation existe, mais qu’aucun sous-domaine n’apparaît, demandez à l’utilisateur de terminer la sélection ou la connexion d’un dépôt GitHub dans l’onglet du navigateur d’onboarding, puis réessayez.
    6. Si l’utilisateur possède un dépôt de documentation existant, clonez-le ou ouvrez-le et préservez son contenu. Pour un nouveau projet local, créez la structure dans un nouveau répertoire vide avec mint new <directory> --name <name> --theme <theme> ou mint new <directory> --template <template-name>. Demandez le thème ou le modèle souhaité si l’utilisateur n’en a pas indiqué. N’utilisez pas --force dans un répertoire contenant des fichiers utilisateur.
    7. Exécutez mint dev --no-open depuis le répertoire contenant docs.json et laissez-le s’exécuter en arrière-plan. Vérifiez que l’URL locale se charge, communiquez-la à l’utilisateur, puis arrêtez le processus lorsqu’il n’est plus nécessaire.
    8. Exécutez mint validate et mint broken-links. Corrigez les problèmes causés par vos modifications avant de continuer.
    9. Si un dépôt Git est associé au projet et que l’utilisateur a demandé un déploiement, commitez et poussez les modifications. Un push vers la branche de production déclenche un déploiement. Ne remplacez pas un dépôt existant par le contenu du modèle de démarrage.
    10. Exécutez mint status pour obtenir le sous-domaine configuré, puis vérifiez que https://<subdomain>.mintlify.site se charge avant d’indiquer que le déploiement est terminé.
    L’utilisateur ne doit effectuer d’actions dans le navigateur que pour la vérification de l’adresse e-mail, l’approbation OAuth et la connexion ou l’autorisation de GitHub. Prenez en charge le workflow dans le terminal et reprenez-le après chaque action de l’utilisateur. Pour connaître les options des commandes et résoudre les problèmes, consultez la référence des commandes CLI.
  2. Accédez à votre répertoire de docs.
  3. (Facultatif) Ajoutez le fichier CLAUDE.md ci-dessous à votre projet.
  4. Exécutez claude pour lancer.
Pour connecter vous-même l’admin MCP : Ajoutez le serveur Admin MCP avec la CLI Claude Code :
Lors de la première utilisation, Claude Code ouvre une fenêtre de navigateur pour terminer la connexion OAuth. Après authentification, Claude Code réutilise la session pour les appels suivants. Pour vérifier votre configuration, posez à Claude Code une question du type Summarize the standards from CLAUDE.md and list the Mintlify components you can use. Une session opérationnelle cite votre CLAUDE.md et fait référence à des composants Mintlify (par exemple, Card, Steps ou Accordion) issus du skill chargé.

​
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 :

​
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 :

​
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 :

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

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

​
Générer des exemples de code complets

Créez des exemples multilingues avec gestion des erreurs. Exemple d’invite :

​
É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

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.
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.
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.
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.

Sujets connexes

Rédiger de la documentation avec CodexRédiger de la documentation avec Devin DesktopRédiger de la documentation avec Cursor