Update Project Docs

Propagera un changement de code à travers l'ensemble de documentation multi-langues et multi-surfaces de ce dépôt

par hoangsonww · hoangsonww/Claude-Code-Agent-Monitor

Testé · Fonctionne ★ 9.2/10

Update Project Docs — Propagera un changement de code à travers l'ensemble de documentation multi-langues et multi-surfaces de ce dépôt

Ce que fait

Une compétence de synchronisation de documentation pour le dépôt Claude-Code-Agent-Monitor : étant donné un changement de code (variable d'environnement, type d'événement, route API, schéma de base de données, comportement de hook, outil MCP ou fonctionnalité), elle mappe ce changement à chaque document qui doit être mis à jour — README plus les traductions VN/CN/KO, ARCHITECTURE, READMEs serveur/client, docs/*, la page d'accueil et le wiki avec son cache i18n. Se déclenche automatiquement à la fin de tout ensemble de changements qui modifie le comportement, la configuration ou les interfaces observables de l'extérieur, ou lorsque l'utilisateur demande de mettre à jour le README/wiki/architecture. Fournit une matrice grep doc-coverage.sh pour vérifier qu'un nouveau terme est présent sur la surface de documentation signalée.

Rapport de test

Cloné le dépôt et exécuté les scripts/doc-coverage.sh inclus contre une variable d'environnement existante (DASHBOARD_STALE_MINUTES) — elle se trouve dans 10 fichiers de documentation, confirmant le problème de dérive ciblé par la compétence. Pour le test de SORTIE, j'ai ajouté une variable d'environnement fictive DASHBOARD_HEARTBEAT_MS : une édition de référence (mon instinct naturel, tableau d'env README + .env.example) a mesuré 2 HITs ; l'édition guidée par la compétence suivant le mappage changement→docs a ajouté des lignes aux tableaux d'env README VN/CN/KO (identifiants anglais, prose traduite selon la règle de la compétence) et a mesuré 5 HITs, rattrapant 3 fichiers de traduction laissés obsolètes par la référence. Tous les fichiers référencés ont été récupérés via HTTP 200 ; le script est un bash propre sans odeurs de réseau ou de sécurité.

Testé le: 2026-07-21 · Claude Code 2.x (agent harness)

Installation

git clone --depth 1 https://github.com/hoangsonww/Claude-Code-Agent-Monitor.git /tmp/update-project-docs-src
mkdir -p ~/.claude/skills
cp -R /tmp/update-project-docs-src/.claude/skills/update-project-docs ~/.claude/skills/update-project-docs
# SKILL.md lands at ~/.claude/skills/update-project-docs/SKILL.md
# Bundles references/doc-map.md and scripts/doc-coverage.sh (repo-root-relative; run from repo root).
# No external deps or API keys. The doc-map anchors are specific to THIS repo's doc layout,
# so the skill is most useful when working inside the Claude-Code-Agent-Monitor tree.

Commandes et exemples de prompts

/update-project-docsPropagera un changement de code à travers l'ensemble de documentation multi-langues et multi-surfaces de ce dépôt

Les skills se déclenchent sur des demandes en langage courant — aucune commande à retenir. Après installation, des prompts comme ceux-ci l'activent (en anglais) :

Update the docs after adding this new API route
Sync the README with the new environment variable
Update architecture docs for this schema change

Rapport complet →