Claude Code

Configurez Claude Code pour vous aider à rédiger, relire et mettre à jour votre documentation

Claude Code est un outil en ligne de commande agentique qui peut vous aider à gérer 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 en matière de documentation en ajoutant un fichier CLAUDE.md à votre projet et en l’affinant au fil du temps.

​

Prise en main

Prérequis :

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

Configuration :

1. Installez Claude Code :

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

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.

​

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

​

Étendre Claude Code

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

​

Automatisation 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 des modifications d’API sont détectées.

​

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.