SuperAPI AI Directory
Partner with us中文AI newsFavorites
Skillsdoc-scanner

doc-scanner

Writing & research

View repository

Updated 10-13 16:40

About this skill

Documentation Scanner

Scan for and synthesize project documentation.

When to Activate

  • User asks to review, understand, or explore a codebase
  • Starting work in a new/unfamiliar project
  • User asks about project conventions or workflows
  • Before making significant architectural decisions

Instructions

Step 1: Scan for Documentation

Use Glob to search project root:

AGENTS.md, CLAUDE.md, AI.md, ASSISTANT.md,
GEMINI.md, COPILOT.md, CHATGPT.md, CODEIUM.md,
CURSOR.md, WINDSURF.md, VSCODE.md, JETBRAINS.md,
WARP.md, FIG.md, DEVCONTAINER.md, GITPOD.md

Step 2: Read All Found Files

Read complete contents of every documentation file found.

Step 3: Synthesize

Combine information into unified summary:

PROJECT DOCUMENTATION

Sources: [list files found]

RECOMMENDED AGENTS
  Primary: [agents for core work]
  Secondary: [agents for specific tasks]

KEY WORKFLOWS
  [consolidated workflows]

CONVENTIONS
  [code style, patterns]

QUICK COMMANDS
  [common commands]

Step 4: Offer Consolidation

If 2+ documentation files exist, offer to consolidate:

  1. Create .doc-archive/ directory
  2. Archive originals with date suffix
  3. Generate unified AGENTS.md
  4. Report what was consolidated

Step 5: No Documentation Found

If none found, offer to draft an AGENTS.md with the repo-doctor skill's scaffold. It builds the draft from a sourced deep scan (declared scripts only, landmine questions from git history) instead of guessing:

# run from the repo-doctor skill's directory
python scripts/agents-md.py scaffold --repo path/to/project > AGENTS.draft.md

Priority Order

  1. AGENTS.md (platform-agnostic)
  2. CLAUDE.md (Claude-specific)
  3. Other AI docs
  4. IDE docs
  5. Terminal docs

Additional Resources

For detailed patterns, load:

  • ./references/file-patterns.md - Complete list of files to scan
  • ./references/templates.md - the consolidation template (merging several platform docs)

The AGENTS.md standard itself (contents, the 150/200-line budget, CLAUDE.md shadowing) is the repo-doctor skill's references/agents-md-protocol.md. When consolidating, keep the result to that standard, and if a CLAUDE.md must remain, make its first line @AGENTS.md: Claude Code reads only the CLAUDE.md files when one exists. To AUDIT or UPGRADE an existing AGENTS.md, hand off to repo-doctor's agents-md.py audit --diff.