返回 Skill 列表
extension
分类: 开发与工程无需 API Key

docs-keeper

文档组织、维护和清理。使用场景:整理文档、清理项目根目录、更新文档、检查冗余性、维护文档结构。不适用于:技术实现(请使用相关技术技能)。示例:<example>上下文:用户将文档添加到了错误的位置。用户:'我把一个新的API文档文件添加到了根目录。'助手:'我将使用docs-keeper将其移动到正确的docs/位置。'<commentary>文件组织是docs-keeper的责任。</commentary></example><example>上下文:用户需要在代码更改后更新文档。用户:'我修改了认证系统,需要更新文档。'助手:'我将使用docs-keeper来更新认证相关的文档。'<commentary>文档更新是docs-keeper的责任。</commentary></example>

person作者: jakexiaohubgithub

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 |