软件开发文档指南(21)

软件开发文档指南：软件需求分析报告文档模板软件概要设计报告文档模板软件详细设计报告文档模板软件数据库设计报告文档模

6. 词汇表

列出本文件中用到的专业术语的定义，以及有关缩写的定义(如有可能，列出相关的外文原词)。为了便于非软件专业或者非计算机专业人士阅读软件产品需求分析报告，要求使用非软件专业或者非计算机专业的术语描述软件需求。所以这里所指的专业术语，是指业务层面上的专业术语，而不是软件专业或者计算机专业的术语。但是，对于无法回避的软件专业或者计算机专业术语，也应该列入词汇表并且加以准确定义。

7. 数据定义

数据定义是一个定义了应用程序中使用的所有数据元素和结构的共享文档，其中对每个数据元素和结构都准确描述：含义、类型、数据大小、格式、计量单位、精度以及取值范围。数据定义的维护独立于软件需求规格说明，并且在软件产品开发和维护的任何阶段，均向风险承担者开放。

如果为软件开发项目创建一个独立的数据定义，而不是为每一项特性描述有关的数据项，有利于避免冗余和不一致性。但是却不利于多人协同编写需求分析报告，容易遗漏数据，也不方便阅读。因此还是建议为每个特性描述有关的数据项，汇总数据项创建数据定义，再根据数据定义复核全部数据，使得它们的名称和含义完全一致。必须注意的是，为了避免二义性，在汇总数据项时应该根据数据项所代表的实际意义汇总，而不是根据数据项的名称汇总。

在数据定义中，每个数据项除了有一个中文名称外，还应该为它取一个简短的英文名称，该英文名称应该符合命名规范，因为在软件开发时将沿用该英文名称。可以使用等号表示数据项，名称写在左边，定义写在右边。常见数据项的描述方式如下：

● 原数据元素

一个原数据元素是不可分解的，可以将一个数量值赋给它。定义原数据元素必须确定其 含义、类型、数据大小、格式、计量单位、精度以及取值范围。采用以星号为界的一行 注释文本，描述原数据元素的定义。 ● 选择项

选择项是一种只可以取有限离散值的特殊原数据元素，描述时一一枚举这些值，并用方 括号括起来写在原数据元素的定义前。在两项离散值之间，使用管道符分隔。 ● 组合项

组合项是一个数据结构或者记录，其中包含了多个数据项。这些数据项可以是原数据元 素，也可以是组合数据项，各数据项之间用加号连接。其中每个数据项都必须是数据定 义中定义过的，结构中也可以包括其它结构，但是绝对不允许递归。如果数据结构中有 可选项，使用圆括号把该项括起来。 ● 重复项

重复项是组合项的一种特例，其中有一项将有多个实例出现在数据结构中，使用花括号 把该项括起来。如果知道该项可能允许的范围，就按“最小值：最大值”的形式写在花 括号前。