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
- •Collecte Contexte
- •Lire
memory-bank/{activeContext,progress,decisionLog}.md. - •Identifier les fichiers impactés par la feature/bugfix.
- •Lire
- •Audit Code
- •Lancer le helper
./.windsurf/skills/docs-sync-automaton/run_docs_audit.sh. - •Noter les modules modifiés pour guider les docs.
- •Lancer le helper
- •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.).
- •Associer chaque changement à un fichier dans
- •Écriture
- •Utiliser un ton descriptif, mentionner les dates si pertinent.
- •Ajouter des ancres/table des matières pour les nouveaux fichiers.
- •Validation
- •Relire la cohérence (typos, liens, références croisées).
- •Mettre à jour la Memory Bank (progress + decision) pour tracer la doc.
- •Tests / Commandes
- •Si le workflow exige, exécuter
python scripts/docs/lint_links.py(exemple) ou autre validation doc.
- •Si le workflow exige, exécuter
Ressources
- •
run_docs_audit.sh: active le venv, exécutetree -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 dansdocs/README.md. - •Synchroniser les captures JSON/ENV si de nouvelles variables sont introduites.