documentation - 用例文档的详细程度

Question

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












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

3年前关闭。




Improve this question




我正在努力规范我的项目并在开始时创建愿景/范围文件。其中包括用例图。仅仅列出用例确实帮助我充分了解客户要求的所有要求，并且它已经打开了对话框。

我想知道用例应该有多详细。如果我正在制作一个 Web 应用程序并且用户将登录查看报告，我是否在用例描述中列出报告中的所有列？

如果没有，那么我什么时候可以记录这些细节？

Answer 1

我工作的用例是从用户的角度对应用程序的描述。在那个层面上，它是非常详细的。因此，在您的报告示例中，用例将描述报告的布局、显示的数据、显示的顺序等。用例没有告诉您数据的获取方式或来源。

另一种看待它的方式是考虑将用例交给测试人员。他们可以测试文档中的任何内容(黑盒测试)并将其注册为缺陷。因此，如果应该在某些条件下显示某些数据，则应在您的用例中指定该情况，以便对其进行测试。

您可能想要创建以完成图片的其他文档是我们所说的 SAD(软件架构文档)和 NFR(非功能需求)。 SAD 将从软件设计的角度描述您将如何对解决方案进行编程、您将使用哪些技术以及需要哪些算法。 NFR 将包括诸如从软件或硬件中断中恢复、响应时间等内容。