Dev Report

根据代码修改生成开发报告。用于代码修改完成后编写报告,记录问题背景、解决方案和总结。

orange-gi Updated

File contents

开发报告编写

根据代码修改内容,按照以下格式生成开发报告。

报告结构

记录日期:YYYY-MM-DD

## 问题背景
[简要说明本次修改的背景和目的]

## 问题列表

### 问题一
**根因分析**(链式证据级定位,最多3轮):
- why1: 为什么xxx,因为有bug1
- why2: 为什么有bug1,因为有bug2
- why3: ...

**方案**:
- 短期方案: xxxxxx
  - 优点: xxx
  - 缺点: xxx
- 长远方案: xxxx
  - 优点: xxx
  - 缺点: xxx

**采纳方案**:
xxxxx

**补充用例**:
xxxx

### 问题二
...

## 小结
xxxxxx

编写步骤

  1. 分析代码修改:理解本次修改的内容和目的
  2. 识别问题:从修改中提取需要记录的问题点
  3. 根因分析:对每个问题进行链式why分析(最多3层)
  4. 方案对比:列出短期和长远方案
  5. 确定采纳:明确选择哪个方案及原因
  6. 补充用例:添加必要的测试用例
  7. 总结:整体总结本次修改的收获

注意事项

  • 保持简洁、清晰、直接、真实的写作风格
  • 根因分析使用链式 why 追问,直到找到根本原因
  • 每个问题不超过两个方案
  • 记录日期使用实际修改日期

orange-gi/yuchen-skills/tree/main/dev-report commit 8512a12c2e

Frequently asked questions

npx skillmds@latest add orange-gi/dev-report