系统概要设计说明书（内部版）模板

更新时间：2024-05-25 11:04:01 阅读量：综合文库文档下载

说明：文章内容仅供预览，部分内容可能不全。下载后的文档，内容与下面显示的完全一致。下载之前请确认下面内容是否您想要的，是否完整无缺。

{XXX系统}

概要设计说明书（内部版）

文件状态（?□） ? 征求意见稿 □ 正式发布

当前版本作者完成日期 V1.0.0 XX公司 XXXX年XX月

修订记录

版本修订日期修订位置（章节号）修订内容修订人

第1章引言 ..................................................................................................................................... 1 1.1 编写目的 ....................................................................................................................................... 1 1.2 定义 .............................................................................................................................................. 1 1.3 读者对象 ....................................................................................................................................... 1 1.4 参考文档 ....................................................................................................................................... 2 第2章需求概述 .............................................................................................................................. 2 2.1 项目背景 ....................................................................................................................................... 2 2.2 建设目标 ....................................................................................................................................... 2 2.3 建设内容 ....................................................................................................................................... 2 2.4 设计开发基本要求 ....................................................................................................................... 2 2.5 功能需求 ....................................................................................................................................... 2 2.5.1档案数字化加工 ................................................................................................................... 2 2.6 非功能需求 ................................................................................................................................... 4 2.7 项目工期与进度要求 ................................................................................................................... 4 第3章总体设计 .............................................................................................................................. 4 3.1 系统概述 ....................................................................................................................................... 4 3.2 系统平台架构 ............................................................................................................................... 4 3.3 系统关联模型 ............................................................................................................................... 4 3.4 系统功能结构 ............................................................................................................................... 4 3.5 系统功能模型 ............................................................................................................................... 4 3.6 系统部署结构 ............................................................................................................................... 5 3.7 系统运行环境 ............................................................................................................................... 5 3.8 需求检查表 ................................................................................................................................... 5 第4章档案数字化加工子系统 ....................................................................................................... 5 4.1 概述 .............................................................................................................................................. 5 4.2 功能结构 ....................................................................................................................................... 5

4.3 业务工作流程 ............................................................................................................................... 5 4.4 企业登记 ....................................................................................................................................... 5 4.4.1 概述 ...................................................................................................................................... 5 4.4.2 功能单元1 ........................................................................................................................... 5 4.4.3 功能单元2 ........................................................................................................................... 6 4.4.4关键处理流程（可选） ........................................................................................................ 6 4.5 档案扫描 ....................................................................................................................................... 6 4.6 著录标引 ....................................................................................................................................... 6 4.7 图文质检 ....................................................................................................................................... 6 4.8 工作考核 ....................................................................................................................................... 6 4.9 关键处理流程（可选） ............................................................................................................... 6 4.10安全技术应用概述（可选） ..................................................................................................... 6 4.11组件应用设计（可选） ............................................................................................................. 6 4.11.1组件调用列表 ..................................................................................................................... 6 4.11.2组件调用模型 ..................................................................................................................... 6 4.11.3组件应用功能设计 ............................................................................................................. 6 4.12全局数据结构设计 ..................................................................................................................... 6 4.12.1 物理模块1 ......................................................................................................................... 6 4.12.2 物理模块2 ......................................................................................................................... 7 4.13 需求检查表 ................................................................................................................................. 7 4.13.1 功能需求检查表 ................................................................................................................ 7 4.13.2 非功能需求检查表............................................................................................................. 8 第5章对外接待查询服务子系统 ................................................................................................... 8 第6章内部综合查询服务子系统 ................................................................................................... 8 第7章综合安全防护子系统 ........................................................................................................... 8 第8章集散式电子档案远程同步子系统 ........................................................................................ 8 第9章电子档案迁入迁出管理子系统 ............................................................................................ 8 第10章档案库房综合业务管理子系统 .......................................................................................... 8

