智能日报周报生成器 (smart-work-report)
定位
智能工作汇报生成引擎。从 Git 提交记录、任务列表、项目进度等来源自动汇总,生成结构化的日报/周报/项目更新/月报。支持多种汇报模板,告别手工写汇报。
核心能力
- Git 提交汇总:解析
feat/fix/docs/...规范提交,按类别聚合归纳为工作项 - 任务/卡点/计划提取:从逗号或分号分隔的列表快速组织汇报结构
- 文件读取:支持从本地 Git log 文件批量读取提交记录
- 多模板输出:站会日报(daily) / 周报(weekly) / 项目更新(project) / 月报(monthly) 四种模板
- 智能措辞:自动归类提交类型(功能开发/问题修复/架构优化/工程化等),零碎提交归纳为完整工作项
- 灵活输出:可直接打印到终端,或导出为 Markdown 文件
上架信息
- 技能 ID:smart-work-report
- 展示名:智能日报周报生成器
- 分类:效率工具
- 图标:📊
- 入口:
scripts/main.py - 清单文件:
skill.json(供技能商店读取名称/描述/标签/图标) - 最低版本:CodeBuddy 1.0.0
- 触发词:生成日报 / 写周报 / 项目进度汇报 / 工作总结 / 根据 git 提交生成汇报
使用方式
# 日报(站会风格)
python3 scripts/main.py generate --type daily --git-log "fix: 修复登录超时; feat: 新增用户导出功能; docs: 更新API文档"
# 周报(自动归类提交 + 任务补充)
python3 scripts/main.py generate --type weekly --git-log "feat: 完成订单模块; fix: 修复支付回调" --tasks "完成XX模块开发,修复3个bug,参加需求评审" --plans "联调测试,上线评审"
# 项目更新
python3 scripts/main.py generate --type project --project-name "智能档案系统" --progress "后端开发完成80%,前端50%,测试0%" --blockers "测试环境数据未就绪"
# 月报
python3 scripts/main.py generate --type monthly --git-log "feat: ...; refactor: ..." --plans "下月重点:性能压测"
# 从文件读取 Git log,并导出到文件
python3 scripts/main.py generate --type daily --git-file ./git-log.txt --output report.md
命令说明
generate:生成报告(主命令)--type:报告类型daily/weekly/project/monthly,默认daily--git-log:Git 提交记录(分号;或换行分隔,支持 conventional commit 前缀)--git-file:Git log 文件路径(与--git-log二选一,文件优先合并)--tasks:完成的任务列表(逗号/分号分隔)--blockers:卡点/阻碍(逗号/分号分隔)--plans:明日/下周/下月计划(逗号/分号分隔)--project-name:项目名称(project模板用)--progress:进度描述(project模板用)--author:汇报人--team:团队名称--output/-o:输出到 Markdown 文件(不指定则打印到 stdout)
输出模板
日报(站会)
- ✅ 昨日完成(提交 + 任务)
- 📌 今日计划
- 🆘 需要协助
周报
- 一、本周工作总结(按类别聚合)
- 二、关键成果(功能/修复提取)
- 三、遇到的问题
- 四、下周计划
项目更新
- 一、项目进度
- 二、里程碑达成
- 三、风险与卡点
- 四、下一步行动
月报
- 一、月度总览(提交分布统计)
- 二、重点事项
- 三、问题与风险
- 四、下月规划
能力边界(什么场景适合 / 不适合)
✅ 适合
- 有常规 Git 提交记录、任务清单、项目进度,需要快速产出结构化汇报
- 团队周会/站会/月报等固定节奏汇报
- 想把零散 commit 自动归类成"业务语言"给非技术干系人看
❌ 不适合(当前版本搞不定)
- 需要连接真实 Git 仓库自动拉取(本工具只读取你提供的 --git-log 文本或 --git-file 文件,不自动调用 git)
- 需要多人在线协作编辑、历史版本管理(输出是本地 Markdown 文件)
- 需要图表/数据可视化(仅生成文本 Markdown,不画饼图柱状图)
- 需要联网获取 Jira/飞书等平台数据(无外部 API 集成)
- 提交信息完全无 feat/fix/... 前缀时,归类会退化为"按关键词猜测",准确率下降
常见错误与排查(FAQ)
- 报错
找不到 Git log 文件→--git-file给的是相对路径时,请确认当前工作目录;建议用绝对路径。 - 中文在 Windows 终端显示乱码/崩溃 → 工具已内置 UTF-8 兜底(
_safe_print),若仍异常请用-o导出到文件再用编辑器打开。 - 报告里"今日计划"显示"(请补充今日计划)" → 没传
--plans,属正常占位提示,非 bug。 python3命令不存在 → Windows 请用python scripts/main.py ...或py scripts/main.py ...。- 想生成 PDF/Word → 当前只输出 Markdown,可把
.md粘贴进 Typora/Word 另存。
版本
v1.1.0 - 新增可运行 scripts/main.py 脚本、月报模板、文件读取、Markdown 导出,统一命令与参数;补能力边界与 FAQ,符合 CodeBuddy Skills 规范(YAML frontmatter + scripts/ 结构)