Skills Guide

Mise à jour de la documentation

VérifiéSûr

Met à jour l'ensemble de la documentation du projet après des modifications de code. Analyse les changements via git, met à jour les fichiers KNOWLEDGE_BASE.md, README.md et leur version chinoise, puis vérifie l'intégrité des modifications.

Télécharger et utiliser
Spar Skills Guide Bot
DocumentationIntermédiaire
02/06/2026
Claude CodeCursor
#documentation#code-changes#readme#knowledge-base#sync

Recommandé pour

Claude CodeCursorDocumentation automatique

Synthèse automatique

Met à jour tous les fichiers de documentation du projet après des modifications de code.

Points forts

  • Automatise le processus de mise à jour de la documentation après chaque changement.
  • Assure la cohérence entre les versions anglaise et chinoise du README.
  • Vérifie automatiquement les modifications avec les tests.

Limites

  • Nécessite que des fichiers spécifiques (KNOWLEDGE_BASE.md, README.md, README_ZH.md) existent déjà.
  • Dépend de sous-compétences (update-knowledge-base, sync-readme) qui doivent être disponibles.
  • Ne couvre pas la documentation générée automatiquement (ex: JSDoc, API docs).
Quand l'utiliser

Utilisez cette compétence après toute modification affectant l'interface utilisateur, l'API ou la configuration du projet.

Quand l'éviter

Évitez de l'utiliser pour des changements purement internes ou des corrections mineures sans impact utilisateur.

Analyse de sécurité

Sûr
Score qualité90/100

The skill only instructs to run documentation update skills and 'npm test', which are standard, safe operations for maintaining project docs. No destructive commands, exfiltration, or obfuscation.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Update docs after adding OpenCode support
Update all docs after adding OpenCode support
Update docs after CLI command change
Update documentation after modifying CLI commands

name: update-docs description: Update all project documentation after code changes.

Update Documentation

Instructions

One-click command to update all project documentation after code changes.

Steps

  1. Analyze Changes

    • Check git status for modified files
    • Review recent commits if no uncommitted changes
    • Identify what documentation needs updating

  2. Update KNOWLEDGE_BASE.md

    • Run the update-knowledge-base skill
    • Document any architectural or feature changes

  3. Update README.md

    • Add new features or commands
    • Update examples if API changed
    • Ensure accuracy of all documented commands

  4. Sync README_ZH.md

    • Run the sync-readme skill
    • Ensure Chinese documentation matches English

  5. Verify

    • Run tests to ensure nothing broken: npm test
    • Check that all documented commands work
    • Review diff before committing

When to Use

  • After adding a new adapter
  • After adding or modifying CLI commands
  • After changing the configuration format
  • After any user-facing changes

Output

All documentation files updated and in sync:

  • KNOWLEDGE_BASE.md (if exists)
  • README.md
  • README_ZH.md

Examples

Request: Update all docs after adding OpenCode support Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated

Du fichier au premier essai

Le téléchargement contient exactement le contenu affiché sur cette fiche. Cette copie peut différer de la dernière version du dépôt source.

Consulter la source et ses fichiers annexes

Ce téléchargement contient uniquement SKILL.md. Les scripts, références, modèles et dépendances éventuels ne sont pas inclus. Récupérez les fichiers nécessaires depuis la source en conservant leur arborescence avant de poursuivre.

1. Télécharger le fichier

Télécharger SKILL.md

Depuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/update-documentation-mmlj2p6y/SKILL.md, ou utilisez la commande suivante. Ce dossier sert à examiner la skill avant son installation.

Commande pour macOS/Linux ou WSL : un shell POSIX et curl sont nécessaires. Sous Windows sans WSL, utilisez le bouton de téléchargement et créez le dossier manuellement.

mkdir -p '.skill-downloads/update-documentation-mmlj2p6y' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/update-documentation-mmlj2p6y/download' --output '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md.part' && mv '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md.part' '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md'

2. Vérifier les prérequis

Lisez SKILL.md avant de l’utiliser. Si le fichier cite des scripts ou services externes, examinez-les et préparez les accès nécessaires dans votre environnement de test.

Aucune section de prérequis reconnue dans ce fichier. Cela ne signifie pas qu’il est autonome : les bibliothèques, outils et accès peuvent être cités ailleurs dans le contenu ou dans le dépôt source.

Les plateformes de la fiche sont des indications du catalogue. Les chemins ci-dessous suivent la documentation des outils ; ils ne prouvent pas que cette skill y a été exécutée. Aucune version minimale de ces outils n’est attestée pour cette fiche.

3. Charger la skill

Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.

Claude Code
test -f '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && test -s '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/update-docs' && cp -R '.skill-downloads/update-documentation-mmlj2p6y' '.claude/skills/update-docs'

Cursor
test -f '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && test -s '.skill-downloads/update-documentation-mmlj2p6y/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/update-docs' && cp -R '.skill-downloads/update-documentation-mmlj2p6y' '.cursor/skills/update-docs'

OpenSkills

OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.

Installation officielle d’OpenSkills
openskills install './.skill-downloads/update-documentation-mmlj2p6y'

openskills read 'update-documentation-mmlj2p6y'

La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.

Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.

openskills sync

Mode manuel ou autre outil : joignez SKILL.md à une conversation, ou ouvrez-le dans un agent capable de lire les fichiers. Ajoutez les ressources annexes nécessaires. Il n’existe pas de dossier universel reconnu par tous les outils.

4. Faire un premier essai

Utilisez une entrée courte et fictive : un endpoint d’API, un petit document ou un brief d’interface. Dans une nouvelle conversation, joignez le fichier ou donnez son chemin à l’agent, puis adaptez cette demande :

Lis .skill-downloads/update-documentation-mmlj2p6y/SKILL.md et applique ses instructions à cet exemple : [décrire une entrée de test]. Indique les fichiers, dépendances ou accès qui manquent. Produis le résultat demandé par la skill sans inventer de données ni exécuter de script non examiné.

Résultat attendu : une sortie correspondant aux instructions de la skill, ou une liste précise des prérequis manquants. Une simple confirmation de lecture ne valide pas le premier usage. Si une ressource externe est indisponible, ce parcours reste à tester.

Skills similaires

Rédaction de docs Supabase

Documentation

Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.

Claude CodeintermediateSûr 108,544
Skills Guide Bot

Créer un enregistrement de décision d'architecture

Documentation

Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.

Claude CodeintermediateSûr 69,659
Skills Guide Bot

Mise à jour de plan avec recherche approfondie

Documentation

Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.

Claude CodeadvancedSûr 248,015
Skills Guide Bot