Aller au contenu principal

Configuration de Claude Code

Claude Code est l'outil CLI officiel d'Anthropic. Ce guide vous aidera à configurer Claude Code pour vous aider à rédiger et maintenir votre documentation.

Prérequis​

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

Configuration​

  1. Installez Claude Code globalement :
npm install -g @anthropic-ai/claude-code
  1. Accédez à votre répertoire de documentation.
  2. (Optionnel) Ajoutez le fichier CLAUDE.md ci-dessous à votre projet.
  3. Exécutez claude pour démarrer.

Créer CLAUDE.md​

Créez un fichier CLAUDE.md à la racine de votre référentiel de documentation pour former Claude Code à vos normes de documentation spécifiques :

# Documentation Mintlify

## Relation de travail
- Vous pouvez remettre en question les idées — cela peut conduire à une meilleure documentation. Citez vos sources et expliquez votre raisonnement lorsque vous le faites
- TOUJOURS demander une clarification plutôt que de faire des suppositions
- JAMAIS mentir, deviner ou inventer des informations

## 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 assez pour le succès de l'utilisateur - ni trop, ni trop peu
- Prioriser l'exactitude et l'utilisabilité des informations
- Rendre le contenu intemporel si possible
- Rechercher les informations existantes avant d'ajouter du nouveau contenu. Éviter la duplication sauf si elle est faite pour une raison stratégique
- Vérifier les modèles existants pour la cohérence
- Commencer par apporter les plus petits changements raisonnables

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

## Normes 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 la publication
- Correspondre au style et au formatage des pages existantes
- Inclure les cas d'usage basiques et avancés
- Étiquettes de langue sur tous les blocs de code
- Texte alternatif sur toutes les images
- Chemins relatifs pour les liens internes

## Workflow Git
- JAMAIS utiliser --no-verify lors de la validation
- Demander comment gérer les changements non validés avant de commencer
- Créer une nouvelle branche quand aucune branche claire n'existe pour les changements
- Valider fréquemment tout au long du développement
- JAMAIS sauter ou désactiver les hooks de pré-validation

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