概要设计说明书实例

1、1 引言1.1编写目的1.2背景1.3定义1.4参考资料2 总体设计2.1简述22架构设计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.3 类说明3.1.4 界面设计3.2我的工作台子系统3.2.1 子系统说明 3.2.2 类图3.2.3 类说明3.2.4 界面设计3.3工作进展子系统3.3.1 子系统说明 3.3.2 类图3.3.3 类说明3.3.4 界面设计3.4信

2、息发布子系统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个人设置子系统3.6.1 子系统说明 362类图3.6.3 类说明3.6.4 界面设计4 约束和假定5 系统数据结构设计5.1逻辑结构设计5.1.1 角色表(PUBLIC ROLE )5.1.2 权限表(PUBLIC PRIVILEGE )5.1.3 角色权限表(PUBLIC ROLEPRIVILEGE )5.1.4 部门表(PUBLIC DEPT )5.1.5 岗位表(PUBLIC POST)5.1.

3、6 员工表(PUBLIC MEMBER)5.1.7 工作任务表(WORKPLAN TASK )5.1.8 任务分派表(WORKPLAN ALLOTTASK )5.1.9 工作计戈表(WORKPLAN_ PLAN )计戈U任务表(WORKPLAN_ PLANTASK )工作日志表(WORKPLAN WORKLOG )工作汇报表(WORKPLAN_ WORKREPORT )信息发布表(PUBLIC PUBLISHINFO )收件箱表(PUBLIC INBOX )系统操作日志表(PUBLIC_OPERA TELOG )个人提醒设置表(PUBLIC_EVENTS )系统表(PUBLIC SYSTEM

4、)系统功能模块表(PUBLIC SYSTEMMODULE )5.2物理结构设计5.3数据结构与程序的关系6 系统出错处理设计6.1出错信息6.2补救措施6.3系统维护设计工作计划管理系统概要设计说明书1 引言1.1 编写目的 此概要设计说明书是为了说明整个系统的体系架构， 以及需求用例的各个功能点在架构 中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。1.2 背景 石油工程公司将打造“国际一流的石油工程技术服务公司”作为公司发展的战略目标， 为 确保这一目标的实现，本项目将建立一套以国际一流企业为战略标杆的企业间对标评价体 系， 引导企业持续对不足， 促改进， 使企业经营管理各项目

5、标不断缩小与国内或国际先进水 平的差距，保持领先优势，持续提升综合赢利能力。1.3 定义1.4 参考资料 石油工程公司对标评价合同书系统项目合同书 石油工程公司对标评价合同书系统项目技术服务合同附件 石油工程公司对标评价系统需求分析说明书2 总体设计2.1 简述系统采用流行的 B/S 结构模式。系统的分析设计采用面向对象的技术，应用Visio 等工具进行辅助设计。2.2 架构设计2.2.1 系统逻辑架构图2.2.2 系统物理架构图2.2.3 顶层系统包图类包说明 ： 业务页面：用户动态网页。业务操作：主要控制业务访问的接口和业务流转。 数据处理：提供业务的实现，包括对业务数据的增、删、改、查等

6、操作。 数据实体：业务对象的实体类。 数据接口：提供数据库的访问，传递数据或返回相应数据。 系统辅助：提供了供整个系统辅助的功能。2.2.4 业务逻辑图2.2.5 模块关系图2.3 接口设计2.3.1 界面框架设计2.3.2 外部接口设计 说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、 本系统与各支持软件 之间的接口关系。3 系统模块设计3.1 系统管理模块3.1.1 模块说明 系统管理模块包括：角色管理、部门管理、权限管理、员工管理四部分。 角色管理：定义角色和系统权限之间的对应关系，方便用户权限的分配控制。 部门管理：实现对公司部门基本信息的维护。 权限管理：实现对用户访问权限

7、信息的配置。员工管理：实现对公司员工基本信息的维护。类图角色、权限部门管理岗位管理员工管理类说明角色、权限通过ID查询角色：页面得到角色ID，调用Service:角色的通过ID查询角色方法，得到指 定角色的实体数据。通过名称查询角色：页面得到角色名称，调用Service:角色的通过名称查询角色方法得到指定角色的实体数据。查询全部角色：调用Service:角色的查询全部角色方法，得到全部角色的实体数据。增加角色：在页面上得到角色的实体数据，调用Service:角色的增加角色方法，实现角色的添加。修改角色：在页面上得到修改后的角色实体数据，调用Service:角色的修改角色方法,实现角色的修改。删

