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

Question

敏捷应该是轻量级的文档。在敏捷的世界中，最初的需求很可能会基于最终用户的输入或设计中的变化而变化得非常快。新需求以新用户故事的形式被捕获，这同样可能是非常短暂的，并可能在不久的将来发生变化。在这种情况下，很难管理/维护有关任何功能的标准化行为的文档，以便将来可以参考它。在IT世界中，人们有时往往行动迅速，弄清楚一年前的设计是如何设计的以及为什么会变得很有挑战性。如果有任何信息专家想要分享这一点，那就太好了。谢谢

Answer 1

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

在技术方面，将文档保存在自解释代码和代码文档中，在可执行测试(从单元测试到验收测试)中表达功能。将多余的信息放在一个可以很容易更新的wiki中。自动构建/发布文档站点，并遵循DRY原则:一件事应该只记录一次，并从那里引用。

要点：

• 很好地记录了需要记录的内容(考虑典型用户)，而
• 没有记录明显的内容。好的软件是self-explanatory.
• Do
• ，不要重复自己。
• 以可执行测试的形式从源代码automatically.
• Keep规范生成文档。
• 快速丢弃陈旧的文档。

Answer 2

这取决于你需要什么。没有预定义的规则。敏捷促进轻量级文档的需求。但是，建议根据您的特定需求来记录您构建的软件切片(用户故事)。

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

在您的定义中，您可以指定您需要关于您构建的功能的良好编写的技术文档，包括为什么选择它以及……

由你决定。

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