第11章综合统计子系统 ................................................................................................................. 8 第12章系统维护管理子系统 ......................................................................................................... 8 第13章与其它信息化系统衔接子系统 .......................................................................................... 8 第14章组件设计 ............................................................................................................................ 8 14.1 XXX1组件 .................................................................................................................................... 8 14.1.1 概述 .................................................................................................................................... 8 14.1.2 接口设计 ............................................................................................................................ 9 14.1.3 功能设计与技术机制......................................................................................................... 9 14.1.4 关键处理流程（可选） ..................................................................................................... 9 14.1.5 调用关系 ............................................................................................................................ 9 14.2 XXX2组件 .................................................................................................................................... 9 14.3 XXX1代码模块 ............................................................................................................................ 9 14.3.1 概述 .................................................................................................................................. 10 14.3.2 接口设计 .......................................................................................................................... 10 14.3.3 关键处理流程（可选） ................................................................................................... 10 14.3.4 调用关系 .......................................................................................................................... 10 14.4 XXX2代码模块 .......................................................................................................................... 10 第15章数据结构设计 .................................................................................................................. 10 15.1 数据库设计 ............................................................................................................................... 10 15.2重要数据编码设计 ................................................................................................................... 10 第16章关键算法与技术机制（可选） ........................................................................................ 10 16.1 XXX ............................................................................................................................................. 10 16.1.1应用子系统及模块名称 .................................................................................................... 10 16.1.2 算法与技术机制说明....................................................................................................... 11 第17章系统性能设计 .................................................................................................................. 11 17.1 XXX功能 .................................................................................................................................... 11 17.1.1 应用子系统及模块名称 ................................................................................................... 11

17.1.2 性能设计 .......................................................................................................................... 11 第18章出错处理设计 .................................................................................................................. 11 18.1 出错信息 ................................................................................................................................... 11 18.2 错误日志文件 ........................................................................................................................... 11 第19章兼容性设计 ...................................................................................................................... 11 19.1 兼容性功能设计 ....................................................................................................................... 11 19.2 非兼容功能设计 ....................................................................................................................... 11 第20章相关性分析与设计 ........................................................................................................... 12 20.1 功能相关性 ............................................................................................................................... 12 20.2 数据结构相关性 ....................................................................................................................... 12 第21章界面设计概述 .................................................................................................................. 12 21.1 界面总体风格 ........................................................................................................................... 12 22.2 界面配色 ................................................................................................................................... 12 22.3 人机交互方式 ........................................................................................................................... 12 第22章旧系统遗留问题解决方案概述 ........................................................................................ 12 第23章产品功能配置与保护 ....................................................................................................... 12 23.1 产品功能配置与授权 ............................................................................................................... 12 23.2 软件产品保护 ........................................................................................................................... 13 第24章遗留问题 .......................................................................................................................... 13

XXX系统概要设计说明书（内部版）

第1章引言

1.1 编写目的

本文档描述了《XX系统》设计人员对该系统总体框架的设计方案，包括系统的基本处理流程、系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，用于指导开发人员进行编码设计开发，并且帮助后续升级维护人员了解掌握该系统的设计思路。用户也可以通过该文档更深一步的了解该系统。

1.2 定义

? 新系统：本次全新开发的《XX系统》。 ? 旧系统：原有的XX系统。

? 功能需求清单：对业务功能需求以表格形式逐项进行说明，包含功能需求编

号、业务功能名称、需求描述等内容。需求编号规则（如：“R1.1”）：字母“R”为前缀，第一位数字表示子系统编号，后面的数字表示当前子系统下的需求项编号。

? 功能单元清单：根据业务功能需求对系统功能模块及模块功能项进行划分，

以表格形式逐项进行说明，包含功能模块编号、功能模块名称、功能项编号、功能项名称、对应功能需求编号等内容。功能项编号规则（如：“F1.1.1”）：字母“F”为前缀，第一位数字表示子系统编号，第二位数字表示功能模块编号，最后的数字表示当前子系统功能模块下的功能项编号。

1.3 读者对象

客户方的技术、管理人员以及最终用户；开发方的需求、设计、实现人员，以及项目管理人员。

第 1 页共 13 页

XXX系统概要设计说明书（内部版）

1.4 参考文档

? XX招标文件 ? XX投标文件 ? XX用户需求说明书 ? XX项目合同

第2章需求概述

2.1 项目背景 2.2 建设目标 2.3 建设内容

2.4 设计开发基本要求 2.5 功能需求

（按子系统以表格形式列出系统功能需求，对需求项进行编号，便于引用及检查。）

系统业务功能涵盖档案数字化加工、对外接待查询服务、内部综合查询服务、综合安全防护、集散式电子档案远程同步、电子档案迁入迁出管理、档案库房综合业务管理、综合统计、系统维护管理、与其它信息化系统衔接等多个方面。

2.5.1档案数字化加工

用于实现纸质档案的数字化处理，提供企业登记、档案扫描、著录标引、图文质检等功能，支持流水线式档案数字化加工，具备闭环的质量控制机制。业务功能需求清单如下所示：

