如何编写功能规范?

Mem*_*eak 18 specifications functional-specifications

我们总是编写函数或类,它们的逻辑非常复杂.如果没有这些结构的规范,那么即使我们自己也很难掌握这些结构.

你如何编写复杂函数和类的规范?

请告诉我一些你自己的经历,但不只是一些链接,谢谢.

Eri*_* J. 13

我发现功能规范的最大挑战不是直接的格式,而是让它们与驱动它们的东西(需求)和构建它们的东西(测试用例,文档)保持同步.

出于这个原因,我更倾向于使用模型驱动的方法来处理这个问题而不是纸张驱动的方法.

我使用UML建模工具(Sparx Systems的Enterprise Architect,但许多工具也可以工作)在一个地方捕获项目的所有工件,并在它们之间创建可跟踪性.在企业架构师,我可以通过只把它们都在同一图上,并且创建连接器从一个到另一个用鼠标拖动创建从一个需求工件到一个设计伪影(例如)可追溯性.

我的"功能规范"实际上是活动图的集合,系统中每个用例一个.每个用例都与一个或多个需要该用例的要求相关联.即使最终用户也能轻松地按照活动图并验证它们(让最终用户阅读,更不用说理解和验证传统的基于纸张的功能规范有多容易?)

以类似的方式,我可以创建从我的活动图(用例)到特定设计工件(如类图)的可追溯性.

QA可以对测试用例进行建模,并创建从测试用例到用例的可追溯性.这样,我们看看是否有任何用例没有测试用例(或者没有足够的测试用例).

关于Enterprise Architect作为工具的好处是,所有这些工件都存储在SQL数据库中,因此我可以运行一些我随着时间的推移建立的查询,以查找没有跟踪到/来自它们的工件.


use*_*559 12

查看Joel on Software.而在这里.而在这里.甚至还有一个现实世界的例子.

  • 这个例子就是钱. (3认同)

rog*_*pvl 5

您应该研究以下主题(不一定按顺序):

这些是软件项目规范的最常用方法.