概要设计说明书实例(共43页).doc

《概要设计说明书实例(共43页).doc》由会员分享，可在线阅读，更多相关《概要设计说明书实例(共43页).doc（43页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、精选优质文档-倾情为你奉上专心-专注-专业工作计划管理系统概要设计说明书1 引言1.1 编写目的此概要设计说明书是为了说明整个系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。1.2 背景石油工程公司将打造“国际一流的石油工程技术服务公司”作为公司发展的战略目标，为确保这一目标的实现，本项目将建立一套以国际一流企业为战略标杆的企业间对标评价体系，引导企业持续对不足，促改进，使企业经营管理各项目标不断缩小与国内或国际先进水平的差距，保持领先优势，持续提升综合赢利能力。1.3 定义1.4 参考资料石油工程公司对标评价合同书系统项目合同书石油工

2、程公司对标评价合同书系统项目技术服务合同附件石油工程公司对标评价系统需求分析说明书2 总体设计2.1 简述系统采用流行的B/S结构模式。系统的分析设计采用面向对象的技术，应用Visio等工具进行辅助设计。2.2 架构设计2.2.1 系统逻辑架构图2.2.2 系统物理架构图2.2.3 顶层系统包图类包说明：n 业务页面：用户动态网页。n 业务操作：主要控制业务访问的接口和业务流转。n 数据处理：提供业务的实现，包括对业务数据的增、删、改、查等操作。n 数据实体：业务对象的实体类。n 数据接口：提供数据库的访问，传递数据或返回相应数据。n 系统辅助：提供了供整个系统辅助的功能。2.2.4 业务逻辑

3、图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 员工管

4、理3.1.3 类说明3.1.3.1 角色、权限通过ID查询角色：页面得到角色ID，调用Service:角色的通过ID查询角色方法,得到指定角色的实体数据。通过名称查询角色：页面得到角色名称，调用Service:角色的通过名称查询角色方法,得到指定角色的实体数据。查询全部角色：调用Service:角色的查询全部角色方法,得到全部角色的实体数据。增加角色：在页面上得到角色的实体数据，调用Service:角色的增加角色方法，实现角色的添加。修改角色：在页面上得到修改后的角色实体数据，调用Service:角色的修改角色方法，实现角色的修改。删除角色：调用Service:删除角色方法，将指定角色的数据置

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

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

7、ervice:权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。读取用户权限：调用Service:权限的读取用户权限，读取指定用户的权限数据。查询全部权限：调用Data:权限的查询全部权限，读取全部的权限数据。通过所属系统查询全部权限：调用Data:权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。读取用户权限：调用Data:权限的读取用户权限，读取指定用户的权限数据。查询全部权限：读取全部权限数据，返回全部的权限实体类数据。通过所属系统查询全部权限：读取所属系统权限数据，返回某系统下的全部权限实体类数据。读取用户权限：读取指定用户的权限数据。权限实体类数据。3.1.3.2

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

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

10、删除员工：根据员工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 模块说明对标评价管理模块包括：对标体系管理、对标指标管理、报表管理、对标评价管理、对标评价参数管理、对标评价算法管理、对标指标值管理。对标体系管理：实现管理层分派任务和公司员工接收任务的管理功能。对标指标管理：报表管理：对标评价管

11、理：对标评价参数管理：对标评价算法管理：对标指标值管理：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，得到指定工作任务实体类数据。多条件查询任务：根据多条件（起始日期、截止日期、任务标题、重要程度、任务状态部门、任务接收人）查询对象，得到工作任务的实体数据。查询全部任务：执行查询，获取全部工作任务的实体数据。增加任务：得到任务实体数据，将数据添加至库中。暂停任务：对指定的任务，执行暂停处理操作。

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

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

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

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

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

17、五部分。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软件）以及这样导致的约束（比如只允许纯文本的E

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

19、的字段标识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角色标识IdPKNOVARCHAR32RoleNa

20、me角色名称NOVARCHAR32Remark角色说明VARCHAR1285.1.2 权限表（PUBLIC_PRIVILEGE）字段名称中文说明键别是否空数据类型长度备注PrivilegeId权限标识IdPKNOVARCHAR32PrivilegeCode权限编码NOVARCHAR32PrivilegeName权限名称NOVARCHAR64PrivilegeParentId上级权限IdVARCHAR32上级权限SystemId权限所属系统IdFKVARCHAR32权限所属系统5.1.3 角色权限表（PUBLIC_ROLEPRIVILEGE）字段名称中文说明键别是否空数据类型长度备注RoleId

