Mises à jour automatisées de la documentation
Synchronisez la documentation avec votre code via la skill /update-jamdesk pour Claude Code. Mettez à jour les docs automatiquement.
La skill /update-jamdesk pour Claude Code surveille vos changements de code et génère les mises à jour de documentation correspondantes. Après avoir livré une fonctionnalité visible par l'utilisateur, exécutez la skill et elle déterminera quelles pages de documentation doivent être créées ou modifiées.
Vous cherchez des conseils généraux sur l'écriture avec l'IA ? Cette page couvre la skill /update-jamdesk pour les mises à jour automatisées de documentation. Pour la configuration de l'outil, voir Claude Code. Pour des conseils plus généraux sur l'utilisation d'outils IA pour rédiger de la documentation, voir Rédiger avec l'IA.
Quand l'utiliser
À utiliser quand : Vous avez apporté des changements visibles par l'utilisateur aux API, commandes CLI, à l'UI, aux options de configuration ou au comportement des composants.
À éviter quand : Refactorisations internes, changements limités aux tests, configuration build/CI, ou travail de performance sans changement de comportement. Ceux-ci ne nécessitent pas de documentation utilisateur.
Prérequis
- Claude Code installé et configuré
- Un projet de documentation Jamdesk avec
docs.json - Optionnel : Jamdesk CLI pour la vérification (
npm install -g jamdesk)
Démarrage rapide
Créez un fichier .jamdesk-docs-path dans votre dépôt de code pointant vers votre documentation :
docs_path: ../my-docsLe chemin peut être relatif (depuis le fichier de configuration) ou absolu.
Après avoir implémenté une fonctionnalité, exécutez :
/update-jamdeskClaude analysera vos changements et posera des questions de clarification avant de rédiger la documentation.
Vérifiez la documentation générée, puis Claude la validera avec jamdesk validate et jamdesk broken-links avant de commiter.
Format du fichier de configuration
Le fichier .jamdesk-docs-path indique à Claude où se trouve votre documentation.
Format simple - juste le chemin :
../my-docsFormat complet - avec options :
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainLe fichier de configuration est découvert en remontant depuis votre répertoire actuel jusqu'à la racine git. Placez-le à la racine de votre dépôt pour de meilleurs résultats.
Fonctionnement
Lorsque vous exécutez /update-jamdesk, Claude :
- Localise vos docs - Trouve le fichier de configuration
.jamdesk-docs-path - Pose des questions - Clarifie la stratégie de branche, la portée et le contenu
- Analyse la documentation existante - Recherche le contenu associé à mettre à jour ou étendre
- Rédige la documentation - Crée ou met à jour des pages selon les standards Jamdesk, avec des exemples simples en premier
- Vérifie le ton - Vérifie que le résultat ne contient pas de remplissage IA. Claude rédige mieux avec un CLAUDE.md qui définit la voix (voir Claude Code)
- Vérifie - Exécute
jamdesk validateetjamdesk broken-links - Commite - Prépare les changements et propose de commiter/pousser/créer une PR
Vous n'aimez pas les changements ? Exécutez git checkout . avant de commiter pour annuler toutes les modifications.
| Scénario | Action |
|---|---|
| Nouvelle fonctionnalité | Créer une nouvelle page |
| Changement de comportement | Mettre à jour la page existante |
| Petit ajout | Ajouter une section à la page existante |
| Capacité majeure | Nouvelle page autonome |
| Dépréciation/suppression | Mettre à jour l'existant + ajouter des notes de migration |
Exemple de session
User: I just added a webhook feature. Can you document it?
Claude: I'm using the update-jamdesk skill to update your documentation.
Found .jamdesk-docs-path: ../customer-docs
How should I handle changes to the docs repository?
1. Create a new feature branch (recommended)
2. Update directly on main
3. Use current branch
User: 1
Claude: Based on the webhook implementation, I plan to:
- Create: webhooks/overview.mdx
- Update: getting-started.mdx (add link)
Any changes to this plan?
User: Looks good
Claude: [Creates documentation...]
✓ jamdesk validate passed
✓ jamdesk broken-links passed
Commit these changes?Mode aperçu
Exécutez avec --preview pour voir ce qui changerait sans effectuer de modifications :
/update-jamdesk --previewLe mode aperçu vous permet de :
- Vérifier quelle documentation doit être mise à jour
- Vérifier les changements proposés avant de commiter
- Voir l'analyse de la skill sans effets de bord
Suggestions proactives
Après avoir commité des changements de code visibles par l'utilisateur, Claude peut suggérer :
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.Cela apparaît quand :
- Vous avez un fichier de configuration
.jamdesk-docs-path, ET - Votre commit inclut des fichiers correspondant à des patterns visibles par l'utilisateur (API, CLI, composants)
Installer la skill
Installez la skill /update-jamdesk avec le CLI skills :
npx skills add jamdesk/skills --skill update-jamdeskCeci installe la skill dans .claude/skills/update-jamdesk/ de votre projet.
Installe dans le répertoire de votre projet actuel :
npx skills add jamdesk/skills --skill update-jamdeskLa skill est disponible lorsque vous travaillez dans ce projet.
Lister les skills disponibles
Consultez toutes les skills Jamdesk :
npx skills add jamdesk/skills --listMise à jour
Réexécutez la commande d'installation pour obtenir la dernière version :
npx skills add jamdesk/skills --skill update-jamdeskAprès avoir installé ou mis à jour, redémarrez Claude Code ou démarrez une nouvelle session pour que les changements prennent effet.
Dépannage
Assurez-vous que le fichier de la skill se trouve à .claude/skills/update-jamdesk/SKILL.md et redémarrez votre session Claude Code.
Créez .jamdesk-docs-path à la racine de votre dépôt avec le chemin vers votre répertoire de documentation. La skill recherche depuis votre répertoire actuel jusqu'à la racine git.
Installez avec npm install -g jamdesk. La skill fonctionnera sans lui mais n'exécutera pas la validation automatisée.