home / skills / 0xdarkmatter / claude-mods / doc-scanner

doc-scanner skill

safe

This skill scans project docs and synthesizes a unified AGENTS.md to help you review, understand, and explore codebases quickly.

npx playbooks add skill 0xdarkmatter/claude-mods --skill doc-scanner

Review the files below or copy the command above to add this skill to your agents.

Files (7)

SKILL.md

2.1 KB

---
name: doc-scanner
description: "Scans for project documentation files (AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, and 15+ other formats) and synthesizes guidance. Auto-activates when user asks to review, understand, or explore a codebase, when starting work in a new project, when asking about conventions or agents, or when documentation context would help. Can consolidate multiple platform docs into unified AGENTS.md."
allowed-tools: "Glob Read Write Bash"
---

# 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 generate AGENTS.md based on:
- Project structure and tech stack
- Patterns observed in codebase

## 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` - AGENTS.md generation templates

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

FAQ

What file types and names does the scanner look for?

It searches a prioritized list that includes AGENTS.md, CLAUDE.md, GEMINI.md, COPILOT.md, CURSOR.md, WARP.md, IDE and terminal docs, plus many common AI and assistant-related filenames.

Will consolidation overwrite my originals?

No. Consolidation archives originals into a .doc-archive directory with date suffixes and writes a new AGENTS.md; originals are preserved unless you explicitly remove them.

Can it generate documentation when none exists?

Yes. If no documentation is found, the tool can draft an AGENTS.md based on codebase structure, dependencies, and detected patterns to jump-start your docs.