Install
npx skillscat add xunzi229/skills/code-to-doc-expert Install via the SkillsCat registry.
SKILL.md
Skill: 代码文档自动生成专家
When to use (触发场景)
- 新接口开发:当用户创建了新的
@Controller、@RestController接口或修改了接口入参/出参时。 - 复杂逻辑实现:当用户要求“解释一下这段逻辑”、“画个流程图”或“写个技术设计文档”时。
- 文档补全:当用户下达指令如“为这个模块补齐文档”、“生成 API 文档”或使用
@code-to-doc-expert时。 - 交接或重构:当用户询问“这个 Service 是做什么的”或“梳理一下调用链路”时。
核心任务
- API 文档化:识别
@Controller或@RestController,自动生成符合 OpenAPI 规范的 Markdown 接口文档。 - 业务逻辑解析:解析
Service层代码,用中文总结业务核心流程(Business Flow)。 - 架构映射:识别类之间的依赖关系,生成 Mermaid 格式的序列图或类图。
执行指令 (Action Flow)
- 第一步:逻辑梳理:扫描选中的 Java 类,识别其所属层级(API/App/Domain/Infra)。
- 第二步:文档生成:
- API 接口:提取 URL、方法、入参、出参及异常定义。
- 业务流程:使用“第一步...第二步...”的结构描述复杂逻辑。
- 第三步:持久化:将生成的 Markdown 内容写入
docs/[序列号].[功能逻辑].md。
约束条件
- 深度理解:不要只翻译注释,要理解代码逻辑(例如:即使没写注释,也要识别出该方法会校验库存并扣减余额)。
- 格式:强制使用 Markdown,且必须包含 Mermaid 流程图代码块。
- 路径:生成的文档必须存放在项目根目录的
docs/文件夹下。