104 lines
2.5 KiB
Markdown
104 lines
2.5 KiB
Markdown
|
# 工单与归档模板
|
|||
|
|
|
|||
|
|
复制下面的模板去用，不要每次从零写。字段说明见 [AGENTS.md](../../AGENTS.md)。
|
|||
|
|
|
|||
|
|
- **建单时**用模板 A，贴到 Gitea 工单正文里。
|
|||
|
|
- **做完后**用模板 B，另存为 `docs/task/<工单号>-<简短名称>.md`。
|
|||
|
|
|
|||
|
|
模板里带 `（选填）` 的行，没有内容就整行删掉，不要留个空标题。
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 模板 A：单元任务工单（建单时用）
|
|||
|
|
|
|||
|
|
```markdown
|
|||
|
|
## 基本信息
|
|||
|
|
|
|||
|
|
- 类型：需求 / 缺陷 / 重构
|
|||
|
|
- 父级大工单：#
|
|||
|
|
- 所属 MVP / 版本：
|
|||
|
|
- 阶段：
|
|||
|
|
|
|||
|
|
## 要解决什么
|
|||
|
|
|
|||
|
|
<!-- 现在是什么情况，为什么要改。缺陷要写清怎么复现。 -->
|
|||
|
|
|
|||
|
|
## 做什么 / 不做什么
|
|||
|
|
|
|||
|
|
- 做：
|
|||
|
|
- 不做：
|
|||
|
|
|
|||
|
|
## 怎么做
|
|||
|
|
|
|||
|
|
<!-- 已经和用户确认过的方案。写清楚改哪几个文件、动不动数据库、动不动接口。 -->
|
|||
|
|
|
|||
|
|
## 验收标准
|
|||
|
|
|
|||
|
|
<!-- 一条一条能打勾的。别写"功能正常"这种没法验证的。 -->
|
|||
|
|
|
|||
|
|
- [ ]
|
|||
|
|
- [ ]
|
|||
|
|
|
|||
|
|
## 怎么验证
|
|||
|
|
|
|||
|
|
<!-- 具体到能复制粘贴的命令；需要真机的要写明。 -->
|
|||
|
|
|
|||
|
|
## 风险和回退（选填）
|
|||
|
|
|
|||
|
|
<!-- 可能出什么问题，出了怎么退回去。碰采购、数据库迁移、Admin 接口的必填。 -->
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 模板 B：完成归档（`docs/task/` 用）
|
|||
|
|
|
|||
|
|
```markdown
|
|||
|
|
# <工单号> <标题>
|
|||
|
|
|
|||
|
|
- 类型：需求 / 缺陷 / 重构
|
|||
|
|
- 父级大工单：#
|
|||
|
|
- 所属 MVP / 版本：
|
|||
|
|
- 状态：已完成
|
|||
|
|
- 日期：YYYY-MM-DD
|
|||
|
|
- Gitea 工单：<链接>
|
|||
|
|
|
|||
|
|
## 背景与目标
|
|||
|
|
|
|||
|
|
<!-- 原来什么问题，这次要达到什么。 -->
|
|||
|
|
|
|||
|
|
## 最终方案
|
|||
|
|
|
|||
|
|
<!-- 实际怎么做的。和建单时的方案有出入就写清楚差在哪、为什么改。 -->
|
|||
|
|
|
|||
|
|
## 改了哪些
|
|||
|
|
|
|||
|
|
<!-- 主要文件清单 + 一句话说明各改了什么。 -->
|
|||
|
|
|
|||
|
|
## 验收结果
|
|||
|
|
|
|||
|
|
| 验收标准 | 结果 |
|
|||
|
|
|---|---|
|
|||
|
|
| | 通过 / 未通过 |
|
|||
|
|
|
|||
|
|
## 测试
|
|||
|
|
|
|||
|
|
- 执行的命令：
|
|||
|
|
- 结果：
|
|||
|
|
- **没验证到的部分**：<!-- 必填。没有就写"无"。真机行为、迁移、并发这类经常漏，漏了要写出来。 -->
|
|||
|
|
|
|||
|
|
## 遗留问题（选填）
|
|||
|
|
|
|||
|
|
## 相关提交
|
|||
|
|
|
|||
|
|
- `<提交哈希>` <提交说明>
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
## 写工单的几个提醒
|
|||
|
|
|
|||
|
|
1. **验收标准要能打勾。** "表格显示正常"没法验证；"1000 条数据下滚动到底能继续加载，且当前选中行不丢"可以验证。
|
|||
|
|
2. **"没验证到的部分"不许留空。** 真机没跑就写真机没跑。瞒下来的风险最后都会变成事故。
|
|||
|
|
3. **不确定的东西写进工单，不要只写在代码注释里。** 聊天记录和注释都不算数。
|
|||
|
|
4. **一个工单只干一件事。** 顺手改的无关内容单独开工单，别混进来。
|