软件系统需求规格使用说明规范文本格式.docx

1、软件系统需求规格使用说明规范文本格式XXX公司XXXX系统XXX公司2013年8月需求规格说明书修订记录版本编号描述修订人单位修订日期1.1创建需求规格说明书。 2013-01-011.2增加XXX系统的XXX需求2013-06-011.3增加XXX需求及XXX需求2013-09-012.0定稿2014-01-01名词缩写：1. XXX集团，即“XXX省XXX集团有限责任公司”；引号里面为全称2. XXX系统，即“XXX集团XXX系统”；引号里面为全称3. XXX公司，即“XXX有限公司”，系统承建单位。引号里面为全称1. 引言1.1. 编写目的XXX公司项目团队在完成对XXX公司已有业务系统

2、（财务、供应、销售和人力资源）的功能调研，并对其作深入研究，同时分别派驻项目组员到、公司进行调研，并对调研结果进行详细分析，在和相关人员对建设功能深入探讨的基础上，提交这份系统需求规格说明书。本文档对XXX公司XXX系统做了全面细致的用户需求分析，明确所要开发的系统应具有的功能、性能与安全机制，使软件开发人员能清楚地了解用户的需求，并在此基础上完成后续设计与开发工作，同时本文档也作为项目评审验收的依据之一。本文档由甲乙双方项目负责人签字后方可生效。在项目实施过程中，根据XXX集团实际业务需要，在框架范围内的需求调整和变化，乙方应予满足；如有框架外需求更新，则由项目各方协商一致，任何一方不可单独

3、修改。本文档的主要读者包括：XXX集团管理人员、XXX集团部门及与XXX相关业务用户、XXX公司项目组实施人员、XXX系统项目组。1.2. 项目背景介绍招标单位实施该项目的背景。1.3. 术语定义术语定义J2EEJava 2 Platform, Enterprise Edition，是使用Java技术开发企业级应用的一种工业标准B/S架构即Browser/Server（浏览器/服务器）结构，是当今应用软件的首选体系结构ETLETL，Extraction-Transformation-Loading的缩写，中文名称为数据提取、转换和加载XXXXXX1.4. 参考资料序号资料名称1如中华人民共和国

4、国家标准GB8567-88计算机软件文件编制规范2XXX345672. 任务概述2.1. 建设目标介绍项目的建设目标如：围绕XXX工作的需要，XXX系统需要实现以下的建设目标：一、 实现XXX“结合”和XXX“转变”，即实现从XXX与XXX相结合；二、 实现；三、 全面.；四、 建立中心；五、 实现相关等。2.2. 建设内容写项目所需开发建设的功能及部署上线工作等内容如本项目的建设内容包括以下六大项：一、 建设XXX系统中心；二、 XXX系统基础应用平台；三、 XXX管理子系统（包括：系统管理、数据管理等模块）；四、 XXX子系统（包括：等模块）；五、 完成系统部署（硬件及相关配套软件部分另行

5、采购）；六、 完成项目配套的服务体系。七、 完成与XXX系统的集成对接工作。2.3. 用户要求写系统最终用户的要求如本系统最终用户主要为本系统维护人员、XXX业务操作人员及相关管理人员。对XXX维护人员的要求：掌握计算机基本操作，熟悉数据库基础知识，了解XXX各业务系统的数据库结构。对XXX系统维护人员的要求：掌握计算机基本操作，熟悉XXX业务流程。对系统操作人员的要求：了解XXX业务操作规范，掌握XXX工作基础知识。2.4. 假定和约束本文档是XXX系统需求的说明性文档。以XXX系统建设项目技术合同具体需要看实际项目中的文档资料的附件一XXX系统需求方案书为基本参照，若本开发需求规格说明书与

