知识库首页 知识库-世界 TEMPLATE.md

TEMPLATE

本地来源:Knowledge/World/项目/Practice/Claude-Skills/bug-report-generator/TEMPLATE.md

{YYYY-MM-DD} {问题标题} 问题报告


TL;DR 速查表

问题速览

# 问题 原因 解决方案
1 {问题1简述} {原因} {解决方案}
2 {问题2简述} {原因} {解决方案}

关键函数速查

// {函数1说明}
functionName1()  // {作用描述}

// {函数2说明}
functionName2()  // {作用描述}

决策流程图

{起点}
  ↓
{判断1}? ─否→ {分支1结果}
  ↓是
{判断2}? ─否→ {分支2结果}
  ↓是
{最终动作}

修改文件清单

文件 改动
{文件路径1} {改动描述}
{文件路径2} {改动描述}

项目信息

  • 项目名称: {项目名}
  • 涉及模块: {模块名}
  • 相关服务: {API/服务商}
  • 报告日期: {YYYY-MM-DD}

问题一:{问题标题}

具体问题

{一句话描述问题}

现象

  1. {现象1}
  2. {现象2}
  3. {现象3}

本质

{技术层面的根本原因分析}

罪魁祸首

  1. {原因1} - {详细说明}
  2. {原因2} - {详细说明}

解决办法

{解决方案说明}

// 关键代码示例
{代码}

关键代码修改

文件: {文件路径}

  • {修改点1}
  • {修改点2}

问题二:{问题标题}

{重复上述结构}


查漏补缺

已确认不受影响的场景

场景 是否受影响 原因
{场景1} ❌ 不受影响 {原因}
{场景2} ✅ 正常工作 {原因}

潜在改进点

  1. {改进1} - {说明}
  2. {改进2} - {说明}

修改文件清单

文件路径 修改内容
{path1} {内容}
{path2} {内容}

测试建议

  1. {测试1} - {预期结果}
  2. {测试2} - {预期结果}

总结

{总结本次修改的核心价值和影响}


SOP 检查清单

部署前检查

  • [ ] 代码编译通过 - npm run build 无错误
  • [ ] TypeScript 类型检查 - 无 type error
  • [ ] 环境变量配置 - 确认相关环境变量已配置

功能验证清单

1. 正常流程测试

  • [ ] {测试项1}
  • [ ] {测试项2}

2. 异常流程测试

  • [ ] {测试项1}
  • [ ] {测试项2}

3. 边界条件测试

  • [ ] {测试项1}
  • [ ] {测试项2}

监控与告警

  • [ ] 日志关键词监控
  • {关键词1} - {含义}
  • {关键词2} - {含义}

  • [ ] 异常情况检查

  • 正常情况:{描述}
  • 异常情况:{描述}

回滚方案

如需回滚,直接 revert 以下 commit:

git revert {commit_hash}  # {commit message}

回滚后影响: - {影响1} - {影响2}


变更记录

日期 版本 变更内容 作者
{YYYY-MM-DD} v1.0 初始版本 {作者}

本文档为站内渲染。原始文件本地路径:saas/source/knowledge-world/Knowledge-World-项目-Practice-Claude-Skills-bug-report-generat-0acbdf.md(仅本地保留,不入库不部署)