首页 休闲单机 正文

假如我来做主:如果我可以改变更新日志你会支持吗?

更新日志这东西,我跟你们它就是给内部代码猴子看的“自嗨”记录,普通用户谁看得懂?我之前接手一个老项目,几个月没碰,想看看更新了翻了半天,完全就是一堆机器码在吵架。什么“修复了#1234上的NPE问题”,或者干脆就是一行“refactor and improvement”。

假如我来做主:如果我可以改变更新日志你会支持吗?

本站为89游戏官网游戏攻略分站,89游戏每日更新热门游戏,下载请前往主站地址:www.gm89.me

我当时就炸毛了,这不是扯淡吗?连我自己都看不明白,还指望用户能理解?我寻思着,假如我来做主,这事儿必须改。我得动手搞一个真正有用的更新日志标准。

下定决心:看了一百份日志找毛病

我这个实践是怎么开始的?我跑去Gitee和GitHub上,扫了起码一百个项目的更新日志。从大厂的到个人的,我一个一个点进去看。我找核心问题:更新日志根本不是写给人的,它是堆砌提交记录,给开发者自己留个底儿。

  • 问题一:全是英文缩写和黑话,NPE、Refactor、WIP,你当用户是你的同事吗?
  • 问题二:分类混乱,一个版本里又是修Bug又是加功能的,全混在一个列表里,找东西像淘金。
  • 问题三:动不动就贴Commit Hash,那玩意儿除了能回滚,对理解更新有啥帮助?屁用没有。

我拍板决定,我自己的项目,以后谁爱怎么写怎么写,但我得自己动手重新制定一套新标准。就是要让一个不碰代码的运营也能读懂。

动手改造:我把日志写成了故事

我拉起了一个私有仓库,从头设计了一套流程,我把它叫“人话日志”:

第一步: 我砍掉了所有技术术语,要求必须用大白话。比如,“修复了登录页面,密码输入框有时候会消失的毛病。”多好理解!谁都能看明白。

第二步: 我硬性划分了三个大类,逼着自己每次更新都得归类:

  • 新功能 (用加粗表示,让用户一眼看到惊喜)
  • 优化与调整 (那些看不见的跑腿活儿,但有必要提一下)
  • 缺陷修复 (必须指出是哪个功能出了错,让用户心里有数)

第三步: 我写了一个小小的钩子脚本(一个强制工具),部署到我个人的Git环境里。只要提交信息里没有用我定义的那几个前缀(例如:[功能]、[优化]、[修补]),直接拒绝提交!没得商量。想提交?回去重写!

结果反馈:从抱怨到真香

最开始推进的时候,简直是灾难!项目组里那几个小子骂声一片,说我多此一举,浪费时间,逼着他们多打几个字,抱怨声能淹死人。

但是过了两个版本,效果就立竿见影了。

以前用户问:“这回更新到底干了”项目组的人得翻代码,看半天。只要甩出这份新的“人话日志”,一分钟就能搞定。新的日志读起来就像在看一篇小故事,清楚明白。这个实践走下来,我得出一个不是日志不能写是没人想承担这个写“好”的责任。如果大公司也能像我这样,强制要求把更新日志写得像人话,你们会支持吗?

相关推荐