
项目类别:xxxxxxxxxx
项目名称:xxxxxxxxxxxxx
修订历史记录
| 日期 | 版本 | 说明 | 作者 |
| 2xxxxx-xx | 0.1 | 确定xxxxxxxxx分内容 | xxxxxx |
| 201xxxxxx | 0.2 | 第xxxxxxxxxxxxxx修改 | xxxxxxxxxxxxxxxx |
引言
1.1. 目的
本文档首xxxxxxxxxxxxxxxxxx。这些文字和图形都为了详xxxxxxxxxxxxxxxxxxxxxxxx的描述创造了条件。
该文档详尽xxxxxxxxxxx需求的主要依据。
本需求规格说明书合法读者对象为:软xxxx项目xxxxxxx、测试工程师、运维人员….。
1.2. 需求优先级的约定
优先级的可能取值为:最高、高、中、低、最低,具体定义如下:
(1)最高。xxxxxxxxxxxx基本工作。
(2)高。是xxxxxxxxxxxxxx竞争力。
(3)中。是应该xxxxxxxxxxxxx的普通需求。
(4)低。是可能xxxxxxxxxxxxxxxxx的锦上添花的需求。
(5)最低。是备忘的,xxxxxxxxxxxx的需求。
注意:不管优先级为何值,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx变更为无需交付的需求除外。
1.3. 项目双方描述
xxxxxxxxxx
1.4. 预期的读者和阅读建议
本文档的主要内容共分xxxxx部分:综合xxxxxx、外部接xxxxxx述、系统特性和xxxxxxxxxx需求。综合描述部分主要xxxxxxxxx进行了大致的介绍;外部接xxxxxxxxxxxxxxxxxxxxx进行了详细的描述。
本文档面向多种读者对象:
(1)项目经理:项目经理可以根据该xxxxxxxxxxx能,并据此进行系统设计。
……
在阅读本文档时,首先要了解产品的功能概貌,然后可以根据自身的需要对每一功能进行适当的了解。
1.5. 术语和缩略词
| 术语/英文缩写 | 术语/英文全称 | 解释与描述 |
| xxxxx | xxxxxxxxxxxx | xxxxxxxxxxxxxx |
2. 综合描述
2.1. 项目背景
近些年………
2.2. 产品的功能
该系统分为xxxxxxxxxxxxx平台,这xxxxxxxxxxx。
(1)xxxxx平台
xxxxxxxxxxxx管理、xxxxx口管理、xxxxxxxxxxxxxx、其它基础功能。
(2)xxxxxxxx平台
数据xxxxxxxxxxxxx管理。
(3)xxxxxxxx平台
文件导航、代xxxxxxxxxxxcell右键功能、视图管理、xxxxxxxxxxxx选项卡管理、帮助。
(4)xxxxxxxx平台
欢迎xxxxxxxxxxxx管理、API介绍。
(5)后台管理平台
用户管理、角色管理、日志管理。
该系统的结构图如下所示:
(1)网络结构示意图如下:
……
图 2-1
(2)系统技术架构示意图如下:
……
图 2-2
(3)功能结构示意图如下:
………
图 2-3
为方便描述,根据实际需要把系统的功能划分为模块,这些功能将在“系统特性”部分进行详细的描述和说明。
2.3. 用户类和特征
该产品主要面向以下用户群体:
(1)xxxxx用户
使用xxxxxxxxxxxxxxxxxx。
(2)xxxxxx用户
1)xxxxx工程师:设计xxxxxxxxxxxxxxx改。
2)xxxxx平台工程师:对多xxxxxxxxxxxxxxxx理和维护。
(3)xxxxxx用户
对系统xxxxxxxxxxxxxxxxx操作。
2.4. 运行环境
该系统xxxxxxxxxxxx分。
2.5.设计和实现上的
……
2.6.假设和依赖
……
3.外部接口需求
……
4.系统特性
4.1.功能需求描述
4.1.1. 通用需求
4.1.1.1. 分xxxxxxxx
(1)显示列表记xxxxxxxxxxxxxxxxxxxxxxx则显示所有;
(2)可实现到xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx的跳转;
(3)可实现xxxxxxxxxx的跳转;
(4)当前页有选中状xxxxxxxxxxx保留选中状态。
4.1.1.2. 批量xxxxx
(1)若当页复选框xxxx,则xxxxxxxx;
(2)若xxxxxxxxx或等于1个,则“xxxxxxxxxxxxxxxxxx用状态;
(3)当前xxxxxxxxxxxxxxxxxx”按钮为禁用状态。
4.1.1.3. 重置xxxxxxxx
(1)点击“重置”按钮后,筛选条件中的各信息项恢复为默认值或空。
4.1.1.4. 时间/日期xxxxxxx
(1)默认显示“xxxxxxxxx”;
(2)xxxxxxxxx选择范围不限,初始化选择范围为xxxxxxxxxx;
(3)xxxxx的时间选择范围在一个自然月内,系统初始化日期选择范围为xxxxxxxxxx;
(4)日期选择组件所选xxxxxxxx;例如:2019-03-01到2019-03-03 ,表达含义为 2019-03-01 00:00:00 到 2019-03-03 23:59:59。
4.1.1.5. 删xxxxxxxx明
(1)所有删除操作xxxxxxxxxx则取消当前操作。
(2)本项目xxxxxxxxxxxxxxxx删除。
4.1.1.6. 文xxxxxxxxxxx说明
(1)系统对xxxxxxx。
4.1.1.7. 列表xxxxxxxx明
(1)单列内容过xxxxxxxxxxxxxxxxxxx部内容并可复制。
4.1.1.8.校xxx则
(1)需要校验的输xxxxxxxxxxxxxxxx法性校验。
4.1.1.9. 列表xxxxx
(1)xxxx操作:xxxxxxxx件的信息”。
(2)列表中xxxxxxx表示。
(3)关于时xxxxxxxxx示的列表项支持排序。
4.1.1.10.xxxxx说明
(1)主体xxxxxxxx为.pdf;
(2)批量下载用xxxxxxxxx;
(3)下载xx告时,xxx最大xxx为xxxxx;
(4)下载报告模板参见附录xxxxxxxxxxx模板 。
4.1.1.11. xxx请求
(1)所有xxxxxxxx需添加“加载中”图标。
4.1.1.12. 导航xx
(1)xxxxxxx的页面滚动时功能导航菜单位置固定。
…………
4.1.2. 系统xxx
系统xx包括:左xxxxxx展示系统…..。
xx及xx的用例图如下所示:
图 4-1
登录及平台选择业务流程图如下图所示:
图 4-2
4.1.2.1. 登xxxx
(1)页面操作
| 需求编号 | GN-xxx | 需求名称 | 登录 | |||
| 创建者 | Xxxx | 最后更改者 | xxx | 更改时间 | 2019.05.08 09:34 | |
| 用户类 | 业务用户、….用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.用户访问系统,点击子系统的入口;3.输入“账号”及密码; 4.点击“记住密码”(可不点); 5.点击“登录”按钮; | 2.显示登录框; 6.系统………………..。如果不通过,则……,清除密码框内容。 | |||||
| 功能需求 | ||||||
| 1.用户登录; 2.记住密码。 | ||||||
| 例外以及相应处理 | ||||||
| 1.如果………….成功的账号,密码默认填充。 | ||||||
| 特殊需求或限定 | ||||||
| 1.登录要求……….; 2.登录要求密码……….; 3.若用户账号被停用,……….。 | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
(1)个人信息下的二级菜单包括:xxxxxxx,xxxxxxxxxxx
(2)页面操作
| 需求编号 | GN-xxxxxC | 需求名称 | 修改昵称 | |||
| 创建者 | xxxxxxx | 最后更改者 | xxxx | 更改时间 | 2019.04.18 13:42 | |
| 用户类 | xxx用户、xx用户、xx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.点击“xxxxxxxxxxx”; 3.修改xxxxxx; 4.点击“确定”或“返回”; | 2.页面跳转到“xxxxxx”页面; 5.若用户点击“确定”…..,…..取消xxxxxxx页。 | |||||
| 功能需求 | ||||||
| 1.修改xxxxxx功能。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 1.默认展示原始账号及昵称信息; 2……; 3.昵称非空,…….; | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
| 需求编号 | GN-xxxxxxGMM | 需求名称 | 修改xxxxxx | |||
| 创建者 | xx | 最后更改者 | xxxxx | 更改时间 | 2019.04.18 13:42 | |
| 用户类 | 业务用户、研发用户、管理用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.点击“xxxxxxxx”; 3.修改xx; 4.点击“xx”或“xx”; | 2.页面跳转到“修改xxxxxx”页面; 5.点击“xxxxxxx登录框提示用户重新登录;点击“返回”,xxxxxxx到路由页。 | |||||
| 功能需求 | ||||||
| 1.修改xxxxx功能。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 1.账号修改中账号栏置灰,为不可修改状态; 2.修改密码……; 3.新密码………..; 4.“确认新密码”……….; 5.“新密码”…………; 6.点击确定按钮后……..通过才能成功修改密码; | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
(1)页面操作
| 需求编号 | xxxxxx | 需求名称 | 系xxxx择 | |||
| 创建者 | xxxxx | 最后更改者 | xxxxx | 更改时间 | 2019.03.06 09:21 | |
| 用户类 | xx用户、xx用户、xx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.用户点击“xxx平台”; | 2.在当前浏览器新标签页打开“xxx数据平台”; | |||||
| 1.用户点击“xx平台”; 3.用户点击“xxxxxx”或“xxxxxxx”; | 2.展开显示“xxxxxx”和“xxxxxxxxx”; 4. 在当前浏览器新标签页打开“xxxx”或“xxx.平台”。 | |||||
| 1.用户点击“平台”; | 2. 在当前浏览器新标签页打开“xxxxx用平台”; | |||||
| 1.用户点击“xxxxxxxx平台”; | 2. 在当前浏览器新标签页打开“xxxxxxxx平台”。 | |||||
| 功能需求 | ||||||
| 1.实现xxxxxxxxxxxx。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
(1)页面操作
| 需求编号 | GN-xxxxx-TC | 需求名称 | xxxxxxx | |||
| 创建者 | xxxxxx | 最后更改者 | xxxxxxx | 更改时间 | 2019.03.01 14:10 | |
| 用户类 | xx用户、xx用户、xx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.用户在当前页点击“xxxxxx按钮; 3.用户点击“是”或“否”按钮; | 2.系统弹出xxxxxxxxxx; 4.若为“是”,xxxxxxxxxxxxxxxx操作; | |||||
| 功能需求- | ||||||
| 1.退xxx。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 1.如果同xxxxxxxxxxxxxxxxx录状态失效并跳回登录页面。 2.cookie有效期为xxxxxxx。 | ||||||
| 调用的功能 | 同xxxxxxxxxxxxx | |||||
| 注释和说明 | ||||||
xxxxxxx管理系统分为xx管理、xx管理、xx管理及xxxx修改,管理员可以对平台进行操作。
4.1.3.1. xxx管理
xxxx管理用例图如下所示:
图 4-72
该页面包括xxxx条件,xxxxx列表(按最近一次xxx时间降序排列、列表不显示xxxx),翻页组件,xxxxxxxxxx。
(1)用户筛选条件包括:xxxxxxxxxxxxxxx。
(2)列表项包括:xxxxxxxxxxxxxxxxxxxxx。
(3)页面操作
4.1.3.1.1. 账号xx
| 需求编号 | GN-xxxxxxxx | 需求名称 | 账号xxxx | |||
| 创建者 | xxxxx | 最后更改者 | xxxxxx | 更改时间 | 2019.04.18 10:32 | |
| 用户类 | xx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.选择xxxxxx条件; 2.点击“xxxxxxxx按钮。 | 3.列表展示搜索结果。 | |||||
| 功能需求 | ||||||
| 1.筛选xxxx。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 1.账号xxxxxxxxxxxx1个数字 | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
添加账号弹框内信息项包括:xxxxxxx期间(精确到天),xxxxxxxxxxxx账号只能关联一个角色)。
xxxxxxxxxx流程图如下所示:
图 4-73
| 需求编号 | GN-xxxxxxxxx | 需求名称 | 添加xxxxxxxx | |||
| 创建者 | xxxxxx | 最后更改者 | xxxxxxxx | 更改时间 | 2019.03.07 10:50 | |
| 用户类 | xxx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.点击 “xxxxxx”按钮; 3.输xxxxxxxxxxxx项; 4.点击“确定”或“取消”或“X”按钮; | 2.弹出xxxxxxxx”弹框; 5.若xxxxxxxxxxxxx取消账号添加。 | |||||
| 功能需求 | ||||||
| 1.添xxxxxxx | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 1.初次打开添xxxxxxxxxx; 2.账号xxxxxxxx; 3.昵称不xxxxxxx; 4.密码为xxxxxxxxx; 5.重复密xxxxxxxxx持一致; 6.关联角色:xxxxxxxxxx关联一个角色; 7.点击确xxxxxxxxxxxxxx性校验通过才能成功添加账号。 | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
账号xxxxxxxx业务流程图如下所示:
图 4-74
| 需求编号 | GN-xxxxxx | 需求名称 | 账号停用/启用 | |||
| 创建者 | xxxxxxxx | 最后更改者 | xxxxxxxxxx | 更改时间 | 2019.03.04 16:20 | |
| 用户类 | xxxx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1. 点击列表xxxxx”; | 2.该账号的xxxxxxxx”。 | |||||
| 1.勾选xxx框; 2.点击“xxxxxxxxxx”按钮; | 2.对应的账号xxxxx常”。 | |||||
| 功能需求 | ||||||
| 1.账号xxxxxxxx功能。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
xx编辑弹框内信息项包括:xxxxxxxxxxxxxxxxxxxxxxxx信息。
xx编辑业务流程图如下所示:
图 4-75
| 需求编号 | GN-xxxxxx | 需求名称 | 编辑xxxxxxxxx | |||
| 创建者 | xxxx | 最后更改者 | xxxxxxx | 更改时间 | 2019.03.07 10:20 | |
| 用户类 | xxxxxx用户 | 需求优先级 | 高 | |||
| 用户输入或系统外激励 | 系统响应 | |||||
| 1.点击xxxxxxx中x辑”; 3.修改xxxxxxx项; 4.点击xxx“X”按钮; | 2.当前页xxxxxxxxxxx弹框; 5.若点击“确定xxxxxxxxxxxx成功;若点xxxxxxxxx“X”xxxxx改。 | |||||
| 功能需求 | ||||||
| 1.编辑账号。 | ||||||
| 例外以及相应处理 | ||||||
| 特殊需求或限定 | ||||||
| 1.除账号xxxxxxxxxxxxxxxxxxxxxxxxxxx同添加账号。 | ||||||
| 调用的功能 | ||||||
| 注释和说明 | ||||||
……
6.附录A:xxxxxxx平台系统组件信息
……
7.附录B:xxx下载
……..
8.附录C:xxxxxxxxx介绍
……….
