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 @@
```
tasks/
├── done/ # 已完成的任务
├── plan/ # 进行中和计划中的任务
└── todo/ # 待办事项列表
├── ideas/ # 💡 需求收集(零碎、原始)
├── todo/ # 📝 待办任务(整理后、相对完整)
├── plan/ # ⚙️ 技术方案(详细设计)
└── done/ # ✅ 完成总结
```
## 🔄 任务生命周期
```
ideas(零碎需求) → todo(整理后) → plan(技术方案) → done(完成总结)
```
### 各阶段说明
| 阶段 | 用途 | 文档特点 | 时机 | 预估时间 |
| ---------- | -------- | -------------------- | ---------- | -------- |
| **ideas/** | 需求收集 | 零碎、随便写、随时记 | 收到需求时 | 5 分钟 |
| **todo/** | 待办任务 | 简短、完整、可评估 | 需求整理后 | 15 分钟 |
| **plan/** | 技术方案 | 详细、可执行、可评审 | 决定开发时 | 1-2 小时 |
| **done/** | 完成总结 | 记录、反思、可复用 | 开发完成后 | 30 分钟 |
---
## 📂 各目录说明
### ✅ done/ - 已完成任务
### 💡 ideas/ - 需求收集
**用途**: 存放已完成的功能和任务的详细记录
**用途**: 记录**原始的、零碎的**需求和反馈,在整理成正式需求之前。
**包含内容**:
**适合放这里的内容**:
- 功能实现记录
- 技术方案文档
- 上线总结报告
- ✅ 用户反馈的原话(一句话也行)
- ✅ 临时想到的功能点
- ✅ 简短的问题描述
- ✅ 未整理的会议记录
- ✅ 任何不完整的需求
**示例**:
**特点**:
- 欢迎页布局优化
- 打卡草稿缓存功能
- 视频播放器优化
- 📝 随便写,不需要格式
- 🎯 快速记录,不要过度整理
- 💾 先存下来,避免遗忘
**如何添加**:
完成任务后,将相关文档移动到 `done/` 目录,并更新此索引。
**文档格式示例**:
---
```markdown
## 2026-01-28 用户反馈
### 🔄 plan/ - 开发计划
- 图片上传失败
- 草稿不能恢复
- 视频卡顿
```
**用途**: 存放正在进行或计划中的功能开发文档
**或者稍详细版**:
**包含内容**:
```markdown
# 打卡图片上传失败
- 功能设计文档
- 技术方案讨论
- 开发进度跟踪
- API 设计文档
**时间**: 2026-01-28 14:30
**来源**: 用户微信群 - 张三
**示例**:
**问题**:
上传图片时,转圈30秒,最后提示"上传失败",图片需要重新选。
- 新功能设计方案
- 性能优化计划
- 重构方案
**初步想法**:
**如何添加**:
- 可能是网络问题
- 需要加重试机制
```
**就这么简单!** 不需要模板,想到就写。
**何时整理**: 当相关需求收集得差不多时,整理成正式的 `todo/` 文档。
1.`plan/` 下创建文档
2. 按功能或时间组织
3. 完成后移动到 `done/`
**详细说明**: 见 `ideas/README.md`
---
### 📝 todo/ - 待办事项
### 📝 todo/ - 待办任务
**用途**: 存放**原始需求 + 初步分析**,作为任务的初始记录
**用途**: 存放**整理后、相对完整的**需求文档,等待排期和开发。
**包含内容**:
- ✅ 原始需求描述(来自产品/用户反馈/技术债务)
- ✅ 简短的技术评估(复杂度、工作量、风险)
- ✅ 整理后的需求描述
- ✅ 清晰的目标和预期结果
- ✅ 初步技术评估(复杂度、工作量、风险)
- ✅ 优先级标记
- ✅ 相关资源链接(设计稿、参考文档)
- ✅ 讨论记录(如果有)
- ❌ 详细技术方案(应放在 `plan/`
- ❌ 实现细节(应放在 `plan/`
- ✅ 相关资源链接
- ❌ 详细技术方案(应在 `plan/`
- ❌ API 设计(应在 `plan/`
**文档特点**:
......@@ -80,159 +105,217 @@ tasks/
- **快速评估**: 技术可行性初步判断
- **易于决策**: 判断是否要做、何时做
**如何使用**:
1. 新增待办项时,使用模板 `todo/TODO_TEMPLATE.md`
2. 填写核心内容,不要展开技术细节
3. 决定开发后,移到 `plan/` 并详细设计
4. 避免过度设计,还没决定就写太详细
**示例**:
```markdown
# 打卡草稿缓存功能
# 优化打卡上传体验
**优先级**: 🟡中
**来源**: 用户反馈
**提出日期**: 2026-01-28
**来源**: 多个用户反馈
**日期**: 2026-02-03
## 需求描述
用户反馈打卡过程中,如果意外退出或网络中断,已填写的内容会丢失。
综合最近收到的多个用户反馈:
1. 图片上传失败率高
2. 上传慢
3. 失败后需要重新选图
## 期望结果
- 打卡内容自动保存
- 再次进入时可恢复
- 提交成功后清除缓存
- 上传成功率 > 95%
- 上传时间 < 5 秒
- 支持失败重传
## 初步评估
- 技术复杂度: 中等
- 预估工作量: 2天
- 涉及模块: 打卡组件、localStorage
- 潜在风险: 存储容量限制
- 预估: 3人天
- 方向: 七牛云 SDK 优化、重试机制
```
**完整模板**: 见 `todo/TODO_TEMPLATE.md`
**何时移到 plan/**:
- ✅ 需求已确认,准备开发
- ✅ 需要详细技术设计
- ✅ 需要排期和资源规划
**完整模板**: 见 `todo/TODO_TEMPLATE.md`
---
## 🔄 任务生命周期
### ⚙️ plan/ - 技术方案
```
todo → plan → done
(待办) (计划) (完成)
```
**用途**: 存放正在进行或计划中的功能的**详细技术设计文档**
### 详细流程
**包含内容**:
1. **新建任务** → 添加到 `todo/`
2. **开始规划** → 移动到 `plan/`,创建设计文档
3. **开发完成** → 移动到 `done/`,记录实现细节
- 功能需求分析(来自 `todo/`
- 技术方案设计
- API 接口设计
- 数据库设计(如需要)
- 实现步骤和时间规划
- 测试方案
---
**文档特点**:
## 📝 文档命名规范
- **详细设计**: 包含技术细节
- **可执行**: 开发者能按方案实施
- **可评审**: 团队可评审方案的可行性
### 格式
**何时创建**:
```
[日期]_[类型]_[简短描述].md
```
-`todo/` 移过来时
- 决定要开发,需要详细设计时
### 示例
---
- `20260128_feature_打卡草稿缓存.md`
- `20260128_bugfix_视频播放器修复.md`
- `20260128_optimize_首页加载优化.md`
- `20260128_refactor_组件拆分.md`
### ✅ done/ - 已完成任务
### 类型标识
**用途**: 存放已完成的功能和任务的**实现记录和总结**
| 类型 | 说明 |
| ---------- | -------- |
| `feature` | 新功能 |
| `bugfix` | Bug 修复 |
| `optimize` | 性能优化 |
| `refactor` | 代码重构 |
| `docs` | 文档更新 |
| `config` | 配置变更 |
**包含内容**:
- 功能实现总结
- 技术方案记录
- 遇到的问题与解决方案
- 测试结果
- 部署记录
**文档特点**:
- **回顾价值**: 未来可参考
- **经验总结**: 记录踩坑经验
- **知识沉淀**: 团队知识共享
---
## 🔍 快速查找
## 🔄 工作流示例
### 查看所有已完成的任务
### 场景:收到用户反馈
#### 1️⃣ 零碎反馈阶段
```bash
ls -1 done/
# 直接记录,随便写
vim ideas/feedback_20260128.md
```
### 查看所有计划中的任务
```markdown
## 2026-01-28 用户反馈
```bash
ls -1 plan/
- 图片上传失败
- 草稿不能恢复
```
### 查看所有待办事项
**时间**: 5 分钟
---
#### 2️⃣ 需求整理阶段
```bash
ls -1 todo/
# 一两周后,相关反馈收集得差不多了
# 整理成正式需求
vim todo/20260203_优化打卡上传.md
```
### 搜索特定任务
使用 `TODO_TEMPLATE.md` 模板,填写:
- 需求描述
- 期望结果
- 初步评估
**时间**: 15 分钟
---
#### 3️⃣ 技术设计阶段
```bash
# 搜索关键词
find . -name "*.md" | xargs grep -l "关键词"
# 决定要做这个功能
# 展开为详细技术方案
mv todo/20260203_优化打卡上传.md plan/20260203_优化打卡上传.md
vim plan/20260203_优化打卡上传.md
```
添加:
- 详细技术方案
- API 设计
- 实现步骤
- 测试方案
**时间**: 1-2 小时
---
## 📊 任务统计
#### 4️⃣ 开发完成
| 状态 | 数量 | 说明 |
| --------- | ---- | --------------- |
| ✅ 已完成 | - | 见 `done/` 目录 |
| 🔄 进行中 | - | 见 `plan/` 目录 |
| 📝 待办 | - | 见 `todo/` 目录 |
```bash
# 功能开发完成
# 移到 done,写实现总结
mv plan/20260203_优化打卡上传.md done/20260203_优化打卡上传.md
vim done/20260203_优化打卡上传.md
```
记录:
- 实现过程
- 遇到的问题
- 解决方案
- 测试结果
**时间**: 30 分钟
---
## 💡 使用建议
## 💡 核心原则
### ideas/ - 快速记录
-**不要过度整理**: 先记下来,避免遗忘
- 🎯 **不要追求完美**: 有想法就写
- 📝 **不要用模板**: 随便写,能看懂就行
### 1. 定期清理
### todo/ - 简洁完整
- **每月**: 检查 `todo/`,删除过时任务
- **每周**: 更新 `plan/` 中的任务进度
- **每季度**: 归档 `done/` 中的旧任务
- **需求相对完整**: 不是零碎的
- **可以评估决策**: 领导能看懂
- **不要太详细**: 详细设计留给 `plan/`
### 2. 保持更新
### plan/ - 详细可执行
- 完成任务后立即移动文档
- 及时更新任务状态
- 记录关键决策和教训
- **技术细节完整**: 开发者能照着做
- **经过评审**: 团队达成一致
- **考虑边界情况**: 异常处理、错误流程
### 3. 团队协作
### done/ - 经验沉淀
- 使用统一的文档格式
- 明确任务负责人
- 设置合理的截止日期
-**记录真实过程**: 包括踩坑
-**有复用价值**: 未来可参考
-**简洁即可**: 不需要太详细
---
## 📊 任务统计
| 状态 | 数量 | 说明 |
| ------------------ | ---- | --------------- |
| 💡 收集中 (ideas/) | - | 待整理的需求 |
| 📝 待办 (todo/) | - | 等待排期 |
| ⚙️ 进行中 (plan/) | - | 正在开发/计划中 |
| ✅ 已完成 (done/) | - | 已上线 |
---
## 🔗 相关资源
- [项目文档导航](../README.md)
- [更新日志](../CHANGELOG.md)
- [开发工作流](../development/WORKFLOW.md)
- [文档编写规范](../DOCUMENTATION_STANDARDS.md)
- [需求收集指南](./ideas/README.md)
- [TODO 模板](./todo/TODO_TEMPLATE.md)
---
......
# 💡 需求收集箱 (Ideas)
> 这里记录零碎的需求、反馈、想法,等待整理
## 📌 用途
记录**原始的、零碎的**需求和反馈,在整理成正式需求之前。
## ✅ 适合放这里的内容
- ✅ 用户反馈的原话(一句话也行)
- ✅ 临时想到的功能点
- ✅ 简短的问题描述
- ✅ 未整理的会议记录
- ✅ 任何不完整的需求
**特点**
- 📝 随便写,不需要格式
- 🎯 快速记录,不要过度整理
- 💾 先存下来,避免遗忘
## 📝 文档格式(建议)
### 格式1:超简单版
```markdown
## 2026-01-28 用户反馈
- 图片上传失败
- 草稿不能恢复
```
### 格式2:稍详细版
```markdown
# 打卡图片上传失败
**时间**: 2026-01-28 14:30
**来源**: 用户微信群 - 张三
**问题**:
上传图片时,转圈30秒,最后提示"上传失败",图片需要重新选。
**频率**:
大概有 5 个用户反馈过类似问题。
**初步想法**:
- 可能是网络问题
- 可能是七牛云问题
- 需要加重试机制
```
**就这么简单!** 不需要模板,想到就写。
---
## 🔄 后续流程
当需求收集得差不多时:
### 1. 整理成 TODO
```bash
# 1. 合并相关的反馈
# 2. 使用 TODO_TEMPLATE.md 创建正式需求文档
mv ideas/xxx.md TODO/20260128_xxx.md
```
### 2. 生成技术方案
```bash
# 决定要做后,移到 plan/
mv TODO/20260128_xxx.md plan/20260128_xxx.md
# 然后展开为详细技术方案
```
### 3. 实现完成
```bash
# 完成后移到 done/
mv plan/20260128_xxx.md done/20260128_xxx.md
# 写实现总结
```
---
## 💡 使用建议
### 日常使用
1. **有需求/反馈** → 直接在 `ideas/` 创建文件记录
2. **每周/每月** → 回顾 `ideas/`,整理相关需求到 `TODO/`
3. **决定开发** → 从 `TODO/` 移到 `plan/`,写详细方案
4. **开发完成** → 移到 `done/`,写总结
### 命名建议
- 按时间:`feedback_20260128.md`
- 按主题:`打卡相关反馈.md`
- 按来源:`用户群反馈_张三.md`
**不用太讲究**,能看懂就行。
---
## 📊 统计
- 当前收集数:X 个
- 已整理成 TODO:Y 个
- 待整理:Z 个
---
**最后更新**: YYYY-MM-DD