第 2 页共 13 页

XXX系统概要设计说明书（内部版）

功能需求编号 R1.1 R1.2 业务功能名称加工流程控制与闭环质量控制管理企业登记企业登记档案扫描档案扫描需求描述支持流水线式档案数字化加工，具备闭环的质量控制机制。提供档案基本信息的录入功能。提供档案基本信息的批量自动导入功能，可与其它信息化系统衔接，实现新增企业信息的自动获取与批量导入。要求采用标准的TWAIN接口规范，支持多种扫描仪采用档案一体化扫描及高效数字化处理技术获取高清晰度图像，扫描分辨率要求在200dpi以上（含200dpi）。无需通过扫描仪驱动界面即可直接对扫描方式、图像类型、幅面、扫描分辨率等扫描参数进行灵活设置。扫描同时自动完成图像压缩，黑白图像压缩格式采用CCITT Group 4，灰度及彩色压缩格式采用JPEG 。每卷档案存储为一个图像文件，将多页不同幅面的黑白、灰度R1.3 R1.4 R1.5 R1.6 R1.7 档案扫描档案扫描 R1.8 档案扫描及彩色图像压缩存储到一个TIFF文件中，著录信息存储在数据库中。 R1.9 R1.10 R1.11

著录标引著录标引图文质检提供目录信息录入、图像自动挂接、图像处理、页序调整等功能。自动建立分类索引和关键词索引等多种索引数据。提供数字化加工质量管控功能，可对电子档案图像、著录及索引信息进行全面的检查、校对及纠错处理。第 3 页共 13 页

XXX系统概要设计说明书（内部版）

2.6 非功能需求

2.7 项目工期与进度要求

第3章总体设计

3.1 系统概述 3.2 系统平台架构 3.3 系统关联模型

描述系统边界及与其它系统的关联关系。一般用图形来表达。

3.4 系统功能结构 3.5 系统功能模型

概括描述子系统、模块、组件之间的关联关系可以用数据流图、方框图、UML交互图来表达。

第 4 页共 13 页

XXX系统概要设计说明书（内部版）

3.6 系统部署结构 3.7 系统运行环境 3.8 需求检查表

第4章档案数字化加工子系统

4.1 概述 4.2 功能结构 4.3 业务工作流程

流程方框图中出现的是业务功能或活动。

4.4 企业登记 4.4.1 概述 4.4.2 功能单元1

以表格形式对此功能单元的具体功能项进行描述

第 5 页共 13 页

XXX系统概要设计说明书（内部版）

4.4.3 功能单元2

4.4.4关键处理流程（可选） 4.5 档案扫描 4.6 著录标引 4.7 图文质检 4.8 工作考核

4.9 关键处理流程（可选） 4.10安全技术应用概述（可选） 4.11组件应用设计（可选） 4.11.1组件调用列表 4.11.2组件调用模型 4.11.3组件应用功能设计 4.12全局数据结构设计 4.12.1 物理模块1

物理模块中的全局数据结构。主要描述内容为：

? 作用域 ? 耦合关系

第 6 页共 13 页

XXX系统概要设计说明书（内部版）

? 生命周期

4.12.2 物理模块2 4.13 需求检查表 4.13.1 功能需求检查表

功能模块编号功能模块名称功能项编号 F1.1.1 F1.1.2 F1.1.3 F1.1 企业登记 F1.1.4 F1.1.5 F1.1.6 F1.1.7 功能项名称客户端配置身份认证主界面启动选局企业登记信息同步企业信息管理企业状态管理对应功能需求编号 R1.2 R1.2 R1.2 R1.2 R1.2 R1.2 R1.2 第 7 页共 13 页

XXX系统概要设计说明书（内部版）

4.13.2 非功能需求检查表

第5章对外接待查询服务子系统第6章内部综合查询服务子系统第7章综合安全防护子系统第8章集散式电子档案远程同步子系统第9章电子档案迁入迁出管理子系统第10章档案库房综合业务管理子系统

第11章综合统计子系统第12章系统维护管理子系统第13章与其它信息化系统衔接子系统

第14章组件设计

14.1 XXX1组件 14.1.1 概述

第 8 页共 13 页

XXX系统概要设计说明书（内部版）

14.1.2 接口设计

14.1.3 功能设计与技术机制 14.1.4 关键处理流程（可选） 14.1.5 调用关系 14.2 XXX2组件 14.3 XXX1代码模块

（以源码方式进行复用的代码模块）

第 9 页共 13 页