评分明细
适用场景
doc-cleanup 快速入门
清理 Agent 项目的 Markdown 文档——归档历史、修复过时事实、消除矛盾,让文档保持”活”的确证状态
⭐ 评分: 8.0/10 💰 价格: 开源免费 🏢 厂商: aka-luan 🌐 官网: GitHub
一、这是什么
doc-cleanup 是一个 Agent Skill,专门用于审计和清理面向 AI Agent 的 Markdown 文档。在使用 Agent 进行项目开发的过程中,项目文档会不断积累”历史包袱”——已完成的 TODO 列表、过时的设计决策、矛盾的事实陈述、重复的上下文信息。这些”文档垃圾”会占用 Agent 的上下文窗口,增加 Token 消耗,甚至导致 Agent 基于过时信息做出错误决策。
doc-cleanup 自动化了这个清理过程:扫描文档 → 识别过时/矛盾/重复内容 → 归档历史 → 只保留活的确证事实。
适合人群:使用 Agent 进行长期项目开发的团队,维护大型 Agent 项目文档的开发者。
二、快速上手
准备工作
- Claude Code 或兼容的 Agent 环境
- 需要清理的 Markdown 文档目錄
安装
# Claude Code
cp doc-cleanup.md ~/.claude/skills/
三步使用
Step 1: 启用 Skill
/skill doc-cleanup
Step 2: 审计文档
请审计 docs/ 目录下的所有 Agent 文档
Agent 会扫描文档,标记:
- 已完成的 TODO 和计划项
- 过时的事实陈述(如 “当前版本是 1.0” 但实际已是 2.0)
- 矛盾的内容(如两处文档对同一事实的描述不一致)
- 冗余的上下文信息
Step 3: 执行清理
请按审计结果清理文档,将历史内容归档到 archive.md
三、核心功能
- 文档审计:自动扫描 Agent 文档,识别过时/矛盾/重复内容
- 历史归档:将已完成的工作记录归档到独立文件
- 事实修复:修正过时的事实陈述和矛盾内容
- 去芜存菁:只保留活的确证信息,删除冗余上下文
- 单文件 Skill:纯 Markdown,即装即用
四、常见踩坑
- 清理前务必备份——虽然 doc-cleanup 会将历史归档,但一旦删除就无法恢复
- 不要过度清理——有些”过时”信息可能对理解项目演进有价值,建议人工审核审计结果后再执行清理
- 归档文件也需要管理——
archive.md会不断增长,定期也需要清理 - 项目较新(2026-07-09 创建),对复杂文档结构的处理可能不够完善
五、常见问题 FAQ
Q1: 和手动维护文档有什么区别?
A: 手动维护文档需要你定期检查所有文档、判断哪些内容过时、手动归档和删除。doc-cleanup 将这个过程自动化,Agent 帮你做审计和清理,你只需要审核结果。
Q2: 清理后会不会丢失重要信息?
A: doc-cleanup 的默认行为是”归档”而非”删除”——过时内容会移到 archive.md,不会丢失。如果你确认不再需要,可以手动删除归档文件。
Q3: 支持哪些文档格式?
A: 目前主要支持 Markdown 文档(.md)。这是 Agent 项目中最常见的文档格式。
Q4: 可以自定义清理规则吗?
A: 可以。Skill 文件是纯 Markdown,你可以修改审计规则来适配你的项目需求(如保留某些类型的”过时”信息)。
Q5: 建议多久运行一次清理?
A: 建议在每个开发里程碑(如版本发布、功能完成)后运行一次。对于高频 Agent 使用的项目,每周运行一次可以保持文档健康。
参考链接
最后更新:2026-07-11 · 作者:MagicNetWorld
📊 评分与标签
评分说明
总分 8.0/10 · P_优选
📊 可观测社区指标(数据核验日期:2026-07-13)
- GitHub: aka-luan/doc-cleanup ★35, 🔱0
- 语言: 配置类 | 创建: 2026-07-09 | 最近 push: 2026-07-09
- Open Issues: 0 | License: 无
📦 可安装性 2.5/2.5
- 单个 Markdown 文件,即装即用,零依赖
- 支持 Claude Code 及兼容 Agent 平台
- 安装就是复制一个文件到 Skill 目录,无可失败点
- 竞品对比 1(Vale 文档检查工具):doc-cleanup 单文件即装 vs Vale 需要安装二进制+配置文件;doc-cleanup 安装成本更低
- 竞品对比 2(repomix 打包工具):doc-cleanup 清理 vs repomix 打包;不同用途,安装难度相当
🎯 实用性 2.0/2.5
- 解决 Agent 项目文档的「熵增」问题——过时 TODO、矛盾事实、重复上下文
- Agent 上下文窗口有限,清理文档直接降低 Token 消耗
- 归档而非删除——历史内容移到 archive.md,不会丢失
- 局限:项目仅 4 天历史,对复杂文档结构的处理可能不够完善
- 竞品对比 1(手动文档维护):doc-cleanup 自动化 vs 手工定期检查;自动化大幅降低维护成本
- 竞品对比 2(Vale):doc-cleanup Agent 文档专用 vs Vale 通用文档检查;Vale 更通用但 doc-cleanup 对 Agent 文档更精准
📖 文档质量 1.5/2.0
- README 清晰说明了审计和清理流程
- 清理规则可自定义,灵活性好
- 缺失:无清理前后对比示例、无不同文档类型的适配指南、无与 CI/CD 集成的说明
- 竞品对比 1(Vale):doc-cleanup 文档简洁 vs Vale 有完整文档网站和规则库;Vale 文档生态更成熟
- 竞品对比 2(手动维护流程文档):doc-cleanup 自动化说明 vs 手动流程文档;doc-cleanup 更系统化
👥 社区活跃 1.0/1.5
- 35 Stars,0 Forks,社区认可度较低
- 0 Open Issues,项目状态干净但用户基数小
- 项目仅 4 天历史,且最近一次 push 是 7 月 9 日(3 天未更新)
- 来源:GitHub API
- 竞品对比 1(Vale):doc-cleanup 35 Stars vs Vale 4k+ Stars;Vale 社区远超
- 竞品对比 2(其他 Skill 项目):doc-cleanup 社区规模在 Skill 类目中属于中下水平
🔗 兼容性 1.0/1.5
- 兼容所有支持 Markdown Skill 格式的 Agent(Claude Code、Codex、Cursor)
- 纯 Markdown 格式,无平台锁定
- 局限:仅支持 Markdown 文档(.md),不支持其他格式
- 审计规则是通用型的,特定项目类型需要自行定制
- 竞品对比 1(Vale):doc-cleanup Agent 集成 vs Vale 独立 CLI/CI;Vale 集成方式更多样
- 竞品对比 2(repomix):doc-cleanup 清理 vs repomix 打包;两者互补,可组合使用
🏷️ 标签说明
- 开源免费: 无 License 声明,代码完全公开。来源:GitHub
- Skill系统: Agent Skill,用于文档维护。来源:GitHub
- AI开发平台: AI 开发辅助工具,提升 Agent 项目文档质量。来源:GitHub
- 海外: 开源项目,英文 README。来源:GitHub
📋 来源与核验记录
- ✅ GitHub API 已验证: aka-luan/doc-cleanup — 35 stars, 0 forks, pushed 2026-07-09
- ✅ 功能描述已验证: 文档审计 + 历史归档 + 事实修复 + 去芜存菁
- ⚠️ 未验证(本地运行): 实际清理效果和误删率