概要设计说明书实例经典Word文档格式.docx
《概要设计说明书实例经典Word文档格式.docx》由会员分享，可在线阅读，更多相关《概要设计说明书实例经典Word文档格式.docx（26页珍藏版）》请在冰豆网上搜索。
员工管理：
实现对公司员工基本信息的维护，并为员工分配角色和初始化登录系统信息。
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:
角色的修改角色方法，实现角色的修改。
删除角色：
删除角色方法，将指定角色的数据置为已删除状态。
分配权限：
分配权限方法，给指定角色分配权限。
读取角色权限：
读取角色权限方法，读取指定角色的权限数据。
调用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.2.1查询工作任务
查询工作任务功能的设计实现，请参照类图：
工作任务。
3.3.2.2查询工作计划
查询工作计划功能的设计实现，请参照类图：
3.3.2.3查询工作日志
查询工作日志功能的设计实现，请参照类图：
工作日志。
3.3.2.4查询工作汇报
查询工作汇报功能的设计实现，请参照类图：
工作汇报。
3.3.3类说明
3.3.4界面设计
工作进展子系统页面包括：
查询工作任务、查询工作计划、查询工作日志、查询工作汇四部分。
3.3.4.1查询工作任务页面
3.3.4.2查询工作计划页面
3.3.4.3查询工作日志页面
3.3.4.4查询工作汇报页面
3.4信息发布子系统
3.4.1子系统说明
实现公司内部员工之间发布信息或者通知的管理。
3.4.2类图
3.4.3类说明
通过ID查询消息：
根据消息ID，得到指定的消息实体类数据。
多条件查询已发出的消息：
根据多条件（起始日期、截止日期、接收人）查询对象，得到消息实体数据。
多条件查询已收到的消息：
根据多条件（起始日期、截止日期、发送人）查询对象，得到消息实体数据。
发布新消息：
得到发布消息实体类数据，将数据添加至库中。
实时查询已收到的未阅读的消息：
实时查询已收到的未阅读的消息实体类数据。
当有未阅读的消息时系统应实时提醒用户，并弹出提醒信息。
处理查看未阅读的消息：
根据消息ID，查看未阅读的消息实体类数据。
发布消息实体类数据。
3.4.4界面设计
信息发布子系统页面包括：
3.5系统管理子系统
3.5.1子系统说明
系统管理包括系统数据备份和系统操作日志查询功能，只有系统管理员才有权限操作此功能。
系统数据备份：
实现将系统数据备份到指定的路径。
操作日志查询：
实现查询系统数据的修改历史及登录系统用户的操作记录。
3.5.2类图
3.5.3类说明
备份系统数据：
执行数据备份操作，将当前系统数据库备份至指定路径。
记录系统操作日志：
得到登录系统人员操作日志实体类数据，将日志信息保存至库中。
查询全部操作日志：
执行查询，得到全部的系统操作日志实体类数据。
多条件查询操作日志：
根据多条件（起始日期、截止日期、姓名、功能模块、动作类型）查询对象，查询得到系统操作日志实体类数据。
人员操作日志实体类数据。
3.5.4界面设计
系统管理子系统页面包括：
数据备份、操作日志两部分。
3.5.4.1数据备份页面
3.5.4.2操作日志页面
3.6个人设置子系统
3.6.1子系统说明
个人设置子系统包括：
个人提醒和修改密码两部分。
个人提醒：
实现员工个人对工作事务上重要事件的提醒告知功能。
修改密码：
实现登录用户修改维护自身密码。
3.6.2类图
3.6.2.1个人提醒
3.6.2.2修改密码
用户修改自身登录密码功能的设计实现，请参照类图：
员工管理。
3.6.3类说明
3.6.3.1个人提醒
设置个人定时提醒：
得到个人提醒实体类数据，将数据添加至库中。
触发已设置的个人提醒事件：
触发定时提醒事件的发生。
查询全部已设置的个人提醒事件：
执行查询，得到全部的已设置的个人提醒事件数据。
关闭已设置的提醒事件：
对设置的指定提醒事件，执行关闭操作。
开启已关闭的提醒事件：
对已关闭的指定提醒事件，执行开启操作。
删除已设置的个人提醒事件：
根据指定ID，删除已设置的个人提醒事件。
个人提醒实体类数据。
3.6.3.2修改密码
3.6.4界面设计
个人设置子系统页面包括：
个人提醒、修改密码两部分。
3.6.4.1个人提醒页面
3.6.4.2修改密码页面
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
角色名称
Remark
角色说明
128
5.1.2权限表（PUBLIC_PRIVILEGE）
PrivilegeId
权限标识Id
PrivilegeCode
权限编码
PrivilegeName
权限名称
64
PrivilegeParentId
上级权限Id
上级权限
SystemId
权限所属系统Id
FK
权限所属系统
5.1.3角色权限表（PUBLIC_ROLEPRIVILEGE）
角色ID
PK，FK
角色表外键
权限ID
权限表外键
5.1.4部门表（PUBLIC_DEPT）
DeptId
部门标识Id
DeptName
部门名称
DeptParentId
父类部门Id
上一级部门
Tel
电话
Fax
传真
SortOrder
排序
INT
4
5.1.5岗位表（PUBLIC_POST）
PostId
岗位标识Id
PostName
岗位名称
PostParentId
父类岗位Id
上一级岗位
所属部门Id
部门表外键
Function
岗位职责
5.1.6员工表（PUBLIC_MEMBER）
MemberId
JobNumber
工号
作为系统登录帐号使用
Password
登录密码
MemberName
员工姓名
所属岗位Id
岗位表外键
Sex
性别
1
办公电话
30
Mobile
手机
Email
电子邮箱
Address
住址
所属角色Id
Status
帐号状态
8
状态如：
有效，停用；
默认值为有效
5.1.7工作任务表（WORKPLAN_TASK）
TaskId
任务标识Id
TaskTile
任务标题
TaskContent
任务内容
1024
Level
重要程度
重要程度“★”
StartDate
任务开始时间
24
EndDate
任务完成时间
CreatorId
创建人Id
F
升级会员 