分析文档格式_数据要求说明书编写规范

文档附录

附录6-1 数据要求说明书编写规范

1. 引言

1.1编写目的

说明编写这份数据要求说明书的目的指出预期的读者

1.2背景

说明

(1) 待开发软件系统的名称

(2) 列出本项目的任务提出者开发者用户

1.3定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组

1.4参考资料

列出有关的参考资料如

(1) 本项目的经核准的计划任务书或合同上级机关的批文

(2) 属于本项目的其他已发表文件

(3) 本文件中各处引用的文件资料包括所要用到的软件开发标准列出这些文件的标题文件编号发表日期和出版单位说明能够得到这些文件资料的来源

2. 数据的逻辑描述

对数据进行逻辑描述时可把数据分为动态数据和静态数据所谓静态数据指在运过程中主要作为参考的数据它们在很长的一段时间内不会变化一般不随运行而改变所谓动态数据包括所有在运行中要发生变化的数据以及在运行中要输入输出的数据进行描述时应把各数据元素逻辑地分成若干组例如函数源数据或对于其应用更为恰当的逻辑分组给出每一数据元的名称包括缩写和代码定义或物理意义度量单位值域格式和类型等有关信息

2.1静态数据

列出所有作为控制或参考用的静态数据元素

2.2动态输入数据

列出动态输入数据元素包括在常规运行中或联机操作中要改变的数据

2.3动态输出数据

列出动态输出数据元素包括在常规运行中或联机操作中要改变的数据

2.4内部生成数据

列出向用户或开发单位中的维护调试人员提供的内部生成数据

2.5数据约定

说明对数据要求的制约逐条列出对进一步扩充或使用方面的考虑而提出的对数据要求的限制容量文件记录和数据元的个数的最大值对于在设计和开发中确定是临界性

的限制更要明确指出

3. 数据的采集

3.1要求和范围

按数据元的逻辑分组来说明数据采集的要求和范围指明数据的采集方法说明数据采集工作的承担者是用户还是开发者具体的内容包括

(1) 输入数据的来源例如是单个操作人员数据输入站专业的数据输入公司或它们的一个分组

(2) 数据输入指把数据输入处理系统内部所用的媒体和硬设备如果只有指定的输入点的输人才是合法的则必须对此加以说明

(3) 接受者说明输出数据的接受者

(4) 输出数据的形式和设备列出输出数据的形式和硬设备无论接受者将接收到的数据是打印输出还是CRT上的一组字符一帧图形或一声警铃或向开关线圈提供的一个电脉冲或常用媒体如磁盘磁带穿孔卡片等均应具体说明

a.数据值的范围给出每一个数据元的合法值的范围

b.量纲给出数字的度量单位增量的步长零点的定标等在数据是非数字量的情况

下要给出每一种合法值的形式和含意

c.更新和处理的频度给出预定的对输入数据的更新和处理的频度如果数据的输入

随机的应给出更新处理的频度的平均值或变化情况的某种其他度量

3.2输入的承担者

说明预定的对数据输人工作的承担者如果输入数据同某一接口软件有关还应说明该接口软件的来源

3.3预处理

对数据的采集和预处理过程提出专门的规定包括适合应用的数据格式预定的数据通信媒体和对输入的时间要求等对于需经模拟转换或数字转换处理的数据量要给出转换方法和转换因子等有关信息以便软件系统使用这些数据

3.4影响

说明这些数据要求对于设备软件用户开发单位所可能产生的影响例如求用单位增设某个机构等

附录6-2 需求分析说明书编写规范

1引言Introduction

1.1编写目的Purpose

简要说明编写本需求分析说明书的目的

1.2读者对象Reader

简要说明本需求分析说明书可能的合法读者对象

1.3编写原则Rule

简要说明本需求分析说明书的编写原则

1.4编写目标(Goal)

简要说明本需求分析说明书的编写目标

1.5项目背景(Background of Project)

简要说明关于本项目的项目名称简称项目代号委托单位开发单位和主管部门该软件系统与其它系统的关系等背景信息

1.6定义(Definitions)

简要说明本需求分析说明书中涉及的专门术语容易引起歧义的概念关键词缩写及其他需要解释的内容

1.7参考资料Reference

以列表或排序的方式给出重要的参考资料的名称作者单位出版日期地点联系方式等信息

1.8变更历史(Change History)

序号人员日期变更详情

2任务概述(Task Description)

可以以合同文本为基础阐述清楚如下观点

1本系统开发完成后的用途能够产生的效果

2实现技术先进性可靠性易操作性易维护性易扩展性和安全性

3如果分多期工程应按工期分别列出其目标

3业务需求调查(Business Processes and Flows)

3.1组织机构调查

此处给出组织关系结构图以及组织部门岗位的隶属关系与职能

3.2应用现状调查

1现有计算机系统的网络服务器终端的软硬件环境状态数量关系

2现行应用系统的分布及运行状况

3客户对现有应用系统优缺点的评价

4现有应用系统的数据来源和出口IPO

3.3业务处理总体流程调查

3.3.1总体流程图

给出总体业务流程图

1描述组成系统的各个子系统(或环节)之间的业务处理关系

2列出分析的基本原则

3严格按照图表的含义设计流程图主要图标所表达的意义遵照相关标准

3.3.2业务处理环节定义及处理说明

经过对业务总体流程的分析总结出业务处理的环节并对环节进行定义包括文字和流程图注意这里所说的环节必须具有通用性

3.4子系统处理流程调查

3.4.1子系统1业务需求调查

1业务处理流程图

1按业务环节非常详细的画出业务处理过程并用文字标注和说明

2流程图的图表标准与总体流程图相同

3业务流程文字说明

2数据流程图

1按业务环节非常详细的画出数据处理过程并用文字标注和说明

2流程图的图表标准与总体流程图相同

3数据流程文字说明

3实体初步描述

1在对业务流程图和数据流程图进行详细分析的基础上找出其中的实体

2实体描述方式

3最终应用的界面要素描述

3.4.2子系统2业务需求调查

3.5对新系统的环境要求调查