hookehuyr

docs(tasks): 新增 ideas/ 目录用于需求收集

问题:零碎需求陆续来时,不知道放哪里
解决:新增 ideas/ 目录,专门存放原始、零碎的需求

任务生命周期(4个阶段):
1. ideas/ - 需求收集(零碎、原始、5分钟)
2. todo/ - 待办任务(整理后、完整、15分钟)
3. plan/ - 技术方案(详细、可执行、1-2小时)
4. done/ - 完成总结(记录、反思、30分钟)

ideas/ 特点:
- 快速记录,随便写,不需要模板
- 避免过度整理和过早设计
- 先存下来,避免遗忘

使用流程:
1. 收到零碎需求 → ideas/(随便记)
2. 需求相对完整 → todo/(用模板)
3. 决定开发 → plan/(详细设计)
4. 开发完成 → done/(写总结)
...@@ -6,72 +6,97 @@ ...@@ -6,72 +6,97 @@
6 6
7 ``` 7 ```
8 tasks/ 8 tasks/
9 -├── done/ # 已完成的任务 9 +├── ideas/ # 💡 需求收集(零碎、原始)
10 -├── plan/ # 进行中和计划中的任务 10 +├── todo/ # 📝 待办任务(整理后、相对完整)
11 -└── todo/ # 待办事项列表 11 +├── plan/ # ⚙️ 技术方案(详细设计)
12 +└── done/ # ✅ 完成总结
12 ``` 13 ```
13 14
15 +## 🔄 任务生命周期
16 +
17 +```
18 +ideas(零碎需求) → todo(整理后) → plan(技术方案) → done(完成总结)
19 +```
20 +
21 +### 各阶段说明
22 +
23 +| 阶段 | 用途 | 文档特点 | 时机 | 预估时间 |
24 +| ---------- | -------- | -------------------- | ---------- | -------- |
25 +| **ideas/** | 需求收集 | 零碎、随便写、随时记 | 收到需求时 | 5 分钟 |
26 +| **todo/** | 待办任务 | 简短、完整、可评估 | 需求整理后 | 15 分钟 |
27 +| **plan/** | 技术方案 | 详细、可执行、可评审 | 决定开发时 | 1-2 小时 |
28 +| **done/** | 完成总结 | 记录、反思、可复用 | 开发完成后 | 30 分钟 |
29 +
30 +---
31 +
14 ## 📂 各目录说明 32 ## 📂 各目录说明
15 33
16 -### ✅ done/ - 已完成任务 34 +### 💡 ideas/ - 需求收集
17 35
18 -**用途**: 存放已完成的功能和任务的详细记录 36 +**用途**: 记录**原始的、零碎的**需求和反馈,在整理成正式需求之前。
19 37
20 -**包含内容**: 38 +**适合放这里的内容**:
21 39
22 -- 功能实现记录 40 +- ✅ 用户反馈的原话(一句话也行)
23 -- 技术方案文档 41 +- ✅ 临时想到的功能点
24 -- 上线总结报告 42 +- ✅ 简短的问题描述
43 +- ✅ 未整理的会议记录
44 +- ✅ 任何不完整的需求
25 45
26 -**示例**: 46 +**特点**:
27 47
28 -- 欢迎页布局优化 48 +- 📝 随便写,不需要格式
29 -- 打卡草稿缓存功能 49 +- 🎯 快速记录,不要过度整理
30 -- 视频播放器优化 50 +- 💾 先存下来,避免遗忘
31 51
32 -**如何添加**: 52 +**文档格式示例**:
33 -完成任务后,将相关文档移动到 `done/` 目录,并更新此索引。
34 53
35 ---- 54 +```markdown
55 +## 2026-01-28 用户反馈
36 56
37 -### 🔄 plan/ - 开发计划 57 +- 图片上传失败
58 +- 草稿不能恢复
59 +- 视频卡顿
60 +```
38 61
39 -**用途**: 存放正在进行或计划中的功能开发文档 62 +**或者稍详细版**:
40 63
41 -**包含内容**: 64 +```markdown
65 +# 打卡图片上传失败
42 66
43 -- 功能设计文档 67 +**时间**: 2026-01-28 14:30
44 -- 技术方案讨论 68 +**来源**: 用户微信群 - 张三
45 -- 开发进度跟踪
46 -- API 设计文档
47 69
48 -**示例**: 70 +**问题**:
71 +上传图片时,转圈30秒,最后提示"上传失败",图片需要重新选。
49 72
50 -- 新功能设计方案 73 +**初步想法**:
51 -- 性能优化计划
52 -- 重构方案
53 74
54 -**如何添加**: 75 +- 可能是网络问题
76 +- 需要加重试机制
77 +```
78 +
79 +**就这么简单!** 不需要模板,想到就写。
80 +
81 +**何时整理**: 当相关需求收集得差不多时,整理成正式的 `todo/` 文档。
55 82
56 -1.`plan/` 下创建文档 83 +**详细说明**: 见 `ideas/README.md`
57 -2. 按功能或时间组织
58 -3. 完成后移动到 `done/`
59 84
60 --- 85 ---
61 86
62 -### 📝 todo/ - 待办事项 87 +### 📝 todo/ - 待办任务
63 88
64 -**用途**: 存放**原始需求 + 初步分析**,作为任务的初始记录 89 +**用途**: 存放**整理后、相对完整的**需求文档,等待排期和开发。
65 90
66 **包含内容**: 91 **包含内容**:
67 92
68 -- ✅ 原始需求描述(来自产品/用户反馈/技术债务) 93 +- ✅ 整理后的需求描述
69 -- ✅ 简短的技术评估(复杂度、工作量、风险) 94 +- ✅ 清晰的目标和预期结果
95 +- ✅ 初步技术评估(复杂度、工作量、风险)
70 - ✅ 优先级标记 96 - ✅ 优先级标记
71 -- ✅ 相关资源链接(设计稿、参考文档) 97 +- ✅ 相关资源链接
72 -- ✅ 讨论记录(如果有) 98 +- ❌ 详细技术方案(应在 `plan/`
73 -- ❌ 详细技术方案(应放在 `plan/` 99 +- ❌ API 设计(应在 `plan/`
74 -- ❌ 实现细节(应放在 `plan/`
75 100
76 **文档特点**: 101 **文档特点**:
77 102
...@@ -80,159 +105,217 @@ tasks/ ...@@ -80,159 +105,217 @@ tasks/
80 - **快速评估**: 技术可行性初步判断 105 - **快速评估**: 技术可行性初步判断
81 - **易于决策**: 判断是否要做、何时做 106 - **易于决策**: 判断是否要做、何时做
82 107
83 -**如何使用**:
84 -
85 -1. 新增待办项时,使用模板 `todo/TODO_TEMPLATE.md`
86 -2. 填写核心内容,不要展开技术细节
87 -3. 决定开发后,移到 `plan/` 并详细设计
88 -4. 避免过度设计,还没决定就写太详细
89 -
90 **示例**: 108 **示例**:
91 109
92 ```markdown 110 ```markdown
93 -# 打卡草稿缓存功能 111 +# 优化打卡上传体验
94 112
95 **优先级**: 🟡中 113 **优先级**: 🟡中
96 -**来源**: 用户反馈 114 +**来源**: 多个用户反馈
97 -**提出日期**: 2026-01-28 115 +**日期**: 2026-02-03
98 116
99 ## 需求描述 117 ## 需求描述
100 118
101 -用户反馈打卡过程中,如果意外退出或网络中断,已填写的内容会丢失。 119 +综合最近收到的多个用户反馈:
120 +
121 +1. 图片上传失败率高
122 +2. 上传慢
123 +3. 失败后需要重新选图
102 124
103 ## 期望结果 125 ## 期望结果
104 126
105 -- 打卡内容自动保存 127 +- 上传成功率 > 95%
106 -- 再次进入时可恢复 128 +- 上传时间 < 5 秒
107 -- 提交成功后清除缓存 129 +- 支持失败重传
108 130
109 ## 初步评估 131 ## 初步评估
110 132
111 - 技术复杂度: 中等 133 - 技术复杂度: 中等
112 -- 预估工作量: 2天 134 +- 预估: 3人天
113 -- 涉及模块: 打卡组件、localStorage 135 +- 方向: 七牛云 SDK 优化、重试机制
114 -- 潜在风险: 存储容量限制
115 ``` 136 ```
116 137
117 -**完整模板**: 见 `todo/TODO_TEMPLATE.md`
118 -
119 **何时移到 plan/**: 138 **何时移到 plan/**:
120 139
121 - ✅ 需求已确认,准备开发 140 - ✅ 需求已确认,准备开发
122 - ✅ 需要详细技术设计 141 - ✅ 需要详细技术设计
123 - ✅ 需要排期和资源规划 142 - ✅ 需要排期和资源规划
124 143
144 +**完整模板**: 见 `todo/TODO_TEMPLATE.md`
145 +
125 --- 146 ---
126 147
127 -## 🔄 任务生命周期 148 +### ⚙️ plan/ - 技术方案
128 149
129 -``` 150 +**用途**: 存放正在进行或计划中的功能的**详细技术设计文档**
130 -todo → plan → done
131 - (待办) (计划) (完成)
132 -```
133 151
134 -### 详细流程 152 +**包含内容**:
135 153
136 -1. **新建任务** → 添加到 `todo/` 154 +- 功能需求分析(来自 `todo/`
137 -2. **开始规划** → 移动到 `plan/`,创建设计文档 155 +- 技术方案设计
138 -3. **开发完成** → 移动到 `done/`,记录实现细节 156 +- API 接口设计
157 +- 数据库设计(如需要)
158 +- 实现步骤和时间规划
159 +- 测试方案
139 160
140 ---- 161 +**文档特点**:
141 162
142 -## 📝 文档命名规范 163 +- **详细设计**: 包含技术细节
164 +- **可执行**: 开发者能按方案实施
165 +- **可评审**: 团队可评审方案的可行性
143 166
144 -### 格式 167 +**何时创建**:
145 168
146 -``` 169 +-`todo/` 移过来时
147 -[日期]_[类型]_[简短描述].md 170 +- 决定要开发,需要详细设计时
148 -```
149 171
150 -### 示例 172 +---
151 173
152 -- `20260128_feature_打卡草稿缓存.md` 174 +### ✅ done/ - 已完成任务
153 -- `20260128_bugfix_视频播放器修复.md`
154 -- `20260128_optimize_首页加载优化.md`
155 -- `20260128_refactor_组件拆分.md`
156 175
157 -### 类型标识 176 +**用途**: 存放已完成的功能和任务的**实现记录和总结**
158 177
159 -| 类型 | 说明 | 178 +**包含内容**:
160 -| ---------- | -------- | 179 +
161 -| `feature` | 新功能 | 180 +- 功能实现总结
162 -| `bugfix` | Bug 修复 | 181 +- 技术方案记录
163 -| `optimize` | 性能优化 | 182 +- 遇到的问题与解决方案
164 -| `refactor` | 代码重构 | 183 +- 测试结果
165 -| `docs` | 文档更新 | 184 +- 部署记录
166 -| `config` | 配置变更 | 185 +
186 +**文档特点**:
187 +
188 +- **回顾价值**: 未来可参考
189 +- **经验总结**: 记录踩坑经验
190 +- **知识沉淀**: 团队知识共享
167 191
168 --- 192 ---
169 193
170 -## 🔍 快速查找 194 +## 🔄 工作流示例
171 195
172 -### 查看所有已完成的任务 196 +### 场景:收到用户反馈
197 +
198 +#### 1️⃣ 零碎反馈阶段
173 199
174 ```bash 200 ```bash
175 -ls -1 done/ 201 +# 直接记录,随便写
202 +vim ideas/feedback_20260128.md
176 ``` 203 ```
177 204
178 -### 查看所有计划中的任务 205 +```markdown
206 +## 2026-01-28 用户反馈
179 207
180 -```bash 208 +- 图片上传失败
181 -ls -1 plan/ 209 +- 草稿不能恢复
182 ``` 210 ```
183 211
184 -### 查看所有待办事项 212 +**时间**: 5 分钟
213 +
214 +---
215 +
216 +#### 2️⃣ 需求整理阶段
185 217
186 ```bash 218 ```bash
187 -ls -1 todo/ 219 +# 一两周后,相关反馈收集得差不多了
220 +# 整理成正式需求
221 +vim todo/20260203_优化打卡上传.md
188 ``` 222 ```
189 223
190 -### 搜索特定任务 224 +使用 `TODO_TEMPLATE.md` 模板,填写:
225 +
226 +- 需求描述
227 +- 期望结果
228 +- 初步评估
229 +
230 +**时间**: 15 分钟
231 +
232 +---
233 +
234 +#### 3️⃣ 技术设计阶段
191 235
192 ```bash 236 ```bash
193 -# 搜索关键词 237 +# 决定要做这个功能
194 -find . -name "*.md" | xargs grep -l "关键词" 238 +# 展开为详细技术方案
239 +mv todo/20260203_优化打卡上传.md plan/20260203_优化打卡上传.md
240 +vim plan/20260203_优化打卡上传.md
195 ``` 241 ```
196 242
243 +添加:
244 +
245 +- 详细技术方案
246 +- API 设计
247 +- 实现步骤
248 +- 测试方案
249 +
250 +**时间**: 1-2 小时
251 +
197 --- 252 ---
198 253
199 -## 📊 任务统计 254 +#### 4️⃣ 开发完成
200 255
201 -| 状态 | 数量 | 说明 | 256 +```bash
202 -| --------- | ---- | --------------- | 257 +# 功能开发完成
203 -| ✅ 已完成 | - | 见 `done/` 目录 | 258 +# 移到 done,写实现总结
204 -| 🔄 进行中 | - | 见 `plan/` 目录 | 259 +mv plan/20260203_优化打卡上传.md done/20260203_优化打卡上传.md
205 -| 📝 待办 | - | 见 `todo/` 目录 | 260 +vim done/20260203_优化打卡上传.md
261 +```
262 +
263 +记录:
264 +
265 +- 实现过程
266 +- 遇到的问题
267 +- 解决方案
268 +- 测试结果
269 +
270 +**时间**: 30 分钟
206 271
207 --- 272 ---
208 273
209 -## 💡 使用建议 274 +## 💡 核心原则
275 +
276 +### ideas/ - 快速记录
277 +
278 +-**不要过度整理**: 先记下来,避免遗忘
279 +- 🎯 **不要追求完美**: 有想法就写
280 +- 📝 **不要用模板**: 随便写,能看懂就行
210 281
211 -### 1. 定期清理 282 +### todo/ - 简洁完整
212 283
213 -- **每月**: 检查 `todo/`,删除过时任务 284 +- **需求相对完整**: 不是零碎的
214 -- **每周**: 更新 `plan/` 中的任务进度 285 +- **可以评估决策**: 领导能看懂
215 -- **每季度**: 归档 `done/` 中的旧任务 286 +- **不要太详细**: 详细设计留给 `plan/`
216 287
217 -### 2. 保持更新 288 +### plan/ - 详细可执行
218 289
219 -- 完成任务后立即移动文档 290 +- **技术细节完整**: 开发者能照着做
220 -- 及时更新任务状态 291 +- **经过评审**: 团队达成一致
221 -- 记录关键决策和教训 292 +- **考虑边界情况**: 异常处理、错误流程
222 293
223 -### 3. 团队协作 294 +### done/ - 经验沉淀
224 295
225 -- 使用统一的文档格式 296 +-**记录真实过程**: 包括踩坑
226 -- 明确任务负责人 297 +-**有复用价值**: 未来可参考
227 -- 设置合理的截止日期 298 +-**简洁即可**: 不需要太详细
299 +
300 +---
301 +
302 +## 📊 任务统计
303 +
304 +| 状态 | 数量 | 说明 |
305 +| ------------------ | ---- | --------------- |
306 +| 💡 收集中 (ideas/) | - | 待整理的需求 |
307 +| 📝 待办 (todo/) | - | 等待排期 |
308 +| ⚙️ 进行中 (plan/) | - | 正在开发/计划中 |
309 +| ✅ 已完成 (done/) | - | 已上线 |
228 310
229 --- 311 ---
230 312
231 ## 🔗 相关资源 313 ## 🔗 相关资源
232 314
233 - [项目文档导航](../README.md) 315 - [项目文档导航](../README.md)
234 -- [更新日志](../CHANGELOG.md) 316 +- [文档编写规范](../DOCUMENTATION_STANDARDS.md)
235 -- [开发工作流](../development/WORKFLOW.md) 317 +- [需求收集指南](./ideas/README.md)
318 +- [TODO 模板](./todo/TODO_TEMPLATE.md)
236 319
237 --- 320 ---
238 321
......
1 +# 💡 需求收集箱 (Ideas)
2 +
3 +> 这里记录零碎的需求、反馈、想法,等待整理
4 +
5 +## 📌 用途
6 +
7 +记录**原始的、零碎的**需求和反馈,在整理成正式需求之前。
8 +
9 +## ✅ 适合放这里的内容
10 +
11 +- ✅ 用户反馈的原话(一句话也行)
12 +- ✅ 临时想到的功能点
13 +- ✅ 简短的问题描述
14 +- ✅ 未整理的会议记录
15 +- ✅ 任何不完整的需求
16 +
17 +**特点**
18 +
19 +- 📝 随便写,不需要格式
20 +- 🎯 快速记录,不要过度整理
21 +- 💾 先存下来,避免遗忘
22 +
23 +## 📝 文档格式(建议)
24 +
25 +### 格式1:超简单版
26 +
27 +```markdown
28 +## 2026-01-28 用户反馈
29 +
30 +- 图片上传失败
31 +- 草稿不能恢复
32 +```
33 +
34 +### 格式2:稍详细版
35 +
36 +```markdown
37 +# 打卡图片上传失败
38 +
39 +**时间**: 2026-01-28 14:30
40 +**来源**: 用户微信群 - 张三
41 +
42 +**问题**:
43 +上传图片时,转圈30秒,最后提示"上传失败",图片需要重新选。
44 +
45 +**频率**:
46 +大概有 5 个用户反馈过类似问题。
47 +
48 +**初步想法**:
49 +
50 +- 可能是网络问题
51 +- 可能是七牛云问题
52 +- 需要加重试机制
53 +```
54 +
55 +**就这么简单!** 不需要模板,想到就写。
56 +
57 +---
58 +
59 +## 🔄 后续流程
60 +
61 +当需求收集得差不多时:
62 +
63 +### 1. 整理成 TODO
64 +
65 +```bash
66 +# 1. 合并相关的反馈
67 +# 2. 使用 TODO_TEMPLATE.md 创建正式需求文档
68 +mv ideas/xxx.md TODO/20260128_xxx.md
69 +```
70 +
71 +### 2. 生成技术方案
72 +
73 +```bash
74 +# 决定要做后,移到 plan/
75 +mv TODO/20260128_xxx.md plan/20260128_xxx.md
76 +# 然后展开为详细技术方案
77 +```
78 +
79 +### 3. 实现完成
80 +
81 +```bash
82 +# 完成后移到 done/
83 +mv plan/20260128_xxx.md done/20260128_xxx.md
84 +# 写实现总结
85 +```
86 +
87 +---
88 +
89 +## 💡 使用建议
90 +
91 +### 日常使用
92 +
93 +1. **有需求/反馈** → 直接在 `ideas/` 创建文件记录
94 +2. **每周/每月** → 回顾 `ideas/`,整理相关需求到 `TODO/`
95 +3. **决定开发** → 从 `TODO/` 移到 `plan/`,写详细方案
96 +4. **开发完成** → 移到 `done/`,写总结
97 +
98 +### 命名建议
99 +
100 +- 按时间:`feedback_20260128.md`
101 +- 按主题:`打卡相关反馈.md`
102 +- 按来源:`用户群反馈_张三.md`
103 +
104 +**不用太讲究**,能看懂就行。
105 +
106 +---
107 +
108 +## 📊 统计
109 +
110 +- 当前收集数:X 个
111 +- 已整理成 TODO:Y 个
112 +- 待整理:Z 个
113 +
114 +---
115 +
116 +**最后更新**: YYYY-MM-DD