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

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改善这个问题吗？更新问题，以便可以通过 editing this post 用事实和引文回答问题.

4年前关闭。




Improve this question




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

Answer 1

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

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

关键点:

记录好需要记录的内容(想想典型用户)。

不要记录显而易见的事情。

好的软件是不言自明的。

不要重复自己。

自动从源代码生成文档。

以可执行测试的形式保留规范。

快速扔掉过时的文档。