概要设计说明书实例.docx

概要设计说明书实例1 引言. 3 1.1 编写目的 . 3 1.2 背景 . 3 1.3 定义 . 3 1.4 参考资料 . 3 2 总体设计 . 3 2.1 简述 . 3 2.2 架构设计 . 4 2.2.1 系统逻辑架构图 . 4 2.2.2 系统物理架构图 . 4 2.2.3 顶层系统包图 . 5 2.2.4 业务类包图 . 6 2.2.5 子系统关系图 . 7 2.3 接口设计 . 7 2.3.1 界面框架设计 . 7 2.3.2 外部接口设计 . 8 3 子系统设计 . 8 3.1 基础信息子系统 . 错误!未定义书签。 3.1.1 子系统说明 . 8 3.1.2 类图 . 9 3.1.3 类说明 . 13 3.1.4 界面设计 . 20 3.2 我的工作台子系统 . 错误!未定义书签。 3.2.1 子系统说明 . 22 3.2.2 类图 . 23 3.2.3 类说明 . 27 3.2.4 界面设计 . 33 3.3 工作进展子系统 . 错误!未定义书签。 3.3.1 子系统说明 . 34 3.3.2 类图 . 35 3.3.3 类说明 . 35 3.3.4 界面设计 . 35 3.4 信息发布子系统 . 错误!未定义书签。 3.4.1 子系统说明 . 错误!未定义书签。 3.4.2 类图 . 错误!未定义书签。 3.4.3 类说明 . 错误!未定义书签。 3.4.4 界面设计 . 错误!未定义书签。 3.5 系统管理子系统 . 错误!未定义书签。 3.5.1 子系统说明 . 错误!未定义书签。 3.5.2 类图 . 错误!未定义书签。 3.5.3 类说明 . 错误!未定义书签。 3.5.4 界面设计 . 错误!未定义书签。 3.6 个人设置子系统 . 错误!未定义书签。 1 4 5 3.6.1 子系统说明 . 错误!未定义书签。 3.6.2 类图 . 错误!未定义书签。 3.6.3 类说明 . 错误!未定义书签。 3.6.4 界面设计 . 错误!未定义书签。 约束和假定 . 35 系统数据结构设计 . 35 5.1 逻辑结构设计 . 35 5.1.1 角色表 . 36 5.1.2 权限表 . 36 5.1.3 角色权限表 . 36 5.1.4 部门表 . 36 5.1.5 岗位表 . 37 5.1.6 员工表 . 37 5.1.7 工作任务表 . 38 5.1.8 任务分派表 . 38 5.1.9 工作计划表 . 38 5.1.10 计划任务表 . 39 5.1.11 工作日志表 . 39 5.1.12 工作汇报表 . 40 5.1.13 信息发布表 . 40 5.1.14 收件箱表 . 40 5.1.15 系统操作日志表 . 41 5.1.16 个人提醒设置表 . 41 5.1.17 系统表 . 41 5.1.18 系统功能模块表 . 42 5.2 物理结构设计 . 42 5.3 数据结构与程序的关系 . 42 6 系统出错处理设计 . 42 6.1 6.2 6.3 出错信息 . 42 补救措施 . 42 系统维护设计 . 43 2 工作计划管理系统概要设计说明书 1 引言 1.1 编写目的 此概要设计说明书是为了说明整个系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。 1.2 背景 石油工程公司将打造“国际一流的石油工程技术服务公司”作为公司发展的战略目标，为确保这一目标的实现，本项目将建立一套以国际一流企业为战略标杆的企业间对标评价体系，引导企业持续对不足，促改进，使企业经营管理各项目标不断缩小与国内或国际先进水平的差距，保持领先优势，持续提升综合赢利能力。 1.3 定义 1.4 参考资料 石油工程公司对标评价合同书系统项目合同书 石油工程公司对标评价合同书系统项目技术服务合同附件 石油工程公司对标评价系统需求分析说明书 2 总体设计 2.1 简述 系统采用流行的B/S结构模式。系统的分析设计采用面向对象的技术，应用Visio等工具进行辅助设计。 2.2 架构设计 2.2.1 系统逻辑架构图 用户运维管理应用系统绩效考核系统对标评价系统运维系统信息服务绩效考核服务对标评价服务指标信息服务安全验证服务业务模块指标管理指标值管理评价管理绩效管理部门管理用户管理数据支撑评价数据库指标值数据库指标数据库2.2.2 系统物理架构图 Web服服服服服服服服服服服服服服服/服服服Internet服服服服服服服服服服服服服服服服服服服服服服服服 4 2.2.3 顶层系统包图 服服服服服服服服服服服服服服服服服服服服服服服服类包说明： n 业务页面：用户动态网页。 n 业务操作：主要控制业务访问的接口和业务流转。 n 数据处理：提供业务的实现，包括对业务数据的增、删、改、查等操作。 n 数据实体：业务对象的实体类。 n 数据接口：提供数据库的访问，传递数据或返回相应数据。 n 系统辅助：提供了供整个系统辅助的功能。 5 2.2.4 业务逻辑图 6 2.2.5 模块关系图 2.3 接口设计 2.3.1 界面框架设计 7 2.3.2 外部接口设计 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。 3 系统模块设计 3.1 系统管理模块 3.1.1 模块说明 系统管理模块包括：角色管理、部门管理、权限管理、员工管理四部分。 角色管理：定义角色和系统权限之间的对应关系，方便用户权限的分配控制。部门管理：实现对公司部门基本信息的维护。 权限管理：实现对用户访问权限信息的配置。 员工管理：实现对公司员工基本信息的维护。 8 3.1.2 类图 3.1.2.1 角色、权限 UI:角色Service:权限+通过ID查询角色(in 角色ID) : Data:角色实体类+通过名称查询角色(in 角色名称) : Data:角色实体类+查询全部角色 : Data:角色实体类+增加角色(in Data:角色实体类) : boolean+修改角色(in Data:角色实体类) : boolean+删除角色(in 角色ID) : boolean+分配权限(in 角色ID, in 权限列表) : boolean+读取角色权限(in 角色ID) : ObjectService:角色+通过ID查询角色(in 角色ID) : Data:角色实体类Data:角色实体类+通过名称查询角色(in 角色名称) : Data:角色实体类-角色ID : String+查询全部角色 : Data:角色实体类-角色名称 : String+增加角色(in Data:角色实体类) : boolean-拥有的权限 : String+修改角色(in Data:角色实体类) : boolean-角色说明 : String+删除角色(in 角色ID) : boolean+分配权限(in 角色ID, in 权限列表) : boolean+读取角色权限(in 角色ID) : ObjectData:角色+通过ID查询角色(in 角色ID) : Data:角色实体类+通过名称查询角色(in 角色名称) : Data:角色实体类+查询全部角色 : Data:角色实体类+增加角色(in Data:角色实体类) : boolean+修改角色(in Data:角色实体类) : boolean+删除角色(in 角色ID) : boolean+分配权限(in 角色ID, in 权限列表) : boolean+读取角色权限(in 角色ID) : Object9 UI:服服+服服服服服服服服服服 : void+服服服服服服服服服服服服(in 服服服服ID) : Data:服服服服服+服服服服服服(in 服服ID) : Data:服服服服服Data:服服服服服Service:服服+服服服服服服 : Data:服服服服服+服服服服服服服服服服服服(in 服服服服ID) : Data:服服服服服+服服服服服服(in 服服ID) : Data:服服服服服-服-服-服-服-服-服服服服服服服ID : String服服 : String服服 : String服服 : String服服 : String服服服服 : StringData:服服+服服服服服服 : Data:服服服服服+服服服服服服服服服服服服(in 服服服服ID) : Data:服服服服服+服服服服服服(in 服服ID) : Data:服服服服服10 3.1.2.2 部门管理 UI:部门管理+通过ID查询部门(in 角色ID) : Data:部门实体类+通过名称查询部门(in 角色名称) : Data:部门实体类+多条件查询部门(in 查询条件对象) : Data:部门实体类+查询全部部门 : Data:部门实体类+增加部门(in Data:部门实体类) : boolean+修改部门(in Data:部门实体类) : boolean+删除部门(in 部门ID) : boolean+树形显示部门 : voidData:部门实体类Service:部门管理+通过ID查询部门(in 角色ID) : Data:部门实体类+通过名称查询部门(in 角色名称) : Data:部门实体类+多条件查询部门(in 查询条件对象) : Data:部门实体类+查询全部部门 : Data:部门实体类+增加部门(in Data:部门实体类) : boolean+修改部门(in Data:部门实体类) : boolean+删除部门(in 部门ID) : boolean-部门ID : String-部门名称 : String-上级部门 : String-电话 : String-传真 : String-排序 : int-备注 : StringData:部门管理+通过ID查询部门(in 角色ID) : Data:部门实体类+通过名称查询部门(in 角色名称) : Data:部门实体类+多条件查询部门(in 查询条件对象) : Data:部门实体类+查询全部部门 : Data:部门实体类+增加部门(in Data:部门实体类) : boolean+修改部门(in Data:部门实体类) : boolean+删除部门(in 部门ID) : boolean11 3.1.2.3 岗位管理 UI:岗位管理+通过ID查询岗位(in 岗位ID) : Data:岗位实体类+多条件查询岗位(in 查询条件对象) : Data:岗位实体类+查询全部岗位 : Data:岗位实体类+增加岗位(in Data:岗位实体类) : boolean+修改岗位(in Data:岗位实体类) : boolean+删除岗位(in 岗位ID) : boolean+树形显示岗位 : voidService:部门管理Service:岗位管理+通过ID查询岗位(in 岗位ID) : Data:岗位实体类+多条件查询岗位(in 查询条件对象) : Data:岗位实体类+查询全部岗位 : Data:岗位实体类+增加岗位(in Data:岗位实体类) : boolean+修改岗位(in Data:岗位实体类) : boolean+删除岗位(in 岗位ID) : booleanData:岗位实体类-岗位ID : String-岗位名称 : String-上级岗位 : String-所属部门 : String-岗位职责 : String-排序 : intData:岗位管理+通过ID查询岗位(in 岗位ID) : Data:岗位实体类+多条件查询岗位(in 查询条件对象) : Data:岗位实体类+查询全部岗位 : Data:岗位实体类+增加岗位(in Data:岗位实体类) : boolean+修改岗位(in Data:岗位实体类) : boolean+删除岗位(in 岗位ID) : boolean12 3.1.2.4 员工管理 UI:员工管理+通过ID查询员工(in 员工ID) : Data:员工实体类+多条件查询员工(in 查询条件对象) : Data:员工实体类+查询全部员工 : Data:员工实体类+增加员工(in Data:员工实体类) : boolean+修改员工(in Data:员工实体类) : boolean+删除员工(in 员工ID) : boolean+员工修改登录密码(in 员工ID, in 密码) : booleanService:角色管理Service:岗位管理Service:部门管理Data:员工实体类Service:员工管理+通过ID查询员工(in 员工ID) : Data:员工实体类+多条件查询员工(in 查询条件对象) : Data:员工实体类+查询全部员工 : Data:员工实体类+增加员工(in Data:员工实体类) : boolean+修改员工(in Data:员工实体类) : boolean+删除员工(in 员工ID) : boolean+员工修改登录密码(in 员工ID, in 密码) : boolean+读取员工所属角色 : Object-员工ID : String-登录密码 : String-姓名 : String-性别 : String-所属部门 : String-所属岗位 : String-办公电话 : String-移动电话 : String-电子邮箱 : String-通讯地址 : String-备注 : String-所属角色 : String-帐号状态 : StringData:员工管理+通过ID查询员工(in 员工ID) : Data:员工实体类+多条件查询员工(in 查询条件对象) : Data:员工实体类+查询全部员工 : Data:员工实体类+增加员工(in Data:员工实体类) : boolean+修改员工(in Data:员工实体类) : boolean+删除员工(in 员工ID) : boolean+员工修改登录密码(in 员工ID, in 密码) : boolean+读取员工所属角色 : Object3.1.3 类说明 3.1.3.1 角色、权限 UI:角色+通过ID查询角色(in 角色ID) : Data:角色实体类+通过名称查询角色(in 角色名称) : Data:角色实体类+查询全部角色 : Data:角色实体类+增加角色(in Data:角色实体类) : boolean+修改角色(in Data:角色实体类) : boolean+删除角色(in 角色ID) : boolean+分配权限(in 角色ID, in 权限列表) : boolean+读取角色权限(in 角色ID) : Object通过ID查询角色：页面得到角色ID，调用Service:角色的通过ID查询角色方法,得到 13 指定角色的实体数据。 通过名称查询角色：页面得到角色名称，调用Service:角色的通过名称查询角色方法,得到指定角色的实体数据。 查询全部角色：调用Service:角色的查询全部角色方法,得到全部角色的实体数据。 增加角色：在页面上得到角色的实体数据，调用Service:角色的增加角色方法，实现角色的添加。 修改角色：在页面上得到修改后的角色实体数据，调用Service:角色的修改角色方法，实现角色的修改。 删除角色：调用Service:删除角色方法，将指定角色的数据置为已删除状态。 分配权限：调用Service:分配权限方法，给指定角色分配权限。 读取角色权限：调用Service:读取角色权限方法，读取指定角色的权限数据。 Service:角色+通过ID查询角色(in 角色ID) : Data:角色实体类+通过名称查询角色(in 角色名称) : Data:角色实体类+查询全部角色 : Data:角色实体类+增加角色(in Data:角色实体类) : boolean+修改角色(in Data:角色实体类) : boolean+删除角色(in 角色ID) : boolean+分配权限(in 角色ID, in 权限列表) : boolean+读取角色权限(in 角色ID) : Object通过ID查询角色：调用Data:角色的通过ID查询角色方法,得到指定角色的实体数据。 通过名称查询角色：调用Data:角色的通过名称查询角色方法,得到指定角色的实体数据。 查询全部角色：调用Data:角色的查询全部角色方法,得到全部角色的实体数据。 增加角色：调用Data:角色的增加角色方法，实现角色的添加。 修改角色：调用Data:角色的修改角色方法，实现角色的修改。 删除角色：调用Data:删除角色方法，将指定角色的数据置为已删除状态。 分配权限：调用Data:分配权限方法，给指定角色分配权限。 读取角色权限：调用Data:读取角色权限方法，读取指定角色的权限数据。 14 Data:角色+通过ID查询角色(in 角色ID) : Data:角色实体类+通过名称查询角色(in 角色名称) : Data:角色实体类+查询全部角色 : Data:角色实体类+增加角色(in Data:角色实体类) : boolean+修改角色(in Data:角色实体类) : boolean+删除角色(in 角色ID) : boolean+分配权限(in 角色ID, in 权限列表) : boolean+读取角色权限(in 角色ID) : Object通过ID查询角色：得到指定角色的实体数据。 通过名称查询角色：得到指定角色的实体数据。 查询全部角色：调用Data:角色的查询全部角色方法,得到全部角色的实体数据。 增加角色：实现角色的添加。 修改角色：实现角色的修改。 删除角色：将指定角色的数据置为已删除状态。 分配权限：给指定角色分配权限。 读取角色权限：读取指定角色的权限数据。 Data:角色实体类-角色ID : String-角色名称 : String-拥有的权限 : String-角色说明 : String角色实