Mises à jour automatiques de la documentation

Le skill /update-jamdesk pour Claude Code surveille vos modifications de code et génère les mises à jour de documentation correspondantes. Après avoir livré une fonctionnalité visible par les utilisateurs, exécutez le skill et il déterminera quelles pages de documentation doivent être créées ou modifiées.

Quand l'utiliser

À utiliser lorsque : Vous avez apporté des modifications visibles par les utilisateurs aux API, commandes CLI, interface utilisateur, options de configuration, ou au comportement des composants.

À ignorer lorsque : Refactorisations internes, modifications uniquement liées aux tests, configuration build/CI, ou travaux 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 : CLI Jamdesk pour la vérification (npm install -g jamdesk)

Démarrage rapide

docs_path: ../my-docs

/update-jamdesk

Format du fichier de configuration

Le fichier .jamdesk-docs-path indique à Claude où se trouve votre documentation.

Format simple - juste le chemin :

../my-docs

Format complet - avec options :

# Path to documentation repository
docs_path: ../my-docs

# Optional: Branch for doc updates (default: main)
docs_branch: main

Comment ça fonctionne

Lorsque vous exécutez /update-jamdesk, Claude :

1. Localise votre documentation - Trouve le fichier de configuration .jamdesk-docs-path
2. Pose des questions - Clarifie la stratégie de branche, la portée et le contenu
3. Analyse la documentation existante - Recherche le contenu associé à mettre à jour ou à enrichir
4. Rédige la documentation - Crée ou met à jour des pages en suivant les standards Jamdesk, avec des exemples simples en premier
5. Révise le ton - Vérifie la présence de formulations IA dans le résultat. Claude écrit mieux avec un CLAUDE.md qui définit la voix (voir Claude Code)
6. Vérifie - Exécute jamdesk validate et jamdesk broken-links
7. Valide - Prépare les modifications et propose de les committer/pousser/créer une PR

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 preview

Exécutez avec --preview pour voir ce qui changerait sans effectuer de modifications :

/update-jamdesk --preview

Le mode preview vous permet de :

• Vérifier quelle documentation doit être mise à jour
• Réviser les modifications proposées avant de valider
• Voir l'analyse du skill sans effets secondaires

Suggestions proactives

Après avoir validé des modifications de code visibles par les utilisateurs, Claude peut suggérer :

Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.

Ceci apparaît lorsque :

• Vous avez un fichier de configuration .jamdesk-docs-path, ET
• Votre commit inclut des fichiers correspondant aux patterns visibles par les utilisateurs (API, CLI, composants)

Installer le skill

Installez le skill /update-jamdesk avec le CLI skills :

npx skills add jamdesk/skills --skill update-jamdesk

Cela installe le skill dans .claude/skills/update-jamdesk/ de votre projet.

npx skills add jamdesk/skills --skill update-jamdesk

Lister les skills disponibles

Voir tous les skills Jamdesk :

npx skills add jamdesk/skills --list

Mise à jour

Réexécutez la commande d'installation pour obtenir la dernière version :

npx skills add jamdesk/skills --skill update-jamdesk

Dépannage

Et ensuite ?