SKILL
本地来源:Knowledge/World/项目/Practice/Claude-Skills/bug-report-generator/SKILL.md
name: bug-report-generator description: 生成标准化的 Bug 问题报告文档。当遇到问题需要记录、总结、或用户要求写问题日志时自动触发。文档会同步到全局知识库和当前项目。 license: MIT metadata: author: charliesimmon version: "1.0.0"
Bug 报告生成器技能
当遇到 Bug、问题、或需要记录解决方案时,自动生成标准化的问题报告文档。
触发条件
- 用户说"写个问题日志"、"总结问题"、"记录这个 bug"
- 解决了一个复杂问题后
- 用户要求生成报告
文档结构
每个报告必须包含以下章节:
1. TL;DR 速查表(开头)
- 问题速览表格:# | 问题 | 原因 | 解决方案
- 关键函数速查代码块
- 决策流程图(ASCII)
- 修改文件清单
2. 项目信息
- 项目名称
- 涉及模块
- 相关服务商/API
- 报告日期
3. 每个问题的详细分析
- 具体问题:一句话描述
- 现象:用户看到的表现(1-4 条)
- 本质:技术层面的根本原因
- 罪魁祸首:导致问题的具体代码/设计缺陷
- 解决办法:详细代码示例和说明
4. 查漏补缺
- 已确认不受影响的场景表格
- 潜在改进点
5. 修改文件清单
- 文件路径 | 修改内容
6. 测试建议
- 具体测试用例
7. SOP 检查清单(末尾)
- 部署前检查(编译、类型、环境变量)
- 功能验证清单(分类列出)
- 监控与告警关键词
- 回滚方案
- 变更记录表
文件命名规范
{YYYY-MM-DD}-{问题简述}.md
示例:2026-01-16-image-load-failed-retry-mechanism.md
存储位置
文档需要同步到两个位置:
-
全局知识库(主存储):
/Users/项目/上站上站/千百万刀/Knowledge/World/项目/Practice/BUG- SOLUTIONS/ -
当前项目(备份):
{project_root}/doc/BUG_SOLUTIONS/
同步命令
文档写完后自动执行:
# 1. 复制到全局知识库
cp "{project}/doc/BUG_SOLUTIONS/{filename}.md" "/Users/项目/上站上站/千百万刀/Knowledge/World/项目/Practice/BUG- SOLUTIONS/"
# 2. 提交当前项目
cd {project}
git add doc/BUG_SOLUTIONS/
git commit -m "docs: add bug report {date}"
git push
# 3. 提交知识库(如果是 git 仓库)
cd "/Users/项目/上站上站/千百万刀/Knowledge"
git add .
git commit -m "docs: sync bug report from {project}"
git push
模板文件
完整模板见:TEMPLATE.md
使用示例
用户:总结一下我们刚才遇到的问题,写个日志
Claude 执行:
1. 分析对话历史,提取所有问题
2. 按模板生成文档
3. 写入当前项目 doc/BUG_SOLUTIONS/
4. 同步到全局知识库
5. 提交并推送
本文档为站内渲染。原始文件本地路径:saas/source/knowledge-world/Knowledge-World-项目-Practice-Claude-Skills-bug-report-generat-9ea630.md(仅本地保留,不入库不部署)