版本管理 on Eric 個人部落格https://chihhung.github.io/Blog/tags/%E7%89%88%E6%9C%AC%E7%AE%A1%E7%90%86/Recent content in 版本管理 on Eric 個人部落格Hugo -- 0.151.0zh-TWMon, 18 May 2026 00:00:00 +0000版本發行說明範本（Release Notes Template）https://chihhung.github.io/Blog/posts/%E6%95%99%E5%AD%B8/templates/deployment/releasenote_template/Mon, 18 May 2026 00:00:00 +0000https://chihhung.github.io/Blog/posts/%E6%95%99%E5%AD%B8/templates/deployment/releasenote_template/<h1 id="版本發行說明範本release-notes">版本發行說明範本（Release Notes）</h1> <blockquote> <p><strong>參照標準</strong>：Keep a Changelog 1.1.0 / SemVer 2.0.0 / ISO/IEC/IEEE 12207:2017（Release Management）<br> <strong>文件用途</strong>：正式記錄每個版本的變更內容，供開發、維運、使用者了解版本差異<br> <strong>適用階段</strong>：部署上線階段（Deployment Phase）— Release Management</p></blockquote> <hr> <h2 id="-章節目錄">📋 章節目錄</h2> <ol> <li><a href="#1-%E6%96%87%E4%BB%B6%E8%B3%87%E8%A8%8A">文件資訊</a></li> <li><a href="#2-%E7%89%88%E6%9C%AC%E6%91%98%E8%A6%81">版本摘要</a></li> <li><a href="#3-%E6%96%B0%E5%A2%9E%E5%8A%9F%E8%83%BDadded">新增功能（Added）</a></li> <li><a href="#4-%E8%AE%8A%E6%9B%B4%E9%A0%85%E7%9B%AEchanged">變更項目（Changed）</a></li> <li><a href="#5-%E4%BF%AE%E5%BE%A9%E9%A0%85%E7%9B%AEfixed">修復項目（Fixed）</a></li> <li><a href="#6-%E6%A3%84%E7%94%A8%E9%A0%85%E7%9B%AEdeprecated">棄用項目（Deprecated）</a></li> <li><a href="#7-%E7%A7%BB%E9%99%A4%E9%A0%85%E7%9B%AEremoved">移除項目（Removed）</a></li> <li><a href="#8-%E5%AE%89%E5%85%A8%E6%80%A7%E4%BF%AE%E5%BE%A9security">安全性修復（Security）</a></li> <li><a href="#9-%E5%B7%B2%E7%9F%A5%E5%95%8F%E9%A1%8Cknown-issues">已知問題（Known Issues）</a></li> <li><a href="#10-%E5%8D%87%E7%B4%9A%E6%8C%87%E5%8D%97">升級指南</a></li> <li><a href="#11-%E7%9B%B8%E5%AE%B9%E6%80%A7%E8%AA%AA%E6%98%8E">相容性說明</a></li> </ol> <hr> <h2 id="1-文件資訊">1. 文件資訊</h2> <h3 id="-範本">📝 範本</h3> <table> <thead> <tr> <th>項目</th> <th>內容</th> </tr> </thead> <tbody> <tr> <td><strong>產品名稱</strong></td> <td>{系統名稱}</td> </tr> <tr> <td><strong>版本號</strong></td> <td>v{MAJOR}.{MINOR}.{PATCH}</td> </tr> <tr> <td><strong>發佈日期</strong></td> <td>{YYYY-MM-DD}</td> </tr> <tr> <td><strong>版本類型</strong></td> <td>Major / Minor / Patch / Hotfix</td> </tr> <tr> <td><strong>發佈人</strong></td> <td>{Release Manager 姓名}</td> </tr> <tr> <td><strong>Git Tag</strong></td> <td>{tag name}</td> </tr> <tr> <td><strong>Build Number</strong></td> <td>#{build}</td> </tr> <tr> <td><strong>對應里程碑</strong></td> <td>{Sprint/Milestone 名稱}</td> </tr> </tbody> </table> <h3 id="-使用說明">📖 使用說明</h3> <ul> <li>版本號遵循 SemVer 2.0.0： <ul> <li><strong>MAJOR</strong>：不相容的 API 變更</li> <li><strong>MINOR</strong>：向後相容的新功能</li> <li><strong>PATCH</strong>：向後相容的 Bug 修復</li> </ul> </li> <li>每次正式發佈（含 Hotfix）都需要 Release Notes</li> <li>Git Tag 與 Build Number 確保可從 Release Notes 追溯到原始碼</li> </ul> <h3 id="-範例">💡 範例</h3> <table> <thead> <tr> <th>項目</th> <th>內容</th> </tr> </thead> <tbody> <tr> <td><strong>產品名稱</strong></td> <td>人力資源管理系統（HRMS）</td> </tr> <tr> <td><strong>版本號</strong></td> <td>v2.1.0</td> </tr> <tr> <td><strong>發佈日期</strong></td> <td>2026-05-20</td> </tr> <tr> <td><strong>版本類型</strong></td> <td>Minor</td> </tr> <tr> <td><strong>發佈人</strong></td> <td>林 DevOps</td> </tr> <tr> <td><strong>Git Tag</strong></td> <td>v2.1.0</td> </tr> <tr> <td><strong>Build Number</strong></td> <td>#489</td> </tr> <tr> <td><strong>對應里程碑</strong></td> <td>Sprint 12</td> </tr> </tbody> </table> <hr> <h2 id="2-版本摘要">2. 版本摘要</h2> <h3 id="-範本-1">📝 範本</h3> <h4 id="概述">概述</h4> <p>{用 2-3 句話描述本版本的核心主題與重要變更}</p>變更日誌範本（CHANGELOG Template）https://chihhung.github.io/Blog/posts/%E6%95%99%E5%AD%B8/templates/project/changelog_template/Mon, 18 May 2026 00:00:00 +0000https://chihhung.github.io/Blog/posts/%E6%95%99%E5%AD%B8/templates/project/changelog_template/<h1 id="變更日誌範本changelog-template">變更日誌範本（CHANGELOG Template）</h1> <blockquote> <p><strong>參照標準</strong>：<a href="https://keepachangelog.com/">Keep a Changelog 1.1.0</a> / <a href="https://semver.org/">Semantic Versioning 2.0.0</a><br> <strong>文件用途</strong>：記錄專案每個版本的顯著變更，讓使用者與開發者了解版本間的差異<br> <strong>適用階段</strong>：專案全生命週期（每次發版皆需更新）</p></blockquote> <hr> <h2 id="-章節目錄">📋 章節目錄</h2> <ol> <li><a href="#1-%E6%96%87%E4%BB%B6%E8%B3%87%E8%A8%8A">文件資訊</a></li> <li><a href="#2-%E6%A0%BC%E5%BC%8F%E8%A6%8F%E7%AF%84">格式規範</a></li> <li><a href="#3-%E8%AE%8A%E6%9B%B4%E9%A1%9E%E5%88%A5%E5%AE%9A%E7%BE%A9">變更類別定義</a></li> <li><a href="#4-%E7%89%88%E6%9C%AC%E7%B7%A8%E8%99%9F%E8%A6%8F%E5%89%87">版本編號規則</a></li> <li><a href="#5-%E6%92%B0%E5%AF%AB%E8%A6%8F%E7%AF%84">撰寫規範</a></li> <li><a href="#6-changelog-%E5%AE%8C%E6%95%B4%E7%AF%84%E6%9C%AC">CHANGELOG 完整範本</a></li> <li><a href="#7-%E8%87%AA%E5%8B%95%E5%8C%96%E7%94%A2%E7%94%9F">自動化產生</a></li> <li><a href="#8-%E9%99%84%E9%8C%84">附錄</a></li> </ol> <hr> <h2 id="1-文件資訊">1. 文件資訊</h2> <h3 id="-範本">📝 範本</h3> <table> <thead> <tr> <th>項目</th> <th>內容</th> </tr> </thead> <tbody> <tr> <td><strong>文件名稱</strong></td> <td>CHANGELOG.md</td> </tr> <tr> <td><strong>位置</strong></td> <td>專案根目錄</td> </tr> <tr> <td><strong>格式</strong></td> <td>Markdown（Keep a Changelog 格式）</td> </tr> <tr> <td><strong>維護者</strong></td> <td>{Release Manager / 開發團隊}</td> </tr> <tr> <td><strong>更新時機</strong></td> <td>每次版本發布（Release）</td> </tr> </tbody> </table> <h3 id="-使用說明">📖 使用說明</h3> <ul> <li>CHANGELOG.md 置於專案根目錄，與 README.md 並列</li> <li>每次 Release 前更新，不是每個 Commit 都記錄</li> <li>記錄「對使用者有意義的變更」，非所有技術細節</li> </ul> <h3 id="-範例">💡 範例</h3> <p>CHANGELOG.md 通常長這樣的開頭：</p> <div class="highlight"> <pre tabindex="0"><code class="language-markdown" data-lang="markdown"># Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).</code></pre> </div> <hr> <h2 id="2-格式規範">2. 格式規範</h2> <h3 id="-範本-1">📝 範本</h3> <div class="highlight"> <pre tabindex="0"><code class="language-markdown" data-lang="markdown"># Changelog All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] ### Added - {新功能描述} ## [{版本號}] - {YYYY-MM-DD} ### Added - {新增功能} ### Changed - {變更項目} ### Deprecated - {即將移除的功能} ### Removed - {已移除的功能} ### Fixed - {修復的問題} ### Security - {安全性修復} [Unreleased]: {repo-url}/compare/v{版本}...HEAD [{版本號}]: {repo-url}/compare/v{前版本}...v{版本}</code></pre> </div> <h3 id="-使用說明-1">📖 使用說明</h3> <ul> <li><strong>[Unreleased]</strong> 區塊永遠在最上方，收集尚未發布的變更</li> <li>發版時將 [Unreleased] 內容移至新版本區塊</li> <li>版本由新到舊排列（最新在最上面）</li> <li>底部的連結區塊提供版本間的 diff 比較連結</li> </ul> <h3 id="-範例-1">💡 範例</h3> <p>見第 6 節完整範本。</p>