用途:在实现新功能或重构代码后,自动更新项目文档,使文档与本地代码改动保持一致。支持用户通过参数指定关注领域或文档类型;未提供参数时,聚焦未提交改动的全部文档需求,若改动已全部提交则覆盖最近一次提交。
主要能力:先发现文档基础设施(读取根 README.md 与项目配置,识别 docs/、README、JSDoc 结构及 OpenAPI、JSDoc、TypeDoc 等生成工具),再并行分析文档结构与本地改动,按文档区域分组任务,随后由 tech-writer 智能体撰写或更新文档,并进行质量复核与迭代。
使用方式:按改动复杂度选择流程。若 3 个以上文件影响文档或存在重大 API 变更,使用多智能体工作流;若仅 1-2 处简单改动,则自行编写文档。分析阶段可用 git status -u 查看改动,无未提交改动时用 git show --name-status 查看最近提交。文档撰写需遵循项目既有风格,包含可运行示例,避免重复与冗余。
适用场景:面向用户可见的 API 变更、新功能、配置项、模块结构变化,以及需要同步更新的索引类文档(根 README、模块 README、docs/ 索引、导航文件)。
限制:并非所有代码改动都需要文档;文档须证明其存在价值,避免膨胀与维护负担。资料未提供具体安装命令、收费方式、支持平台或效果数据。