Skip to content

需求文档化

文档化需求的原因 重点

软件开发的子任务与人员(可能包含:用户、项目管理者、设计和开发人员、测试人员、文档编写人员和维护人员)之间存在着错综复杂的关系,需要进行大量的沟通与交流。而软件需求作为项目中最需要进行广泛交流的内容之一,必须通过文档化来建立共识并标准化需求。

用例文档

用例文档从用户的角度、以用例文本为主描述软件系统与外界的交互。在现代软件开发中,用例文档的地位越来越重要。下面是用例文档的一个模板

Screen Shot 2024-06-17 at 5.04.37 PM

软件需求规格说明文档

软件需求规格说明文档从软件产品的角度、以系统级需求列表的方式描述软件系统解决方案。下面是软件需求规格说明文档的一个大概的模板,具体还需根据项目类型进行调整

Screen Shot 2024-06-17 at 5.06.09 PM

需求文档的写作要点 重点

基本技术文档的写作要遵循以下要点:

  • 简洁:平铺直叙,尽量使用简单句而非长难句,避免使用复杂的形容词和副词。

  • 精确:需要消歧义,消除模糊词汇。

  • 易读:使用引言、目录、索引等。使用系统化的方式来组织内容信息。

  • 易修改:对于冗余的信息可以使用引用来简化。

特别地,需求文档的写作还需遵循以下要点:

  • 使用用户术语:保证对用户易读,尽可能少使用计算机术语。

  • 可验证:需求应当是可以验证的。若某需求不可验证,则可能因为描述过于抽象或模糊不清。应该把模糊的部分转为可以量化的标准。

  • 可行性:开发人员需要检查需求的可行性。在检查过程中可能还将开展一系列分析,甚至设计原型。

此外,软件需求规格说明文档还需要做到:

  • 充分利用标准的文档模板

  • 保持文档内需求集的完备性和一致性。若有未下定论的需求,需要用 TBD 标注出来。

  • 为需求划分优先级

需求验证

为需求开发测试用例

在需求开发完成之后,测试人员就可以以需求为基础开发系统测试用例(主要是功能测试),这些测试用例将在软件系统实现之后的测试阶段得到执行。为需求开发测试用例的过程中也可以发现软件需求规格说明文档的缺陷与问题,因此,这属于需求验证的一种方法(还可以通过评审需求度量)。

开发测试用例的步骤 重点

为需求开发测试用例的步骤一般有两个:

  • 以需求为线索,开发测试用例套件;
  • 使用测试技术确定输入 / 输出数据,开发测试用例。

测试用例套件是测试用例的集合,它以需求为线索,将相关的测试用例组织在一起。

度量需求

TODO