概要设计说明书实例.docx
《概要设计说明书实例.docx》由会员分享，可在线阅读，更多相关《概要设计说明书实例.docx（26页珍藏版）》请在冰点文库上搜索。
概要设计说明书实例
工作计划管理系统概要设计说明书
1引言
1.1编写目的
此概要设计说明书是为了说明整个系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。
1.2背景
石油工程公司将打造“国际一流的石油工程技术服务公司”作为公司发展的战略目标，为确保这一目标的实现，本项目将建立一套以国际一流企业为战略标杆的企业间对标评价体系，引导企业持续对不足，促改进，使企业经营管理各项目标不断缩小与国内或国际先进水平的差距，保持领先优势，持续提升综合赢利能力。
1.3定义
1.4参考资料
《石油工程公司对标评价合同书系统项目合同书》
《石油工程公司对标评价合同书系统项目技术服务合同附件》
《石油工程公司对标评价系统需求分析说明书》
2总体设计
2.1简述
系统采用流行的B/S结构模式。
系统的分析设计采用面向对象的技术，应用Visio等工具进行辅助设计。
2.2架构设计
2.2.1系统逻辑架构图
2.2.2系统物理架构图
2.2.3顶层系统包图
类包说明：
⏹业务页面：
用户动态网页。
⏹业务操作：
主要控制业务访问的接口和业务流转。
⏹数据处理：
提供业务的实现，包括对业务数据的增、删、改、查等操作。
⏹数据实体：
业务对象的实体类。
⏹数据接口：
提供数据库的访问，传递数据或返回相应数据。
⏹系统辅助：
提供了供整个系统辅助的功能。
2.2.4业务逻辑图
2.2.5模块关系图
2.3接口设计
2.3.1界面框架设计
2.3.2外部接口设计
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、本系统与各支持软件之间的接口关系。
3系统模块设计
3.1系统管理模块
3.1.1模块说明
系统管理模块包括：
角色管理、部门管理、权限管理、员工管理四部分。
角色管理：
定义角色和系统权限之间的对应关系，方便用户权限的分配控制。
部门管理：
实现对公司部门基本信息的维护。
权限管理：
实现对用户访问权限信息的配置。
员工管理：
实现对公司员工基本信息的维护。
3.1.2类图
3.1.2.1角色、权限
3.1.2.2部门管理
3.1.2.3岗位管理
3.1.2.4员工管理
3.1.3类说明
3.1.3.1角色、权限
通过ID查询角色：
页面得到角色ID，调用Service:
:
角色的通过ID查询角色方法,得到指定角色的实体数据。
通过名称查询角色：
页面得到角色名称，调用Service:
:
角色的通过名称查询角色方法,得到指定角色的实体数据。
查询全部角色：
调用Service:
:
角色的查询全部角色方法,得到全部角色的实体数据。
增加角色：
在页面上得到角色的实体数据，调用Service:
:
角色的增加角色方法，实现角色的添加。
修改角色：
在页面上得到修改后的角色实体数据，调用Service:
:
角色的修改角色方法，实现角色的修改。
删除角色：
调用Service:
:
删除角色方法，将指定角色的数据置为已删除状态。
分配权限：
调用Service:
:
分配权限方法，给指定角色分配权限。
读取角色权限：
调用Service:
:
读取角色权限方法，读取指定角色的权限数据。
通过ID查询角色：
调用Data:
:
角色的通过ID查询角色方法,得到指定角色的实体数据。
通过名称查询角色：
调用Data:
:
角色的通过名称查询角色方法,得到指定角色的实体数据。
查询全部角色：
调用Data:
:
角色的查询全部角色方法,得到全部角色的实体数据。
增加角色：
调用Data:
:
角色的增加角色方法，实现角色的添加。
修改角色：
调用Data:
:
角色的修改角色方法，实现角色的修改。
删除角色：
调用Data:
:
删除角色方法，将指定角色的数据置为已删除状态。
分配权限：
调用Data:
:
分配权限方法，给指定角色分配权限。
读取角色权限：
调用Data:
:
读取角色权限方法，读取指定角色的权限数据。
通过ID查询角色：
得到指定角色的实体数据。
通过名称查询角色：
得到指定角色的实体数据。
查询全部角色：
调用Data:
:
角色的查询全部角色方法,得到全部角色的实体数据。
增加角色：
实现角色的添加。
修改角色：
实现角色的修改。
删除角色：
将指定角色的数据置为已删除状态。
分配权限：
给指定角色分配权限。
读取角色权限：
读取指定角色的权限数据。
角色实体类数据。
页面显示全部权限内容：
调用Service:
:
权限的查询全部权限或通过所属系统查询全部权限，将权限数据显示到页面上。
通过所属系统查询全部权限：
调用Service:
:
权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。
读取用户权限：
调用Service:
:
权限的读取用户权限，读取指定用户的权限数据。
查询全部权限：
调用Data:
:
权限的查询全部权限，读取全部的权限数据。
通过所属系统查询全部权限：
调用Data:
:
权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。
读取用户权限：
调用Data:
:
权限的读取用户权限，，读取指定用户的权限数据。
查询全部权限：
读取全部权限数据，返回全部的权限实体类数据。
通过所属系统查询全部权限：
读取所属系统权限数据，返回某系统下的全部权限实体类数据。
读取用户权限：
读取指定用户的权限数据。
权限实体类数据。
3.1.3.2部门管理
通过ID查询部门：
根据部门ID，得到指定的部门实体类数据。
多条件查询部门：
根据多条件（部门名称、上级部门）查询对象，得到部门实体数据。
查询全部部门：
执行查询，获取全部部门的实体数据。
增加部门：
得到部门实体数据，将数据添加至库中。
修改部门：
得到修改后的部门实体数据，将数据保存至库中。
删除部门：
根据部门ID，删除指定的部门。
树形显示部门：
查询得到树形结构上的部门数据，并显示。
此类的说明同上。
此类的说明同上。
部门实体类数据。
3.1.3.3岗位管理
通过ID查询岗位：
根据岗位ID，得到指定的岗位实体类数据。
多条件查询岗位：
根据多条件（岗位名称、上级岗位）查询对象，得到岗位实体数据。
查询全部岗位：
执行查询，获取全部岗位的实体数据。
增加岗位：
得到部门实体数据，将数据添加至库中。
修改岗位：
得到修改后的部门实体数据，将数据保存至库中。
删除岗位：
根据岗位ID，删除指定的岗位。
树形显示岗位：
查询得到树形结构上的岗位数据，并显示。
此类的说明同上。
此类的说明同上。
岗位实体类数据。
3.1.3.4员工管理
通过ID查询员工：
根据员工ID，得到指定的员工实体类数据。
多条件查询员工：
根据多条件（工号、姓名、性别、部门、岗位、角色）查询对象，得到员工实体数据。
查询全部员工：
执行查询，获取全部员工的实体数据。
增加员工：
得到员工实体数据，将数据添加至库中。
修改员工：
得到修改后的员工实体数据，将数据保存至库中。
删除员工：
根据员工ID，删除指定的员工。
员工修改登录密码：
员工执行修改登录密码数据。
此类的说明同上。
此类的说明同上。
员工实体类数据。
3.1.4界面设计
基础信息子系统页面包括：
角色管理、部门管理、岗位管理、员工管理四部分。
3.1.4.1角色管理页面
3.1.4.2部门管理页面
3.1.4.3岗位管理页面
3.1.4.4员工管理页面
3.2对标评价管理模块
3.2.1模块说明
对标评价管理模块包括：
对标体系管理、对标指标管理、报表管理、对标评价管理、对标评价参数管理、对标评价算法管理、对标指标值管理。
对标体系管理：
实现管理层分派任务和公司员工接收任务的管理功能。
对标指标管理：
报表管理：
对标评价管理：
对标评价参数管理：
对标评价算法管理：
对标指标值管理：
3.2.2类图
3.2.2.1工作任务
3.2.2.2工作计划
3.2.2.3工作日志
3.2.2.4工作汇报
3.2.2.5审批计划
审批计划功能的设计实现，参照类图：
工作计划。
3.2.3类说明
3.2.3.1工作任务
通过ID查询任务：
根据任务ID，得到指定工作任务实体类数据。
多条件查询任务：
根据多条件（起始日期、截止日期、任务标题、重要程度、任务状态部门、任务接收人）查询对象，得到工作任务的实体数据。
查询全部任务：
执行查询，获取全部工作任务的实体数据。
增加任务：
得到任务实体数据，将数据添加至库中。
暂停任务：
对指定的任务，执行暂停处理操作。
处理完成任务：
对指定的任务，执行完成处理操作。
实时检查收到的新任务或还未做计划的任务：
根据当前的用户ID，实时检查目前收到的新任务或还未做计划的任务，以便系统实时提醒用户，并弹出提醒信息。
此类的说明同上。
此类的说明同上。
工作任务实体类数据。
3.2.3.2工作计划
通过ID查询计划：
根据计划ID，得到指定的工作计划实体类数据。
多条件查询计划：
根据多条件（起始日期、截止日期、计划标题、计划类型）查询对象，，得到工作计划实体类数据。
查询全部计划：
执行查询，得到全部工作计划的实体类数据。
增加计划：
得到计划实体数据和所属任务计划完成百分比列表，将数据添加至库中。
修改计划：
计划未经审批时，得到修改后的计划实体数据和所属任务计划完成百分比列表，将数据保存至库中。
写计划总结：
某指定的工作计划结束时，将总结内容和所属任务实际完成百分比列表数据，保存至库中。
处理所属工作任务完成情况：
写计划时或写总结时，保存所属工作任务列表（包括计划或实际完成百分比数据），添加至数据库。
查询所属任务完成情况：
根据指定的工作计划，查询其所属工作任务的完成进度情况。
审批计划：
管理层对某一指定的工作计划，执行审批处理，以使审批后的工作计划不能再进行修改。
取消审批：
管理层对某一指定的工作计划，执行取消审批处理，以使此工作计划能进行再修改。
实时查询未审批的工作计划：
执行查询未经管理层审批的工作计划，得到未审批的工作计划实体类数据。
当有未审批信息时系统应实时提醒用户，并弹出提醒信息。
多条件查询已审批的工作计划：
根据多条件（起始日期、截止日期、计划比他、计划类型、创建人）查询对象，得到管理层已审批过的工作计划实体类数据。
实时查询他人抄送来的工作计划：
根据当前用户ID，查询得到他人抄送给自己的工作计划实体类数据。
当有未阅读的信息时系统应实时提醒用户，并弹出提醒信息。
处理查看未阅读的他人抄送的工作计划：
根据工作计划ID，查看未阅读的他人抄送给自己的工作计划实体类数据。
此类的说明同上。
此类的说明同上。
工作计划实体类数据。
3.2.3.3工作日志
通过ID查询工作日志：
根据日志ID，得到指定的工作日志实体类数据。
多条件查询任务：
根据多条件（起始日期、截止日期）查询对象，得到工作日志实体数据。
查询全部工作日志：
执行查询，得到全部的工作日志实体类数据。
增加工作日志：
得到工作日志实体类数据，将数据添加至库中。
删除工作日志：
根据日志ID，删除指定的工作日志。
实时查询他人发来的工作日志：
根据当前用户ID，查询得到他人发来的工作日志实体数据。
当有未阅读的信息时系统应实时提醒用户，并弹出提醒信息。
处理查看未阅读的他人发来的工作日志：
根据工作日志ID，查看未阅读的他人发来的工作日志实体类数据。
此类的说明同上。
此类的说明同上。
工作日志实体类数据。
3.2.3.4工作汇报
通过ID查询工作汇报：
根据工作汇报ID，得到指定的工作汇报实体类数据。
多条件查询工作汇报：
根据多条件（起始日期、截止日期）查询对象，得到工作汇报实体数据。
查询全部工作汇报：
执行查询，得到全部的工作汇报实体类数据。
增加工作汇报：
得到工作汇报实体类数据，将数据添加至库中。
实时查询员工发来的工作汇报：
根据当前用户ID，查询得到员工发来的工作汇报实体数据。
当有未阅读的信息时系统应实时提醒用户，并弹出提醒信息。
处理查看未阅读的员工发来的工作汇报：
根据工作汇报ID，查看未阅读的员工发来的工作汇报实体类数据。
此类的说明同上。
此类的说明同上。
工作汇报实体类数据。
3.2.3.5审批计划
3.2.4界面设计
我的工作台子系统页面包括：
工作任务、工作计划、工作日志、工作汇报、审批计划五部分。
3.2.4.1工作任务页面
3.2.4.2工作计划页面
3.2.4.3工作日志页面
3.2.4.4工作汇报页面
3.2.4.5审批计划页面
3.3绩效考核模块
3.3.1模块说明说明
3.3.2类图
3.3.3类说明
3.3.4界面设计
4约束和假定
描述系统设计中最主要的约束，这些是由客户强制要求并在需求说明书写明的。
说明系统是如何来适应这些约束的。
另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。
这种情况下，要求清楚地描述与本系统有交互的软件类型（比如某某某数据库软件，某某某EMail软件）以及这样导致的约束（比如只允许纯文本的Email）。
实现的语言和平台也会对系统有约束，同样在此予以说明。
对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。
包括运行环境的约束，简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。
5系统数据结构设计
5.1逻辑结构设计
注：
表和表字段命名规范：
1.表名的定义：
规范格式：
系统名_表名（字母全部大写）
比如，工作计划管理系统中的某个表定义为：
WORKPLAN_TASK;
2.表字段的定义：
规范格式：
表名+字段名称（首字母大写），以避免字段重名出现在不同表中。
比如，表WORKPLAN_TASK中的字段标识Id定义为：
TaskId；
3.表字段长度的定义：
规范格式：
长度一般为8的整数倍；
比如，VARCHAR的长度可为8或16或24或32或64等；
4.表字段类型为日期型的定义：
规范格式：
一般日期型的字段设为VARCHAR，且长度一般为24（已精确到毫秒）
5.公共表名的定义：
规范格式：
PUBLIC_表名（字母全部大写）
比如，各个子系统都会用到的公共表，如角色或操作日志表可定义为：
PUBLIC_ROLE，PUBLIC_OPERATELOG;
5.1.1角色表（PUBLIC_ROLE）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
RoleId
角色标识Id
PK
NO
VARCHAR
32
RoleName
角色名称
NO
VARCHAR
32
Remark
角色说明
VARCHAR
128
5.1.2权限表（PUBLIC_PRIVILEGE）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
PrivilegeId
权限标识Id
PK
NO
VARCHAR
32
PrivilegeCode
权限编码
NO
VARCHAR
32
PrivilegeName
权限名称
NO
VARCHAR
64
PrivilegeParentId
上级权限Id
VARCHAR
32
上级权限
SystemId
权限所属系统Id
FK
VARCHAR
32
权限所属系统
5.1.3角色权限表（PUBLIC_ROLEPRIVILEGE）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
RoleId
角色ID
PK，FK
NO
VARCHAR
32
角色表外键
PrivilegeId
权限ID
PK，FK
NO
VARCHAR
32
权限表外键
5.1.4部门表（PUBLIC_DEPT）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
DeptId
部门标识Id
PK
NO
VARCHAR
32
DeptName
部门名称
NO
VARCHAR
32
DeptParentId
父类部门Id
VARCHAR
32
上一级部门
Tel
电话
VARCHAR
32
Fax
传真
VARCHAR
32
SortOrder
排序
INT
4
Remark
备注
VARCHAR
128
5.1.5岗位表（PUBLIC_POST）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
PostId
岗位标识Id
PK
NO
VARCHAR
32
PostName
岗位名称
NO
VARCHAR
32
PostParentId
父类岗位Id
VARCHAR
32
上一级岗位
DeptId
所属部门Id
FK
VARCHAR
32
部门表外键
Function
岗位职责
VARCHAR
128
SortOrder
排序
INT
4
5.1.6员工表（PUBLIC_MEMBER）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
MemberId
部门标识Id
PK
NO
VARCHAR
32
JobNumber
工号
NO
VARCHAR
32
作为系统登录帐号使用
Password
登录密码
NO
VARCHAR
32
MemberName
员工姓名
NO
VARCHAR
32
DeptId
所属部门Id
FK
NO
VARCHAR
32
部门表外键
PostId
所属岗位Id
FK
NO
VARCHAR
32
岗位表外键
Sex
性别
VARCHAR
1
Tel
办公电话
VARCHAR
30
Mobile
手机
VARCHAR
30
Email
电子邮箱
VARCHAR
30
Address
住址
VARCHAR
64
Remark
备注
VARCHAR
128
RoleId
所属角色Id
FK
NO
VARCHAR
32
角色表外键
Status
帐号状态
NO
VARCHAR
8
状态如：
有效，停用；
默认值为有效
5.1.7工作任务表（WORKPLAN_TASK）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
TaskId
任务标识Id
PK
NO
VARCHAR
32
TaskTile
任务标题
NO
VARCHAR
32
TaskContent
任务内容
NO
VARCHAR
1024
Level
重要程度
NO
VARCHAR
8
重要程度“★”
StartDate
任务开始时间
NO
VARCHAR
24
EndDate
任务完成时间
NO
VARCHAR
24
CreatorId
创建人Id
FK
NO
VARCHAR
32
员工表外键
Status
任务状态
NO
VARCHAR
8
状态如：
未完成、暂停、已完成
AddDate
创建时间
NO
VARCHAR
24
5.1.8任务分派表（WORKPLAN_ALLOTTASK）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
AllotId
分派标识ID
PK
NO
VARCHAR
32
TaskId
派发的工作任务Id
FK
NO
VARCHAR
32
工作任务表外键
ReceiverId
任务接收人Id
FK
NO
VARCHAR
32
员工表外键
RemainPercent
任务剩余百分比
NO
INT
4
默认为100
5.1.9工作计划表（WORKPLAN_PLAN）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
PlanId
任务标识Id
PK
NO
VARCHAR
32
PlanType
计划类型
NO
VARCHAR
64
计划类型如：
周计划、月计划、年计划
PlanTitle
计划标题
NO
VARCHAR
32
PlanTime
计划时间
NO
VARCHAR
32
PlanContent
计划内容
NO
VARCHAR
1024
PlanSum
计划总结
VARCHAR
1024
CreatorId
创建人Id
FK
NO
VARCHAR
32
员工表外键
AddDate
创建时间
NO
VARCHAR
24
AuditorId
计划审批人Id
FK
NO
VARCHAR
32
员工表外键
IsAudit
是否审批
NO
VARCHAR
8
是或否，默认值为否
5.1.10计划任务表（WORKPLAN_PLANTASK）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
PlanId
计划标识Id
PK，
FK
NO
VARCHAR
32
AllotId
接收的任务标识Id
PK，
FK
NO
VARCHAR
32
PlanPercent
任务计划完成百分比
NO
INT
4
0到100之间
FinishedPercent
任务实际完成百分比
INT
4
0到100之间
5.1.11工作日志表（WORKPLAN_WORKLOG）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
LogId
工作日志标识Id
PK
NO
VARCHAR
32
LogInfo
日志记录
NO
VARCHAR
1024
LogSum
日志小结
VARCHAR
1024
CreatorId
创建人Id
FK
NO
VARCHAR
32
员工表外键
AddDate
创建时间
NO
VARCHAR
24
5.1.12工作汇报表（WORKPLAN_WORKREPORT）
字段名称
中文说明
键别
是否空
数据类型
长度
备注
ReportId
汇报标识Id
PK
NO
VARCHAR
32
ReportTitle
标题
NO
VARCHAR
32
ReportContent
内容
NO
VARCHAR
1024
CreatorId
创建人Id
FK
NO
VARCHAR
32
员工表外键
AddDate
创建时
升级会员 