21、角色IDPK，FKNOVARCHAR32角色表外键PrivilegeId权限IDPK，FKNOVARCHAR32 权限表外键5.1.4 部门表（PUBLIC_ DEPT）字段名称中文说明键别是否空数据类型长度备注DeptId部门标识IdPKNOVARCHAR32DeptName部门名称NOVARCHAR32DeptParentId父类部门IdVARCHAR32上一级部门Tel电话VARCHAR32Fax传真VARCHAR32SortOrder排序INT4Remark备注VARCHAR1285.1.5 岗位表（PUBLIC_POST）字段名称中文说明键别是否空数据类型长度备注PostId岗位标识

22、IdPKNOVARCHAR32PostName岗位名称NOVARCHAR32PostParentId父类岗位IdVARCHAR32上一级岗位DeptId所属部门IdFKVARCHAR32部门表外键Function岗位职责VARCHAR128SortOrder排序INT45.1.6 员工表（PUBLIC_MEMBER）字段名称中文说明键别是否空数据类型长度备注MemberId部门标识IdPKNOVARCHAR32JobNumber工号NOVARCHAR32作为系统登录帐号使用Password登录密码NOVARCHAR32MemberName员工姓名NOVARCHAR32DeptId所属部门IdF

23、KNOVARCHAR32部门表外键PostId所属岗位IdFKNOVARCHAR32岗位表外键Sex性别VARCHAR1Tel办公电话VARCHAR30Mobile手机VARCHAR30Email电子邮箱VARCHAR30Address住址VARCHAR64Remark备注VARCHAR128RoleId所属角色IdFKNOVARCHAR32角色表外键Status帐号状态NOVARCHAR8状态如：有效，停用；默认值为有效5.1.7 工作任务表（WORKPLAN_ TASK）字段名称中文说明键别是否空数据类型长度备注TaskId任务标识IdPKNOVARCHAR32TaskTile任务标题NO

24、VARCHAR32TaskContent任务内容NOVARCHAR1024Level重要程度NOVARCHAR8重要程度“”StartDate任务开始时间NOVARCHAR24EndDate任务完成时间NOVARCHAR24CreatorId创建人IdFKNOVARCHAR32员工表外键Status任务状态NOVARCHAR8状态如：未完成、暂停、已完成AddDate创建时间NOVARCHAR245.1.8 任务分派表（WORKPLAN_ ALLOTTASK）字段名称中文说明键别是否空数据类型长度备注AllotId分派标识IDPKNOVARCHAR32TaskId派发的工作任务IdFKNOVA

25、RCHAR32工作任务表外键ReceiverId任务接收人IdFKNOVARCHAR32员工表外键RemainPercent任务剩余百分比NOINT4默认为1005.1.9 工作计划表（WORKPLAN_ PLAN）字段名称中文说明键别是否空数据类型长度备注PlanId任务标识IdPKNOVARCHAR32PlanType计划类型NOVARCHAR64计划类型如：周计划、月计划、年计划PlanTitle计划标题NOVARCHAR32PlanTime计划时间NOVARCHAR32PlanContent计划内容NOVARCHAR1024PlanSum计划总结VARCHAR1024CreatorId

26、创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR24AuditorId计划审批人IdFKNOVARCHAR32员工表外键IsAudit是否审批NOVARCHAR8是或否，默认值为否5.1.10 计划任务表（WORKPLAN_ PLANTASK）字段名称中文说明键别是否空数据类型长度备注PlanId计划标识IdPK，FKNOVARCHAR32AllotId接收的任务标识IdPK，FKNOVARCHAR32PlanPercent任务计划完成百分比NOINT40到100之间FinishedPercent任务实际完成百分比INT40到100之间5.1.11 工作日

