Major Updates: - ✅ Implemented 4 Claude Code Skills (2600+ lines) - code-review: Security, quality, type checking - test-generator: Auto-generate pytest tests - doc-updater: Auto-update README and API docs - refactor-assistant: Code smell detection - ✅ Implemented 2 Git Hooks (450+ lines) - pre-commit: Auto-format, lint, review - pre-push: Test suite and coverage check - 📚 Complete documentation (20+ files) - Skills READMEs with examples - Optimization roadmap and progress - TODO list with 22 tasks - Quick reference guide - 📊 Progress: 45% → 64% (Phase 1: 20% → 60%) - 💰 ROI: Saving 50.6 hours/month ≈ 6.3 person-days/month Next Steps: - API Designer Skill - Code templates library - Prompt library - GitHub Projects task tracking 🤖 Generated with Claude Code Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
11 KiB
11 KiB
项目进度管理 - 时间线/甘特图快速入门
🎯 目标
使用 GitHub Projects 的时间线视图(类似甘特图)来管理项目进度,实现:
- 📅 可视化任务时间线
- 📊 追踪项目进度
- ⚠️ 识别延期风险
- 🔗 管理任务依赖关系
✅ 已完成配置
你的组织项目已经配置完成,包含:
📊 项目信息
- 项目名称: SDLC Management - Gold Template
- 项目 URL: https://github.com/orgs/BrunoGaoSZ/projects/2
- 项目类型: 组织级别
🎨 自定义字段(11 个)
进度管理字段 ✅
- ✅ Phase (单选) - SDLC 阶段:Requirements, Design, Development, Testing, Deployment, Operations
- ✅ Doc Type (单选) - 文档类型:BRD, PRD, Design, API, Test Case, etc.
- ✅ Document Priority (单选) - P0-Critical, P1-High, P2-Medium, P3-Low
- ✅ Document Status (单选) - Draft, Review, Approved, Implemented, Archived
- ✅ Progress (数字) - 完成进度 0-100%
- ✅ Blocking (文本) - 阻塞因素描述
- ✅ Dependencies (文本) - 依赖的 Issue 编号
日期字段(时间线专用)✅
- ✅ Start Date (日期) - 任务开始日期
- ✅ Target Date (日期) - 计划完成日期
- ✅ Due Date (日期) - 最后期限
- ✅ Actual Completion Date (日期) - 实际完成日期
🚀 快速开始(5 步)
第 1 步:为 Issues 设置字段值
访问项目:https://github.com/orgs/BrunoGaoSZ/projects/2
为现有的 3 个 Issues 设置字段值(建议值):
Issue #1 - BRD-001 用户认证系统需求文档
Phase: Requirements
Doc Type: BRD
Document Priority: P0 - Critical
Document Status: Draft
Progress: 0
Start Date: 2025-01-02
Target Date: 2025-01-15
Due Date: 2025-01-20
Issue #2 - ARCH-001 系统架构设计文档
Phase: Design
Doc Type: Design
Document Priority: P1 - High
Document Status: Draft
Progress: 0
Start Date: 2025-01-16
Target Date: 2025-02-05
Due Date: 2025-02-10
Dependencies: #1
Issue #3 - TC-001 用户登录功能测试用例
Phase: Testing
Doc Type: Test Case
Document Priority: P2 - Medium
Document Status: Draft
Progress: 0
Start Date: 2025-02-06
Target Date: 2025-02-20
Due Date: 2025-02-25
Dependencies: #1, #2
操作方法:
- 在项目看板中点击 Issue 卡片
- 在右侧面板中找到对应字段
- 填入建议的值
第 2 步:创建时间线视图(甘特图)
- 在项目页面,点击当前视图名称(Table)旁边的 "+" 按钮
- 点击 "New view"
- 选择 "Timeline" 作为视图类型
- 命名为 "Project Timeline" 或 "甘特图"
- 点击 "Create"
第 3 步:配置时间线视图
在时间线视图页面,点击右上角的 "⋮" → "Settings"
配置以下选项:
Layout: Timeline ✅
Start date field: Start Date
End date field: Target Date
Zoom level: Week (或 Month)
Show markers: ✅ (显示今天的标记线)
保存设置。
第 4 步:配置分组和着色
在时间线视图中:
方式 A:按阶段分组
Group by: Phase
Color by: Document Priority
效果: 看到各 SDLC 阶段的任务时间线,优先级用颜色标识
方式 B:按人员分组
Group by: Assignees
Color by: Phase
效果: 看到每个人的任务时间线,识别资源冲突
第 5 步:查看甘特图
配置完成后,你会看到类似这样的时间线:
2025年1月 2025年2月
Week 1 Week 2 Week 3 Week 4 Week 1 Week 2 Week 3
Phase: Requirements
┌─────── #1 BRD ──────────┐ [P0-Critical]
Jan 2 → Jan 15 │
└───────────────────────────┘
Phase: Design
┌──────── #2 Architecture ──────────┐ [P1-High]
│ Jan 16 → Feb 5 │
└────────────────────────────────────┘
Phase: Testing
┌──── #3 Test Cases ────┐ [P2-Medium]
│ Feb 6 → Feb 20 │
└────────────────────────┘
📊 进度追踪工作流
日常更新(建议每周)
1. 更新进度字段
# 在 GitHub UI 中
Progress: 0% → 30% → 60% → 100%
2. 更新状态
Document Status: Draft → Review → Approved → Implemented
3. 调整日期(如有延期)
# 如果任务延期,更新 Target Date
Target Date: 2025-01-15 → 2025-01-20
4. 记录阻塞因素
Blocking: "等待架构评审" 或 "缺少测试环境"
生成进度报告(自动化)
# 设置 Token
export GITHUB_TOKEN="your_token"
# 生成报告
python3 scripts/generate-progress-report.py \
--project-id PVT_kwDOAgn-Q84BLjWg \
--output docs/reports/progress-report-$(date +%Y%m%d).md
# 查看报告
cat docs/reports/progress-report-20241230.md
报告内容包括:
- 总体进度统计
- 各阶段状态
- 优先级分布
- 逾期任务警告
- 阻塞任务列表
- 下一步建议
周会使用时间线视图
准备周会:
- 更新所有 Issues 的 Progress 和 Status
- 调整延期任务的日期
- 生成进度报告
- 打开时间线视图
周会演示:
- 按 Phase 分组 - 展示各阶段进度
- 按 Assignees 分组 - 展示人员负载
- 按 Status 分组 - 展示任务状态分布
- 标记逾期任务(显示为红色或过了今天标记线的任务)
- 讨论阻塞因素和依赖关系
🎨 高级技巧
技巧 1:使用多个视图
创建不同用途的视图:
1. "Daily Standup" (Table view)
- Group by: Assignees
- Filter: Status != Implemented
- Sort: Priority (High → Low)
2. "Sprint Timeline" (Timeline view)
- Group by: Phase
- Color by: Priority
- Filter: Start Date >= This Week
3. "Overdue Items" (Board view)
- Group by: Status
- Filter: Due Date < Today AND Status != Implemented
- Color by: Priority
4. "Roadmap" (Roadmap view)
- Group by: Phase
- Zoom: Quarter
技巧 2:关键路径识别
在时间线视图中:
-
筛选 P0/P1 任务
- Filter: Priority = "P0 - Critical" OR "P1 - High"
-
查看依赖链
- 检查 Dependencies 字段
- 确保前置任务在后续任务之前完成
-
标记关键任务
- 使用 Labels 添加 "critical-path" 标签
- 或在 Blocking 字段中注明 "关键路径"
技巧 3:里程碑管理
使用 GitHub Milestones:
# 创建里程碑
gh milestone create "Alpha Release" \
--due-date 2025-02-28 \
--description "Alpha 版本发布" \
--repo BrunoGaoSZ/gold-template
# 关联 Issues 到里程碑
gh issue edit 1 --milestone "Alpha Release" --repo BrunoGaoSZ/gold-template
gh issue edit 2 --milestone "Alpha Release" --repo BrunoGaoSZ/gold-template
# 里程碑会在时间线视图中显示为垂直标记线
技巧 4:批量更新日期
使用 GitHub API 批量设置日期(高级用户):
# TODO: 创建批量更新脚本
# python3 scripts/bulk-update-dates.py --config dates-config.yml
技巧 5:导出数据
# 导出项目数据为 JSON
gh project item-list 2 --owner BrunoGaoSZ --format json > project-data.json
# 或使用进度报告作为周报
python3 scripts/generate-progress-report.py \
--project-id PVT_kwDOAgn-Q84BLjWg \
--output weekly-report.md
📚 视图配置参考
时间线视图配置清单
| 配置项 | 推荐值 | 说明 |
|---|---|---|
| Start date | Start Date | 任务开始日期字段 |
| End date | Target Date | 计划完成日期字段 |
| Zoom level | Week / Month | 按周或按月显示 |
| Group by | Phase / Assignees | 分组方式 |
| Color by | Priority / Status | 着色方式 |
| Show markers | ✅ | 显示今天标记线 |
| Sort | Start Date (Asc) | 按开始日期排序 |
常用筛选器
# 筛选进行中的任务
Filter: Status = "Review" OR Status = "Draft"
# 筛选本月任务
Filter: Start Date >= This Month
# 筛选高优先级
Filter: Priority = "P0 - Critical" OR "P1 - High"
# 筛选逾期任务
Filter: Due Date < Today AND Status != "Implemented"
# 筛选某阶段任务
Filter: Phase = "Development"
🔄 最佳实践
✅ 应该做的
- 每周至少更新一次 Progress 和 Status
- 设置合理的缓冲时间(Target Date 早于 Due Date 5-7天)
- 及时记录 Blocking 因素
- 明确标注 Dependencies
- 使用多个视图从不同角度查看项目
- 定期生成进度报告用于团队沟通
❌ 不应该做的
- 不要设置过于乐观的日期
- 不要长时间不更新进度
- 不要忽略依赖关系
- 不要在一个 Issue 中包含太多内容(保持粒度合理)
- 不要只看一个视图
📋 检查清单
配置完成后,确认以下事项:
- 所有 Issues 都设置了 Start Date 和 Target Date
- 创建了时间线视图并配置正确
- 设置了分组(Group by Phase 或 Assignees)
- 设置了着色(Color by Priority)
- 可以看到任务的时间条(横向条形)
- 今天的标记线可见
- 任务按开始日期正确排列
- 依赖关系已记录在 Dependencies 字段中
- 尝试生成了进度报告
🔗 相关资源
文档
- 完整指南: docs/best-practices/github-projects-timeline-gantt.md
- 项目配置记录: ORGANIZATION-PROJECT-SETUP.md
- 字段快速设置: SETUP-FIELDS.md
脚本工具
- 添加日期字段:
scripts/add-date-fields.py - 生成进度报告:
scripts/generate-progress-report.py - 配置项目字段:
scripts/setup-project-fields.py
GitHub 链接
- 项目看板: https://github.com/orgs/BrunoGaoSZ/projects/2
- 代码仓库: https://github.com/BrunoGaoSZ/gold-template
- Issues: https://github.com/BrunoGaoSZ/gold-template/issues
🎯 下一步行动
-
立即执行(5 分钟)
- 访问项目:https://github.com/orgs/BrunoGaoSZ/projects/2
- 为 3 个现有 Issues 设置日期字段
- 创建时间线视图
-
今天完成(30 分钟)
- 为所有 Issues 设置完整字段值
- 配置 2-3 个不同的视图
- 生成第一份进度报告
-
本周完成
- 创建更多文档 Issues(覆盖所有 SDLC 阶段)
- 设置里程碑
- 建立周会使用时间线视图的习惯
-
持续改进
- 每周更新进度和日期
- 每周生成进度报告
- 根据团队反馈调整视图配置
创建时间: 2024-12-30 适用项目: SDLC Management - Gold Template 维护者: DevOps 团队
需要帮助?
- 查看完整文档:
docs/best-practices/github-projects-timeline-gantt.md - 运行脚本问题:检查 GITHUB_TOKEN 是否设置
- GitHub Projects 问题:访问 https://docs.github.com/en/issues/planning-and-tracking-with-projects