手册-最新信息？

如果您的产品已经投放市场很长时间了，但仍每天都在积极开发中-手册应该多久更新一次？如果您的用户由于您的组织认为合适而不断更新到最新版本，则最新的错误修复程序始终在出厂版本中。意思是，您可以在某一天修复一个错误，第二天就可以修复该错误。

我将更新手册：

1. 对于每个主要版本，以及
2. 当重要的新功能变得足够稳定和成熟时，您便知道它们不会每隔五分钟更改一次。

只要代码更改会更改手册中的说明，就更新（PDF）手册-只需在发布过程中进行手册更新

如果用户依靠手册来告诉他们如何使用产品，并且产品有所更改，则手册的相关部分也应进行更改是常识

在2010年，我们仍然参考印刷文档吗？为什么？;）

认真地说，文档（“ F1”应用程序帮助，PDF或在线文档）应该成为每个发行版的一部分。零借口。“发布”就是这么简单。事实上，对于IMO，没有任何借口，只要知道并纠正了问题，就不定期（在线和PDF）不定期更新文档（即使是在发行版之间）。它不需要相同级别的质量检查-甚至不需要关闭。

我假设您正在谈论最终用户文档。在@ $$中编写文档是一件很痛苦的事情，尽管我已经开发出一种说服我自己相反的技巧，但是我仍然遇到问题。这是我尝试管理的方式：

将文档更新集成到DoD中（完成的定义）

这将确保您的文档在每个用户故事完成时都保持最新。

这是我们写的完成的定义。我试图保留原始格式，所以您明白了。这是放在白板上的A4页面。

---------- 8 <------------切到这里------------ 8 <----------

面议

“完成”的定义

• 代码具有80％的单元测试覆盖率，已在存储库中提交

• 屏幕截图（如果适用）（1024x728、395x281、170x121和729x329）

• 功能说明（如果适用）（50个字符，100个字符）

• 完整的最终用户文档

• 新文件正确更新

---------- 8 <------------切到这里------------ 8 <----------

当然，您可以在文档中添加审核过程。之所以这样，是因为我们都不是说英语的人。

这样的“完成定义”的优点之一是，您的产品可能会在每个用户故事完成时交付。

结合使用这种技术用这一个。

在我的组织中，我们通常有3种版本：

1. 工程版本-基本上是针对某些特定客户的热修复程序，或者仅是特定客户立即请求的某些功能的修补程序。
2. 次要版本-错误修复，增量支持
3. 主要版本-新功能支持等

根据定义，主要版本必须在线和离线都具有相关的文档。我们的跟踪系统可确保文档在清单中非常重要。

次要版本仅需要有关在用户感知级别上添加的任何新内容的文档。因此，如果您添加了另一种启发式方法，可以在某些特定情况下降低时间复杂度，那么将其放入pdf中可能不是一个重要的要求。

工程发布可以没有文档。一些非正式的使用说明应该足以入门。

该文档应与您要交付给客户的任何软件同步。任何其他不匹配都会给您带来麻烦。如果您没有工作人员，请尝试承包商。找到喜欢的人后，将他留在固定器上。