27、志表（WORKPLAN_ WORKLOG）字段名称中文说明键别是否空数据类型长度备注LogId工作日志标识IdPKNOVARCHAR32LogInfo日志记录NOVARCHAR1024LogSum日志小结VARCHAR1024CreatorId创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR245.1.12 工作汇报表（WORKPLAN_ WORKREPORT）字段名称中文说明键别是否空数据类型长度备注ReportId汇报标识IdPKNOVARCHAR32ReportTitle标题NOVARCHAR32ReportContent内容NOVARCHAR102

28、4CreatorId创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR245.1.13 信息发布表（PUBLIC_ PUBLISHINFO）字段名称中文说明键别是否空数据类型长度备注InfoId消息标识IdPKNOVARCHAR32Title主题NOVARCHAR32Content内容NOVARCHAR1024CreatorId创建人IdFKNOVARCHAR32员工表外键AddDate创建时间NOVARCHAR245.1.14 收件箱表（PUBLIC_INBOX）字段名称中文说明键别是否空数据类型长度备注BoxId标识IDPKNOVARCHAR32Info

29、Type信息类型NOVARCHAR24抄送或发送来的信息类型如：工作计划、工作日志、工作汇报、发布的消息等InfoId抄送或发送来的具体信息IdFKNOVARCHAR32ReceiverId信息接收人IdFKNOVARCHAR32员工表外键AddDate接收时间NOVARCHAR24接收信息时间IsRead是否已阅读NOVARCHAR8是或否，默认值为否5.1.15 系统操作日志表（PUBLIC_OPERATELOG）字段名称中文说明键别是否空数据类型长度备注LogId操作日志标识IdPKNOVARCHAR32OperatorId操作员IdFKNOVARCHAR32员工表外键SystemMod

30、uleId系统模块IdNOVARCHAR32系统功能模块表外键ActionType动作类型NOVARCHAR8如：增、删、改、查等Remark操作说明VARCHAR128OperateTime操作时间NOVARCHAR245.1.16 个人提醒设置表（PUBLIC_EVENTS）字段名称中文说明键别是否空数据类型长度备注EventsId提醒事件标识IdPKNOVARCHAR32EventsType提醒类型NOVARCHAR24如：工作任务、工作计划、工作日志、工作汇报等EventsTitle主题NOVARCHAR32EventsContent内容NOVARCHAR1024Second秒VARC

31、HAR64Minute分VARCHAR64Hour时VARCHAR64DayOfMonth月的某一天VARCHAR64Month月VARCHAR64DayOfWeek星期的某一天VARCHAR64Year年VARCHAR64IsOpen是否开启NOVARCHAR8是或否，默认值为是CreatorId创建人IDNOVARCHAR32AddDate创建时间NOVARCHAR24SystemId提醒所属系统IdFKVARCHAR32系统表外键5.1.17 系统表（PUBLIC_SYSTEM）字段名称中文说明键别是否空数据类型长度备注SystemId系统标识IdPKNOVARCHAR32SystemC

32、ode系统编码VARCHAR30SystemName系统名称NOVARCHAR30SystemParentId父类系统IdVARCHAR325.1.18 系统功能模块表（PUBLIC_SYSTEMMODULE）字段名称中文说明键别是否空数据类型长度备注SystemModuleId功能模块标识IdPKNOVARCHAR32SystemModuleCode模块编码VARCHAR32SystemModuleName模块名称NOVARCHAR32SystemModuleParentId父类模块IdVARCHAR32SystemId功能模块所属系统IdFKVARCHAR32系统表外键5.2 物理结构设计

33、给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。5.3 数据结构与程序的关系说明各个数据结构与访问这些数据结构的形式:6 系统出错处理设计6.1 出错信息用一览表的方式说朗每种可能的出错或故障情况出现时，系统输出信息的形式、含意及处理方法。6.2 补救措施说明故障出现后可能采取的变通措施，包括：a. 后备技术说明准备采用的后备技术，当原始系统数据万一丢失时启用的副本的建立和启动的技术，例如周期性地把磁盘信息记录到磁带上去就是对于磁盘媒体的一种后备技术；b. 降效技术说明准备采用的后备技术，使用另一个效率稍低的系统或方法来求得所需结果的某些部分，例如一个自动系统的降效技术可以是手工操作和数据的人工记录；c. 恢复及再启动技术说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。6.3 系统维护设计说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。 各个程序之间的对应关系，可采用如下的矩阵图的形式；