软件需求规格说明书

XXX公司 {项目名称} 软件需求规格说明书

编号： 版本：V1.0 发布日期：2021-11-1

本文件中包含的任何文字叙述、文档格式、插图、照片、方法、过程等内容。未经许可任何人不得将此文件中的任何部分以任何形式进行复制、储存和传播。

XXXX-02-05 V1.0

文件修订记录

A-增加 M-修订 D-删除 版本号 修订日期 变更类型 (A*M*D) 修订描述 位置（页/段落/章节号 修订人及备注

II

XXXX-02-05 V1.0

目 录

1 概述 ...................................................................................................................................... 1

1.1 目的 ........................................................................................................................... 1 1.2 术语及缩略语 ........................................................................................................... 1 2 引用文档 .............................................................................................................................. 1 3 综合描述 .............................................................................................................................. 1

3.1 系统功能结构图 ....................................................................................................... 1 3.2 系统功能列表 ........................................................................................................... 1 3.3 系统角色说明 ........................................................................................................... 2 4 系统功能 .............................................................................................................................. 3

4.1 功能用例X（例如监控系统） .............................................................................. 3 4.2 用例参与者描述（例如操作员） ........................................................................... 3 4.3 流程图（例如操作流程） ....................................................................................... 3 4.4 用例描述（例如） ................................................................................................... 3 4.5 界面示例（例如） ................................................................................................... 4

4.5.1 子功能用例x（例如：） ............................................................................. 5

5 系统运行环境 ...................................................................................................................... 6

5.1 硬件环境 ................................................................................................................... 6 5.2 软件环境 ................................................................................................................... 6 5.3 网络环境 ................................................................................................................... 6 5.4 通信环境 ................................................................................................................... 6 6 性能需求 .............................................................................................................................. 6

6.1 系统容量估算 ........................................................................................................... 6 6.2 性能指标 ................................................................................................................... 6 7 接口需求 .............................................................................................................................. 7

7.1 硬件接口 ................................................................................................................... 7 7.2 软件接口 ................................................................................................................... 7

7.2.1 软件外部接口 ................................................................................................ 7 7.2.2 软件内部接口 ................................................................................................ 7 7.3 通信接口 ................................................................................................................... 7 8 用户特殊需求 ...................................................................................................................... 8

8.1 安全性需求 ............................................................................................................... 8 8.2 备份与恢复 ............................................................................................................... 8 8.3 与旧系统衔接 ........................................................................................................... 8 8.4 条件与限制 ............................................................................................................... 8 8.5 数据移植 ................................................................................................................... 8 8.6 数据维护 ................................................................................................................... 8 8.7 标准需求 ................................................................................................................... 9 8.8 不需要的特性 ........................................................................................................... 9 9 质量属性 .............................................................................................................................. 9

III

XXXX-02-05 V1.0

1 概述

1.1 目的

描述编写本文档目的

1.2 术语及缩略语

表 1-1本文档使用的术语及缩略语一览表 序号 1 2 3 术语或缩略语 解释 备注 2 引用文档

表 2-1引用文档一览表

序号 1 2 文档标识 文档名称 版本号 备注 3 综合描述

3.1 系统功能结构图

XX系统XXX1模块XXX2模块…………XXXn模块……功…………能…………请通知…假管…出差理功…能…功…功…能…能…功………功能………能功…功能…能图 3-1 系统功能结构图

3.2 系统功能列表

序号 1 2 功能名称/标识 子功能名称/标识 优先级 备注 -- -- 信息管理 /m_xxfb m_xxfb_gl 高 中 信息显示 m_xxfb_xs - 1 -

XXXX-02-05 V1.0

3

m_xxfb_fb 高 -- 3.3 系统角色说明

表 3-1 用户角色说明表

角色 工作职责 系统功能 1. 2. 3. 4. 5. 1. 2. 3. 4. 5. 操作员 信息编辑 信息显示 查询信息 删除信息 新增信息 查询情报板 管理员 信息编辑 信息显示 查询信息 删除信息 新增信息 查询情报板 维护员 信息显示 1. 查询信息 2. 查询情报板 - 2 -

XXXX-02-05 V1.0

4 系统功能

4.1 功能用例X（例如监控系统） uc 主用例 全程监控系统信息发布数据业务应用视频控制基础信息管理事件处理综合图形显示操作员路网协调车道监控管理系统基础功能数据统计分析智能专家 4.2 用例参与者描述（例如操作员）

本系统除定义了外部的参与者，还定义了“时间”的参与者，主要用于描述系统中用例的交互。 4.3 流程图（例如操作流程）

4.4 用例描述（例如）

功能名称/标识 用例名称 主要角色 //m_xxfb 操作员 子功能名称/标识 用例标识 无 u_xxfb - 3 -

XXXX-02-05 V1.0

上下文目标 在系统中操作 前置条件 最小保证 成功保证 1 2 信息已编辑 情报板状态正常 同【成功保证】 成功进行 1 用例执行者进入“”界面，显示所有本单位已编辑信息 点击已编辑信息列表 “勾选”信息，点击“”；显示预发布信息情况；点击“发布”； 点击“查看”，弹出“发送列表”，显示“发送结果”为“成功” 成功场景“1”的备选场景 成功场景 2 3 A 备选场景 4 无 5 扩展 无 无 1、当选择信息时，系统显示匹配情报板； 业务规则 2、当没有匹配的情报板时，不能发布操作; 3、当设备状态为故障时，系统提示不能发布情报板 界面ID 备注

ui_xxfb 含“追加”、“覆盖”方式。 4.5 界面示例（例如）

- 4 -

XXXX-02-05 V1.0

4.5.1 子功能用例x（例如：）

