概要设计说明书(练习模版).docVIP

概要设计说明书 1．引言 2 1.1编写目的 2 1.2项目背景 2 1.3编码风格及命名规则 3 1.4参考资料 3 2．任务概述 3 2.1目标 3 2.2运行环境 3 2.3需求概述 3 2.3.1 Weekly Report 3 2.3.2 Change Request 3 2.4条件与限制 4 3．总体设计 4 3.1处理流程 4 3.1.1 Weekly Report 4 3.1.2 Change Request 5 3.2总体结构和模块外部设计 5 3.3功能分配 6 3.3.1 Weekly Report功能分配 6 3.3.2 Change Request功能分配 7 4．Class设计 7 4.1 Weekly Report 7 4.1.1 WeeklyReportBean 7 Attributes 7 Operations 8 4.1.2 ReportStatus 8 Attributes 8 Operations 8 4.1.3 ReportProblemBean 8 Attributes 8 Operations 9 4.1.3 ProblemSeverity 9 Attributes 9 Operations 9 4.2 Change Request 9 4.2.1 ChangeRequest 9 Attributes 9 Operations 10 4.2.2 Catalog 10 Attributes 10 Operations 10 4.2.3 ChangeStatus 10 Attributes 10 Operations 11 4.3 与主模块之间的接口 11 4.3.1 UserInfo 11 Attributes 11 Operations 11 4.3.2 ProjectInfo 11 Attributes 11 Operations 12 4.3.3 DBConnectPool 12 5．数据结构设计 12 5.1 Weekly Report 12 5.1.1 TBL_Report： 12 5.1.2 TBL_Report_Problem 12 5.2 Change Request 13 5.2.1 TBL_Change 13 6．系统部署 14 7．出错处理设计 14 7.1出错输出信息 14 7.2出错处理对策 14 8.安全保密设计 15 9.维护设计 15 1．引言 1.1编写目的 本文档为Weekly Report和Change Request的概要设计说明书，描述了模块业务，GUI，数据字典，为设计者提供基础。 1.2项目背景 委托单位：xxxxx有限公司 开发单位：xxxxxxxx有限公司 1.3编码风格及命名规则 具体规格遵守xxxxxx限公司内部编定的《Java编码规范》文档。 1.4参考资料 Weekly Report Change Request需求说明书。 2．任务概述 2.1目标 2.2运行环境 Hardware: PC Server: CPU: Intel 1.2G MHz; Memory: 512M; HD: 20G Software: 操作系统： Microsoft Windows 2000 professional, Linux 数 据 库： Oracle，SQL Server 支持环境： Websphere ，Weblogic 2.3需求概述 2.3.1 Weekly Report Weekly Report模块是整个PMS系统中不可缺少的一部分，它向PM或上层领导提供项目开发进程的总的汇报，以便PM及时掌握项目的进展情况，人员耗费情况，项目完成百分比等，以便合理分配各项资源，更能针对开发中所遇到的障碍及时提出解决办法。 2.3.2 Change Request Change Request模块是PMS系统的一部分，主要记录开发项目的Request Change or Design Change，跟踪已提出的需求更改的执行情况，并统计出当前项目所有需求更改的累计Effort(person-days)。使PM及时掌握项目的更改情况，开发周期的变化，以便及时修改项目计划，人员设备的配置，以及与用户进行协商。 2.4条件与限制 3．总体设计 3.1处理流程 3.1.1 Weekly Report 开发团队的Team Leader，需要把每周的开发进展情况写进Weekly Report,让PM查看以便掌握整个Project的进展。Team Leader可以通过两种方式填写Weekly Report,一种是在一周开始时，把上一周的报告一次填写完，然后提交给PM查看。另一种是如果报告需要填写的内容太多，Team Leader可以在