📋 Changelog 產生器

依 Keep a Changelog 格式建立結構化版本日誌。管理多個版本、將變更分類為 Added、Changed、Deprecated、Removed、Fixed、Security，即時預覽 Markdown，並匯出含 CHANGELOG.md 與 data.json 的 ZIP 壓縮檔。

什麼是更新日誌產生器？

更新日誌產生器依 Keep a Changelog 格式，協助你建立結構化的版本更新日誌（changelog）。你可以管理多個版本，把每項變更分類為 Added（新增）、Changed（變更）、Deprecated（棄用）、Removed（移除）、Fixed（修復）、Security（安全），產出清楚一致的 CHANGELOG。

一份維護良好的 changelog，能讓使用者與團隊快速了解「這版改了什麼」，是開源專案與產品發布的好習慣。

適用情境

如何使用

  1. 新增一個版本（含版本號與日期）。
  2. 把各項變更歸類到對應類別（Added、Fixed 等）。
  3. 重複管理多個版本，由新到舊排列。
  4. 匯出符合 Keep a Changelog 格式的內容。

使用技巧

名詞解釋

Changelog
依版本記錄專案變更內容的文件。
Keep a Changelog
一套廣為採用的 changelog 撰寫格式規範。
語意化版本（SemVer）
以 主.次.修 表示版本、反映變更程度的規範。

常見問題 FAQ

什麼是 Keep a Changelog 格式？

Keep a Changelog 是一套維護版本日誌的慣例，以易讀的格式記錄每個版本的重要變更。版本以倒序排列（最新版在最上面），變更依性質分為六類：Added（新增功能）、Changed（現有功能的修改）、Deprecated（即將棄用）、Removed（已移除功能）、Fixed（Bug 修正）、Security（安全性修補）。這個格式廣泛應用於開源專案，對人與機器都友善。

如何匯出後再重新匯入繼續編輯？

點擊「匯出 ZIP」可下載包含 CHANGELOG.md（格式化輸出）和 changelog-data.json（原始結構化資料）的壓縮檔。若要繼續編輯先前的版本日誌，點擊「匯入 JSON」並選取 changelog-data.json 檔案，工具會完整還原所有版本及其分類項目。注意：匯入功能僅支援 JSON 資料檔，不支援直接匯入 CHANGELOG.md 檔案。

版本號應該如何命名？

Keep a Changelog 格式最適合搭配語意化版本號（SemVer）使用：MAJOR.MINOR.PATCH。MAJOR 代表不相容的 API 變更，MINOR 代表向下相容的新功能，PATCH 代表向下相容的 Bug 修正。尚未發佈的變更建議使用「Unreleased」作為版本名稱。正式發佈時，將「Unreleased」改為版本號（如 1.2.0）並填入發佈日期。

我的變更應該歸入哪個分類？

Added：新增使用者可以使用的功能；Changed：修改現有功能的行為；Deprecated：功能仍可用但已規劃在未來版本移除；Removed：在此版本完全移除的功能；Fixed：修正原本有問題的行為；Security：修補安全性漏洞（即使同時符合其他分類也建議標記為 Security）。若一個變更同時符合多個分類，選擇最能描述其主要目的的分類。

Keep a Changelog 是什麼？

一套廣為採用的更新日誌撰寫規範，建議把變更分類為 Added、Changed、Deprecated、Removed、Fixed、Security，並由新到舊列出版本，讓 changelog 清楚一致。

變更該怎麼分類？

新增功能歸 Added、既有功能調整歸 Changed、即將移除歸 Deprecated、已移除歸 Removed、修 bug 歸 Fixed、安全性相關歸 Security。

資料會上傳嗎？

不會。changelog 在你的瀏覽器本機產生，內容不會上傳或儲存。

要搭配版本號嗎？

建議遵循語意化版本（SemVer，主.次.修），讓版本號反映變更程度，並在 changelog 對應每個版本的內容。