4.5.1.1 用例参与者描述 4.5.1.2 流程图 4.5.1.3 用例描述 4.5.1.4 界面示例 4.5.1.5 业务规则/算法

1. 页面的功能操作，做局部刷新，不刷新整个页面； 2. 删除文件夹时，文件夹及包含的所有文件都删除；

3. 共享的文件夹与不共享的文件夹在图片展示时需要区分；

4. 删除共享的文件夹或删除的文件夹内包含共享文件夹，系统需要给出用户提示，用户决定是否删除；如果删除的是所属于该共享文件夹内的文件夹或者文件，不用做是否删除共享的提示；

5. 上传的文件名前显示的格式图标，系统内置；

4.5.1.6 数据需求

表 4-1 情报板数据

- 5 -

XXXX-02-05 V1.0

字段名称 类型 宽度 20 取值范围 来源 缺省值 空否 备注 设备编码 字符 否 5 系统运行环境

5.1 硬件环境

表 5-1 运行环境中硬件项一览表 序号 1 2 3 4 硬件项名称 硬件配置 数量 备注 5.2 软件环境

表 5-2 运行环境中软件项一览表

序号 1 2 3 4 软件项名称 软件版本 数量 备注 5.3 网络环境

5.4 通信环境

6 性能需求

6.1 系统容量估算

注1： 描述对系统容量需求的估算，如数据库记录估算、数据库初始化需求、批处理作业估算、实时作业估算。

6.2 性能指标

注1： 所有的性能需求在这里列出，描述性能的峰值能力。包括响应时间、并发用户数、实时系统的时间关系等。

表 6-1性能指标

序号 1 2 3 4 功能模块名称 优先级 响应时间 8秒以内 5秒以内 5秒以内 3秒以内 并发数 20 10 10 200 - 6 -

数据规模 1万 5000 5000 10万 在线用户数 200 100 100 2000 备注 高 中 高 高

XXXX-02-05 V1.0

注1： 如有必要可将不同类型性能指标进一步细分，分别用不同章节进行描述。

7 接口需求

7.1 硬件接口

注1： 描述系统中软件和硬件每一接口的特征。这种描述可能包括支持的硬件类型、软硬件之间交流的数据和控制信息的性质以及所使用的通信协议。

表 7-1硬件接口 序号 1 2 3 硬件接口需求 名称/标识 具体要求 优先级 备注 注1： 如有必要对上表中的每条记录可分别扩展为表，详细描述每条记录的接口要求，扩展的表格由编写者根据需要自行定义格式。

7.2 软件接口

7.2.1 软件外部接口

注1： 描述该产品与其它外部组件（由名字和版本识别）的连接，包括数据库、操作系统、工具、库和集成的商业组件。明确并描述在软件组件之间交换数据或消息的目的。描述所需要的服务以及内部组件通信的性质。确定将在组件之间共享的数据。

7.2.2 软件内部接口

注1： 描述改产品本身系统内部子系统之间，模块之间的接口

表 7-2软件接口 序号 软件接口需求名称/标识 1 2 具体要求 优先级 备注 注1： 如有必要对上表中的每条记录可分别扩展为表，详细描述每条记录的接口要求，扩展的表格由编写者根据需要自行定义格式。

7.3 通信接口

注1： 描述与产品所使用的通信功能相关的需求，包括电子邮件、We b浏览器、网络通信标准或协议及电子表格等等。定义相关的消息格式。规定通信安全或加密问题、数据传输速率和同步通信机制。

表 7-3通信接口

序号 1 2 通信接口需求 名称/标识 具体要求 优先级 备注 注1： 如有必要对上表中的每条记录可分别扩展为表，详细描述每条记录的接口要求，扩展的表格由编写者根据需要自行定义格式。

- 7 -

XXXX-02-05 V1.0

8 用户特殊需求

8.1 安全性需求

注1： 详尽陈述与系统安全性、完整性或与私人问题相关的需求。定义用户身份确认或授权需求。明确产品必须满足的安全性或保密性策略。

8.2 备份与恢复

注1： 描述用户对备份与系统恢复的需求。

表 8-1备份与恢复 序号 1 2 3 4 5 备份与恢复需求名称/标识 具体要求 优先级 备注 8.3 与旧系统衔接

表 8-2与旧系统衔接 序号 1 2 3 4 5 与旧系统衔接需求名称/标识 具体要求 优先级 备注 8.4 条件与限制 8.5 数据移植

表 8-3数据移植 序号 1 2 3 4 数据移植需求名称/标识 具体要求 优先级 备注 8.6 数据维护

表 8-4数据维护 序号 1 数据维护需求名称/标识 - 8 -

具体要求 优先级 备注

XXXX-02-05 V1.0

2 3 4

8.7 标准需求

注1： 列出项目中必须遵循客户要求的标准。实际标准可作为本文档的附近单独列出。

表 8-5标准需求 序号 1 2 3 4 标准需求 名称/标识 具体要求 优先级 备注 8.8 不需要的特性

注1： 本节描述非隐含的用户明确提出的软件中不需要的特性。

9 质量属性

注1： 用文字描述有关在合同中标识的或从更高层说明派生出来的软件质量方面的需求，例如包括：

a) 有关软件的功能性（实现全部所需功能的能力）； b) 可靠性（产生正确、一致结果的能力）； c) 可维护性（易于更正的能力）；

d) 可用性（需要时进行访问和操作的能力）； e) 灵活性（易于适应需求变化的能力）；

f) 可移植性（易于修改以适应新环境的能力）； g) 可重用性（可被多个应用使用的能力）； h) 可测试性（易于充分测试的能力）； i) 易用性（易于学习和使用的能力）； j) 其它属性的定量需求。

- 9 -