8、除角色：调用 Service:删除角色方法，将指定角色的数据置为已删除状态。分配权限：调用 Service:分配权限方法，给指定角色分配权限。读取角色权限：调用 Service:读取角色权限方法，读取指定角色的权限数据。通过 ID 查询角色：调用Data:角色的通过ID查询角色方法，得到指定角色的实体数据。通过名称查询角色：调用Data:角色的通过名称查询角色方法，得到指定角色的实体数据。查询全部角色：调用 Data:角色的查询全部角色方法，得到全部角色的实体数据。增加角色：调用 Data:角色的增加角色方法，实现角色的添加。修改角色：调用 Data:角色的修改角色方法，实现角色的修改。删除角

9、色：调用 Data:删除角色方法，将指定角色的数据置为已删除状态。分配权限：调用 Data:分配权限方法，给指定角色分配权限。读取角色权限：调用 Data:读取角色权限方法，读取指定角色的权限数据。通过 ID 查询角色：得到指定角色的实体数据。通过名称查询角色：得到指定角色的实体数据。 查询全部角色：调用 Data: 角色的查询全部角色方法 ,得到全部角色的实体数据。 增加角色：实现角色的添加。修改角色：实现角色的修改。删除角色：将指定角色的数据置为已删除状态。分配权限：给指定角色分配权限。读取角色权限：读取指定角色的权限数据。角色实体类数据。页面显示全部权限内容：调用Service:权限的查

10、询全部权限或通过所属系统查询全部权 限，将权限数据显示到页面上。通过所属系统查询全部权限：调用Service:权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。读取用户权限：调用 Service:权限的读取用户权限，读取指定用户的权限数据。查询全部权限：调用 Data:权限的查询全部权限，读取全部的权限数据。通过所属系统查询全部权限：调用Data:权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。读取用户权限：调用 Data:权限的读取用户权限，读取指定用户的权限数据。 查询全部权限：读取全部权限数据，返回全部的权限实体类数据。通过所属系统查询全部权限： 读取所属系统权限数

11、据， 返回某系统下的全部权限实体类 数据。读取用户权限：读取指定用户的权限数据。权限实体类数据。3.1.3.2 部门管理通过ID查询部门：根据部门ID，得到指定的部门实体类数据。 多条件查询部门：根据多条件（部门名称、上级部门）查询对象，得到部门实体数据。 查询全部部门：执行查询，获取全部部门的实体数据。增加部门：得到部门实体数据，将数据添加至库中。 修改部门：得到修改后的部门实体数据，将数据保存至库中。删除部门：根据部门ID,删除指定的部门。树形显示部门：查询得到树形结构上的部门数据，并显示。此类的说明同上。此类的说明同上。部门实体类数据。3.1.3.3 岗位管理通过 ID 查询岗位：根据岗

12、位 ID ，得到指定的岗位实体类数据。 多条件查询岗位：根据多条件（岗位名称、上级岗位）查询对象，得到岗位实体数据。 查询全部岗位：执行查询，获取全部岗位的实体数据。 增加岗位：得到部门实体数据，将数据添加至库中。修改岗位：得到修改后的部门实体数据，将数据保存至库中。 删除岗位：根据岗位ID,删除指定的岗位。 树形显示岗位：查询得到树形结构上的岗位数据，并显示。 此类的说明同上。此类的说明同上。岗位实体类数据。3.1.3.4 员工管理通过 ID 查询员工：根据员工 I D ,得到指定的员工实体类数据。 多条件查询员工：根据多条件（工号、姓名、性别、部门、岗位、角色）查询对象,得 到员工实体数据

13、。查询全部员工：执行查询,获取全部员工的实体数据。 增加员工：得到员工实体数据,将数据添加至库中。 修改员工：得到修改后的员工实体数据,将数据保存至库中。删除员工：根据员工ID,删除指定的员工。员工修改登录密码：员工执行修改登录密码数据。此类的说明同上。此类的说明同上。员工实体类数据。3.1.4 界面设计基础信息子系统页面包括：角色管理、部门管理、岗位管理、员工管理四部分。3.141角色管理页面部门管理页面岗位管理页面3.144员工管理页面3.2对标评价管理模块模块说明对标评价管理模块包括：对标体系管理、对标指标管理、报表管理、对标评价管理、对 标评价参数管理、对标评价算法管理、对标指标值管理