6、XXX系统需求方案书存在不一致或冲突的地方，以本开发需求规格说明书为准。 本文档不能完整描述所有的界面展示与操作流程情况。所以在实际开发过程中数据展示方式或操作流程按照需求可进行一定调整。 3. 系统需求3.1. 功能架构图放系统的架构图3.2. 通用需求各个用户功能界面基本都有类似/相同的操作功能，如列表显示，筛选和查询，导出，打印等，此类功能主要集中在“通用工具栏”。3.2.1. 系统通用工具栏1. 功能描述功能界面的工具栏可实现翻页、跳页、设置每页显示记录数、刷新界面内容、筛选查询和导出界面内容保存到本地等功能（注：本系统中，数据查询和数据分析等运用到查询控件实现的功能不配置本通用工具栏

7、，控件类查询具有自身的工具栏支持对应功能。除控件外的功能页面均在下方配置本通用工具栏，因此下文的非控件类查询功能不再阐述查询、条件搜索与导出的功能实现）。2. 功能设计a) 本功能主要设有翻页、跳页、设置每页显示记录数、刷新界面内容、筛选查询和导出界面内容保存到本地等功能按钮；b) 工具栏右侧显示当前页面记录数和所有记录数；c) 筛选查询弹窗显示自定义查询条件录入框，能对当前页面的显示字段进行条件定义，筛选查询对应的内容。3. 输入条件翻页：当界面分为多页时，点击相关按钮或直接填写跳转翻页。点击“”，界面跳转到第一页；点击“”，界面跳转到最后一页；点击“”，界面跳转到上一页；点击“”，界面跳转

8、到下一页；在“”空白处，直接填写数字，按“回车键（Enter键）”界面即跳转到所输入的页面。 名称 取值方式 类型 格式 精度跳页 （手工录入） 数值 整数每页显示条数（手工录入） 数值 整数（1-1000）刷新：刷新当前页面的内容，更新显示的页面信息。查询条件：弹窗显示自定义查询条件录入框。名称 取值方式 类型 格式 精度列名称 （下拉选择） 字符条件 （下拉选择） 字符值 （手工录入） 字符导出excel：把当前页面的内容导出到excel电子表格。3.2.2. 其它通用需求XXX系统内涉及到修改、更新和删除操作的功能点，均弹出确认是否继续的对话框，以减少误操作而带来的麻烦。3.3. XXX

9、管理子系统此处开始写各功能模块的用途、设计界面等内容，下面以常见的单位管理功能为例3.3.1. 系统管理3.3.1.1. 日常维护日常维护是对系统最基础信息的初始化设置管理与维护，主要包括单位管理、部门管理、人员管理、日志管理、在线用户等。3.3.1.1.1. 单位管理1. 功能描述单位管理可编辑单位编号、单位名称、单位类型以及其它单位详细资料，本功能主要为系统提供建立单位库信息功能。 2. 功能设计a) 本功能主要设有新增下级、新增同级、修改、删除、单位排序设置等功能按钮；b) 主界面分两部分显示，左侧以树状结构显示单位分类、右侧是各下级单位显示界面；c) 右侧界面显示单位编号、单位名称、单

10、位电话、单位法人和单位地址等信息。3. 输入条件新增下级：新增下级单位，进入新增界面，需录入内容如下（*号为必选项）， 名称 取值方式 类型 格式 精度* 单位名称（手工录入） 字符* 单位编号（手工录入） 字符* 单位简称（手工录入） 字符单位类型（下拉选择） 字符行业类型（下拉选择） 字符办公地址（手工录入） 字符法人代表（手工录入） 字符联系电话（手工录入） 字符传真 （手工录入） 字符邮箱 （手工录入） 字符新增同级：新增同级与新增下级界面相同。修改：修改内容与新增内容相同。删除：选择某个单位后点击“删除”按钮，即可删除对应的单位。单位排序：单击拖动进行单位位置上下排序。输入信息校验，

