doc-scanner_skill

Overview

This skill scans a codebase for project documentation files (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and many other formats) and synthesizes them into concise guidance. It auto-activates when you ask to review or explore a repository, start work in a new project, or request information about agents or conventions. The goal is a single, practical summary you can use immediately.

How this skill works

The scanner glob-searches the project root for a prioritized list of documentation files and reads the full contents of each file it finds. It synthesizes a unified summary that highlights recommended agents, key workflows, conventions, and quick commands. When multiple platform docs exist, it can offer to consolidate originals into a .doc-archive and generate a harmonized AGENTS.md. If no docs are present, it can generate an AGENTS.md draft based on the project structure and observed tech stack.

When to use it

• When reviewing or onboarding into a new or unfamiliar repository
• Before starting development work or making architectural decisions
• When you need to understand project agent workflows or conventions
• When you want a single consolidated reference from multiple platform docs
• When preparing documentation or onboarding materials for teammates

Best practices

• Run the scanner from the project root to ensure complete coverage
• Review the synthesized AGENTS.md before applying automated consolidation
• Keep original docs archived with date suffixes if you consolidate into a unified file
• Customize generated recommendations to match team-specific workflows and toolchain
• Use the consolidated output as a living reference and update it when workflows change

Example use cases

• Onboarding a new engineer: produce a concise agents and workflows summary for ramp-up
• Code review kickoff: gather project conventions and quick commands before reviewing PRs
• Cross-platform consolidation: merge CLAUDE.md, GEMINI.md, and IDE-specific docs into one AGENTS.md
• New project bootstrap: generate an initial AGENTS.md when no documentation exists
• Pre-decision audit: collect conventions and existing agent configurations before an architecture change