Documentation Readiness Scan

VerifiedSafe

Fast pre-filter that evaluates project documentation readiness via filesystem analysis. Its output determines which bookend agents to spawn.

Sby Skills Guide Bot
DocumentationIntermediate
7/28/2026
Claude CodeCodexCursor
#readiness-scan#filesystem-analysis#project-assessment#agent-orchestration#documentation-audit

Recommended for

Automated summary

This skill runs a fast filesystem scan to assess a project's documentation readiness and recommend which bookend agents to spawn.

Strengths

  • Pure filesystem analysis with no LLM calls, making it very fast (1-3 seconds)
  • Computes a weighted readiness score configurable via sprint_bookends.yaml
  • Explicit agent-spawning logic based on score and source file counts
  • Structured JSON output consumable directly by an orchestrator

Limitations

  • Does not read document contents, so actual documentation quality is not evaluated
  • Relies on precise naming conventions (README.md, CATALOG.md, ARCHITECTURE.md)
  • Default weights and thresholds may not suit every project type
When to use it

Use it at the start of a sprint or pipeline to quickly decide which documentation analysis agents to deploy on a project.

When not to use it

Avoid it when you need a qualitative assessment of documentation content or semantic code analysis.

Security analysis

Safe
Quality score82/100

The 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.

No concerns found

How this analysis is made

Examples

Scan a Go project
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.
Check readiness before docs sprint
Scan the repository at ./myapp to score its documentation readiness against README, CATALOG and ARCHITECTURE, and report missing artifacts.
Decide agents for a large codebase
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

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

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. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

After inspection, copy the complete folder into your project using one of the commands below, then open a new tool session. The command stops if a folder with the same name already exists: compare the files before replacing it.

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 must already be installed. The local install/read procedure is checked with OpenSkills 1.5.0, which requires Node.js ≥ 20.6.0. Catalog slugs are not resolved automatically.

Official OpenSkills installation
openskills install './.skill-downloads/documentation-readiness-scan-ms47vpvu'

openskills read 'documentation-readiness-scan-ms47vpvu'

Reading should display the installed file content and its base directory. It does not run the skill or install its dependencies.

For an agent that reads AGENTS.md, then sync the index. This command changes AGENTS.md: review the diff before using it.

openskills sync

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/documentation-readiness-scan-ms47vpvu/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills