update-architecture-doc
约 255 字小于 1 分钟
2026-08-03
技能:实时架构文档维护
前提
项目根目录下存在 ARCHITECTURE.md 文件,它是程序的框架数据图。
工作流程
- 完成任务:首先,按照用户要求完成代码编写或修改。
- 读取当前架构:读取
ARCHITECTURE.md文件。 - 分析变更影响:判断你的修改是创建了新模块、修改了现有模块的职责,还是改变了模块间的依赖关系。
- 更新架构文档:直接使用文件编辑工具修改
ARCHITECTURE.md,使其反映最新的程序状态。更新内容包括:- 模块图:如果新增了模块,在文档中添加一个文本块图。
- 接口说明:简要说明新增或修改的公共函数签名及用途。
- 数据流路径:如果数据流有重大变化,更新关键路径的描述。
- 变更摘要:在回复中,用几句话总结你对
ARCHITECTURE.md做了哪些更新。