14、。对标体系管理：实现管理层分派任务和公司员工接收任务的管理功能。对标指标管理：报表管理：对标评价管理：对标评价参数管理：对标评价算法管理：对标指标值管理：类图工作任务工作计划工作日志工作汇报审批计划审批计划功能的设计实现，参照类图：工作计划。类说明3.2.3.1 工作任务通过ID查询任务：根据任务ID，得到指定工作任务实体类数据。多条件查询任务：根据多条件（起始日期、截止日期、任务标题、重要程度、任务状态 部门、任务接收人）查询对象，得到工作任务的实体数据。查询全部任务：执行查询，获取全部工作任务的实体数据。增加任务：得到任务实体数据，将数据添加至库中。暂停任务：对指定的任务，执行暂停处理操作

15、。处理完成任务：对指定的任务，执行完成处理操作。实时检查收到的新任务或还未做计划的任务：根据当前的用户ID，实时检查目前收到的新任务或还未做计划的任务，以便系统实时提醒用户，并弹出提醒信息。此类的说明同上。此类的说明同上。工作任务实体类数据。3.2.3.2 工作计划通过ID查询计划：根据计划ID，得到指定的工作计划实体类数据。多条件查询计划： 根据多条件 （起始日期、 截止日期、 计划标题、 计划类型） 查询对象， 得到工作计划实体类数据。查询全部计划：执行查询，得到全部工作计划的实体类数据。 增加计划：得到计划实体数据和所属任务计划完成百分比列表，将数据添加至库中。修改计划： 计划未经审批时

16、， 得到修改后的计划实体数据和所属任务计划完成百分比列 表，将数据保存至库中。写计划总结： 某指定的工作计划结束时， 将总结内容和所属任务实际完成百分比列表数 据，保存至库中。处理所属工作任务完成情况： 写计划时或写总结时， 保存所属工作任务列表 （包括计划 或实际完成百分比数据） ，添加至数据库。查询所属任务完成情况：根据指定的工作计划，查询其所属工作任务的完成进度情况。审批计划： 管理层对某一指定的工作计划，执行审批处理， 以使审批后的工作计划不能再进行修改。取消审批： 管理层对某一指定的工作计划，执行取消审批处理， 以使此工作计划能进行再修改。实时查询未审批的工作计划： 执行查询未经管理

17、层审批的工作计划， 得到未审批的工作 计划实体类数据。当有未审批信息时系统应实时提醒用户，并弹出提醒信息。多条件查询已审批的工作计划：根据多条件（起始日期、截止日期、计划比他、计划类 型、创建人）查询对象，得到管理层已审批过的工作计划实体类数据。实时查询他人抄送来的工作计划：根据当前用户ID，查询得到他人抄送给自己的工作计划实体类数据。当有未阅读的信息时系统应实时提醒用户，并弹出提醒信息。处理查看未阅读的他人抄送的工作计划：根据工作计划ID，查看未阅读的他人抄送给自己的工作计划实体类数据。此类的说明同上。此类的说明同上。工作计划实体类数据。3.2.3.3 工作日志通过ID查询工作日志：根据日志

18、 ID，得到指定的工作日志实体类数据。多条件查询任务：根据多条件（起始日期、截止日期）查询对象，得到工作日志实体数 据。查询全部工作日志：执行查询，得到全部的工作日志实体类数据。 增加工作日志：得到工作日志实体类数据，将数据添加至库中。删除工作日志：根据日志ID，删除指定的工作日志。实时查询他人发来的工作日志：根据当前用户ID，查询得到他人发来的工作日志实体数据。当有未阅读的信息时系统应实时提醒用户，并弹出提醒信息。处理查看未阅读的他人发来的工作日志：根据工作日志ID，查看未阅读的他人发来的工作日志实体类数据。此类的说明同上。此类的说明同上。工作日志实体类数据。3.2.3.4 工作汇报通过ID

19、查询工作汇报：根据工作汇报ID，得到指定的工作汇报实体类数据。多条件查询工作汇报：根据多条件（起始日期、截止日期）查询对象，得到工作汇报实 体数据。查询全部工作汇报：执行查询，得到全部的工作汇报实体类数据。 增加工作汇报：得到工作汇报实体类数据，将数据添加至库中。实时查询员工发来的工作汇报：根据当前用户ID，查询得到员工发来的工作汇报实体数据。当有未阅读的信息时系统应实时提醒用户，并弹出提醒信息。处理查看未阅读的员工发来的工作汇报：根据工作汇报ID，查看未阅读的员工发来的工作汇报实体类数据。此类的说明同上。此类的说明同上。 工作汇报实体类数据。3.2.3.5 审批计划3.2.4 界面设计我的工

