發佈版本通知
發行說明(英語:release notes),又稱為發行版本說明、版本說明、版本資訊、發行註記、發佈版本通知、發佈通知,是指當軟件有版本發佈(release)時,一併附在說明文件上藉以說明軟件內容、變更的說明文件。
概述
對軟件用戶而言,發行說明是一個重要的版本控制工具,能藉此了解新舊版本版本在功能上的變化、與差異,以決定是否安裝此一新版本、或是沿用舊版本。
發佈通知的內容
以實務上來說,發行說明的內容包含以下幾項:
- 新功能(What's New in XXX)
- 硬/軟件需求(System Requirements)
- 安裝程序(Installing)
- 解除安裝程序(Uninstalling)
- 已知問題(Known Issues)
- 故障排除方式(Troubleshooting)
- 常見問題(FAQ,Frequently Asked Questions)
常見軟件的發行說明
參見
延伸閱讀
- Laura Moreno et al. ARENA: An Approach for the Automated Generation of Release Notes, IEEE Transactions on Software Engineering (Volume: 43, Issue: 2, Feb. 1 2017)[1]
- Casey Newton. I drank beer and wrote release notes with the Medium release notes team, The Verge (2016-02-10)[2]
- GNU coding standards - 6.8 Change Logs (頁面存檔備份,存於互聯網檔案館)
參考資料
- ^ Moreno, L.; Bavota, G.; Penta, M. D.; Oliveto, R.; Marcus, A.; Canfora, G. ARENA: An Approach for the Automated Generation of Release Notes. IEEE Transactions on Software Engineering. February 2017, 43 (2): 106–127. ISSN 1939-3520. doi:10.1109/TSE.2016.2591536 .
- ^ Newton, Casey. I drank beer and wrote release notes with the Medium release notes team. The Verge. 2016-02-10 [2021-04-05]. (原始內容存檔於2023-02-17) (英語).
外部連結
- How to write release notes (頁面存檔備份,存於互聯網檔案館)
- How should release notes be written? (頁面存檔備份,存於互聯網檔案館) (Stackoverflow)
- The Strange Art of Writing App Release Notes (頁面存檔備份,存於互聯網檔案館)
- Release Notes Hub (頁面存檔備份,存於互聯網檔案館) (also https://www.release-notes.com (頁面存檔備份,存於互聯網檔案館)) open-source on GitHub
- Release Notes Schema Specification (頁面存檔備份,存於互聯網檔案館)