用途:系统化更新项目核心文档,使 README、CODE_DOCUMENTATION、DESIGN_PHILOSOPHY 反映代码库当前状态。
输入:变更摘要(或让 Agent 扫描代码库);需更新的文档类型。
工具策略:用 view_file 读取现有文档,用 replace_file_content 更新章节。
工作流:先分析近期变更,了解新增、修改或移除的功能;再分别更新三份文档。README 聚焦“如何做”,确保安装与使用说明最新,补充新功能到功能列表,核对前置条件与配置步骤。CODE_DOCUMENTATION 聚焦“代码功能——简洁清晰”,描述新功能的技术实现,流程变化时更新架构图或描述,避免过度解释样板代码。DESIGN_PHILOSOPHY 聚焦“为什么与目标——理念”,解释重大变更背后的理由,必要时重新对齐项目目标,保持语气体现核心价值。最后检查三份文档的一致性。
模板:README 按标题与一句话简介、快速开始(5 分钟内运行)、功能、配置(环境变量与默认值)、API 参考链接、贡献与许可证排序。代码注释遵循 JSDoc/TSDoc,注释“为什么”而非显而易见的内容,记录 API 契约与复杂算法。变更日志采用 Keep a Changelog 格式,含 Unreleased 下的 Added、Changed、Fixed。
限制:资料未提供具体安装命令、平台支持、收费或效果信息。