一人工程 · solus opus

← 全部作品

一人工程release-notessolorelease

solo engineer 没有 release notes,我想写就写

团队有 release notes。

每版本一篇文章:什么新功能、什么 bug 修复、什么 breaking change、什么升级指南。GitHub release、App Store release notes、changelog.io、what's new page。

格式统一:Added / Changed / Fixed / Removed / Security。订阅 RSS、邮件订阅、推特公告。

solo engineer 没有 release notes。

commit message 就是 release notes。

我每次 commit 写一行 message:Add no-perf-dashboard essay。这个 commit 就是我的 release notes。每个 commit 一个功能、一个修复、一篇散文——commit message 描述清楚就够了。

我没 upgrade guide 的必要——访问者点开 /works/no-perf-dashboard 直接看散文。我没 what's new page 的必要——主页就是 what's new。我没推特公告的必要——访问者关注我的 commit log。

团队的 release notes 价值是「让用户知道版本变化」。前提是用户量大、需要主动告知、breaking change 多。solo engineer 没这个问题——我的 commit log 就是 release log。

一人工程的 release notes = git log。不是 200 行 markdown。