Mise à jour de la documentation contextuelle

VérifiéSûr

Analyse les récents commits et issues fermées pour détecter les mises à jour manquantes dans la documentation de contexte. Associe les zones de code modifiées aux fichiers de documentation pertinents (domaine, modules, intégrations, etc.) et propose des modifications. Utile pour maintenir la documentation synchronisée avec les fonctionnalités livrées.

Spar Skills Guide Bot
DocumentationIntermédiaire
02/06/2026
Claude Code
#context-documentation#git-integration#documentation-update#project-context

Recommandé pour

Synthèse automatique

Cette compétence aide à maintenir la documentation de contexte d'un projet à jour après des changements, en utilisant git et GitHub Issues pour identifier les écarts.

Points forts

  • Fournit une procédure systématique pour détecter les mises à jour manquantes dans la documentation.
  • Intègre directement git et GitHub Issues pour une vérification efficace.
  • Propose une table de correspondance claire entre types de changements et documents à mettre à jour.
  • Inclut un mécanisme de rattrapage pour les mises à jour oubliées.

Limites

  • Suppose une structure de dossiers spécifique (docs/context/) qui n'est pas universelle.
  • Nécessite que l'utilisateur confirme manuellement chaque mise à jour.
  • Ne peut pas détecter les changements qui ne sont pas reflétés dans git ou les issues.
Quand l'utiliser

Après avoir implémenté une fonctionnalité, modifié l'architecture ou fermé un story, pour synchroniser la documentation de contexte avec l'état réel du projet.

Quand l'éviter

Lorsque la documentation est déjà parfaitement à jour, ou pour des projets sans structure de documentation de contexte formelle.

Analyse de sécurité

Sûr
Score qualité90/100

The skill only runs local read-only git and gh commands to inspect changes and closed issues, then updates documentation files after user confirmation. No destructive, exfiltrating, or obfuscated actions are present.

Aucun point d'attention détecté

Comment cette analyse est faite

Exemples

Update context after feature implementation
/update-context after implementing customer registration
Catch up on missed documentation updates
Check recent closed stories and suggest context documentation updates for any that were missed.
Review context docs after architecture change
I just refactored the payment module. Can you help me update the context documentation accordingly?

Update Context Documentation

You are helping the user review and update context documentation after completing work.

Instructions

  1. Check recent changes and closed stories by running:

    git log --oneline -5
    git diff --name-only HEAD~5
    gh issue list --state closed --label story --search "sort:updated-desc" --json number,title,closedAt --limit 5
    
  2. Cross-reference commits with closed stories:

    • For each recently closed story, check if there's a corresponding commit
    • For each story, review what was delivered (use gh issue view <number>)
    • Identify any gaps where a story was completed but context docs weren't updated
  3. Review what was changed and determine which context docs might need updates:

    | If you changed... | Consider updating... | |-------------------|---------------------| | New domain entity or rules | docs/context/domain/<name>.md | | New module or module boundaries | docs/context/modules/<name>.md | | External integration | docs/context/integrations.md | | New patterns or conventions | docs/context/conventions.md | | Architecture decisions | docs/context/overview.md | | New domain terms | docs/context/glossary.md | | New features built | docs/context/current-state.md |

  4. Present findings to user using AskUserQuestion:

    • List what changed
    • Suggest which context docs might need updates
    • Ask user to confirm which docs to update
  5. For each doc to update:

    • Read the current content
    • Propose specific changes based on recent work
    • Make edits after user approval
  6. After updates, remind user to:

    • Commit context doc changes with the related code
    • Check that current-state.md reflects what's now built

Context Doc Purposes

  • overview.md: System architecture, module structure, tech stack summary
  • glossary.md: Domain terms (credit, lending, customer lifecycle)
  • domain/*.md: Business rules, entity states, lifecycle flows
  • modules/*.md: Module responsibilities, APIs, database schemas
  • integrations.md: External systems, API contracts
  • conventions.md: Code patterns, naming, testing standards
  • current-state.md: What's built vs planned, MVP scope

Example Flow

User runs /update-context after implementing customer registration

1. Check git log and closed stories
2. Cross-reference: Story #21 closed, commit exists, but context not updated
3. Present: "I see story #21 (Customer Registration) was completed. Consider updating:
   - docs/context/domain/customer.md (if business rules changed)
   - docs/context/modules/customer-module.md (if APIs changed)
   - docs/context/current-state.md (to mark feature as built)"
4. User confirms which to update
5. Read each doc, propose changes, apply after approval
6. Remind to commit with code changes

Catching Up on Missed Updates

If you find stories that were closed without context updates:

  1. Review each story's acceptance criteria and tech notes
  2. Compare against current context docs
  3. Propose updates to bring docs in sync with what's actually built
  4. This is especially important for current-state.md which should reflect reality

Important

  • Don't create new domain/module docs unless a new domain or module was added
  • Keep updates focused and concise
  • Context docs should be factual and dense, not narrative
  • Always update current-state.md when features move from "planned" to "built"

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-context-documentation-mm5t8cgj/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-context-documentation-mm5t8cgj' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/update-context-documentation-mm5t8cgj/download' --output '.skill-downloads/update-context-documentation-mm5t8cgj/SKILL.md.part' && mv '.skill-downloads/update-context-documentation-mm5t8cgj/SKILL.md.part' '.skill-downloads/update-context-documentation-mm5t8cgj/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

Le fichier ne fournit pas un en-tête name/description exploitable pour cette procédure native. Le téléchargement reste disponible pour lecture ; utilisez le mode manuel ci-dessous.

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-context-documentation-mm5t8cgj/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