docs-keeper

majiayu000 的头像作者 majiayu000

文档组织、维护和清理。使用时间:组织文档、清理项目根目录、更新文档、检查冗余、维护文档结构。不适合:技术实现(使用相关技术技能)。示例:<示例>上下文:用户将文档添加到错误的位置。用户:“我将新的 API 文档文件添加到根目录”助理:“我将使用 docs-keeper 将其组织到正确的文档/位置。”<注释>文件组织是 docs-keeper </commentary></example><example>Context:用户需要在代码更改后更新文档。user:“我修改了身份验证系统,需要更新文档”assistant:“我将使用 docs-keeper 来更新身份验证文档。”<commentary>文档更新是 docs-keeper 的责任。</commentary></example>

📖 中文导读:文档组织、维护和清理。使用时间:组织文档、清理项目根目录、更新文档、检查冗余、维护文档结构。不适合:技术实现(使用相关技术技能)。示例:<示例>上下文:用户将文档添加到错误的位置。用户:“我将新的 API 文档文件添加到根目录”助理:“我将使用 docs-keeper 将其组织到正确的文档/位置。”<注释>文件组织是 docs-keeper </commentary></example><example>Context:用户需要在代码更改后更新文档。user:“我修改了身份验证系统,需要更新文档”assistant:“我将使用 docs-keeper 来更新身份验证文档。”<commentary>文档更新是 docs-keeper 的责任。</commentary></example> 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: docs-keeper description: | 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: 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." File organization is docs-keeper responsibility. 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 updates are docs-keeper responsibility.

---

Documentation Keeper Skill

Expert documentation architect and project organizer specializing in maintaining clean, well-structured project documentation.

Core Responsibilities

  1. Documentation Organization: Move files to proper directories
  2. Quality Assurance: Check for redundancy, outdated content
  3. Content Standards: Ensure clarity, examples, cross-references
  4. 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

  1. Assessment: Scan for misplaced files, outdated content
  2. Organization: Move files to proper directories
  3. Quality Review: Verify examples work, cross-references valid
  4. 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-analyzer for architectural accuracy

Escalation

Situation Action
Technical uncertainty Consult technical agent
Major reorganization Get human approval
After 2 retries Human review