doc-tidy
Analyzes repository documentation and suggests improvements for better organization and maintenance.
Install
mkdir -p .claude/skills/doc-tidy && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/11705" && unzip -o skill.zip -d .claude/skills/doc-tidy && rm skill.zipInstalls to .claude/skills/doc-tidy
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Scan the repo for scattered documentation files, analyze organization issues, and output cleanup recommendations. Analysis only — no changes made.Key capabilities
- →Scan for all Markdown files in the repository
- →Categorize documents by purpose (design, in-code, temporary, etc.)
- →Identify organization issues like root pollution and unorganized accumulation
- →Detect duplicate or orphaned documentation files
- →Output a cleanup plan with specific actions and target structure
How it works
The skill dispatches subagents to scan for documentation files, then categorizes them and identifies organizational issues. It then outputs a structured cleanup plan.
Inputs & outputs
When to use doc-tidy
- →Audit repository documentation
- →Organize readme and reference files
- →Clean up temporary doc files
- →Find missing architecture docs
About this skill
Respond in the user's preferred language (detect from their recent messages, or fall back to the language setting in CLAUDE.md).
Scan the repo for scattered documentation files, analyze organization issues, and output cleanup recommendations. Analysis only — no changes made.
Execution Steps
1. Full Scan
Dispatch 3 parallel Explore subagents (model: haiku) to collect a documentation inventory:
Subagent A — Root + Docs/
- All .md files in root directory (except CLAUDE.md, AGENTS.md)
- All files and directory structure under Docs/ (recursive)
- For each file: path, first line content, line count
Subagent B — In-code documentation under Assets/
- All .md files under Assets/ (recursive)
- Including README, ARCHITECTURE, API_REFERENCE, CHANGELOG, AGENTS.md, etc.
- For each file: path, first line content, line count
Subagent C — Config & tool documentation
- .claude/ directory structure
- Documentation under scripts/
- Templates under .github/
- Root config files (.mcp.json, opencode.json, etc.)
2. Classify
Categorize all documents by:
| Category | Description |
|---|---|
| Long-term design | System architecture, module design, data config (should be centrally managed) |
| In-code docs | README, API reference, dev guides (should live with the code) |
| Branch artifacts | Review outputs, spec files, timelines (should be archived after merge) |
| Temporary files | tmp-*, one-off bug reports, old prompts (should be cleaned or archived) |
| Project entry points | CLAUDE.md, AGENTS.md, PR templates (should stay in root) |
| Tool config | Skills, hooks, script docs (each has its place, don't move) |
3. Find Issues
Check and report:
- Root pollution: files in root that shouldn't be there
- Unorganized accumulation: directories with >10 files and no subdirectory structure
- Temporal mixing: long-term docs and temporary artifacts in the same directory
- Duplicate docs: files with highly similar names or content across directories
- Orphaned docs: documents referencing deleted modules or outdated code
- Missing docs: Service modules with code but no documentation at all
4. Output Cleanup Plan
Format:
## Current State Summary
- X documentation files across Y locations
- Main issues: 1, 2, 3 (one sentence each)
## Issue List
For each issue: location, description, number of files affected
## Recommended Plan
### Target Directory Structure
(tree diagram)
### Specific Actions
Priority ordered:
1. Delete (temporary files, confirmed unused)
2. Move (archive, categorize)
3. Merge (eliminate duplicates)
4. Fill gaps (important modules missing docs — flag but don't rush)
### Leave Alone
Explicitly list locations that are well-organized and need no changes
Important Notes
- Analysis only — do not execute — output the plan and wait for user confirmation
- Do not touch design docs synced from external sources (e.g., Notion exports) — their structure is managed externally
- Do not touch skill files — they are not ordinary documentation
- Do not touch in-code READMEs — unless duplicates are found, keep them in place
- For docs where staleness is uncertain, mark as "needs confirmation" rather than suggesting deletion
When not to use it
- →When changes to documentation files are to be executed directly
- →When dealing with design docs synced from external sources
- →When skill files or in-code READMEs are to be modified without specific issues
Limitations
- →The skill only performs analysis and outputs recommendations; no changes are made
- →Does not touch design docs synced from external sources
- →Does not touch skill files or in-code READMEs unless duplicates are found
How it compares
This skill provides an automated analysis and structured cleanup plan for documentation organization, unlike manually reviewing and organizing files.
Compared to similar skills
doc-tidy side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| doc-tidy (this skill) | 0 | 4mo | No flags | Beginner |
| documentation-review | 11 | 4mo | No flags | Beginner |
| docs-review | 10 | 7mo | No flags | Beginner |
| workthrough | 10 | 8mo | Review | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
More by tykisgod
View all by tykisgod →You might also like
documentation-review
stacklok
Reviews documentation for factual accuracy
docs-review
metabase
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
workthrough
bear2u
Automatically document all development work and code modifications in a structured workthrough format. Use this skill after completing any development task, bug fix, feature implementation, or code refactoring to create comprehensive documentation.
claude-md-improver
anthropics
Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".
anti-slop
rand
Comprehensive toolkit for detecting and eliminating "AI slop" - generic, low-quality AI-generated patterns in natural language, code, and design. Use when reviewing or improving content quality, preventing generic AI patterns, cleaning up existing content, or enforcing quality standards in writing, code, or design work.
agent-md-refactor
davila7
Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.