FavoriteLoading
0

怎样去写一个版本说明 (Release Notes)?

在一个产品的开发过程中,我们需要很多的文档,有些是给最终用户去看的,有些事给内部的产品干系人去看的。在我目前所做的产品中,由于产品本身比较小,所以没有专职的技术写作来帮助我们写一些版本说明,但是又由于我们采用敏捷开发的模式,基本上每三周就需要做一次版本发布, 所以这个艰巨而细致的任务就落到我的头上。所以不得不自学如何写版本说明,今天我就给大家分享下,什么是版本说明?怎样去写一个版本说明?

什么是版本说明 (Release Notes)?

版本说明是一种产品更新,改正,优化,功能增加的文案。主要的目标用户是产品的使用者。经常这个版本说明是由技术写作,产品项目经理,产品开发经理 或者产品经理来撰写的。

版本说明的文档架构是什么?

由于我的角色主要是和内部的干系人沟通,所以我的版本说明主要是针对干系人的。文档架构也是比标准的版本说明省略的不少,当然各家公司的文档架构也会有所不同,根据需要而定。但是一般的标准的版本说明的文档架构,参考如下:

  • 标题:文档名称 (比如: 版本说明),产品名称,版本号,发布日期等
  • 概要: 简明扼要的描述产品的功能更改优化。
  • 目的:版本说明的目的,比如新的功能更新,或者修复的bug等
  • 问题列表:更新,优化的功能列表以及修复的bug列表
  • 重现步骤:如果有bug修复,应该描述之前bug的重现步骤。
  • 解决方案:针对bug的修复方案等。
  • 最终用户的影响: 更新优化功能给最终用户带来的好处,bug修复后性能的提升等。
  • 声明:公司产品的一些标准信息声明,比如法律声明,隐私声明,版权声明等等。
  • 联系信息:提供版本更新的反馈渠道。
怎样去写版本声明呢?
  1. 确认产品的功能更新,改动,增加,bug的修复信息范围等描述,避免使用 新,优化,功能等词语在标题里面。
  2. 根据公司的版本号码规范,确定版本号。
  3. 对有功能更新,改动,增加等,应该直接描述为用户可以做什么,而不是说什么什么功能更加优化等。
  4. 对于功能更新,改动,增加等的位置,最好做个对比,明确告诉用户更新的改动点。比如在在什么模块,什么步骤,改动了什么参数值等等。
  5. 明确告诉用户默认值,True, False, Yes 或者No。
  6. 应该用现在时态,因为当用户看到的时候,功能已经在线了。
版本说明样例

希望这个对大家有所帮助。

支付宝打赏支付宝打赏 微信打赏微信打赏

如果文章对你有帮助,欢迎点击上方按钮打赏作者

暂无评论

发表评论

电子邮件地址不会被公开。 必填项已用*标注

arrow grin ! ? cool roll eek evil razz mrgreen smile oops lol mad twisted wink idea cry shock neutral sad ???

扫码关注语沃世界

扫码关注语沃世界