AgentSkillsCN

docs-sync-automaton

分析内存银行,检查受影响的源代码,并更新所有相关文档。

SKILL.md
--- frontmatter
name: docs-sync-automaton
description: Analyse la Memory Bank, inspecte le code source impacté, et met à jour TOUTE la documentation associée.

Docs Sync Automaton

Skill à invoquer pour exécuter une mise à jour documentaire complète selon le workflow /docs-updater.

Pré-requis

  • Memory Bank à jour (memory-bank/{activeContext,progress,decisionLog}.md).
  • Accès au repo pour exécuter tree, cloc, radon.
  • Virtualenv /mnt/venv_ext4/venv_render_signal_server (pour les scripts d'audit).

Workflow

  1. Collecte Contexte
    • Lire memory-bank/{activeContext,progress,decisionLog}.md.
    • Identifier les fichiers impactés par la feature/bugfix.
  2. Audit Code
    • Lancer le helper ./.windsurf/skills/docs-sync-automaton/run_docs_audit.sh.
    • Noter les modules modifiés pour guider les docs.
  3. Plan Docs
    • Associer chaque changement à un fichier dans docs/ (architecture, features, operations, quality, etc.) ou README.
    • Prévoir les sections à mettre à jour (tables de services, workflows, API, UX, etc.).
  4. Écriture
    • Utiliser un ton descriptif, mentionner les dates si pertinent.
    • Ajouter des ancres/table des matières pour les nouveaux fichiers.
  5. Validation
    • Relire la cohérence (typos, liens, références croisées).
    • Mettre à jour la Memory Bank (progress + decision) pour tracer la doc.
  6. Tests / Commandes
    • Si le workflow exige, exécuter python scripts/docs/lint_links.py (exemple) ou autre validation doc.

Ressources

  • run_docs_audit.sh : active le venv, exécute tree -L 2, cloc docs/, radon cc app_render.py services routes.

Conseils

  • Toujours citer les fichiers modifiés dans le récap final.
  • Pour les guides longs, déplacer les détails dans docs/features/* et résumer dans docs/README.md.
  • Synchroniser les captures JSON/ENV si de nouvelles variables sont introduites.