20、作台子系统页面包括：工作任务、工作计划、工作日志、工作汇报、审批计划五部分。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 约束和假定描述系统设计中最主要的约束， 这些是由客户强制要求并在需求说明书写明的。 说明系 统是如何来适应这些约束的。另外如果本系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助，那么系统可能还受到其它的约束。 这种情况下， 要求清楚地描述与本系统有交互的软件类型（比如某某

21、某数据库软件， 某某某 EMail 软件）以及这样导致的约束 （比如只允许纯文本的 Email ）。实现的语言和平台也会对系统有约束，同样在此予以说明。对于因选择具体的设计实现而导致对系统的约束，简要地描述你的想法思路，经过怎么样的权衡，为什么要采取这样的设计等等。包括运行环境的约束，简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录 C。5系统数据结构设计5.1逻辑结构设计注：表和表字段命名规范：1. 表名的定义：规范格式：系统名表名（字母全部大写）比如，工作计划管理系统中的某个表定义为：WORKPLAN_TASK;2. 表字段的定义：规范格式：表名+字段名称（首

22、字母大写），以避免字段重名出现在不同表中。比如，表 WORKPLAN_TASK中的字段标识Id定义为：Taskld ；3. 表字段长度的定义：规范格式：长度一般为 8的整数倍；比如，VARCHAR的长度可为 8或16或24或32或64等；4. 表字段类型为日期型的定义：规范格式：一般日期型的字段设为VARCHAR，且长度一般为24 （已精确到毫秒）5. 公共表名的定义：规范格式：PUBLIC名（字母全部大写）比如，各个子系统都会用到的公共表，如角色或操作日志表可定义为： PUBLIC_ROLE PUBLIC_OPERATELOG;5.1.1 角色表(PUBLIC_ROLE)字段名称中文说明键别

23、是否 空数据类型长度备注RoleId角色标识IdPKNOVARCHAR32RoleName角色名称NOVARCHAR32Remark角色说明VARCHAR1285.1.2 权限表(PUBLIC_PRIVILEGE )字段名称中文说明键 别是否空数据类型长度备注Privilege"权限标识IdPKNOVARCHAR32PrivilegeCode权限编码NOVARCHAR32PrivilegeName权限名称NOVARCHAR64PrivilegePare ntld上级权限IdVARCHAR32上级权限SystemId权限所属系统IdFKVARCHAR32权限所属系统5.1.3 角色权限

24、表(PUBLIC_ROLEPRIVILEGE )字段名称中文说 明键别是否 空数据类型长度备注RoleId角色IDPK，FKNOVARCHAR32角色表外键PrivilegeId权限IDPK，FKNOVARCHAR32权限表外键5.1.4 部门表(PUBLIC_ DEPT )字段名称中文说明键别是否 空数据类型长度备注Dept Id部门标识IdPKNOVARCHAR32Dept Name部门名称NOVARCHAR32DeptPare ntld父类部门IdVARCHAR32上一级部门Tel电话VARCHAR32Fax传真VARCHAR32SortOrder排序INT4Remark备注VARCHA

25、R1285.1.5 岗位表(PUBLIC_POST )字段名称中文说明键别是否 空数据类型长度备注PostId岗位标识IdPKNOVARCHAR32PostName岗位名称NOVARCHAR32PostPare ntld父类岗位IdVARCHAR32上一级岗位DeptId所属部门IdFKVARCHAR32部门表外键Function岗位职责VARCHAR128SortOrder排序INT45.1.6 员工表(PUBLIC_MEMBER )字段名称中文说明键别是否 空数据类型长度备注Member Id部门标识IdPKNOVARCHAR32JobNumber工号NOVARCHAR32作为系统登录帐号

