免費發布說明產生器

什麼是發布說明？

發布說明是產品新版本變更的簡短摘要：包含新功能、改進與修復，讓讀者了解現在能做些什麼。發布說明產生器能將團隊現有的原始清單（如提交訊息或工單）轉換為摘要，讓說明能隨版本同步發布，而非延遲一週。

好的發布說明會告訴客戶更新對他們有何意義。提交訊息則是告訴開發人員程式碼變更了什麼。我們的工作就是將兩者進行轉換。

發布說明還是更新日誌？

人們對這些詞彙的定義較為寬鬆。一個實用的區分方式：

此工具也可用作更新日誌產生器：為每次發布產生說明，並將其加到更新日誌頁面的最上方。

發布說明應包含的內容

• 標題包含產品與版本： 「Acme Analytics 3.2 發布說明」。
• 一行摘要： 讀者最關心的一兩個變更。
• 新增、改進、修復： 按此順序排列，並省略空白區塊。
• 以效益為優先的條列式重點： 使用者現在能做什麼，而非程式碼做了什麼。
• 重大變更： 明確指出使用者必須採取的具體行動。
• 連結： 針對需要解釋的內容，連結至說明文章或影片。

發布說明範例

三個提交訊息：「feat: export reports to CSV」、「fix: dashboard timezone off by one hour」與「chore: bump dependencies」，可以變成：

Acme Analytics 3.2
您現在可以隨時隨地匯出報表，儀表板的時間顯示也更準確了。

新增

• CSV 匯出： 將任何報表下載為 CSV 檔案，以便在 Excel 或 Google Sheets 中開啟。

修復

• 儀表板時間： 圖表現在能正確使用您的時區。

依賴項更新被排除在客戶版本之外，因為使用者不會察覺。內部版本則會保留此項。

如何為產生器準備變更內容

您不需要先整理清單，但養成幾個習慣能產生更好的說明。請每行貼上一則變更，無論是提交訊息、工單標題或句子。若您有使用「feat:」或「fix:」等慣用前綴，請保留它們；這有助於將變更歸類為新增或修復。為晦澀的項目增加一點背景說明，例如「fix: export (CSV was empty for large reports)」。填入產品名稱與版本，讓標題準備好發布。若您需要兩種版本，請執行兩次：一次針對客戶，一次針對內部團隊。

發布說明的最佳實踐

為產品使用者撰寫

「報表載入速度更快」勝過「優化查詢規劃器」。請使用介面上顯示的功能名稱。

以最重要的內容為開頭

將大多數人會注意到的變更放在最前面。小修復可以放在最後，每項一行即可。

展示新功能

新功能的截圖或短片比一段文字更有說服力。連結到解釋該功能的說明文章。

按時發布並讓使用者容易找到

將所有發布內容保留在同一個更新日誌頁面上，最新內容置頂，讓客戶與客服團隊隨時知道去哪裡查看。

常見的發布說明錯誤

• 直接貼上包含工單編號與術語的原始提交紀錄。
• 將重大變更隱藏在清單中間。
• 在客戶說明中列出所有內部變更。
• 承諾發布中未包含的日期或功能。

產生器僅包含您清單中的變更，不會添加您未提供的日期，但在發布前請務必檢查每一項內容。