hookehuyr

docs(tasks): 添加 TODO 文档指南和模板

- 新增 TODO_TEMPLATE.md 标准模板
- 更新 tasks/README.md,明确 TODO 文档定位
- TODO 存放原始需求+初步分析,简洁明了
- plan/ 存放详细技术方案
- done/ 存放实现记录和总结

文档特点:
- 简洁:3-5分钟能看完
- 快速评估:技术可行性初步判断
- 避免过度设计:未决定前不写细节
......@@ -61,20 +61,66 @@ tasks/
### 📝 todo/ - 待办事项
**用途**: 待办功能、Bug 修复、改进建议的清单
**用途**: 存放**原始需求 + 初步分析**,作为任务的初始记录
**包含内容**:
- 功能需求列表
- Bug 修复清单
- 优化建议
- 技术债务
- ✅ 原始需求描述(来自产品/用户反馈/技术债务)
- ✅ 简短的技术评估(复杂度、工作量、风险)
- ✅ 优先级标记
- ✅ 相关资源链接(设计稿、参考文档)
- ✅ 讨论记录(如果有)
- ❌ 详细技术方案(应放在 `plan/`
- ❌ 实现细节(应放在 `plan/`
**文档特点**:
- **简洁明了**: 3-5 分钟能看完
- **重点突出**: 核心需求和目标
- **快速评估**: 技术可行性初步判断
- **易于决策**: 判断是否要做、何时做
**如何使用**:
1. 新增待办项时添加到对应分类
2. 开始开发时移到 `plan/`
3. 完成后移到 `done/`
1. 新增待办项时,使用模板 `todo/TODO_TEMPLATE.md`
2. 填写核心内容,不要展开技术细节
3. 决定开发后,移到 `plan/` 并详细设计
4. 避免过度设计,还没决定就写太详细
**示例**:
```markdown
# 打卡草稿缓存功能
**优先级**: 🟡中
**来源**: 用户反馈
**提出日期**: 2026-01-28
## 需求描述
用户反馈打卡过程中,如果意外退出或网络中断,已填写的内容会丢失。
## 期望结果
- 打卡内容自动保存
- 再次进入时可恢复
- 提交成功后清除缓存
## 初步评估
- 技术复杂度: 中等
- 预估工作量: 2天
- 涉及模块: 打卡组件、localStorage
- 潜在风险: 存储容量限制
```
**完整模板**: 见 `todo/TODO_TEMPLATE.md`
**何时移到 plan/**:
- ✅ 需求已确认,准备开发
- ✅ 需要详细技术设计
- ✅ 需要排期和资源规划
---
......
新功能开发list(在.env加上配置开关控制下面设计到的功能点, 比如是否开启置顶功能,开启点评打卡, 开启打卡海报,开启点评列表):
入口页IndexCheckInPage涉及功能
- CheckinCard组件 <#footer-right> 3个点的缩略显示, 点击后从底部弹出vant的ActionSheet组件, 面板有置顶和点评两个选项.
1. 置顶的功能, 使用图标back-top, 点击图标的时候弹出确认弹窗, 确认后调用接口置顶帖子.
2. 点评打卡作业的功能, 使用图标comment, 点击图标的时候弹出确认弹窗, 确认后调用接口点评打卡作业. 评论弹框做成一个单独的组件以后扩展.
3. 海报功能, 使用图标share, 可以参考SharePoster组件的实现, 新增一个组件打卡海报, 这个组件最大的不同就是可能生成的图片是一张长图, 如果超过屏幕高度, 用户可以滑动查看. 现在内容和字段还不确定, 等确定了再实现可以先规划.
- 显示点评列表功能, 在CheckinCard组件里面, 需要新增一个组件专门显示用户点评打卡的列表. 类似于朋友圈下面的评论列表, 放在CheckinCard组件的下面.
# TODO 任务模板
> 使用此模板创建新的待办任务
---
**优先级**: 🔴高 / 🟡中 / 🟢低
**来源**: 产品需求 / 技术债务 / 用户反馈 / 优化建议 / Bug 修复
**提出者**: [姓名]
**提出日期**: YYYY-MM-DD
**预期完成**: YYYY-MM-DD(可选)
---
## 📌 需求背景
### 业务场景
[描述业务场景和目标用户]
### 当前问题
- 问题1: [具体描述]
- 问题2: [具体描述]
**影响**: [对业务/用户/开发的影响]
---
## 🎯 需求目标
### 主要目标
1. [目标1 - 尽可能量化]
2. [目标2 - 尽可能量化]
### 非目标(明确不做)
- [不包含的功能1]
- [不包含的功能2]
---
## 💡 初步方案
### 技术方向
[简短描述技术实现方向,2-3句话即可]
### 涉及模块
- 前端: [相关页面/组件]
- 后端: [相关API,如果已知]
- 数据: [是否需要存储/迁移]
---
## 📊 初步评估
| 评估项 | 评估结果 |
| ---------- | ------------------ |
| 技术复杂度 | 简单 / 中等 / 复杂 |
| 预估工作量 | X 人天 |
| 优先级 | 高 / 中 / 低 |
| 风险等级 | 高 / 中 / 低 |
### 潜在风险
1. [风险点1] - [应对方案]
2. [风险点2] - [应对方案]
---
## 🔗 相关资源
- [设计稿 / 原型](链接)
- [参考文档](链接)
- [类似功能](链接)
- [技术讨论](链接)
---
## 📝 讨论记录
### YYYY-MM-DD [讨论主题]
**参与者**: [姓名]
**要点**:
- [观点1]
- [观点2]
**结论**: [达成的一致意见或待定事项]
---
## ✅ 完成标准
- [ ] [标准1 - 具体可验证]
- [ ] [标准2 - 具体可验证]
- [ ] [测试通过]
- [ ] [文档已更新]
---
## 📅 后续步骤
- [ ] [ ] 需求评审
- [ ] [ ] 技术方案设计(移至 plan/)
- [ ] [ ] 排期开发
---
**状态**: 待讨论 / 待评估 / 待排期 / 已排期
**下一步**: [具体的下一步行动]
**最后更新**: YYYY-MM-DD