编写发行说明的良好做法


Answers:


21

我认为追随者将为良好做法铺平道路

//日期相关

  • 发布日期

//功能相关

  • 新增功能
  • 精选删除
  • 功能已更改

//错误相关

  • 解决的错误
  • 未解决的错误

//依赖关系

  • 依赖清单

//测试相关

  • 单元测试结果
  • 验收测试结果

//与版本控制相关

  • 标签说明
  • 修订号

在某些时候,值得强调的是最终用户可能希望更改其配置或工作流程的内容。

大多数最终用户并不关心测试结果。他们希望它具有高质量,无论发行说明说什么。

关于发行说明,最重要的是要知道,每增加一句话,就会失去另外10%的读者。因此,您必须严格优先考虑当前用户需要了解的版本。


1
它也有一些次值得强调的东西最终用户可能希望在他们的配置或工作流程改变
JK。

@jk。是的,你是对的。我已经将我的回答作为您的好评进行了编辑。
Md Mahbubur Ra​​hman

大多数最终用户并不关心测试结果。他们希望它具有高质量,无论发行说明说什么。
亨里克(Henrik)2012年

@Henrik发行说明可能比终端用户虽然别人有用
JK。

5

关于发行说明,最重要的是要知道,每增加一句话,就会失去另外10%的读者。因此,您必须严格优先考虑当前用户需要了解的版本。


4
每行可能会损失10%的随便的,不感兴趣的(或懒惰的)读者。这些读者不是您的发行说明所针对的读者。那些在乎您所做工作的人将阅读所有内容,并感谢每一条相关的内容-您只需要小心包含确实需要放入文档中的绒毛即可。
gbjbaanb 2012年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.