Doc scanner
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.From its SKILL.md
npx -y skills add bg-szy/TOP-SKILLS --skill doc-scannerAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 5 stars5 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
What its file declares
Copied from the file, not written here
The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.
SKILL.md
2.5 KB, 511 tokens by cl100k_base, as published. Nobody here has run it
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:
- Create
.doc-archive/directory - Archive originals with date suffix
- Generate unified AGENTS.md
- 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
- AGENTS.md (platform-agnostic)
- CLAUDE.md (Claude-specific)
- Other AI docs
- IDE docs
- 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
When generating a NEW AGENTS.md, follow the entry-doc standard in
rules/agentic-quality.md (Landmines section mandatory, ~150-line budget) —
skeleton at the repo-doctor skill's assets/AGENTS-template.md. To AUDIT an
existing doc set rather than generate one, hand off to repo-doctor.
What ships with it: 3 files
61.7 KB alongside SKILL.md
- reference.md2.5 KB
- skill-report.json55.9 KB
- templates.md3.4 KB
Gives 0 of the 12 instructions most docs writing skills give in 511 tokens
Counted across 1,951 of the 3,904 authors here whose files we hold, read 2026-09-06
- Use third-person for skill descriptionsin 54 of 1951, across 35 files
- Start descriptions with Use whenin 43 of 1951, across 29 files
- Run baseline scenarios before writing any skillin 40 of 1951, across 26 files
- Use active voicein 40 of 1951, across 36 files
- Map file responsibilities before defining tasksin 36 of 1951, across 29 files
- Use checkbox syntax for tracking stepsin 35 of 1951, across 27 files
- Ask one question at a timein 35 of 1951
- Offer execution options after saving the planin 33 of 1951, across 24 files
- Include complete code in every stepin 33 of 1951, across 27 files
- Design units with clear boundaries and interfacesin 31 of 1951, across 23 files
- Announce the skill usage at the startin 30 of 1951
- Verify agent compliance after adding the skillin 29 of 1951, across 17 files
Said here and by no other author read
- Offer to consolidate multiple documentation files
- Offer to generate AGENTS.md if none found
- Follow entry-doc standard when generating new documentation
Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once. Length counted with cl100k_base; the agent that loads this file may tokenize it differently.