Notre avis
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.
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.
Lorsque la documentation est déjà parfaitement à jour, ou pour des projets sans structure de documentation de contexte formelle.
Analyse de sécurité
SûrThe 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é
Exemples
/update-context after implementing customer registrationCheck recent closed stories and suggest context documentation updates for any that were missed.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
-
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 -
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
-
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| -
Present findings to user using AskUserQuestion:
- List what changed
- Suggest which context docs might need updates
- Ask user to confirm which docs to update
-
For each doc to update:
- Read the current content
- Propose specific changes based on recent work
- Make edits after user approval
-
After updates, remind user to:
- Commit context doc changes with the related code
- Check that
current-state.mdreflects 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:
- Review each story's acceptance criteria and tech notes
- Compare against current context docs
- Propose updates to bring docs in sync with what's actually built
- This is especially important for
current-state.mdwhich 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.mdwhen features move from "planned" to "built"
Generateur de Documentation API
Documentation
Genere automatiquement de la documentation API OpenAPI/Swagger.
Rédacteur Technique
Documentation
Rédige de la documentation technique claire selon les meilleurs style guides.
Système de formulaires de documentation typés
Documentation
Utilisez la syntaxe `(doc ...)` pour ajouter des annotations typées, des descriptions, des tâches (todo) et d'autres métadonnées directement dans le code Scheme. Les annotations sont extractibles via des commandes comme lf-todo et lf-types, et s'intègrent au vérificateur de types, où les déclarations de type dans les doc prennent le pas sur l'inférence. Idéal pour documenter les fonctions, marquer des déprécations ou lister des améliorations localisées sans recourir à un système externe.