详细设计说明书-模板.docx

《详细设计说明书-模板.docx》由会员分享，可在线阅读，更多相关《详细设计说明书-模板.docx（11页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、详细设计说明书-模板 *项目 详细设计说明书xxxx有限公司 变更记录 版本号修改点说明变更日期变更人审批人V1.0 创建2022/12/14 修改点说明的内容有如下几种：创建、修改（+修改说明）、删除（+删除说明） 目录 1前言 (1) 1.1文档目的 (1) 1.2背景 (1) 1.3文档范围 (1) 1.4读者对象 (1) 1.5参考文档 (1) 1.6术语与缩写解释 (2) 2总体设计 (2) 2.1系统描述 (2) 2.1.1系统概述 (2) 2.1.2运行环境 (2) 2.1.3数据管理要求 (2) 2.1.4故障处理要求 (3) 2.1.5其他要求 (3) 2.2总体设计说明 (

2、4) 2.2.1基本设计概述 (4) 2.2.2设计思想 (4) 2.2.3功能架构 (4) 2.2.4系统功能流程 (4) 2.2.5系统功能分类 (4) 3程序详细设计 (5) 3.1基本信息维护 (5) 3.1.1单位管理 (5) 3.1.2人员维护 (6) 3.2准备阶段 (6) 3.3系统设置 (6) 3.3.1数据备份与恢复 (6) 3.3.2用户管理 (7) 3.3.3日志管理 (7) 4接口设计 (7) 1前言 1.1文档目的 文档编写目的是为了阐述平台的详细设计。详细设计说明书是为了说明平台各功能点的设计思路，作为系统编码人员进行编码实现的依据。本说明书的预期读者为系统开发人

3、员、系统测试人员和项目评审人员。 1.2背景 系统以分层分类考核，定量与定性相结合，突出综合分析研判，力求简便易行、有效管用，各客户单位对此也提出了相应的需求，希望尽快推广。 1.3文档范围 1、产品范围：根据需求规格说明书和概要设计说明书，该文档阐述软件的设计逻辑。 2、涉及到的干系人有：项目经理、质量小组、开发小组。 1.4读者对象 ?项目经理、质量保证人员：据此来进入项目策划过程。 ?测试人员：据此进入测试过程。 ?需求管理员、配置管理员：可以识别配置项制定相关的活动计划 ?开发人员，包括设计人员、编码人员：明确任务与需求，清楚项目开发流程。 1.5参考文档 需求规格说明书 概要设计说明

4、书 1.6术语与缩写解释 术语或缩略语解释 2总体设计 2.1系统描述 2.1.1系统概述 系统使用JAVA计算机语言，提供 B/S架构的网上民主测评业务，实现数据维护、分析等功能。 2.1.2运行环境 对本平台所赖于运行的硬件、软件环境的描述。 ?服务端操作系统：？； ?服务端运行环境：？； ?数据库支持：、？； ?协议支持：TCP/IP、HTTP等； ?硬件支持：服务器CPU 2.0GHz以上、内存2G以上、需要300G 以上的空闲磁盘 空间？； ?网络环境：有固定公网IP，网络畅通； ?客户端要求：？； 2.1.3数据管理要求 提供基于角色、基于功能、基于单位的权限管理，提供用户管理。通

5、过多种用户授权策略，定期对数据库进行自动备份，保证数据信息安全。 2.1.4故障处理要求 （1）产品支撑环境运行错误，包括以下几个方面： ?数据库运行错误：系统无法使用，将提供错误提示页面，并记录日志。 ?系统配置参数错误：系统提供错误提示页面，要求管理员修改相关配置参数。 配置参数的修改方法应参考相关为管理员提供的手册。 ?系统参数初始化错误：提供系统初始化功能，用于成批完成系统初始化。在初 始化过程中，对于严重影响平台运行的错误，提供错误提示页面。对于普通错 误，记录日志。 ?应用程序错误：由应用程序提供错误提示页面，相关错误应记录日志。 2.1.5其他要求 ?先进性：采用先进成熟的技术，

6、确保系统的先进性、经济性和实用性。 ?安全可靠：提供的应用框架及平台本身提供应用安全保证，并可以和第三方安 全手段，如认证、加密、电子签名等进行集成。必须保证数据的安全性和保密 性。对于基于平台开发的应用系统，只允许有权限的人员进行操作和浏览信息。 必须有安全的手段来进行权限控制。 ?开放互连：系统应对各类业务系统、数据库系统、WEB信息等具有通用的或可 定制的接口策略和连接方法。 ?规范性：开发过程控制、开发技术、系统编码、文档应规范化，并遵循相应的 国内外标准。开发结束，需要提供必要的文档资料。 ?可靠性：保证系统的可靠运行和在升级过程中的方便快捷。 ?可扩充性：系统应当可以根据需求的变化

