如何维护有关敏捷环境中当前功能状态的最新文档

Question

敏捷被认为对文档很轻松。在敏捷世界中，最初的需求极有可能根据最终用户输入或设计变化而快速变化。新要求以新用户故事的形式被捕获，这可能是非常短暂的，并且可能在不久的将来发生变化。在这种情况下，很难管理/维护有关任何功能的标准化行为的文档，以便可以引用它以供将来参考。在IT世界中，人们往往会快速行动，并且要弄清楚一年前设计的内容是什么以及原因。如果有任何专家想要分享的信息，那就太棒了。谢谢

Answer 1

将用户文档构建到软件中：软件中的直观用户界面。好的软件是不言自明的。如果需要，请在帮助系统中添加其他文档（工具提示，帮助菜单等）。

在技术方面，将文档保存在自解释代码和代码文档中，在可执行测试中表达功能（从单元测试到验收测试）。将剩余信息放入可轻松更新的Wiki中。自动构建/发布文档站点，并遵循DRY原则：有一件事应该只记录一次，并从那里引用。

关键点：

• 记录需要记录的内容（想想典型用户）。
• 不要记录显而易见的事实。
• 好的软件不言自明。
• 不要重复自己。
• 自动从源代码生成文档。
• 将规格保持为可执行测试的形式。
• 快速丢弃过时的文档。

Answer 2

这取决于你需要什么。没有预定义的规则。敏捷推广轻量级文档以满足需求。但是，建议根据您的具体需求记录您构建的软件片段（用户故事）。

这就是为什么我喜欢'完成定义'的概念。

在您的定义中，您可以指定您需要有关您构建的功能的精心编写的技术文档，包括您选择该功能的原因......

取决于你。

敏捷的力量在于你可以减少浪费。