11、必填项为空或录入非对应的数据类型、格式时，不能通过验证，并提示录入信息错误，修正后方可保存。单位名称同名校验，新增同一单位名称不能保存。4. 输出结果功能主界面：单位编号单位名称单位电话单位法人单位地址1字符字符字符字符字符233.3.1.1.2. XXX1. 功能描述单位对照对每年变更的组织机构与单位进行关联性对照，使得变更后的单位保持权限的延续性与数据的完整性。2. 功能设计a) 本功能主要设有对照、删除对照功能、排序按钮；b) 主界面分三部分显示，左侧是年份，右侧以树状结构显示单位层级界面；c) 右侧界面显示单位编号、单位名称、对照后的单位名称。d) 程序界面可以通过拖拽左边的前期单位与

12、右边当期单位进行关联。e) 可以选定一个单位，对该单位进行对照关系维护。3. 输入条件对照：通过拖拽左边的前期单位名称到右边的当期单位名称进行关联。删除对照：选择某个单位后点击“删除对照”或“X” 按钮，即可删除已对照的单位。4. 输出结果功能主界面：所有年份前期组织机构当前组织机构对照日期 YYYY-MM-DD字符字符固定值3.3.1.2. XXX3.3.1.2.1. XXX1. 功能描述本功能是XXX。2. 功能设计a) 设有XXX功能按钮。b) XXX；c) XXX。3. 输出结果功能主界面：- 所有角色 - 管理子系统 角色1 角色2 - 项目子系统 角色1 角色2菜单编号菜单名称操作

13、登记人登记日期3.3.1.3. XXX3.3.1.3.1. XXX1. 功能描述本功能XXX。2. 功能设计a) XXX；b) XXX；c) XXX。3. 输入条件XXX。4. 输出结果- 所有菜单菜单名称菜单链接菜单类型上级菜单编号是否有下级排序序号+ 管理子系统1XXXXXXXXXXXXXXXXXX+ 项目子系统23.直到列完所有的功能模块3.4. 集成需求3.4.1. 基础数据对接列出本次项目系统与项目实施单位需要对接的系统及对接系统需要采集的相关数据模块如：XXX系统对XXX集团现有的XXX财务系统和XXX管理系统、XXX的营销系统、XXX的人力资源系统的数据进行采集，形成XXX系统内

14、的数据中心。一、XXX财务系统采集的数据包括单位组织架构；二、XXX物资管理系统采集的数据包括库存数据、采购合同、出入库单据、退货单等等相关业务单据；三、XXX营销系统本次采集的数据主要为销售合同；四、XXX人力资源系统。除了对以上4个业务系统数据进行采集之外，XXX集团XXX系统还需实现与XXX系统的集成，从而实现单点登录及XXX系统审批等工作。3.4.2. 单点登录（SSO）XXX系统通过与XXX办公系统实施集成，实现相关基础数据（组织机构、用户数据等）的共享，实施统一身份认证和统一登录界面。3.4.3. 文书跨系统审批XXX系统部分文书需根据需要提交至协同办公系统，由文书审批人在协同办公

15、系统内进行审批，录入审批意见并签章，然后返回；XXX系统将审批意见及签章图片进行保存，同时对审批情况进行展示。3.4.4. 短信提醒XXX系统采集到XXX办公系统中的人员信息和手机号码，XXX系统所有的待办信息可通过协同办公系统的短信功能发送到待办人员的手机。3.5. 性能需求系统运行的性能要求如本项目系统的运行性能如下：系统部署在X86机架式服务器（2个Intel 8核Xeon 7-8837 处理器（2.67GHz/24M缓存）、128GB内存）上，对百万级别的数据表实现页面访问响应时间小于2秒、查询统计响应时间小于4秒，可以达到并发用户数200，最大在线用户数800以上。客户端的操作速度主

16、要和操作系统版本以及内存有关，一般VISTA/WIN7下推荐8G内存至少4G内存、XP下推荐4G内存至少2G内存；CPU推荐双核处理器。3.6. 网络需求XXX系统服务器提供互联网访问服务，则无论是放在局域网端口映射方式还是托管方式，都对XXX集团本身上网带宽有一定要求，一般情况下最低带宽要求是(上行/下行独占4M)，并发人数越多，带宽需求越大，并且XXX集团网络控制实施措施对访问速度也有相应的影响。3.7. 存储需求硬盘剩余空间容量与单位个数和每年的项目数大小相关，推荐的指标为：剩余空间容量基础数据表300M+单位个数100M+项目数100M2；以XXX集团以往两年的XXX项目测算3.8.

