feat: 根目录文档、脚本、gitignore
This commit is contained in:
@@ -0,0 +1,257 @@
|
||||
# DAR 模板（缺陷分析报告）— pmassist-v3
|
||||
|
||||
> **使用说明**：按 8D/根因分析思路组织，所有结论需引用证据。
|
||||
> 涉及代码问题时优先查阅 CodeMap/DomainMap，支持精准根因定位。
|
||||
|
||||
---
|
||||
|
||||
## 0. 文档信息
|
||||
|
||||
| 字段 | 内容 |
|
||||
|---|---|
|
||||
| 缺陷编号 | BUG-xxx |
|
||||
| 版本 | v1.0 |
|
||||
| 状态 | 分析中 / 已修复 / 已验证 |
|
||||
| 作者 | |
|
||||
| 创建日期 | |
|
||||
| 最后更新 | |
|
||||
|
||||
---
|
||||
|
||||
## 1. 缺陷概述
|
||||
|
||||
### 1.1 问题描述
|
||||
> 简要描述缺陷现象，用一句话概括。
|
||||
|
||||
### 1.2 影响范围
|
||||
|
||||
| 维度 | 说明 |
|
||||
|---|---|
|
||||
| 影响用户数 | |
|
||||
| 影响业务功能 | |
|
||||
| 影响系统/服务 | |
|
||||
| 影响时间窗口 | |
|
||||
|
||||
### 1.3 严重级别与优先级
|
||||
|
||||
| 项目 | 值 |
|
||||
|---|---|
|
||||
| 严重级别 | P0（紧急）/ P1（严重）/ P2（一般）/ P3（轻微）|
|
||||
| 处理优先级 | 立即修复 / 本迭代修复 / 下迭代修复 |
|
||||
|
||||
---
|
||||
|
||||
## 2. 复现信息
|
||||
|
||||
### 2.1 复现步骤
|
||||
|
||||
1. 步骤一
|
||||
2. 步骤二
|
||||
3. 步骤三
|
||||
|
||||
### 2.2 期望结果 vs 实际结果
|
||||
|
||||
| | 描述 |
|
||||
|---|---|
|
||||
| **期望结果** | |
|
||||
| **实际结果** | |
|
||||
|
||||
### 2.3 环境信息
|
||||
|
||||
| 项目 | 值 |
|
||||
|---|---|
|
||||
| 系统版本 | |
|
||||
| 分支/Tag | |
|
||||
| 设备/网络 | |
|
||||
| 账号/角色 | |
|
||||
|
||||
### 2.4 相关证据
|
||||
|
||||
| 类型 | 路径/描述 |
|
||||
|---|---|
|
||||
| 日志 | [SRC-001] |
|
||||
| 截图 | [SRC-002] |
|
||||
| 接口请求 | [SRC-003] |
|
||||
| 监控数据 | |
|
||||
|
||||
---
|
||||
|
||||
## 3. 时间线
|
||||
|
||||
| 时间 | 事件 | 操作人 |
|
||||
|---|---|---|
|
||||
| | 首次发现 | |
|
||||
| | 问题升级 | |
|
||||
| | 临时止损 | |
|
||||
| | 根因确认 | |
|
||||
| | 修复上线 | |
|
||||
| | 验证通过 | |
|
||||
|
||||
---
|
||||
|
||||
## 4. 临时遏制措施（Containment）
|
||||
|
||||
### 4.1 当前止损方案
|
||||
|
||||
### 4.2 影响控制范围
|
||||
|
||||
---
|
||||
|
||||
## 5. 根因分析
|
||||
|
||||
### 5.1 直接原因
|
||||
|
||||
### 5.2 根本原因（5 Whys）
|
||||
|
||||
| 层次 | Why | 分析 | 证据 |
|
||||
|---|---|---|---|
|
||||
| 第1层 | 为什么出现缺陷？ | | [SRC-001] |
|
||||
| 第2层 | 为什么第1层原因存在？ | | |
|
||||
| 第3层 | 为什么第2层原因存在？ | | |
|
||||
| 第4层 | 为什么第3层原因存在？ | | |
|
||||
| 第5层 | 根本原因 | | |
|
||||
|
||||
### 5.3 根因类型分类
|
||||
|
||||
- [ ] 代码逻辑错误
|
||||
- [ ] 边界条件未处理
|
||||
- [ ] 需求理解偏差
|
||||
- [ ] 测试覆盖不足
|
||||
- [ ] 配置/环境问题
|
||||
- [ ] 第三方依赖问题
|
||||
- [ ] 数据质量问题
|
||||
- [ ] 其他：______
|
||||
|
||||
### 5.4 触发条件与边界
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
A[触发条件] --> B{边界判断}
|
||||
B -->|条件A| C[正常路径]
|
||||
B -->|条件B| D[Bug触发路径]
|
||||
D --> E[问题结果]
|
||||
```
|
||||
|
||||
### 5.5 代码根因定位
|
||||
|
||||
> 引用 CodeMap/DomainMap 精准定位。
|
||||
|
||||
| 文件/类 | 方法 | 行号（约） | 问题说明 | 证据 |
|
||||
|---|---|---|---|---|
|
||||
| | | | | [CODEMAP:...] |
|
||||
|
||||
---
|
||||
|
||||
## 6. 纠正措施（Corrective Action）
|
||||
|
||||
### 6.1 修复方案
|
||||
|
||||
| 方案 | 描述 | 影响范围 | 风险 | 结论 |
|
||||
|---|---|---|---|---|
|
||||
| 方案 A（选定）| | | | ✅ 采用 |
|
||||
| 方案 B | | | | ❌ 放弃 |
|
||||
|
||||
### 6.2 修复影响评估
|
||||
|
||||
| 维度 | 影响说明 |
|
||||
|---|---|
|
||||
| 影响模块 | |
|
||||
| 数据迁移 | 需要 / 不需要 |
|
||||
| 接口变更 | 有 / 无 |
|
||||
| 回归范围 | |
|
||||
|
||||
### 6.3 回归验证要点
|
||||
|
||||
| 验证项 | 说明 | 负责人 |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
---
|
||||
|
||||
## 7. 效果验证
|
||||
|
||||
### 7.1 验证方式与结果
|
||||
|
||||
| 验证项 | 方式 | 结果 | 时间 |
|
||||
|---|---|---|---|
|
||||
| | 自动化测试/手工测试 | ✅/❌ | |
|
||||
|
||||
### 7.2 监控/指标变化
|
||||
|
||||
| 指标 | 修复前 | 修复后 | 变化 |
|
||||
|---|---|---|---|
|
||||
| | | | |
|
||||
|
||||
---
|
||||
|
||||
## 8. 预防措施与改进
|
||||
|
||||
### 8.1 预防机制
|
||||
|
||||
| 类型 | 措施 | 负责人 | 完成时间 |
|
||||
|---|---|---|---|
|
||||
| 监控告警 | | | |
|
||||
| 测试补充 | | | |
|
||||
| 流程改进 | | | |
|
||||
| 代码规范 | | | |
|
||||
|
||||
### 8.2 长期改进计划
|
||||
|
||||
| 改进项 | 优先级 | 计划时间 | 负责方 |
|
||||
|---|---|---|---|
|
||||
| | P1 | | |
|
||||
|
||||
---
|
||||
|
||||
## 9. 经验总结
|
||||
|
||||
### 9.1 经验教训
|
||||
|
||||
| 类别 | 教训 | 对应改进措施 |
|
||||
|---|---|---|
|
||||
| 研发 | | |
|
||||
| 测试 | | |
|
||||
| 运维 | | |
|
||||
| 产品 | | |
|
||||
|
||||
### 9.2 可复用的规则/检查项
|
||||
|
||||
> 归纳为可在未来需求中复用的防范规则。
|
||||
|
||||
- [ ] {检查项1}
|
||||
- [ ] {检查项2}
|
||||
|
||||
---
|
||||
|
||||
## 10. 证据与引用
|
||||
|
||||
- 引用 `materials_index.md` 中的 SRC-xxx
|
||||
- CODEMAP/DOMAINMAP/RUNTIME 证据引用
|
||||
|
||||
---
|
||||
|
||||
## 11. 证据映射表（强制）
|
||||
|
||||
| 章节 | 关键结论 | 证据 | 状态 |
|
||||
|---|---|---|---|
|
||||
| 复现信息 | | | |
|
||||
| 根因分析 | | | |
|
||||
| 纠正措施 | | | |
|
||||
| 效果验证 | | | |
|
||||
|
||||
---
|
||||
|
||||
## 12. 系统资产引用（强制）
|
||||
|
||||
| 资产类型 | 路径 | 用途 |
|
||||
|---|---|---|
|
||||
| CodeMap | | |
|
||||
| DomainMap | | |
|
||||
| Runtime | | |
|
||||
|
||||
---
|
||||
|
||||
## 图表要求（强制检查）
|
||||
|
||||
- [ ] 至少 1 个 mermaid 图（根因路径/修复流程/时间线任选）
|
||||
- [ ] 至少 1 张表（影响范围/根因层次/预防措施等）
|
||||
Reference in New Issue
Block a user