README.md 4.46 KB

📋 任务管理

此目录包含项目任务管理的相关文档。

📁 目录结构

tasks/
├── done/      # 已完成的任务
├── plan/      # 进行中和计划中的任务
└── todo/      # 待办事项列表

📂 各目录说明

✅ done/ - 已完成任务

用途: 存放已完成的功能和任务的详细记录

包含内容:

  • 功能实现记录
  • 技术方案文档
  • 上线总结报告

示例:

  • 欢迎页布局优化
  • 打卡草稿缓存功能
  • 视频播放器优化

如何添加: 完成任务后,将相关文档移动到 done/ 目录,并更新此索引。


🔄 plan/ - 开发计划

用途: 存放正在进行或计划中的功能开发文档

包含内容:

  • 功能设计文档
  • 技术方案讨论
  • 开发进度跟踪
  • API 设计文档

示例:

  • 新功能设计方案
  • 性能优化计划
  • 重构方案

如何添加:

  1. plan/ 下创建文档
  2. 按功能或时间组织
  3. 完成后移动到 done/

📝 todo/ - 待办事项

用途: 存放原始需求 + 初步分析,作为任务的初始记录

包含内容:

  • ✅ 原始需求描述(来自产品/用户反馈/技术债务)
  • ✅ 简短的技术评估(复杂度、工作量、风险)
  • ✅ 优先级标记
  • ✅ 相关资源链接(设计稿、参考文档)
  • ✅ 讨论记录(如果有)
  • ❌ 详细技术方案(应放在 plan/
  • ❌ 实现细节(应放在 plan/

文档特点:

  • 简洁明了: 3-5 分钟能看完
  • 重点突出: 核心需求和目标
  • 快速评估: 技术可行性初步判断
  • 易于决策: 判断是否要做、何时做

如何使用:

  1. 新增待办项时,使用模板 todo/TODO_TEMPLATE.md
  2. 填写核心内容,不要展开技术细节
  3. 决定开发后,移到 plan/ 并详细设计
  4. 避免过度设计,还没决定就写太详细

示例:

# 打卡草稿缓存功能

**优先级**: 🟡中
**来源**: 用户反馈
**提出日期**: 2026-01-28

## 需求描述

用户反馈打卡过程中,如果意外退出或网络中断,已填写的内容会丢失。

## 期望结果

- 打卡内容自动保存
- 再次进入时可恢复
- 提交成功后清除缓存

## 初步评估

- 技术复杂度: 中等
- 预估工作量: 2天
- 涉及模块: 打卡组件、localStorage
- 潜在风险: 存储容量限制

完整模板: 见 todo/TODO_TEMPLATE.md

何时移到 plan/:

  • ✅ 需求已确认,准备开发
  • ✅ 需要详细技术设计
  • ✅ 需要排期和资源规划

🔄 任务生命周期

todo → plan → done
 (待办)  (计划)  (完成)

详细流程

  1. 新建任务 → 添加到 todo/
  2. 开始规划 → 移动到 plan/,创建设计文档
  3. 开发完成 → 移动到 done/,记录实现细节

📝 文档命名规范

格式

[日期]_[类型]_[简短描述].md

示例

  • 20260128_feature_打卡草稿缓存.md
  • 20260128_bugfix_视频播放器修复.md
  • 20260128_optimize_首页加载优化.md
  • 20260128_refactor_组件拆分.md

类型标识

类型 说明
feature 新功能
bugfix Bug 修复
optimize 性能优化
refactor 代码重构
docs 文档更新
config 配置变更

🔍 快速查找

查看所有已完成的任务

ls -1 done/

查看所有计划中的任务

ls -1 plan/

查看所有待办事项

ls -1 todo/

搜索特定任务

# 搜索关键词
find . -name "*.md" | xargs grep -l "关键词"

📊 任务统计

状态 数量 说明
✅ 已完成 - done/ 目录
🔄 进行中 - plan/ 目录
📝 待办 - todo/ 目录

💡 使用建议

1. 定期清理

  • 每月: 检查 todo/,删除过时任务
  • 每周: 更新 plan/ 中的任务进度
  • 每季度: 归档 done/ 中的旧任务

2. 保持更新

  • 完成任务后立即移动文档
  • 及时更新任务状态
  • 记录关键决策和教训

3. 团队协作

  • 使用统一的文档格式
  • 明确任务负责人
  • 设置合理的截止日期

🔗 相关资源


最后更新: 2026-01-28