工具链手册 项目汇报生成流程 7 分钟

项目周报要从 Git 事实写成可展示页面

阶段汇报不是 commit 清单,先同步远端,再按业务主题归纳,最后输出可直接展示的 HTML。

背景

用户要的周报通常不是“过去一周有哪些 commit”,而是能直接拿去沟通的项目进展。Git 事实是来源,不是最终表达。真正有用的汇报要把提交、文件变化和业务影响重新组织成主题。

这次经验的重点是:先拿最新事实,再写成可展示成品,并确认产物是否应该进入 Git。

这次解决了什么

流程要同时满足三件事:

  1. 基于最新远端代码,不用过期本地状态总结。
  2. 按业务主题写,不按 commit 时间流水账。
  3. 生成独立 HTML,并确认它是否被 Git 忽略。

关键过程

第一步是检查工作区、分支和 remote,然后用快进方式同步。这样可以避免无意 merge commit,也能确保统计窗口里的事实是最新的。

第二步拉取时间窗内的 git log、diff stat、文件列表和作者信息。这里不是为了把数据全塞进周报,而是让后续归纳有证据。

第三步按业务主题重写。比如用户已经认可三个业务要点,就围绕这些主题补关键数字、流程、成本和影响,而不是把十几条 commit 平铺出来。

最后才是 HTML。独立汇报页面要有清晰 hero、数字卡片、三段业务内容、流程块和标签摘要;如果放在默认忽略目录,还要用 git check-ignore 确认可见边界。

踩坑

最常见的坑是把“事实采集”当成“汇报完成”。commit 清单很真实,但读者需要的是业务进展、风险和下一步。

另一个坑是验证方式偏离目标。用户要本地 HTML 文件时,优先确认文件存在、内容命中和 Git 忽略状态;没有必要为了每次汇报都拉起复杂浏览器验证。

最后方案

稳定流程是:同步远端,采集 Git 事实,按业务主题改写,生成独立 HTML,确认忽略规则。汇报成品应该能直接展示,而不是需要用户再二次整理。

以后怎么做

以后做周报或阶段总结,先问时间窗和业务关注点。除非用户明确要 commit 明细,否则默认输出主题化成稿。HTML 产物如果只是展示文件,就先确认它是否应该被 Git 跟踪。