| name | generate-glossary |
| description | 扫描代码库识别关键领域概念,生成包含中英对照名称、描述和关键类名的术语表。当需要首次记录项目核心概念或发生重大架构变更后调用。 |
生成术语表
扫描项目代码库,提取关键领域概念,首次生成术语表文件(docs/glossary.md),帮助 Agent 快速理解项目核心设计,减少重复的代码库深度检索。
何时调用
- 首次分析项目时:了解项目整体的领域概念和架构
- 用户主动要求生成术语表时
操作步骤
1. 扫描代码库结构
- 从项目的
src/main/java(或对应语言的源目录)开始,遍历主要包(package)结构
- 识别核心模块/子系统的顶层包名,理解模块划分
2. 识别关键概念
在每个核心模块中,寻找以下内容:
| 关注点 | 说明 |
|---|
| 核心类/接口 | 模块中最常被引用的类、抽象类、接口 |
| 枚举/常量 | 定义领域常量和枚举类型 |
| 工厂/构建器 | 用于创建复杂对象的类 |
| 事件/回调 | 领域事件、监听器、回调接口 |
| 数据模型 | Entity、DTO、POJO 等数据载体 |
3. 生成术语表文件
将结果写入 docs/glossary.md,格式如下:
# 项目术语表
> 生成时间:{时间}
> 项目:{项目名}
## 概念列表
### {概念英文名}({概念中文名})
- **职责**:{该概念的核心职责}
- **描述**:{对概念的简要说明}
- **关键类**:
- `{包名.类名}` — {该类的主要作用}
- `{包名.类名}` — {该类的主要作用}
---
### 下一个概念...
4. 提炼原则
- 保持精简:每个模块只提炼 2~5 个最核心的概念
- 关注接口:优先收录接口/抽象类定义的抽象概念,而非具体实现
- 中英对照:每个概念名必须包含中文和英文,英文名使用项目源码中的实际命名
- 职责清晰:用一句话说清"这个概念是做什么的"
- 关键类准确:类名使用完整限定名(含包名)
5. 验证
确认 docs/glossary.md 已正确生成且内容格式规范。