📝 docs(prompts): refresh prompt templates

This commit is contained in:
csh
2026-01-27 16:04:48 +08:00
parent 6774a9d4aa
commit 2554c879e4
7 changed files with 251 additions and 357 deletions
+14 -91
View File
@@ -1,5 +1,10 @@
# 需求澄清模板
<!--
按需使用:当需求不明确或存在歧义时参考本模板。
Vibe-coding 场景下可跳过,直接开始实现。
-->
## 何时使用
- 需求描述不明确
@@ -10,119 +15,37 @@
## 澄清步骤
### 1. 理解当前需求
**复述需求**
### 1. 复述需求
```text
我理解你的需求是:[用自己的话复述]
```
**识别歧义点**
### 2. 识别歧义
- 歧义 1[描述不明确的地方]
- 歧义 2[可能有多种理解的地方]
---
### 2. 提出澄清问题
**问题模板**
### 3. 提出问题
> 只问阻塞问题,最多 1–2 个;优先给出选项让用户选择。
#### 功能范围
- 这个功能是否包括 [场景 A]
- 是否需要支持 [边界情况 B]
- 优先级如何?必须有 vs 可选
#### 行为细节
- 当 [条件 X] 时,应该 [行为 Y] 还是 [行为 Z]?
- 如果 [异常情况],如何处理?
- 是否需要与 [现有功能] 保持一致?
#### 技术约束
- 是否有性能要求?
- 是否有兼容性要求?
- 是否有安全要求?
---
### 3. 提供选项
**选项格式**
### 4. 提供选项
**选项 A**[方案描述]
- 优点:[列出优点]
- 缺点:[列出缺点]
- 适用场景:[什么情况下选这个]
- 优点:...
- 缺点:...
**选项 B**[方案描述]
- 优点:[列出优点]
- 缺点:[列出缺点]
- 适用场景:[什么情况下选这个]
- 优点:...
- 缺点:...
**推荐**[推荐哪个选项,为什么]
---
### 4. 确认理解
**确认清单**
- [ ] 功能范围明确
- [ ] 行为细节清晰
- [ ] 技术约束已知
- [ ] 优先级确定
- [ ] 验收标准明确
---
## 示例
### 需求
```text
实现 XXX 功能
```
### 澄清过程
**复述需求**
```text
我理解你的需求是:为 YYY 添加 XXX 功能,
用于 ZZZ。
```
**识别歧义点**
- 歧义 1XXX 是只读还是可写?
- 歧义 2:是否需要支持所有场景?
**澄清问题**
- 是否需要支持 [场景 A]
- 当 [条件 X] 时,应该如何处理?
**提供选项**
**选项 A**:完整实现
- 优点:功能完整
- 缺点:开发周期长
**选项 B**:核心功能
- 优点:快速交付
- 缺点:功能有限
**推荐**:选项 A,因为 [原因]。
**推荐**[推荐哪个,为什么]
---
@@ -0,0 +1,66 @@
# 复盘模板
<!--
用途:Plan 或阶段完成后的回顾总结
触发:主循环汇总报告时、阶段性工作完成时
-->
## 何时使用
- 一批 Plan 执行完毕后
- 阶段性工作告一段落
- 遇到重大阻塞需要总结
---
## 复盘格式
```markdown
# 复盘: [日期/阶段名称]
## 完成情况
### 已完成
- [x] Plan 1: 简述
- [x] Plan 2: 简述
### 阻塞
- [ ] Plan 3: 阻塞原因
### 跳过
- [ ] Plan 4: 跳过原因
## 关键发现
### 做得好的
- 发现1
- 发现2
### 待改进
- 问题1 → 建议改进方式
- 问题2 → 建议改进方式
## 决策记录
| 决策 | 理由 | 影响 |
|------|------|------|
| 决策1 | 为什么 | 影响范围 |
## 下一步
- [ ] 待处理事项1
- [ ] 待处理事项2
```
---
## 复盘原则
- **客观记录**:如实记录完成/阻塞/跳过
- **提取经验**:总结做得好的和待改进的
- **决策留痕**:重要决策记录到 decisions.md
- **明确下一步**:列出后续待处理事项
---
**最后更新**{{DATE}}
@@ -1,93 +0,0 @@
# 验证检查清单
## 代码修改验证
### 语法检查
- [ ] 代码可正常运行(无语法错误)
- [ ] 无未定义的变量或函数
- [ ] 依赖引用正确
### 风格检查
- [ ] 命名符合规范
- [ ] 缩进正确
- [ ] 换行符正确(遵循 .gitattributes
- [ ] 无冗余注释
---
## 测试验证
### 单元测试
- [ ] 相关测试脚本存在
- [ ] 测试可正常运行
- [ ] 测试通过(无失败)
### 回归测试
- [ ] 现有测试仍然通过
- [ ] 未破坏其他功能
---
## 文档验证
### 代码文档
- [ ] 复杂逻辑有注释说明
- [ ] 公开 API 有使用示例(如需)
### 项目文档
- [ ] `memory-bank/progress.md` 已更新
- [ ] 重要决策记录到 `memory-bank/decisions.md`
---
## Git 验证
### 提交前检查
- [ ] 只包含相关修改(无无关文件)
- [ ] 提交信息清晰
- [ ] 无临时文件或调试代码
### 分支检查
- [ ] 在正确的分支上工作
---
## 性能验证(如果涉及)
### 性能测试
- [ ] 处理时间可接受
- [ ] 内存使用正常
- [ ] 无明显性能退化
---
## 安全验证(如果涉及)
### 安全检查
- [ ] 无注入风险
- [ ] 敏感信息已脱敏
---
## 快速检查清单(最小集)
**每次修改必须检查**
- [ ] 代码可运行(无语法错误)
- [ ] 相关测试通过
- [ ] 换行符正确
- [ ] `memory-bank/progress.md` 已更新
---
**最后更新**{{DATE}}