软件需求规格说明书.doc

XXX 项项目目 软软件需求件需求规规格格说说明明书书 文档编号： 当前版本： 密 级：内部公开 作 者： 文件状态： 草稿 正式发布 正在修改 完成日期： - 合肥安慧软件有限公司对本文件资料享受著作权及其它专属权利，未经书面许 可，不得将该等文件资料（其全部或任何部分）披露予任何第三方，或进行修改后 使用。 _ 精品资料 变变更更记录记录 版本号版本号修改点修改点说说明明变变更人更人/ 创创建人建人 存放位置存放位置审审批人批人审审批日期批日期 修改点说明的内容有如下几种：创建、修改（+修改说明）、删除（+删除说明） _ 精品资料 目目目 录录录 1.引言引言.5 1.1.项目背景.5 1.2.编写目标.5 1.3.建设目标（可选）.5 1.4.系统范围.6 1.5.定义/术语/缩写 .6 1.6.参考资料.6 1.7.文档阅读指南（可选）.7 2.总总体体说说明明.7 2.1.产品介绍.7 2.2.假设和依赖（可选）.8 2.3.局限性和排斥性（可选）.8 3.功能描述功能描述.8 3.1.业务描述.9 3.2.用户说明.9 3.3.基本配置及运行环境.9 3.4.用户场景.9 3.4.1.用例总览.10 3.4.2.详细用例说明.10 4.非功能性需求非功能性需求.11 4.1.性能要求.12 4.2.可靠性（可选）.12 4.3.安全性（可选）.12 4.4.可移植性（可选）.13 4.5.设计限制（可选）.13 4.6.电源、工艺结构要求（可选）.13 4.7.逻辑数据库需求（可选）.13 4.8.其他需求.13 5.接口接口说说明明.13 5.1.用户界面.13 5.2.硬件接口.14 5.3.软件接口.14 5.4.通信接口.14 6.需求需求变变更流程更流程.15 7.设计设计描述（可描述（可选选） ）.15 _ 精品资料 7.1.设计和实现的约束条件.15 7.2.设计架构.15 7.3.分析模型.15 7.4.数据库设计.15 7.5.接口函数/类/对象 .16 8.其他（可其他（可选选） ）.16 8.1.故障处理.16 8.2.项目风险预估.16 8.3.客户和市场需求.16 9.项项目建目建设设安排安排.16 9.1.项目优先级.16 9.2.功能优先级.17 9.3.项目进度计划.17 9.4.项目人员配置管理.17 9.5.项目实施方案.18 10.附附录录（可（可选选） ）.18 10.1.数据字典.18 10.2.业务规则.18 10.3.算法说明.18 10.4.相关干系人概览.18 10.5.待确定问题清单.19 10.6.用户文档.19 10.7.相关文档.19 _ 精品资料 1. 引言引言 1.1. 项项目背景目背景 此处说明项目建设的原由与背景，对项目建设内容的历史和现状进行概括性的描述，最终说 明为什么决定开发该产品。 直接引用用户需求说明或产品需求规格说明书中对应章节内容即可。 1.2. 项项目目目目标标 此处一般描述两项内容： 1项目的建设目标，及该项目的成功实施给客户带来的商业上的利益。 2定义该项目成功实施的标准，如项目的进度目标，质量目标等等。 直接引用用户需求说明或产品需求规格说明书中对应章节内容即可。 1.1. 系系统统范范围围 概述本系统的相关业务范围，划清系统边界，明确项目的工作内容。 直接引用用户需求说明或产品需求规格说明书中1.3 项目边界章节内容 即可。 1.2. 适用范适用范围围 此处描述：编写软件需求规格说明书的主要目的和适用的读者。 读者对象一般包括：需求提供方具体责任人、评审人员、开发方的项目经理、系统分析设计人 员、测试人员等。 1.3. 定定义义/术语术语/缩缩写写 此处描述：文档中所有需要向读者解释的专业术语、名词定义、简称、缩写、项目组内达成一 致意见的专用词汇等。 包括:词汇的来源、定义、对该词汇的其它叫法等。 若内容较多，也可将这些的信息放在附录或其他文档中描述。 _ 精品资料 直接应用用户需求说明书中1.5术语表章节内容即可，如果软件需求规格说明书中还引用了 新的术语，也需要更新到该表中。 2. 总总体体说说明明 2.1. 系系统统介介绍绍 该章节从以下几个方面来对系统进行概要性的介绍。 1系系统统功能功能结结构构图图： ：着重从业务层面来介绍该系统，如果有关键业务过程，可用文字进行补 充说明 示例一： 示例二： 示例只提供参考，不产生任何约束性要求。 _ 精品资料 2系系统结统结构构图图： ：从系统的交互来描述各个子系统之间的关系 示例一： 示例二： 示例只提供参考，不产生任何约束性要求。 3高高层层数据流数据流图图 示例一： _ 精品资料 示例只提供参考，不产生任何约束性要求。 4网网络络拓扑拓扑图图 示例： 示例只提供参考，不产生任何约束性要求。 5系系统统部署部署图图 示例： 示例只提供参考，不产生任何约束性要求。 _ 精品资料 6关关键业务过键业务过程（可程（可选选）：）：对对本本项项目的关目的关键业务过键业务过程程进进行描述，也可以通行描述，也可以通过业务过业务流程流程图图来表示来表示 2.2. 用用户说户说明明 对该系统的用户/用户类进行说明，可直接引用用户需求说明或产品需求规格说明书中的“用 户与角色”章节 2.3. 假假设设和依和依赖赖（可（可选选） ） 建议在此处描述所有会影响需求的因素。这些因素不是设计限制，但是只要他们改变就会影 响需求规格说明书里的需求。例如： （1（某个具体的操作系统必须适用于为这个产品设计的硬件。如果这个操作系统不适 用了，需求规格说明书就会相应改变。 （2（假设与其他系统的接口程序由对应系统的厂商在接口开发前提供。 （3（假设各地市已有监控系统正常使用，且网络速度不低于2M/s. 注意：注意：这这部分叙述的内容都是我部分叙述的内容都是我们们潜意潜意识识都知道，但容易都知道，但容易遗遗漏的部分。漏的部分。 2.4. 基本配置及运行基本配置及运行环环境境 建议在此处描述：产品的软硬件配置以及运行环境。 若配置清单过长，则可在本处简述后，指定配置详细清单的存放位置（例如：附录或者另一份 文档中）。 3. 功能描述功能描述 详细定义软件需求规格说明书的每个具体需求。 具体需求应当按逻辑可读的方式组织。 注意： （1（描述清楚对非正常情况和非法值的处理。 （2（描述清楚临界点或者系统边界。 按功能结构图进行细化，软件需求规格说明书书的功能结构应该与用户需求说明书的功能 _ 精品资料 结构基本一致，按照子系统（可选）、模块、功能、功能点逐层进行拆分与细化 3.1. 信号控制信号控制 3.1.1. 信号信号监监控控 3.1.1.1. GIS 监监控控 3.1.1.1.1.1 查查看路口交通信号情况看路口交通信号情况 1.功能描述：功能描述：通过 GIS 地图显示信号机分布情况，选择地图上信号机图标或者选择信号机 编号，可以显示该路口的信息，包括该路口信号机的工作参数，周期、运行相位、相位时 间、路口闯红灯设备采集的视频图像。 2.UI 界面：界面： _ 精品资料 3.前置条件：前置条件： 无无 4.输输入：入：无 5.输输出：出： 路口编号、路口名称、生产厂家、信号机 IP、当前信号机状态，方案号、周期、 当前运行相位、阶段数、控制方式、相位时间 6.处处理理过过程：程： 1：在 GIS 监控页面，在左侧设备树单击设备(或搜索)，定位到 GIS 地图的具体位置 2：双击 GIS 地图上信号机图标获取信号机 ID 请求相关接口和订阅信号机实时运行信 息 7.业务规则业务规则： ：无 _ 精品资料 3.1.1.1.1.2 控制信号机控制信号机 1.功能描述：功能描述：信号配时人员可以通过平台向信号控制系统下发控制指令：进行相位控制、 单点控制。 2.UI 界面：界面： 3.前置条件：前置条件：无 4.输输入：入：无 5.输输出：出： 1：相位控制状态信息（锁定、恢复、快进、步进），相位配时信息输出下发成功 2：单点控制（方案控制方式） 6.处处理理过过程：程： 1：在 GIS 监控页面，在左侧设备树单击设备(或搜索)，定位到 GIS 地图的具体位置 2：双击 GIS 地图上信号机图标获取信号机 ID 请求相关接口和订阅信号机实时运行信 息 3：控制相位：锁定、恢复、快进、步进，相位配时信息的编辑下发，灯态控制 7.业务规则业务规则： ： 1）基于 GIS 地图展示信号机分布 2）下发的控制指包括：相位控制（锁定、恢复、快进、步进）、单点控制（方案控制方 式） _ 精品资料 3.1.1.1.1.3 监监控信号机控信号机设备实时设备实时状状态态 1.功能描述：功能描述：交通信号控制系统设备出现故障，GIS 地图上相应显示为故障，详细故 障信息可通过打开信号控制系统界面进行查看 2.UI 界面：界面： 3.前置条件：前置条件：无 4.输输入：入：信号机设备名称(支持模糊搜索) 5.输输出：出：GIS 地图图标故障为红色，在信号机管理页面展示信号机详细故障描述信息 6.处处理理过过程：程：无 7.业务规则业务规则： ：无 3.1.1.2. 信号机方案信号机方案设计设计 1.功能描述：功能描述：信号配时人员可以通过平台事先对信号机的相位设计、方案配时、调度 计划进行实时配置，以便在使用信号机的时候能够对信号机进行正常的调度控制。 2.UI 界面：界面： _ 精品资料 _ 精品资料 3.前置条件：前置条件：无 _ 精品资料 4.输输入：入： 1 相位添加：相位号(最大支持 32 个相位)、相位通道 2 配时添加：相位差、相位号、绿灯时间、红灯时间、黄灯时间、延迟时间 3 调度计划添加：调度日期、时段划分、配时方案号、控制模式、辅助功能 4 相位删除：相位号 5 配时删除：配时方案号 6 调度计划删除：调度计划号 7 相位修改：相位号 8 配时修改：配时方案号 9 调度计划修改：调度计划号 5.输输出：出： 1 相位添加：添加成功 2 配时添加：添加成功 3 调度计划添加：添加成功 4 相位删除：删除成功 5 配时删除：删除成功 6 调度计划删除：删除成功 7 相位修改：修改成功 8 配时修改：修改成功 9 调度计划修改：修改成功 6.处处理理过过程：程：无 7.业务规则业务规则： ： 1）配置的相位不能有冲突 3.1.1.3. 查询查询交通信号控制指令下交通信号控制指令下发发日志日志 1.功能描述：功能描述：用户要能查询对信号机任何控制操作的日志情况。 2.UI 界面：界面： _ 精品资料 3.前置条件：前置条件：无 4.输输入：入：日志类别、操作类型、操作日期： 5.输输出：出：列表 6.处处理理过过程：程：无 7.业务规则业务规则： ： 1）根据操作类型、操作时间查询； 2）操作类型包括：黄闪控制、步进控制、快进控制、锁定相位、停止控制、检测器维 护、人工校时、其他 3.1.1.4. 信号机配置管理信号机配置管理 1.功能描述：功能描述：用户可在相应图层的 GIS 地图上对信号机进行添加、修改、删除等操作。 2. UI 界面：界面： 3.前置条件：前置条件：无 4.输输入：入： 1 添加信号机：设备名称、设备编号、所属机构、型号、厂商、IP、关联视频、接 入平台、最大相位数 2 删除信号机：信号机 ID 3 修改信号机：信号机需要修改的基本信息 5.输输出：出： 1 添加信号机：添加成功 2 删除信号机：删除成功 _ 精品资料 3 修改信号机：修改成功 6.处处理理过过程：程：无 7.业务规则业务规则： ： 1)设备编号长度 18 位 2)设备号唯一 示例：用示例：用户户管理管理（是将用户管理作为一个功能点还是将增删改查作为一个功能点，根据具体 需求的复杂程度来由项目组自行决定） 功能描述：功能描述： 增加新用户，并能用户进行修改、删除、查询 UI 界面：界面： _ 精品资料 前置条件：无前置条件：无 输输入：入：用户名、姓名、性别、年龄、单位、联系方式 输输出：出：一条用户记录 处处理理过过程：程： 1.用户进入用户管里界面，添加用户，输入用户基本信息，点击保存 2.保存成功，用户能够在用户列表中查询到该条用户信息。 3.若输入用户基本信息非法，则提示保存失败。 4.对选定的用户进行基本信息的修改，点击保存后能修改成功 5.对选定的用户进行删除，删除成功后列表中不再显示该用户信息 6.可以对用户进行查询，支持模糊查询。 业务规则业务规则： ： 1.用户名不可重复，姓名可重复。 2.只有管理员拥有删除用户的权限。 4. E-R 图图 在此章节画出本系统的实体关系图。 5. 性能需求性能需求 在此章节要描述本系统的数据量（接入设备的数据量）需求以指导开发人员在进行软件 设计时，性能上至少要满足此数据量的要求。 _ 精品资料 6. 其他非功能性需求其他非功能性需求 6.1. 可靠性（可可靠性（可选选） ） 系统在一定时间内、在一定条件下无故障地执行指定功能的能力或可能性。 例如：除电源、硬件、操作系统、服务器管理系统外，程序不允许异常退出或崩溃。24小时不 间断运行。 6.2. 安全性（可安全性（可选选） ） 指定与安全性、完整性或保密性问题相关的所有需求，这些问题影响对产品的访问、使用以 及产品所创建或使用的数据的保护。安全性需求一般来源于业务规则，因此要确定产品必须 遵守的所有安全或保密策略或规则。可从如下方面考虑系统的安全性： （1（网络安全（信息认证） （2（资料安全（重要信息加密）和用户权限管理（用户信息保密，操作权限明确） （3（日志管理 （4（数据备份（例如：系统灾难恢复） 注意：有些系统的安全性要求高，可能会独立成一章，描述从安全管理制度到安全保护措施 的所有内容。安全管理制度定义了用