17、安全需求3.8.1. 技术平台设计安全需求XXX公司XXX系统在性能上按照相关的安全需求文件名称的要求如下：XXX系统的安全方案分为两个部分：身份认证、访问控制及代码安全。3.8.1.1. 身份认证系统默认提供两种身份认证方式：1静态密码：使用在用户管理中用户所输入的密码进行身份认证。提供密码的有效期限制。在密码有效期过后可强制用户更改密码。2即时校验码：以单点登录方式登录系统需要先获取用户的即时校验码，在用户及校验码验证通过后才允许登录系统，同时该校验码失效。3.8.1.2. 代码安全和安全代码采用B/S多层结构，系统代码全部放于服务器上，只有服务器管理人员才能更改代码。客户端的代码是在运行

18、时动态地下载到客户端的，意味着不能在客户端修改运行代码。同时借助于Java提供的沙盒功能，也限制了下载的代码访问本地文件的功能，保护了用户的计算机。另外由于只有运行在服务器上的代码才可以访问数据库，客户端不能直接访问，这样也保证了数据库服务器的安全。3.8.2. 系统运行安全需求3.8.2.1. 数据安全需求项目所采取的数据安全保护措施，下列举例说明，具体以各自的实际项目为准在数据中心功能模块中，对来自不同系统、不同种类的数据进行集中、统一管理；实行严格的权限控制，结合操作用户的组织架构、管理角色与项目角色进行数据权限控制，以保证数据的安全性和保密性，XXX系统采取以下二种方式进行数据隔离：一

19、、单位分级隔离本单位只看到本单位数据及其管辖的单位数据。另外，只能对本单位的文书数据进行维护（如XXX中心的XXX模块），其他单位发起的文书数据只能查阅。三、权限隔离系统管理模块中可针对某用户账户进行个性化定制权限。另外，针对系统管理员，还分级设置系统管理员，如一级系统管理员可授权部分功能权限给二级系统管理员，二级系统管理员只能对授权的功能进行权限维护。3.8.2.2. 应用功能安全需求在系统管理功能模块中，机构设置、角色管理、人员管理及资源权限分配使系统的安全性得到保障，系统日志信息等使用户能够对系统的使用情况有详细的了解。4. 运行环境规定4.1. 设备具体以实际的项目设备为准，下面只是举

20、例表示一下格式应用服务器1台CPU：4个Intel 8核Xeon 7-8837 处理器（2.67GHz/24M缓存）内存：128GB（168GB）1066MHz DDR3，最大可扩充至2TB硬盘：8个600GB 10K 6Gbps 2.5 SAS 热插拔硬盘，8个硬盘槽全可用阵列：ServerRAID阵列卡（阵列控制器），支持RAID5网络：1个SAN FC网络口（一进一出），SAS直连，两个千兆以太网口电源：2个热拔插电源（带PDU电源线），满足冗余要求其他：4U机架式、导轨、DVD光驱数据库服务器1台：CPU：4个Intel 8核Xeon 7-8837 处理器（2.67GHz/24M缓存）

21、内存：128GB（168GB）1066MHz DDR3，最大可扩充至2TB硬盘：8个600GB 10K 6Gbps 2.5 SAS 热插拔硬盘，8个硬盘槽全可用阵列：ServerRAID阵列卡（阵列控制器），支持RAID5网络：1个SAN FC网络口（一进一出），SAS直连，两个千兆以太网口电源：2个热拔插电源（带PDU电源线），满足冗余要求其他：4U机架式、导轨、DVD光驱存储系统1个：硬盘扩展笼：1个EVA6400硬盘扩展笼，16块300G硬盘高速影像拍摄扫描仪：XXX拍摄仪：图形色彩24位，分辨率最高25921944，格式JPEG、TIF、PDF、BMP、PNG、GIF4.2. 软件4.

