接口需求规格说明.docx
《接口需求规格说明.docx》由会员分享，可在线阅读，更多相关《接口需求规格说明.docx（7页珍藏版）》请在冰豆网上搜索。
接口需求规格说明
接口需求规格说明
文件编号：
KJXXW-XXSJ-M002-V1.0
版本号：
V1.0
受控状态：
■受控□非受控
保密级别：
公司级
编制人/编制时间：
王攀坤
2014年7月
审核人/审核时间：
批准人/批准时间：
生效日期：
新疆泰戈瑞信息技术有限责任公司发布
变更记录
变更
序号
变更
状态
简要说明变更内容和
变更范围
版本号
变更人
批准人
生效日期
1
C
1.0
（注：
更改状态包括：
C－创建、A－增加、M－修改、D－删除）
1.引言
本章分为以下几条。
1.1标识
【内容】
本条应包含本文档适用的系统和软件的完整标识，（若适用）包括标识号、标题、缩略词语、版本号和发行号。
【裁剪原则】
此部分内容不允许裁剪掉。
1.2系统概述
【内容】
本条应简述本文档适用的系统和软件的用途。
它应描述系统与软件的一般性质；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构；标识当前和计划的运行现场；并列出其他有关文档。
【裁剪原则】
此部分内容不允许裁剪掉。
1.3文档概述
【内容】
本条应概述本文档的用途和内容，并描述与其使用有关的保密性和私密性的要求。
【裁剪原则】
此部分内容不允许裁剪掉。
2.引用文件
【内容】
本章应列出本文档引用的所有文档的编号、标题、修订版本和日期，本章也应标识不能通过正常的供货渠道获得的所有文档的来源。
【裁剪原则】
此部分内容不允许裁剪掉。
3.需求
本章应分以下几条详细说明为实现一个或多个系统、子系统、配置项、手工操作、其他系统部件之间的一个或多个接口而强加在这些实体上的需求。
应为每个需求指定一个项目唯一标识符以支持测试和可追踪性，并且应以一种可以定义客观测试的方式来陈述需求。
如果每个需求有关的合格性方法（见第4章）和对系统（或子系统）需求的可追踪性（见5.a条）在相应的章中没有提供的话，则应在此进行注解。
描述的详细程度应遵循以下规则：
包含作为接口实体的验收条件的那些接口实体特性；需方愿意推迟到设计时留给开发方处理的那些接口实体特性。
如果某个需求在多条中出现，可以只陈述一次，而在其他条中加以引用。
如果本说明中的接口实体要在彼此有着不同接口需求的状态和/或方式下运行的话，则该实体的每个需求或每组需求应与那些状态和方式相关联，该关联可以在本条或本条引用的附录中用表格或其他方法给出；也可以在需求出现的地方加以注解。
3.1接口标识和接口图
【内容】
对于本文档1.1中标识的每个接口，本条应包含项目唯一标识符，（若适用）并应用名字、编号、版本、文档引用指明接口实体（系统、配置项、用户等）。
该标识应说明哪些实体具有固定的接口特性（因而要对这些接口实体强加接口需求），哪些实体正被开发或修改（从而接口需求已被施加于它们）。
可用一个或多个接口图来描述这些接口。
【裁剪原则】
此部分内容允许裁剪掉。
3.2（接口的项目唯一标识符）
【内容】
本条（从3.2开始编号）应通过项目唯一标识符标识接口，应简要标识接口实体，并应根据需要划分为几条描述为实现该接口而强加于一个或多个接口实体的需求。
如果某个实体的接口特性本文没有提及，但是需要在描述本文所包含的接口实体时提到，则这些特性应以假设、或“当[未提及实体]这样做时，[正在描述的实体]将……”的形式描述，而不是描述成本文未提及实体的需求。
本条可引用其他文档（例如数据字典、协议标准、用户接口标准）代替本条的描述信息。
（若适用）本需求应包括以下内容，它们可以任何适合于需求的顺序提供，并且应从接口实体角度指出这些特性之间的区别（例如数据元素的大小、频率或其他特性的不同期望）：
a、接口实体必须分配给接口的优先级别；
b、要实现的接口的类型的需求（如：
实时数据传送、数据的存储和检索等）；
c、接口实体必须提供、存储、发送、访问和接收的单个数据元素的特性，如：
1）名称/标识符；
a）项目唯一标识符；
b）非技术（自然语言）名称；
c）标准数据元素名称；
d）技术名称（如代码或数据库中的变量或字段名称）；
e）缩写名或同义名；
2）数据类型（字母数字、整数等）；
3）大小和格式（如：
字符串的长度和标点符号）；
4）计量单位（如：
米、元、纳秒）；
5）范围或可能值的枚举（如：
0~99）；
6）准确度（正确程度）和精度（有效数字位数）；
7）优先级别、时序、频率、容量、序列和其他的约束条件，如：
数据元素是否可被更新、业务规则是否适用；
8）保密性和私密性的约束；
9）来源（设置/发送实体）和接收者（使用/接收实体）；
d、接口实体必须提供、存储、发送、访问和接收的数据元素集合体（记录、消息、文件、显示和报表等）的特性，如：
1）名称/标识符；
a）项目唯一标识符；
b）非技术（自然语言）名称；
c）技术名称（如代码或数据库的记录或数据结构）；
d）缩写名或同义名；
2）数据元素集合体中的数据元素及其结构（编号、次序、分组）；
3）媒体（如盘）和媒体中数据元素/数据元素集合体的结构；
4）显示和其他输出的视听特性（如：
颜色、布局、字体、图标和其他显示元素、蜂鸣声和亮度等）；
5）数据元素集合体之间的关系。
如排序/访问特性；
6）优先级别、时序、频率、容量、序列和其他的约束条件，如：
数据元素集合体是否可被修改、业务规则是否适用；
7）保密性和私密性约束；
8）来源（设置/发送实体）和接收者（使用/接收实体）；
e、接口实体必须为接口使用通信方法的特性。
如：
1）项目唯一标识符；
2）通信链接/带宽/频率/媒体及其特性；
3）消息格式化；
4）流控制（如：
序列编号和缓冲区分配）；
5）数据传送速率，周期性/非周期性，传输间隔；
6）路由、寻址和命名约定；
7）传输服务，包括：
优先级别和等级；
8）安全性/保密性/私密性方面的考虑，如：
加密、用户鉴别、隔离和审核等；
f、接口实体必须为接口使用协议的特性，如：
1）项目唯一标识符；
2）协议的优先级别/层次；
3）分组，包括：
分段和重组、路由和寻址；
4）合法性检查、错误控制和恢复过程；
5）同步，包括：
连接的建立、保持和终止；
6）状态、标识、任何其他的报告特征；
g、其他所需的特性，如：
接口实体的物理兼容性（大小、容限、负荷、电压和接插件兼容性等）。
【裁剪原则】
此部分内容允许裁剪掉。
3.3……（同3.2）
【内容】
本条应分条详细描述与系统每一能力相关联的需求。
“能力”被定义为一组相关的需求。
可以用“功能”、“性能”、“主题”、“目标”或其他适合用来表示需求的词来替代“能力”。
【裁剪原则】
此部分内容允许裁剪掉。
3.4需求的优先顺序和关键程度
【内容】
本条应编号为第3章的最后一条，（若适用）应给出本规格说明中需求的、表明其相对重要程度的优先顺序、关键程度或赋予的权值，如：
标识出那些认为对安全性、保密性或私密性起关键作用的需求，以便进行特殊的处理。
如果所有需求具有相同的权值，本条应如实描述。
【裁剪原则】
此部分内容允许裁剪掉。
4.合格性规定
【内容】
本章定义一组合格性方法，对于第3章中每个需求，指定为了确保需求得到满足所应使用的方法。
可以用表格形式表述该信息，也可以在第3章的每个需求中注明要使用的方法。
合格性方法包括：
a、演示：
依赖于可见的功能操作，直接运行系统或系统的一部分而不需要使用仪器、专用测试设备或进行事后分析。
b、测试：
使用仪器或其他专用测试设备运行系统或系统的尸部分，以便采集数据供事后分析使用。
c、分析：
对从其他合格性方法中获得的积累数据进行处理，例如测试结果的归约、解释或推断。
d、审查：
对系统部件、文档等进行可视化检查。
e、特殊的合格性方法。
系统的任何特殊合格性方法，如：
专用工具、技术、过程、设施、验收限制、标准样例的使用和生成等。
【裁剪原则】
此部分内容不允许裁剪掉。
5.需求可追踪性
【内容】
对系统级的规格说明，本章不适用；对子系统级的规格说明，本章应包括：
a、从本规格说明中每个子系统需求到其涉及的系统需求的可追踪性。
（该可追踪性也可以通过对第3章中的每个需求进行注释的方法加以描述。
）
注：
每一层次的系统改进可能导致对更高层次的需求不能直接进行追踪。
例如：
建立两个子系统的系统体系结构设计可能会产生有关子系统接口的需求，而这些接口需求在系统需求中并没有被覆盖，这样的需求可以被追踪到诸如“系统实现”这样的一般需求，或被追踪到导致它们产生的系统设计决策上。
b、从分配给被本规格说明所覆盖的子系统的每个系统需求到所涉及的子系统需求的可追踪性。
分配给子系统的所有系统需求都应加以说明。
追踪到接口需求规格说明（IRS）中所包含的子系统需求时，可引用IRS.
【裁剪原则】
此部分内容不允许裁剪掉。
6.注解
【内容】
本章应包含有助于理解本文档的一般信息（例如原理）。
本章应包含为理解本文档需要的术语和定义，所有缩略语和它们在文档中的含义的字母序列表。
【裁剪原则】
不允许裁剪掉。
附录
【内容】
附录可用来提供那些为便于文档维护而单独出版的信息（例如图表、分类数据）。
为便于处理附录可单独装订成册。
附录应按字母顺序（A，B等）编排。
【裁剪原则】
不允许裁剪掉。
升级会员 