發行說明(英語:release notes),又稱為發行版本說明、版本說明、版本資訊、發行註記、發佈版本通知、發佈通知,是指當軟體有版本發佈(release)時,一併附在說明文件上藉以說明軟體內容、變更的說明文件。
概述
對軟體使用者而言,發行說明是一個重要的版本控制工具,能藉此了解新舊版本版本在功能上的變化、與差異,以決定是否安裝此一新版本、或是沿用舊版本。
發佈通知的內容
以實務上來說,發行說明的內容包含以下幾項:
- 新功能(What's New in XXX)
- 硬/軟體需求(System Requirements)
- 安裝程-{}-序(Installing)
- 解除安裝程-{}-序(Uninstalling)
- 已知問題(Known Issues)
- 故障排除方式(Troubleshooting)
- 常見問題(FAQ,Frequently Asked Questions)
常見軟體的發行說明
- [http://www.mozilla.com/en-US/firefox/releases/ Firefox Releases]
- [https://docs.postgresql.tw/appendixes/release-notes PostgreSQL 正體中文使用手冊 E. 版本資訊]
參見
- 變更日誌;}-(Changelog)
- 組態管理}-
- 終端使用者授權合約;}-
- README
- 發佈管理
- 軟件版本週期;}-
- release candidate
- 服務條款
延伸閱讀
- 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)
- Casey Newton. I drank beer and wrote release notes with the Medium release notes team, The Verge (2016-02-10)
- GNU coding standards - [https://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs 6.8 Change Logs]
參考資料
外部連結
- [http://blog.davingranroth.com/2010/03/how-to-write-release-notes/ How to write release notes]
- [https://stackoverflow.com/questions/638423/how-should-release-notes-be-written How should release notes be written?] (Stackoverflow)
- [https://spectrum.ieee.org/tech-talk/telecom/internet/the-art-of-writing-app-release-notes The Strange Art of Writing App Release Notes]
- [https://github.com/release-notes Release Notes Hub] (also https://www.release-notes.com ) open-source on GitHub
- [https://github.com/release-notes/release-notes-spec Release Notes Schema Specification]
评论 (0)