22、2.1. 服务器操作系统版本具体以实际的项目服务器操作系统版本为准，下面只是举例表示一下格式应用服务器操作系统： CentOS5数据库服务器操作系统： CentOS54.2.2. 客户机具体以实际的项目4.2.2. 客户机为准，下面只是举例表示一下格式操作系统：Windows XP/Vista/7/2008/8浏览器：IE （注：在用户登录时，应对用户浏览器是否为IE进行检测并根据情况给出提示）4.2.3. 数据库版本具体以实际的项目数据库版本为准，下面只是举例表示一下格式数据库：Oracle 11g4.2.4. 中间件服务器版本具体以实际的项目4.2.4. 中间件服务器版本为准，下面只是举例

23、表示一下格式中间件服务器：TOMCAT 6.04.3. 接口4.3.1. 外部接口4.3.1.1. 硬件接口系统XXX模块设置了打印功能，直接调用本机系统的打印接口，如需打印报表，需要安装标准打印机进行报表打印。没有对应的功能则可不写4.3.1.2. 软件接口具体以实际的项目设备为准，下面只是举例表示一下格式系统需要对接的软件系统主要有：XXX财务系统和XXX物资管理系统、XXX营销系统、XXX的人力资源系统、XXX的协同办公系统。对接的方式有两种：一种是通过数据采集功能模块将对接系统的数据采集到本系统，这种方式需要对接系统所属部门提供对接系统的数据库接口及相关数据对象。另一种是通过数据文件的

24、形式通过系统数据导入接口将数据导入到本系统，这种方式需要约定数据文件存储格式及数据文件导入格式。目前，使用第一种方式进行对接的软件系统有：XXX财务系统和XXX管理系统、XXX的营销系统、XXX的人力资源系统。使用第二种方式进行对接的软件系统有：XXX的协同办公系统。4.3.2. 内部接口4.3.2.1. 系统使用控件具体以实际的项目系统使用控件为准，下面只是举例表示一下格式系统数据查询及分析报表控件使用webservice接口调用系统数据，采用axis Webservice框架实现，查询控件调用该接口获取系统数据。4.3.2.2. OFFICE公式构件库扩展 MS OFFCIE 系列软件的计

25、算引擎，实现了在 Word/Excel 中直接引用远程服务器上存放的远程文档内容。该公式构件库是基于ACTIVEX、OFFICE VBA 和 AJAX技术扩展了Offcie的内置计算公式，文件传输协议采用HTTP标准协议，实现了本地文档直接获取服务器端公式结果和远程文档内容的调用功能。 系统核心程序采用 B/S 架构开发，采用调度程序完成远程服务器上 OFFICE 的文档下载到本地，以及本地打开和修改权限控制。4.3.2.3. 系统日志系统日志采用LOG4j框架进行日志管理，日志输出分为显示终端输出与文件输出，输出格式通过配置文件进行配置，配置文件为根目录下的WEB-INFclasses文件夹

26、下的log4j.xml文件，系统程序使用LOG4j提供的api接口进行日志输出。4.3.2.4. 计划调度系统计划调用采用Quartz框架，Quartz需要配置启动信息，该配置文件为根目录下的WEB-INFclasses文件夹下的quartz.properties文件。系统程序使用Quartz提供的相关api接口进行调度管理。4.3.2.5. 工作流系统流程控制采用JBPM工作流框架，JBPM需要配置启动信息，该配置文件为根目录下的WEB-INFclasses文件夹下的jbpm.cfg.xml文件。系统程序使用JBPM提供的相关api接口进行流程的发布与扭转控制。4.3.2.6. 界面功能模块系统功能界面数据是通过数据库数据表进行数据交互的，表与表之间的数据关联根据功能要求进行设计。文档确认XXX集团：XXXXXX公司：监理单位：