需求规格说明书编写规范(审定稿).doc

成都市自来水有限责任公司需求规格说明书编写规范文件管理部门：信息中心 编号：GS-12-11-20131 总则1.1 目的为规范公司软件需求规格说明书的格式及表达内容特制定本规范。1.2 适用范围此规范适用于公司各单位信息系统项目的建设。1.3 特定术语1.3.1 跨职能流程图：跨职能流程图显示进程中各步骤之间的关系以及执行它们的职能单位。1.3.2 表单：指业务流转中展现的输入、输出数据表格。1.3.3 数据项：是数据记录中最基本的、不可分的有名数据单位。1.3.4 算法：由基本运算及规定的运算顺序所构成的完整的解题步骤。1.3.5 用户界面：系统和用户之间进行交互和信息交换的媒介。1.3.6 角色：指一个系统中的工作或位置，它代表了一种资格、权利和责任，且它在系统中所具有的操作权限是唯一的不可再分的。1.3.7 岗位：结合管理需求设立的工作岗位，岗位可以具备系统的一个或多个角色。1.3.8 原代码：（也称源程序），是指用于完成某一特定功能的一系列人类可读的计算机语言指令的集合。1.3.9 静态数据：是指系统应用中不随时间或其它数据变化而变化的数据.1.3.10 动态数据：是指在系统应用中随时间或其它数据变化变化而改变的数据。1.3.11 数据字典：用于说明存储数据的定义和属性以及数据表之间关系的文档。1.3.12 数据库规范化：又称数据库或资料库正规化、标准化，是数据库设计中的一系列原理和技术，以减少数据库中数据冗余，增进数据的一致性。1.3.13 字段：表的“列”称为“字段” ，每个字段包含某一专题的信息。1.3.14 主键：即主关键字(primary key)是表中的一个或多个字段，它的值用于惟一地标识表中的某一条记录。1.3.15 外键：如果公共关键字在一个关系中是主关键字，那么这个公共关键字被称为另一个关系的外键。2 需求规格说明书格式约定2.1 标题为宋体2号字2.2 小标题为仿宋4号加粗2.3 正文为仿宋4号2.4 段落间距为单倍行距2.5 页边距上下左右均为2cm3 需求规格说明书应具备的内容及编写说明3.1 引言3.1.1 软件开发目的3.1.2 项目背景标识待开发软件产品的名称；列出本项目的任务提出者、项目负责人、系统分析员、资料员以及与本项目开展工作直接有关的人员和用户；说明此软件涉及的相关业务目前状况，以及周边业务的信息化建设关况。描述该软件产品与其他相关软件产品的相互关系。3.1.3 术语说明列出本文档中所用到的专门术语的定义和英文缩写词的原文。3.1.4 参考资料列举编写软件需求规格说明时所参考的资料，包括公司相关管理规定、技术规范、作业流程、合同、文档范本以及相关软件产品的需求规格说明。序号标题作者（起草人）出版（制定）单位版本号发表（发布）日期资料来源123.2 项目概述3.2.1 概述待开发软件的用途及主要功能。3.2.2 用户特征分类描述最终用户的工作内容及工作特点，以及使用本软件应具备的基本能力。3.3 功能需求3.3.1 功能划分将软件的主要功能模块以框图的形式展现出来，如图1所示。一级功能二级功能二级功能二级功能图1 功能模块图功能分级数量和层次原则上不做限制，满足需求就好。3.3.2 流程描述分功能模块，以垂直跨职能流程图的形式详细描述业务的处理、记录过程，图中的每一个图符节点均要求细化到不可再分的动作。流程图中使用的图符必须符合图2的规定。3.3.3 流程说明对流程图表述不详细的地方作进一步说明。详细描述各事务处理节点中的数据展现和数据收集的内容，列出样式表单和数据项名（数据项描述详见本文3.7数据描述）。算法描述，提出流程中必须用到的统计和运算公式。开 始结 束YN流程的起始标识流程的结束标识事务处理节点，方框内作事务处理描述事务判断处理节点，菱形框内描述判断条件，符合条件流程往下进行，不符合条件则向菱形两边流转。启下连接节点，无法将所有流程表示在限定的页面中，用此图符表示流程未完。承上连接节点，与启下连接节点配对使用，表示流程的继续。图2 流程图图符3.4 外部接口需求3.4.1 用户界面明确软件应具有的界面特征及其它必须说明的界面要求。3.4.2 硬件接口描述系统中软件产品可能用到的外部硬件设备及所需的设备驱动。3.4.3 软件接口描述该软件产品与其他有关软件的接口关系，并指出这些外部软件或组件的名字和版本号，运行在什么操作系统上，采用何种类型的数据库，数据库连接组件，列出接口数据字典，以及其它可供使用的接口方法。3.4.4 通信接口罗列本软件产品所用到的网络协议。3.5 性能需求3.5.1 时间特性时间特性可包括如下几方面：响应时间、更新处理时间、数据转换与传输时间、运行时间等。3.5.2 适应性描述在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时，应具有的适应能力。3.6 软件的其它需求3.6.1 易操作性3.6.2 可维护性3.6.3 安全性及保密性详尽陈述与系统安全性、完整性或与私密问题相关的需求。定义用户身份确认或授权需求。（1） 角色定义以列表的方式列出系统中所有角色，及其权限定义。每个角色所具备的权限必是唯一的，不可再分的。（2） 岗位定义结合管理需要以列表的方式罗列此系统目前可能的用户岗位划分，每个岗位应具备哪些角色，要求在系统用户岗位划分中充分考虑用户职责分离及灵活配置，使得系统满足在访问过程中的不相容职务相分离，对系统功能操作和数据操作避免非授权访问，特别是数据变更操作要满足申请、授权、审批、监控的需求，系统运行维护管理人员原则上不得被授予系统业务操作权限。（3） 日志记录重要功能和数据操作需设置系统操作日志进行监控，确保操作的可追溯性。3.6.4 原代码的可理解性需求3.6.5 系统可移植性需求3.6.6 其他必须说明的需求若系统涉及新旧系统转换，还需对数据迁移、新旧系统转换等需求进行详细描述，以确保顺利切换和平稳衔接。3.7 数据描述收集流程图中所有的数据项，消除冗余数据，区分数据的动态/静态属性，分别写入静态数据列表和动态数据列表，取出简语（可用英文也可用拼音缩写），说明数据来源，按需作相应的描述。3.7.1 静态数据列表序号数据项名简语数据来源描述1n3.7.2 动态数据列表序号数据项名简语数据来源描述1n3.8 条件与限制分析本系统生命周期内可