| name | update-glossary |
| description | 在代码变更、重构或新增功能后更新项目术语表(docs/glossary.md)。重大代码变更后调用以保持术语表与代码同步。 |
更新术语表
在代码发生变更后,更新 docs/glossary.md 术语表文件,确保其中的概念信息与最新代码保持一致。
何时调用
- 完成重大重构后:类名、包结构、核心逻辑发生变动时
- 新增核心功能/模块后:引入了新的领域概念时
- 用户主动要求更新术语表时
- 发现术语表中的概念与代码不一致时
操作步骤
1. 分析代码变更范围
- 确定本次发生了哪些代码变更(新增、修改、删除的文件)
- 判断变更是否涉及现有术语表中的关键类
- 判断是否引入了新的核心领域概念
2. 读取现有术语表
读取 docs/glossary.md,了解当前的术语表内容。
3. 对比差异并更新
针对每种变更类型,执行对应操作:
| 变更类型 | 操作 |
|---|
| 关键类重命名 | 更新术语表中对应的类名和描述 |
| 关键类删除 | 从术语表中移除该概念(如果该概念没有其他关键类支撑) |
| 包结构变更 | 更新所有受影响的关键类完整限定名 |
| 新增核心概念 | 按照 generate-glossary 的格式规范,新增条目 |
| 概念职责变化 | 更新对应的职责描述和说明 |
4. 更新术语表文件
按照 docs/glossary.md 的格式,将变更写入文件:
- 更新受影响的现有条目
- 新增条目放在对应模块区域
- 移除不再适用的条目
- 更新文件头部的生成时间
5. 验证
- 确认术语表格式正确、无语法错误
- 确认新增的关键类名在项目中真实存在
- 确认移除的类名确实已从项目中删除