first commit
This commit is contained in:
@@ -0,0 +1,60 @@
|
||||
# Bug-Fix PRD Pattern
|
||||
|
||||
Bug-fix PRDs are shorter than feature PRDs. Use this structure:
|
||||
|
||||
```markdown
|
||||
# {问题简述}
|
||||
|
||||
> **版本**: v1.0
|
||||
> **日期**: {date}
|
||||
> **状态**: ✅ 已修复 / 📝 待评审
|
||||
|
||||
---
|
||||
|
||||
## 一、问题描述
|
||||
### 1.1 现象
|
||||
### 1.2 复现步骤(编号列表)
|
||||
### 1.3 影响范围
|
||||
|
||||
## 二、根因分析
|
||||
### 2.1 技术细节(贴相关代码片段)
|
||||
### 2.2 问题根因(加粗说明核心原因)
|
||||
|
||||
## 三、解决方案
|
||||
### 3.1 方案对比(表格:方案/实现复杂度/优缺点/推荐度)
|
||||
### 3.2 推荐方案(代码示例)
|
||||
|
||||
## 四、实现细节
|
||||
### 4.1 修改文件
|
||||
### 4.2 具体改动(diff 或代码块)
|
||||
### 4.3 边界情况
|
||||
|
||||
## 五、测试验证
|
||||
### 5.1 测试用例(表格:编号/步骤/预期结果)
|
||||
|
||||
## 六、风险与注意事项
|
||||
|
||||
## 附录
|
||||
### A. 相关文件
|
||||
### B. 参考资料
|
||||
```
|
||||
|
||||
## Key Differences from Feature PRDs
|
||||
|
||||
| Aspect | Feature PRD | Bug-Fix PRD |
|
||||
|--------|-------------|-------------|
|
||||
| User Stories | ✅ Required | ❌ Skip |
|
||||
| Data Model | ✅ Required | ❌ Skip (unless bug is data-related) |
|
||||
| API Design | ✅ Required | ❌ Skip (unless bug is API-related) |
|
||||
| Competitor Analysis | ✅ Required | ❌ Skip |
|
||||
| Root Cause Analysis | Optional | ✅ Critical |
|
||||
| Fix Options Comparison | Optional | ✅ Required |
|
||||
| Regression Test Plan | Optional | ✅ Required |
|
||||
|
||||
## Example
|
||||
|
||||
See `prd-blog-toc-scroll-fix.md` in ephron-ren-qa repo for a real example:
|
||||
- Problem: TOC anchor links scrolled behind fixed navbar
|
||||
- Root cause: `scroll-margin-top` not set on headings
|
||||
- Fix: CSS `scroll-margin-top: 80px`
|
||||
- Testing: 5 test cases covering H2, H3, address bar, rapid clicks
|
||||
Reference in New Issue
Block a user