7、，方便地进行功能的调整、增减，模 块的升级和系统架构的逐步完善。 ?界面友好、操作方便：操作界面要直观、简单、贴近实际，操作过程应当尽量 简化，符合实际过程。身份认证过程即要保证安全，也要尽量简化认证过程。 ?可维护性：系统维护应当简单。 2.2总体设计说明 2.2.1基本设计概述 从需求规格说明书出发，根据需求分析阶段确定的功能设计软件系统的整体结构、划分功能模块、确定每个模块的实现算法以及编写具体的代码，形成软件的具体设计方案。 2.2.2设计思想 本概要设计主要由结构设计、接口设计、全局数据结构设计及其他方面设计组成。需遵循软抽象、模块化、信息隐蔽及模块独立性等特征。模块独立性从两个方面

8、度量： (1)内聚性：偶然内聚、逻辑内聚、时间内聚、过程内聚、通信内聚、顺序内聚、功能内聚。 (2)耦合性：内容耦合、公共耦合、外部耦合、控制耦合、标记耦合、数据耦合、非直接耦合 2.2.3功能架构 ？ 系统功能分为：？ 2.2.4系统功能流程 功能流程依据测评实际业务流程来设计，按照项目管理的阶段划分，系统功能设计也按照，测评准备阶段、测评阶段、测评完成阶段的流程进行设计。功能流程图如下： 2.2.5系统功能分类 功能类别子功能 基础信息维护单位管理人员维护 系统设置数据备份数据恢复用户管理日志管理 3程序详细设计 3.1基本信息维护 3.1.1单位管理 1、功能详细说明：单位信息包括单位设

9、立、单位变更、单位撤消、单位整等功能。设立 主管单位、二级单位、三级单位等。 2、输入:机构名称、机构类型、岗位类型 3、输出：无 4、限制条件：同级单位不能超过999个。 5、处理逻辑：建立单位树形结构，二级单位在上级单位编码下再次自动生成一级编码， 通过orderid控制显示先后位置。 3.1.2人员维护 1、功能详细说明：干部系统维护完成后，可以导入人员数据，单位数据，选取到测评模 块。通过导入完成测评对象的创建。 2、输入：姓名、性别、出生日期、工作单位及职务、主体类别 3、输出：无 4、限制条件：无 5、处理逻辑：通过任职单位确定人员所在单位，可以存在多任职情况。 3.2准备阶段 3

10、.3系统设置 3.3.1数据备份与恢复 1、功能详细说明：对本系统所存储的数据应具有数据备份与恢复的功能，对整个数据库 的备份建议使用光盘库等海量存储设备来进行，每周至少要进行一次对数据库的完整 备份，并在存储介质上作好记录。以便在需要时能够很方便的找到需要的备份数据， 方便以后数据的恢复。 2、输入:数据备份或恢复信号 3、输出：备份或恢复成功 4、限制条件：无 5、处理逻辑：整个数据库的备份与恢复 3.3.2用户管理 1、功能详细说明：用户管理:用户组由多个用户组成，每个用户只能属于一个用户组，系 统管理员只能对用户组授权，每个用户组有一个特权用户，特权用户拥有该用户组的 所有权限，它还可

11、以给本用户组中的其它用户进行授权（所授权限范围，仅限于该用 户组所拥有的权限范围）。权限管理:管理系统用户的权限，包含：授权和收回等功能 项。 2、输入:用户名、密码 3、输出：显示权限范围 4、限制条件：无 5、处理逻辑：根据功能设置权限 3.3.3日志管理 1、功能详细说明：本功能模块主要是对系统日志进行管理和操作，包含如下功能项：日 志记录，浏览日志、日志备份、日志恢复、打印日志、日志查询。系统日志信息包含 以下信息项：用户代码、用户IP地址、登入时间、进行的操作等。对匿名测评不记 录任何日志。 2、输入:系统自动记录日志信息 3、输出：可以查询日志记录信息 4、限制条件：无 5、处理逻辑：匿名测评不记录任何日志。 4接口设计 ？与？系统数据接口 测评结果导出后，转入内网的干部系统，做为干部考察干部管理信息的一部分。 测评单位管理与人员管理可与干部系统交互,可独自建立机构人员,也可共用机构人员。