发布版本通知
发行说明（英语：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 （页面存档备份，存于互联网档案馆）