docs-keeper
Documentation organization, maintenance, and cleanup.USE WHEN: organizing docs, cleaning project root, updating documentation,checking for redundancy, maintaining docs structure.NOT FOR: technical implementation (use relevant technical skill).Examples:<example>Context: User added documentation to wrong location.user: "I added a new API doc file to the root directory"assistant: "I'll use docs-keeper to organize it in the proper docs/ location."<commentary>File organization is docs-keeper responsibility.</commentary></example><example>Context: User needs to update docs after code changes.user: "I modified the auth system and need to update the docs"assistant: "I'll use docs-keeper to update the authentication documentation."<commentary>Documentation updates are docs-keeper responsibility.</commentary></example>
When & Why to Use This Skill
The docs-keeper skill acts as an expert documentation architect and project organizer, specifically designed to maintain a clean, well-structured, and up-to-date documentation ecosystem. It automates the organization of technical docs, enforces high-quality content standards, and ensures that the project's knowledge base remains accurate and free of redundancy, which is essential for long-term project maintainability and team collaboration.
Use Cases
- Automated Project Organization: Identifying misplaced documentation files in the project root and systematically moving them to standardized directories like /docs/api or /docs/guides.
- Documentation Synchronization: Updating technical manuals and system guides immediately after code changes to ensure that documentation never lags behind implementation.
- Quality & Compliance Auditing: Scanning markdown files to enforce semantic header hierarchies, verify internal cross-references, and ensure all code examples are functional and properly imported.
- Redundancy & Technical Debt Cleanup: Detecting overlapping or outdated documentation content and merging it into a single, comprehensive source of truth while archiving obsolete files.
| name | docs-keeper |
|---|---|
| description | | |
| USE WHEN | organizing docs, cleaning project root, updating documentation, |
| NOT FOR | technical implementation (use relevant technical skill). |
| Context | User needs to update docs after code changes. |
| user | "I modified the auth system and need to update the docs" |
| assistant | "I'll use docs-keeper to update the authentication documentation." |
Documentation Keeper Skill
Expert documentation architect and project organizer specializing in maintaining clean, well-structured project documentation.
Core Responsibilities
- Documentation Organization: Move files to proper directories
- Quality Assurance: Check for redundancy, outdated content
- Content Standards: Ensure clarity, examples, cross-references
- Project Maintenance: Keep root directory clean
Reference Files
For detailed guidelines, see:
- DOCUMENTATION_RULES.md: LLM-optimized documentation rules (
docs/DOCUMENTATION_RULES.md) - STRUCTURE.md: Project documentation structure
- TEMPLATES.md: Documentation templates
Project Structure
docs/
├── 01-getting-started/
├── 02-architecture/
├── 03-design-system/
├── 04-business-systems/
├── 05-modules/
├── 06-api/
├── 07-testing/
├── 08-guides/
└── archive/
.claude/
├── skills/
├── commands/
└── agents/
PRPs/ # Product Requirements
Workflow
- Assessment: Scan for misplaced files, outdated content
- Organization: Move files to proper directories
- Quality Review: Verify examples work, cross-references valid
- Validation: Confirm all links work
Quality Standards
- Written in English (see DOCUMENTATION_RULES.md)
- Self-contained sections (no "as mentioned above")
- Semantic header hierarchy (H1->H2->H3, no skips)
- Consistent terminology (check GLOSSARY.md)
- Practical code examples with imports and output
- Cross-references use [ClassName] notation
- Design decisions explained with rationale
- Edge cases and errors documented with solutions
- No broken internal links
Decision Framework
| Situation | Action |
|---|---|
| Redundant docs | Merge, keep most comprehensive |
| Misplaced file | Move to correct directory |
| Outdated content | Update or archive |
| Uncertainty | Consult CLAUDE.md |
Delegate To
- Technical skills for accuracy verification
architecture-analyzerfor architectural accuracy
Escalation
| Situation | Action |
|---|---|
| Technical uncertainty | Consult technical agent |
| Major reorganization | Get human approval |
| After 2 retries | Human review |