概要设计说明书实例-经典.doc

1、11 引言 .31.1 编写目的.31.2 背景.31.3 定义.31.4 参考资料.32 总体设计 .32.1 简述.32.2 架构设计.42.2.1 系统逻辑架构图.42.2.2 系统物理架构图.42.2.3 顶层系统包图.52.2.4 业务类包图.62.2.5 子系统关系图.62.3 接口设计.62.3.1 界面框架设计.62.3.2 外部接口设计.73 子系统设计 .73.1 基础信息子系统.73.1.1 子系统说明.73.1.2 类图.83.1.3 类说明.123.1.4 界面设计.193.2 我的工作台子系统.213.2.1 子系统说明.213.2.2 类图.223.2.3 类说明

2、.263.2.4 界面设计.323.3 工作进展子系统.333.3.1 子系统说明.333.3.2 类图.343.3.3 类说明.343.3.4 界面设计.343.4 信息发布子系统.363.4.1 子系统说明.363.4.2 类图.363.4.3 类说明.373.4.4 界面设计.383.5 系统管理子系统.383.5.1 子系统说明.383.5.2 类图.393.5.3 类说明.393.5.4 界面设计.403.6 个人设置子系统.4123.6.1 子系统说明.413.6.2 类图.423.6.3 类说明.433.6.4 界面设计.444 约束和假定 .455 系统数据结构设计 .455.

3、1 逻辑结构设计.455.1.1 角色表（PUBLIC_ROLE ） .465.1.2 权限表（PUBLIC_PRIVILEGE ） .465.1.3 角色权限表（PUBLIC_ROLEPRIVILEGE ） .465.1.4 部门表（PUBLIC_ DEPT） .465.1.5 岗位表（PUBLIC_POST） .475.1.6 员工表（PUBLIC_MEMBER ） .485.1.7 工作任务表（WORKPLAN_ TASK） .485.1.8 任务分派表（WORKPLAN_ ALLOTTASK） .495.1.9 工作计划表（WORKPLAN_ PLAN） .495.1.10 计划任务表

4、（WORKPLAN_ PLANTASK） .505.1.11 工作日志表（WORKPLAN_ WORKLOG） .505.1.12 工作汇报表（WORKPLAN_ WORKREPORT） .505.1.13 信息发布表（PUBLIC_ PUBLISHINFO） .505.1.14 收件箱表（PUBLIC_INBOX） .515.1.15 系统操作日志表（PUBLIC_OPERATELOG） .515.1.16 个人提醒设置表（PUBLIC_EVENTS） .525.1.17 系统表（PUBLIC_SYSTEM） .525.1.18 系统功能模块表（PUBLIC_SYSTEMMODULE） .5

5、25.2 物理结构设计.535.3 数据结构与程序的关系.536 系统出错处理设计 .536.1 出错信息.536.2 补救措施.536.3 系统维护设计.53工作计划管理系统概要设计说明书1 引言1.1 编写目的概要设计说明书是为了说明整个系统的体系架构，及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。1.2 背景软件系统的名称：工作计划管理系统开发工具：Java开发者： XXX1.3 定义1.4 参考资料2 总体设计2.1 简述系统采用流行的 B/S 结构模式。系统的分析设计采用面向对象的技术，应用 Visio 等工具进行辅助设计。42.2 架构设计

6、2.2.1 系统逻辑架构图业 务 操 作 端逻 辑 校 验逻 辑 校 验业 务 逻 辑基 础 信 息初 始 化我 的 工 作台工 作 进 展信 息 发 布系 统 管 理个 人 设 置数 据 接 口数 据 接 口数 据 源数 据 库 服 务 器系 统 安 全系 统 安 全用 户 工 作 台2.2.2 系统物理架构图W e b 服 务 器 数 据 库 服 务 器远 程 用 户 机远 程 用 户 机局 域 网 用 户 机局 域 网I n t e r n e t 互 联 网路 由 器 / 交 换 机系 统 管 理 员52.2.3 顶层系统包图业 务 页 面业 务 操 作数 据 实 体数 据 处 理 数

7、 据 接 口系 统 辅 助类包说明： 业务页面：用户动态网页，主要是 jsp 文件。 业务操作：主要控制业务访问的接口和业务流转。 数据处理：提供业务的实现，包括对业务数据的增、删、改、查等操作。 数据实体：业务对象的实体类。 数据接口：提供数据库的访问，传递数据或返回相应数据。 系统辅助：提供了供整个系统辅助的功能。62.2.4 业务类包图我 的 工 作 台 ：工 作 任 务我 的 工 作 台 ：工 作 日 志我 的 工 作 台 ：工 作 汇 报我 的 工 作 台 ：工 作 计 划基 础 信 息 ：角 色 管 理基 础 信 息 ：部 门 管 理系 统 管 理 ：数 据 备 份基 础 信 息

8、：员 工 管 理基 础 信 息 ：岗 位 管 理系 统 管 理 ：操 作 日 志个 人 设 置 ：个 人 提 醒2.2.5 子系统关系图信 息 发 布系 统 管 理个 人 设 置基 础 信 息我 的 工 作 台工 作 进 展2.3 接口设计2.3.1 界面框架设计72.3.2 外部接口设计说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。3 子系统设计3.1 基础信息子系统3.1.1 子系统说明基础信息子系统包括：角色管理、部门管理、岗位管理、员工管理四部分。角色管理：定义角色和系统权限之间的对应关系，方便用户权限的分配控制。部门管理：实现对公司部门基

