Synthèse automatique
Ce skill effectue un scan rapide du système de fichiers pour évaluer la maturité documentaire d'un projet et recommander quels agents bookend lancer.
Points forts
- Analyse purement filesystem, sans appel LLM, ce qui le rend très rapide (1-3 secondes)
- Attribution d'un score de readiness pondéré et configurable via sprint_bookends.yaml
- Logique de déclenchement d'agents explicite, basée sur le score et le nombre de fichiers source
- Sortie JSON structurée directement consommable par un orchestrateur
Limites
- Ne lit pas le contenu des documents : la qualité réelle de la documentation n'est pas évaluée
- Dépend de conventions de nommage précises (README.md, CATALOG.md, ARCHITECTURE.md)
- Les poids et seuils par défaut peuvent ne pas convenir à tous les types de projets
À utiliser en début de sprint ou de pipeline pour décider rapidement quels agents d'analyse documentaire déployer sur un projet.
Ne pas l'utiliser lorsqu'on a besoin d'une évaluation qualitative du contenu de la documentation ou d'une analyse sémantique du code.
Analyse de sécurité
SûrThe skill is a read-only filesystem analysis: it loads a YAML config, walks the project directory, counts files by type, and emits a JSON readiness report. It performs no writes, deletions, network calls, secret handling, or obfuscated execution, and it declares no dangerous tools. The only minor consideration is that it recursively scans the project directory and reads config files, but this is benign and non-destructive.
Aucun point d'attention détecté
Comment cette analyse est faiteExemples
Run bookend-scan-readiness on /home/me/projects/myservice with platform go and bookends_dir /opt/go-autonom8, then tell me which bookend agents to spawn.Scan the repository at ./myapp to score its documentation readiness against README, CATALOG and ARCHITECTURE, and report missing artifacts.Evaluate documentation readiness for the Flutter project in ./app and list the recommended agents given its source file count and .git presence.name: bookend-scan-readiness description: Fast filesystem readiness scan — counts docs, source files, manifests, platform signals. Produces initial ReadinessReport for agent spawning decisions.
bookend-scan-readiness - Documentation Readiness Scan
Fast pre-filter that evaluates project documentation readiness via filesystem analysis. Its output determines which bookend agents to spawn.
Input Schema
{
"project_dir": "/path/to/project",
"platform": "web|go|flutter|ios|python|rust",
"bookends_dir": "/path/to/go-autonom8"
}
Instructions
1. Load Configuration
Read sprint_bookends.yaml from bookends_dir. If missing, use defaults:
- documentation.threshold: 60
- complexity.medium_at: 30
- complexity.complex_at: 55
- complexity.very_complex_at: 80
- complexity.max_agents: 5
2. Scan Project
Walk the project directory and count:
- Source files (by extension)
- Documentation files (.md, .rst, .adoc)
- Manifest files (package.json, go.mod, pubspec.yaml, etc.)
- Config files (project.yaml, autonom8.yaml)
- docs/ directory presence
Check for required artifacts from sprint_bookends.yaml:
- README.md
- CATALOG.md
- ARCHITECTURE.md
3. Score Readiness
Apply weights from sprint_bookends.yaml (or defaults):
- README: 20
- CATALOG: 20
- ARCHITECTURE: 15
- docs/ directory: 15
- Project config: 10
- Platform manifest: 10
- Doc file count bonus: 10
4. Classify Project Type
- Greenfield: no source files, no manifests
- Existing: source files > 0 or manifests > 0
- Unknown: non-source files only (e.g., .env.example)
Output Format
{
"skill": "bookend-scan-readiness",
"status": "success",
"project_type": "existing",
"readiness_score": 85,
"documentation_ok": true,
"missing_artifacts": ["ARCHITECTURE"],
"source_file_count": 148,
"doc_file_count": 44,
"recommended_action": "continue_to_complexity_scoring",
"agents_to_spawn": ["dependency-graph-agent", "contract-scanner-agent"]
}
Agent Spawning Logic
Based on readiness score and source file count, recommend which bookend agents to spawn:
| Condition | Agents | |-----------|--------| | readiness < threshold | cartography-agent (always) | | source_files > 20 | dependency-graph-agent | | source_files > 30 | contract-scanner-agent | | source_files > 0 | quality-audit-agent (if complexity >= medium) | | source_files > 50 AND .git exists | risk-assessment-agent |
Token Efficiency
- Pure filesystem scan, no LLM calls
- 1-3 second execution
- Returns structured JSON for orchestrator consumption
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 annexesCe 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.mdDepuis la racine d’un projet de test, enregistrez le fichier sous .skill-downloads/documentation-readiness-scan-ms47vpvu/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/documentation-readiness-scan-ms47vpvu' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-readiness-scan-ms47vpvu/download' --output '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md.part' && mv '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md.part' '.skill-downloads/documentation-readiness-scan-ms47vpvu/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
Après vérification, copiez le dossier complet dans le projet avec l’une des commandes ci-dessous, puis ouvrez une nouvelle session de l’outil. La commande s’arrête si un dossier du même nom existe déjà : comparez les fichiers avant de le remplacer.
Claude Code
test -f '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md' && test -s '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md' && mkdir -p '.claude/skills' && test ! -e '.claude/skills/bookend-scan-readiness' && cp -R '.skill-downloads/documentation-readiness-scan-ms47vpvu' '.claude/skills/bookend-scan-readiness'Cursor
test -f '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md' && test -s '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md' && mkdir -p '.cursor/skills' && test ! -e '.cursor/skills/bookend-scan-readiness' && cp -R '.skill-downloads/documentation-readiness-scan-ms47vpvu' '.cursor/skills/bookend-scan-readiness'Codex
test -f '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md' && test -s '.skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md' && mkdir -p '.agents/skills' && test ! -e '.agents/skills/bookend-scan-readiness' && cp -R '.skill-downloads/documentation-readiness-scan-ms47vpvu' '.agents/skills/bookend-scan-readiness'OpenSkills
OpenSkills doit déjà être installé. La procédure locale install/read est contrôlée avec OpenSkills 1.5.0, qui exige Node.js ≥ 20.6.0. Aucun slug du catalogue n’est résolu automatiquement.
Installation officielle d’OpenSkillsopenskills install './.skill-downloads/documentation-readiness-scan-ms47vpvu'openskills read 'documentation-readiness-scan-ms47vpvu'La lecture doit afficher le contenu du fichier installé et son dossier de base. Elle ne lance ni la skill ni ses dépendances.
Pour un agent qui lit AGENTS.md, synchronisez ensuite l’index. Cette commande modifie AGENTS.md : relisez le diff avant de l’utiliser.
openskills syncMode 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/documentation-readiness-scan-ms47vpvu/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.
Rédaction de docs Supabase
Documentation
Rédigez, éditez et révisez le contenu de la documentation Supabase : guides, tutoriels, références et partiels. Suivez les guides de style et les règles de validation MDX/TOML.
Créer un enregistrement de décision d'architecture
Documentation
Créer un nouveau ADR avec numérotation séquentielle, l'enregistrer dans le graphe AgentDB et le lier aux ADR associés.
Mise à jour de plan avec recherche approfondie
Documentation
Met à jour un document de plan en lançant des sous-agents en parallèle pour analyser un sujet sur tous les passes du compilateur, puis consolide les résultats.