幫產品加分的 Changelog 要怎麼寫? | Star Rocket Blog
我們在上一篇文章〈嗨產品人,我們可以有一份認真的 Changelog 嗎?〉說到規模不同的組織在處理 changelog 的方式不太一樣,也探究了為什麼大型科技公司愛用「bug fixes and performance improvements」公式的為難之處,不過對新創公司來說,changelog 的價值和威力其實很龐大。接著我繼續分享實務上如何寫 changelog,還有把 changelog 寫好的訣竅。
立即分享到: Facebook Twitter LinkedIn 更多 我們在上一篇文章 〈嗨產品人,我們可以有一份認真的 Changelog 嗎?〉 說到規模不同的組織在處理 changelog 的方式不太一樣,也探究了為什麼大型科技公司愛用「bug fixes and performance improvements」公式的為難之處,不過對新創公司來說,changelog 的價值和威力其實很龐大。接著我繼續分享實務上如何寫 changelog,還有把 changelog 寫好的訣竅。 首先,誰是 changelog 的目標受眾?他們為什麼要看 changelog?這兩個關鍵問題決定了 changelog 的模樣。 1 我發現,理想上 changelog 要為不同需求程度的受眾所設計,否則也只是雜訊,尤其身處注意力稀缺的時代,高品質的 changelog 才能幫助開發者和受眾溝通。所以一個產品的 changelog 應該有兩份,發揮「安內攘外」的作用: 對外的 changelog:以客戶價值為中心,寫使用者關心、有興趣的事就好 對內的 changelog:全面完整、具體而微,為開發者量身打造。 除此之外,一份健康的 changelog 也取決於骨骼和肌肉的建構——框架要正,比例要均衡。 怎麼寫出好的 changelog? 資深工程師 Olivier Lacan 因為曾吃過 cha
related reading
- 嗨產品人,我們可以有一份認真的 Changelog 嗎? | Star Rocket Blogblog.starrocket.io
- 11 Best Practices for Changelogsgetbeamer.com
- Keep a Changelogkeepachangelog.com
- Startups, Write Changelogslinear.app
- What actually makes you senior (Changelog News #172)changelog.com
- How to Write Better Release Notes for SaaSgetbeamer.com
- sbensu: How to: friction logsblog.sbensu.com
- Conventional Commitsconventionalcommits.org
- Writing commit messageschiark.greenend.org.uk
- 【PM總動員】理想與現實 — 產品路線圖(Product Roadmap)如何應用於日常工作中?medium.com
- GitHub - conventional-changelog/conventional-changelog: Generate changelogs and release notes from a project's commit messages and metadata.github.com
- Writing great blog postsblog.austn.io