9、本信息的维护。岗位管理：实现对公司岗位基本信息的维护。员工管理：实现对公司员工基本信息的维护，并为员工分配角色和初始化登录系统信息。83.1.2 类图3.1.2.1 角色、权限- 角色 I D : S t r i n g- 角色名称 : S t r i n g- 拥有的权限 : S t r i n g- 角色说明 : S t r i n gD a t a : : 角 色 实 体 类+ 通过 I D 查询角色 ( i n 角色 I D ) : D a t a : : 角色实体类+ 通过名称查询角色 ( i n 角色名称 ) : D a t a : : 角色实体类+ 查询全部角色 ( ) : D

10、a t a : : 角色实体类+ 增加角色 ( i n D a t a : : 角色实体类 ) : b o o l e a n+ 修改角色 ( i n D a t a : : 角色实体类 ) : b o o l e a n+ 删除角色 ( i n 角色 I D ) : b o o l e a n+ 分配权限 ( i n 角色 I D , i n 权限列表 ) : b o o l e a n+ 读取角色权限 ( i n 角色 I D ) : O b j e c tS e r v i c e : : 角 色+ 通过 I D 查询角色 ( i n 角色 I D ) : D a t a : : 角色实

11、体类+ 通过名称查询角色 ( i n 角色名称 ) : D a t a : : 角色实体类+ 查询全部角色 ( ) : D a t a : : 角色实体类+ 增加角色 ( i n D a t a : : 角色实体类 ) : b o o l e a n+ 修改角色 ( i n D a t a : : 角色实体类 ) : b o o l e a n+ 删除角色 ( i n 角色 I D ) : b o o l e a n+ 分配权限 ( i n 角色 I D , i n 权限列表 ) : b o o l e a n+ 读取角色权限 ( i n 角色 I D ) : O b j e c tD a t

12、 a : : 角 色+ 通过 I D 查询角色 ( i n 角色 I D ) : D a t a : : 角色实体类+ 通过名称查询角色 ( i n 角色名称 ) : D a t a : : 角色实体类+ 查询全部角色 ( ) : D a t a : : 角色实体类+ 增加角色 ( i n D a t a : : 角色实体类 ) : b o o l e a n+ 修改角色 ( i n D a t a : : 角色实体类 ) : b o o l e a n+ 删除角色 ( i n 角色 I D ) : b o o l e a n+ 分配权限 ( i n 角色 I D , i n 权限列表 ) :

13、 b o o l e a n+ 读取角色权限 ( i n 角色 I D ) : O b j e c tU I : : 角 色S e r v i c e : : 权 限9+ 页面显示全部权限内容 ( ) : v o i d+ 通过所属系统查询全部权限 ( i n 所属系统 I D ) : D a t a : : 权限实体类+ 读取用户权限 ( i n 用户 I D ) : D a t a : : 权限实体类U I : : 权 限- 权限 I D : S t r i n g- 所属系统 : S t r i n g- 权限编码 : S t r i n g- 权限名称 : S t r i n g- 上

14、级权限 : S t r i n g- 权限所属系统 : S t r i n gD a t a : : 权 限 实 体 类+ 查询全部权限 ( ) : D a t a : : 权限实体类+ 通过所属系统查询全部权限 ( i n 所属系统 I D ) : D a t a : : 权限实体类+ 读取用户权限 ( i n 用户 I D ) : D a t a : : 权限实体类S e r v i c e : : 权 限+ 查询全部权限 ( ) : D a t a : : 权限实体类+ 通过所属系统查询全部权限 ( i n 所属系统 I D ) : D a t a : : 权限实体类+ 读取用户权限 (

15、 i n 用户 I D ) : D a t a : : 权限实体类D a t a : : 权 限103.1.2.2 部门管理+ 通过 I D 查询部门 ( i n 角色 I D ) : D a t a : : 部门实体类+ 通过名称查询部门 ( i n 角色名称 ) : D a t a : : 部门实体类+ 多条件查询部门 ( i n 查询条件对象 ) : D a t a : : 部门实体类+ 查询全部部门 ( ) : D a t a : : 部门实体类+ 增加部门 ( i n D a t a : : 部门实体类 ) : b o o l e a n+ 修改部门 ( i n D a t a :

16、: 部门实体类 ) : b o o l e a n+ 删除部门 ( i n 部门 I D ) : b o o l e a n+ 树形显示部门 ( ) : v o i dU I : : 部 门 管 理- 部门 I D : S t r i n g- 部门名称 : S t r i n g- 上级部门 : S t r i n g- 电话 : S t r i n g- 传真 : S t r i n g- 排序 : i n t- 备注 : S t r i n gD a t a : : 部 门 实 体 类+ 通过 I D 查询部门 ( i n 角色 I D ) : D a t a : : 部门实体类+ 通过

17、名称查询部门 ( i n 角色名称 ) : D a t a : : 部门实体类+ 多条件查询部门 ( i n 查询条件对象 ) : D a t a : : 部门实体类+ 查询全部部门 ( ) : D a t a : : 部门实体类+ 增加部门 ( i n D a t a : : 部门实体类 ) : b o o l e a n+ 修改部门 ( i n D a t a : : 部门实体类 ) : b o o l e a n+ 删除部门 ( i n 部门 I D ) : b o o l e a nS e r v i c e : : 部 门 管 理+ 通过 I D 查询部门 ( i n 角色 I D ) : D a t a : : 部门实体类+ 通过名称查询部门 ( i n 角色名称 ) : D a t a : : 部门实体类+ 多条件查询部门 ( i n 查询条件对象 ) : D a t a : : 部门实体类+ 查询全部部门 ( ) : D a t a : : 部门实体类+ 增加部门 ( i n D a t a : : 部门实体类 ) : b o o l e a n+ 修改部门 ( i n D a t a : : 部门实体类 ) : b o o l e a n+ 删除部门 ( i n 部门 I D ) : b o o l e a nD a t a : : 部 门 管 理