docs(tasks): 添加 TODO 文档指南和模板
- 新增 TODO_TEMPLATE.md 标准模板 - 更新 tasks/README.md,明确 TODO 文档定位 - TODO 存放原始需求+初步分析,简洁明了 - plan/ 存放详细技术方案 - done/ 存放实现记录和总结 文档特点: - 简洁:3-5分钟能看完 - 快速评估:技术可行性初步判断 - 避免过度设计:未决定前不写细节
Showing
3 changed files
with
171 additions
and
16 deletions
| ... | @@ -61,20 +61,66 @@ tasks/ | ... | @@ -61,20 +61,66 @@ tasks/ |
| 61 | 61 | ||
| 62 | ### 📝 todo/ - 待办事项 | 62 | ### 📝 todo/ - 待办事项 |
| 63 | 63 | ||
| 64 | -**用途**: 待办功能、Bug 修复、改进建议的清单 | 64 | +**用途**: 存放**原始需求 + 初步分析**,作为任务的初始记录 |
| 65 | 65 | ||
| 66 | **包含内容**: | 66 | **包含内容**: |
| 67 | 67 | ||
| 68 | -- 功能需求列表 | 68 | +- ✅ 原始需求描述(来自产品/用户反馈/技术债务) |
| 69 | -- Bug 修复清单 | 69 | +- ✅ 简短的技术评估(复杂度、工作量、风险) |
| 70 | -- 优化建议 | 70 | +- ✅ 优先级标记 |
| 71 | -- 技术债务 | 71 | +- ✅ 相关资源链接(设计稿、参考文档) |
| 72 | +- ✅ 讨论记录(如果有) | ||
| 73 | +- ❌ 详细技术方案(应放在 `plan/`) | ||
| 74 | +- ❌ 实现细节(应放在 `plan/`) | ||
| 75 | + | ||
| 76 | +**文档特点**: | ||
| 77 | + | ||
| 78 | +- **简洁明了**: 3-5 分钟能看完 | ||
| 79 | +- **重点突出**: 核心需求和目标 | ||
| 80 | +- **快速评估**: 技术可行性初步判断 | ||
| 81 | +- **易于决策**: 判断是否要做、何时做 | ||
| 72 | 82 | ||
| 73 | **如何使用**: | 83 | **如何使用**: |
| 74 | 84 | ||
| 75 | -1. 新增待办项时添加到对应分类 | 85 | +1. 新增待办项时,使用模板 `todo/TODO_TEMPLATE.md` |
| 76 | -2. 开始开发时移到 `plan/` | 86 | +2. 填写核心内容,不要展开技术细节 |
| 77 | -3. 完成后移到 `done/` | 87 | +3. 决定开发后,移到 `plan/` 并详细设计 |
| 88 | +4. 避免过度设计,还没决定就写太详细 | ||
| 89 | + | ||
| 90 | +**示例**: | ||
| 91 | + | ||
| 92 | +```markdown | ||
| 93 | +# 打卡草稿缓存功能 | ||
| 94 | + | ||
| 95 | +**优先级**: 🟡中 | ||
| 96 | +**来源**: 用户反馈 | ||
| 97 | +**提出日期**: 2026-01-28 | ||
| 98 | + | ||
| 99 | +## 需求描述 | ||
| 100 | + | ||
| 101 | +用户反馈打卡过程中,如果意外退出或网络中断,已填写的内容会丢失。 | ||
| 102 | + | ||
| 103 | +## 期望结果 | ||
| 104 | + | ||
| 105 | +- 打卡内容自动保存 | ||
| 106 | +- 再次进入时可恢复 | ||
| 107 | +- 提交成功后清除缓存 | ||
| 108 | + | ||
| 109 | +## 初步评估 | ||
| 110 | + | ||
| 111 | +- 技术复杂度: 中等 | ||
| 112 | +- 预估工作量: 2天 | ||
| 113 | +- 涉及模块: 打卡组件、localStorage | ||
| 114 | +- 潜在风险: 存储容量限制 | ||
| 115 | +``` | ||
| 116 | + | ||
| 117 | +**完整模板**: 见 `todo/TODO_TEMPLATE.md` | ||
| 118 | + | ||
| 119 | +**何时移到 plan/**: | ||
| 120 | + | ||
| 121 | +- ✅ 需求已确认,准备开发 | ||
| 122 | +- ✅ 需要详细技术设计 | ||
| 123 | +- ✅ 需要排期和资源规划 | ||
| 78 | 124 | ||
| 79 | --- | 125 | --- |
| 80 | 126 | ... | ... |
docs/tasks/TODO/26.1.26新功能.md
deleted
100644 → 0
| 1 | -新功能开发list(在.env加上配置开关控制下面设计到的功能点, 比如是否开启置顶功能,开启点评打卡, 开启打卡海报,开启点评列表): | ||
| 2 | -入口页IndexCheckInPage涉及功能 | ||
| 3 | - | ||
| 4 | -- CheckinCard组件 <#footer-right> 3个点的缩略显示, 点击后从底部弹出vant的ActionSheet组件, 面板有置顶和点评两个选项. | ||
| 5 | - 1. 置顶的功能, 使用图标back-top, 点击图标的时候弹出确认弹窗, 确认后调用接口置顶帖子. | ||
| 6 | - 2. 点评打卡作业的功能, 使用图标comment, 点击图标的时候弹出确认弹窗, 确认后调用接口点评打卡作业. 评论弹框做成一个单独的组件以后扩展. | ||
| 7 | - 3. 海报功能, 使用图标share, 可以参考SharePoster组件的实现, 新增一个组件打卡海报, 这个组件最大的不同就是可能生成的图片是一张长图, 如果超过屏幕高度, 用户可以滑动查看. 现在内容和字段还不确定, 等确定了再实现可以先规划. | ||
| 8 | -- 显示点评列表功能, 在CheckinCard组件里面, 需要新增一个组件专门显示用户点评打卡的列表. 类似于朋友圈下面的评论列表, 放在CheckinCard组件的下面. |
docs/tasks/todo/TODO_TEMPLATE.md
0 → 100644
| 1 | +# TODO 任务模板 | ||
| 2 | + | ||
| 3 | +> 使用此模板创建新的待办任务 | ||
| 4 | + | ||
| 5 | +--- | ||
| 6 | + | ||
| 7 | +**优先级**: 🔴高 / 🟡中 / 🟢低 | ||
| 8 | +**来源**: 产品需求 / 技术债务 / 用户反馈 / 优化建议 / Bug 修复 | ||
| 9 | +**提出者**: [姓名] | ||
| 10 | +**提出日期**: YYYY-MM-DD | ||
| 11 | +**预期完成**: YYYY-MM-DD(可选) | ||
| 12 | + | ||
| 13 | +--- | ||
| 14 | + | ||
| 15 | +## 📌 需求背景 | ||
| 16 | + | ||
| 17 | +### 业务场景 | ||
| 18 | + | ||
| 19 | +[描述业务场景和目标用户] | ||
| 20 | + | ||
| 21 | +### 当前问题 | ||
| 22 | + | ||
| 23 | +- 问题1: [具体描述] | ||
| 24 | +- 问题2: [具体描述] | ||
| 25 | + | ||
| 26 | +**影响**: [对业务/用户/开发的影响] | ||
| 27 | + | ||
| 28 | +--- | ||
| 29 | + | ||
| 30 | +## 🎯 需求目标 | ||
| 31 | + | ||
| 32 | +### 主要目标 | ||
| 33 | + | ||
| 34 | +1. [目标1 - 尽可能量化] | ||
| 35 | +2. [目标2 - 尽可能量化] | ||
| 36 | + | ||
| 37 | +### 非目标(明确不做) | ||
| 38 | + | ||
| 39 | +- [不包含的功能1] | ||
| 40 | +- [不包含的功能2] | ||
| 41 | + | ||
| 42 | +--- | ||
| 43 | + | ||
| 44 | +## 💡 初步方案 | ||
| 45 | + | ||
| 46 | +### 技术方向 | ||
| 47 | + | ||
| 48 | +[简短描述技术实现方向,2-3句话即可] | ||
| 49 | + | ||
| 50 | +### 涉及模块 | ||
| 51 | + | ||
| 52 | +- 前端: [相关页面/组件] | ||
| 53 | +- 后端: [相关API,如果已知] | ||
| 54 | +- 数据: [是否需要存储/迁移] | ||
| 55 | + | ||
| 56 | +--- | ||
| 57 | + | ||
| 58 | +## 📊 初步评估 | ||
| 59 | + | ||
| 60 | +| 评估项 | 评估结果 | | ||
| 61 | +| ---------- | ------------------ | | ||
| 62 | +| 技术复杂度 | 简单 / 中等 / 复杂 | | ||
| 63 | +| 预估工作量 | X 人天 | | ||
| 64 | +| 优先级 | 高 / 中 / 低 | | ||
| 65 | +| 风险等级 | 高 / 中 / 低 | | ||
| 66 | + | ||
| 67 | +### 潜在风险 | ||
| 68 | + | ||
| 69 | +1. [风险点1] - [应对方案] | ||
| 70 | +2. [风险点2] - [应对方案] | ||
| 71 | + | ||
| 72 | +--- | ||
| 73 | + | ||
| 74 | +## 🔗 相关资源 | ||
| 75 | + | ||
| 76 | +- [设计稿 / 原型](链接) | ||
| 77 | +- [参考文档](链接) | ||
| 78 | +- [类似功能](链接) | ||
| 79 | +- [技术讨论](链接) | ||
| 80 | + | ||
| 81 | +--- | ||
| 82 | + | ||
| 83 | +## 📝 讨论记录 | ||
| 84 | + | ||
| 85 | +### YYYY-MM-DD [讨论主题] | ||
| 86 | + | ||
| 87 | +**参与者**: [姓名] | ||
| 88 | + | ||
| 89 | +**要点**: | ||
| 90 | + | ||
| 91 | +- [观点1] | ||
| 92 | +- [观点2] | ||
| 93 | + | ||
| 94 | +**结论**: [达成的一致意见或待定事项] | ||
| 95 | + | ||
| 96 | +--- | ||
| 97 | + | ||
| 98 | +## ✅ 完成标准 | ||
| 99 | + | ||
| 100 | +- [ ] [标准1 - 具体可验证] | ||
| 101 | +- [ ] [标准2 - 具体可验证] | ||
| 102 | +- [ ] [测试通过] | ||
| 103 | +- [ ] [文档已更新] | ||
| 104 | + | ||
| 105 | +--- | ||
| 106 | + | ||
| 107 | +## 📅 后续步骤 | ||
| 108 | + | ||
| 109 | +- [ ] [ ] 需求评审 | ||
| 110 | +- [ ] [ ] 技术方案设计(移至 plan/) | ||
| 111 | +- [ ] [ ] 排期开发 | ||
| 112 | + | ||
| 113 | +--- | ||
| 114 | + | ||
| 115 | +**状态**: 待讨论 / 待评估 / 待排期 / 已排期 | ||
| 116 | +**下一步**: [具体的下一步行动] | ||
| 117 | +**最后更新**: YYYY-MM-DD |
-
Please register or login to post a comment