26、使用Password登录密码NOVARCHAR32MemberName员工姓名NOVARCHAR32DeptId所属部门IdFKNOVARCHAR32部门表外键PostId所属岗位IdFKNOVARCHAR32岗位表外键Sex性别VARCHAR1Tel办公电话VARCHAR30Mobile手机VARCHAR30Email电子邮箱VARCHAR30Address住址VARCHAR64Remark备注VARCHAR128RoleId所属角色IdFKNOVARCHAR32角色表外键Status帐号状态NOVARCHAR8状态如：有效，停用；默认值为有效5.1.7 工作任务表(WORKPLAN_ TA

27、SK )字段名称中文说明键别是否 空数据类型长度备注TaskId任务标识IdPKNOVARCHAR32TaskTile任务标题NOVARCHAR32TaskC ontent任务内容NOVARCHAR1024Level重要程度NOVARCHAR8重要程度“”StartDate任务开始时间NOVARCHAR24En dDate任务完成时间NOVARCHAR24CreatorId创建人IdFKNOVARCHAR32员工表外键Status任务状态NOVARCHAR8状态如：未完成、暂停、已完 成AddDate创建时间NOVARCHAR245.1.8 任务分派表(WORKPLAN_ ALLOTTASK

28、)字段名称中文说明键别是否空数据类型长度备注AllotId分派标识PKNOVARCHAR32IDTaskld派发的工作任务IdFKNOVARCHAR32工作任务表外键Receiverld任务接收人IdFKNOVARCHAR32员工表外键Rema in Perce nt任务剩余百分比NOINT4默认为1005.1.9 工作计戈9表(WORKPLAN_ PLAN )字段名称中文说明键别是否 空数据类型长度备注Plan Id任务标识IdPKNOVARCHAR32Pla nType计划类型NOVARCHAR64计划类型如：周计划、月计划、 年计划Pla nTitle计划标题NOVARCHAR32Pla

29、 nTime计划时间NOVARCHAR32Pla nCo ntent计划内容NOVARCHAR1024Pla nSum计划总结VARCHAR1024CreatorId创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR24AuditorId计划审批人IdFKNOVARCHAR32员工表外键IsAudit是否审批NOVARCHAR8是或否，默认值为否5.1.10 计戈U任务表(WORKPLAN_ PLANTASK )字段名称中文说明键别是否 空数据类型长度备注Pla nId计划标识IdPK，FKNOVARCHAR32AllotId接收的任务标识IdPK，FKNO

30、VARCHAR32Pla nPerce nt任务计划完成百分比NOINT40到100之间Fini shedPerce nt任务实际完成百分比INT40到100之间5.1.11 工作日志表(WORKPLAN_ WORKLOG )字段名称中文说明键别是否 空数据类型长度备注Log Id工作日志标识IdPKNOVARCHAR32LogI nfo日志记录NOVARCHAR1024LogSum日志小结VARCHAR1024Creatorld创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR245.1.12 工作汇报表(WORKPLAN_ WORKREPORT )字段名

31、称中文说明键别是否 空数据类型长度备注Report Id汇报标识IdPKNOVARCHAR32ReportTitle标题NOVARCHAR32ReportC ontent内容NOVARCHAR1024CreatorId创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR245.1.13 信息发布表(PUBLIC_ PUBLISHINFO )字段名称中文说明键别是否 空数据类型长度备注Info Id消息标识IdPKNOVARCHAR32Title主题NOVARCHAR32Content内容NOVARCHAR1024CreatorId创建人IdFKNOVARCHA

32、R32员工表外键AddDate创建时间NOVARCHAR245.1.14 收件箱表(PUBLIC_INBOX )字段名称中文说明键别是否空数据类型长度备注BoxId标识IDPKNOVARCHAR32In foType信息类型NOVARCHAR24抄送或发送来的信息类型如： 工作计划、工作日志、工作汇 报、发布的消息等Info Id抄送或发送来 的具体信息IdFKNOVARCHAR32ReceiverId信息接收人IdFKNOVARCHAR32员工表外键AddDate接收时间NOVARCHAR24接收信息时间IsRead是否已阅读NOVARCHAR8是或否，默认值为否5.1.15 系统操作日志表

33、(PUBLIC_OPERATELOG )字段名称中文说明键别是否 空数据类型长度备注Log Id操作日志标识IdPKNOVARCHAR32Operatorld操作员IdFKNOVARCHAR32员工表外键SystemModule Id系统模块IdNOVARCHAR32系统功能模块表外键Action Type动作类型NOVARCHAR8女口：增、删、改、查等Remark操作说明VARCHAR128OperateTime操作时间NOVARCHAR24个人提醒设置表(PUBLIC_EVENTS )字段名称中文说明键 别是 否 空数据类型长度备注Eve ntsld提醒事件标识IdPKNOVARCHAR32Even tsType提醒类型NOVARCHAR24女:工作任务、工作计划、工作日志、工作汇报等Even tsTitle主题NOVARCHAR32Even tsC ontent内容NOVARCHAR1024Second秒VARCHAR64Min u