name: docs description: > 智能文档助手。根据用户输入自动判断意图:开发前准备、找Bug、归档变更、全量扫描、增量更新。 user-invocable: true allowed-tools: - Read - Write - Edit - Bash - Glob - Grep
/docs — 智能文档助手
当用户输入 /docs <描述> 时,执行以下流程:
步骤 1:意图识别
分析用户输入,判断意图:
| 意图 | 触发词/模式 | 执行流程 |
|---|---|---|
| 开发前准备 | "开发"、"添加"、"实现"、"修改"、"新增"、"功能"、"需求" | 执行步骤 2A |
| 找 Bug | "找bug"、"检查"、"修复"、"问题"、"调试"、"错误"、"异常" | 执行步骤 2B |
| 归档变更 | "完成"、"归档"、"提交"、"结束"、"搞定"、"做完" | 执行步骤 2C |
| 全量扫描 | "扫描"、"初始化"、"生成文档"、"第一次" | 执行步骤 2D |
| 增量更新 | "更新"、"同步"、"增量" | 执行步骤 2E |
步骤 2A:开发前准备
触发词:开发XX功能、添加XX、实现XX、修改XX、新增XX
执行流程:
检查文档是否存在
- 检查
.ai-context/目录是否存在 - 如果不存在,提示用户先运行
/docs-scan或/docs 扫描
- 检查
解析任务描述
- 识别涉及的模块
- 识别涉及的功能
- 识别可能涉及的文件
读取相关文档
- 读取架构文档:
.ai-context/architecture.md - 读取编码规范:
.ai-context/guidelines/coding-style.md - 读取模块文档:
.ai-context/modules/[模块名].md - 读取 API 文档:
.ai-context/api/[API名].md
- 读取架构文档:
输出开发方案
- 列出已读取的文档
- 输出完整的开发方案(任务理解、涉及模块、修改文件清单、实现步骤、影响范围、风险点)
- 提示用户可以开始开发
步骤 2B:找 Bug
触发词:找bug、检查问题、修复XX、调试、异常
执行流程:
分析代码
- 读取相关模块代码
- 分析可能的问题点
检查常见问题
- 空指针/未定义检查
- 边界条件处理
- 异常处理完整性
- 资源释放(连接、流等)
- 并发安全
- SQL注入/XSS等安全问题
输出分析报告
🔍 Bug 分析报告 --- ## 分析范围 - 模块:{分析的模块} - 文件:{分析的文件列表} --- ## 发现的问题 | # | 文件 | 行号 | 问题 | 严重程度 | 建议修复 | |---|------|------|------|----------|----------| | 1 | {文件} | {行号} | {问题描述} | 高/中/低 | {修复建议} | --- ## 潜在风险 - ⚠️ {风险1}:{说明} --- ## 修复建议 1. **{问题1}** - 文件:{文件路径} - 修改:{修改建议}
步骤 2C:归档变更
触发词:完成、归档、提交、结束、搞定、做完
执行流程:
检测变更
- 使用
git diff扫描修改的文件 - 识别涉及的模块
- 使用
生成变更记录
- 创建
.ai-context/changelog/YYYY-MM-DD-HHMMSS-auto-archive.md - 包含变更描述、修改文件列表、影响分析
- 创建
更新相关文档
- 更新模块文档:
.ai-context/modules/[模块名].md - 更新 API 文档:
.ai-context/api/[API名].md
- 更新模块文档:
输出归档摘要
- 列出已更新的文档
- 总结变更内容
- 提示归档完成
步骤 2D:全量扫描
触发词:扫描、初始化、生成文档、第一次
执行流程:
执行 /docs-scan 的完整流程:
- 扫描项目结构
- 识别项目类型
- 读取关键文件
- 分析代码模块
- 分析数据库模块
- 分析中间件使用
- 分析 API 路由
- 生成完整文档
步骤 2E:增量更新
触发词:更新、同步、增量
执行流程:
执行 /docs-update 的完整流程:
- 检测变更(git diff)
- 分析变更影响
- 增量更新文档
- 创建变更记录
- 输出增量更新摘要
步骤 3:输出结果
根据执行的流程,输出对应的结果摘要。
示例
示例 1:开发功能
用户:/docs 开发用户登录功能
AI 执行:
1. 识别意图 → 开发前准备
2. 检查 .ai-context/ 目录
3. 读取相关文档
4. 输出开发方案
示例 2:找 Bug
用户:/docs 检查登录模块的问题
AI 执行:
1. 识别意图 → 找 Bug
2. 分析登录模块代码
3. 输出 Bug 分析报告
示例 3:归档变更
用户:/docs 开发完成了
AI 执行:
1. 识别意图 → 归档变更
2. 检测代码变更
3. 生成变更记录
4. 更新相关文档
5. 输出归档摘要
示例 4:全量扫描
用户:/docs 扫描代码库
AI 执行:
1. 识别意图 → 全量扫描
2. 执行完整扫描流程
3. 生成所有文档
示例 5:增量更新
用户:/docs 更新文档
AI 执行:
1. 识别意图 → 增量更新
2. 检测变更
3. 更新受影响的文档