AgentSkillsCN

docs-cleaner

在保留所有有价值内容的前提下，对冗余文档进行整合归一。当用户希望清理文档臃肿问题、合并重复文档、缩减文档散乱现象，或整合多份涵盖同一主题的文件时，应使用此技能。触发短语包括：“清理文档”、“整合文档”、“文档文件过多”、“合并这些文档”，或当多份文件涵盖相似主题且总行数超过 500 行时使用。

SKILL.md
--- frontmatter
name: docs-cleaner
description: Consolidates redundant documentation while preserving all valuable content. This skill should be used when users want to clean up documentation bloat, merge redundant docs, reduce documentation sprawl, or consolidate multiple files covering the same topic. Triggers include "clean up docs", "consolidate documentation", "too many doc files", "merge these docs", or when documentation exceeds 500 lines across multiple files covering similar topics.

Documentation Cleaner

Consolidate redundant documentation while preserving 100% of valuable content.

Core Principle

Critical evaluation before deletion. Never blindly delete. Analyze each section's unique value before proposing removal. The goal is reduction without information loss.

Workflow

Phase 1: Discovery

  1. •Identify all documentation files covering the topic
  2. •Count total lines across files
  3. •Map content overlap between documents

Phase 2: Value Analysis

For each document, create a section-by-section analysis table:

SectionLinesValueReason
API Reference25KeepUnique endpoint documentation
Setup Steps40CondenseVerbose but essential
Test Results30DeleteOne-time record, not reference

Value categories:

  • •Keep: Unique, essential, frequently referenced
  • •Condense: Valuable but verbose
  • •Delete: Duplicate, one-time, self-evident, outdated

See references/value_analysis_template.md for detailed criteria.

Phase 3: Consolidation Plan

Propose target structure:

code
Before: 726 lines (3 files, high redundancy)
After:  ~100 lines (1 file + reference in CLAUDE.md)
Reduction: 86%
Value preserved: 100%

Phase 4: Execution

  1. •Create consolidated document with all valuable content
  2. •Delete redundant source files
  3. •Update references (CLAUDE.md, README, imports)
  4. •Verify no broken links

Value Preservation Checklist

Before finalizing, confirm preservation of:

  • • Essential procedures (setup, configuration)
  • • Key constraints and gotchas
  • • Troubleshooting guides
  • • Technical debt / roadmap items
  • • External links and references
  • • Debug tips and code snippets

Anti-Patterns

PatternProblemSolution
Blind deletionLoses valuable informationSection-by-section analysis first
Keeping everythingNo reduction achievedApply value criteria strictly
Multiple sources of truthFuture divergenceSingle authoritative location
Orphaned referencesBroken linksUpdate all references after consolidation

Output Artifacts

A successful cleanup produces:

  1. •Consolidated document - Single source of truth
  2. •Value analysis - Section-by-section justification
  3. •Before/after metrics - Lines reduced, value preserved
  4. •Updated references - CLAUDE.md or README with pointer to new location