用途:在涉及 docs、documentation、README、设计文档、计划文档、规范文档或同步、更新说明时触发,帮助查阅、生成、更新、对齐与审校项目文档。
主要能力与流程:一是确认文档类型与读者,判断是规范、设计说明、使用说明、变更记录还是技能文档,并明确文档需要回答的问题;二是收集权威来源,从代码、配置、现有文档和提交意图中提取事实,事实不足时标记未知点而非脑补;三是先组织结构,再补细节、命令、示例与链接,交叉引用要保证路径和标题真实可用;四是做同步检查,核对文档与当前代码和工作流是否一致,无法完整更新时明确写出缺口。
关注点:标题是否准确反映读者任务;示例命令是否真实可执行;链接、路径、技能名与脚本名是否存在;文档是否说明限制、前提和后续动作。仓库存在 docs/ 时,优先检查 standards/、design/、plan/ 等子目录,而非假设文档都在根目录;需要图表时优先使用 Mermaid;代码或技能流程发生重大变化时,优先更新 README、设计文档与技能文档中的命令和路径。
适用场景:README 编写与维护、设计说明与规范文档、变更说明与更新日志、技能文档、计划文档以及文档与代码的对齐审校。
限制与反模式:不要假设 docs/ 一定存在;不要复制代码结构却不解释设计原因;不要用口号替代操作步骤和限制条件。交付前需确认结论有代码、配置或既有文档依据,路径链接与命令均已核对,读者与使用场景明确,未知信息未被伪装成既定事实。