用途:在代码发生变更后更新既有项目文档,而非从零生成文档。适用于实现功能或修复行为变更后、重构影响模块结构或符号后、用户指出文档过时或要求更新文档时,以及计划阶段完成且代码已改动后。创建全新文档应使用 generate-docs,更新根级 AGENTS.md 应使用 generate-agents-md 或手动编辑。主要能力:识别受近期变更影响的文档;更新模块文档(符号、结构、数据流);更新功能文档(新行为、变更流程);更新项目概览(新模块、架构变更);保证交叉引用有效。用法:主代理启动 doc-explorer,由 doc-explorer 将代码变更映射到文档并更新 docs/ 下的文件;主代理仅输出精简聊天信息(改了哪些文档、存在哪些缺口)。可用 git diff、git log --oneline -N、git diff <commit>..HEAD --stat 确定变更范围,或由用户指定。工作流为:识别变更、映射到文档、阅读现有文档、应用更新、校验交叉引用、汇报变更。跨多模块的大变更集可自我委托,按模块分派 doc-explorer 实例。规则:修改前必须先读;保留人工补充内容;只做增量更新;跟踪更新版本;不使用内置 explore 子代理;以文件为界面,更新写入 docs/ 目录而非以聊天消息返回;发现新代码缺少文档时应提示用户。限制:不用于从零创建文档;不用于更新根级 AGENTS.md;具体命令、模板名称与目录结构以资料所述为准,其余实现细节暂未提供。
update-docs
写作与研究
更新于 10-15 21:42