doc-refresh 是 robertguss/claude-code-toolkit 中的技能,用途是在用户提出“文档过期了”“刷新 README”“清理 AGENTS.md”“审计文档”或“建立带架构图的 docs/ 目录”等需求时,系统性地重整仓库文档。它特别适用于已上生产、积累了大量过期 README、失效分析文档、过时 AI 智能体知识库和误导性注释的仓库。
主要能力包括:提供 Phase 0 至 Phase 6 的分阶段流程清单(见技能目录内 CHECKLIST.md),列出审计与重写文档时应避免的常见错误(见 ANTI-PATTERNS.md),并在仓库根目录生成或更新 DOCUMENTATION_ROADMAP.md 记录计划、审计发现和经验,供后续会话交接。
使用方式:先阅读 CHECKLIST.md 与 ANTI-PATTERNS.md,再结合目标仓库调整清单,与用户确认适用哪些阶段(小仓库可省略阶段,大仓库可每阶段单独会话以保护上下文窗口),并识别仓库实际使用的文档工具(默认假设 Markdown + Mermaid,也可适配 Sphinx、Docusaurus 或纯 wiki)。跨会话工作需在阶段边界写 HANDOFF.md,说明已完成、已验证和下一步。阶段完成前应运行仓库实际的 lint/test 命令(可从 AGENTS.md、README.md、justfile、package.json、Makefile 或 CI 配置中发现),确认仅文档改动没有破坏任何东西。
核心原则包括:仓库文档是事实来源,外部 wiki 只镜像仓库;图表以代码形式(优先 Mermaid)保持可版本控制与可 diff;按受众和用途拆分聚焦指南而非单一巨型文档;直接删除过期文档,Git 历史即归档;同步更新代码级 docstring 与注释;分阶段并显式交接。该技能与语言、框架、文档工具无关,不假定特定技术栈。具体命令、安装方式、收费与平台信息暂未提供。