详细设计说明书评审检查表说课讲解
- 格式:xls
- 大小:20.50 KB
- 文档页数:2
OA系统 1.0 详细设计说明书修订历史记录A - 增加M - 修订 D - 删除目录第一章引言 (4)1.1编写目的 (4)1.2背景 (4)1.3术语解释 (4)第二章系统命名规则 (4)一协同办公子系统 (4)1.1 个人邮箱 (4)1.2通知 (8)1.3公告 (9)1.4公文管理 (11)1.5 公文归档WSDL (18)1.6 个人事务助理 (18)第三章系统模块结构 (20)一协同办公子系统 (20)第四章协同办公子系统详细设计 (23)一个人邮箱模块设计 (23)1.1 程序描述 (23)1.2 功能设计 (25)1.3 界面设计 (26)1.4 输人设计 (27)1.5 流程逻辑 (28)1.6 存储设计 (29)1.7 限制条件 (29)二.通知模块设计 (29)2.1 程序描述 (29)2.2 功能设计 (30)2.3 界面设计 (31)2.4 输人设计 (32)2.5 流程逻辑 (33)2.6 存储设计 (34)2.7 限制条件 (34)三.公告模块设计 (34)3.1 程序描述 (34)3.2 功能设计 (35)3.3 界面设计 (35)3.4 输入设计 (36)3.5 流程逻辑 (37)3.6 存储设计 (38)3.7 限制条件 (38)四.发文管理模块设计 (38)4.1 程序描述 (38)4.2 用例图 (40)4.3 界面设计 (41)4.4 流程逻辑 (42)4.5 存储设计 (43)4.6 限制条件 (43)五.收文管理模块设计 (43)5.1 程序描述 (43)5.2 用例图 (45)5.3 界面设计 (45)5.4 流程逻辑 (47)5.5 存储设计 (48)5.6 限制条件 (48)六、日程安排模块设计 (48)6.1 程序描述 (48)6.2 用例图 (50)6.3 界面设计 (51)6.4 流程逻辑 (52)6.5 存储设计 (52)七、工作日志模块设计 (52)7.1 程序描述 (52)7.2 用例图 (53)7.3 界面设计 (53)7.4 流程逻辑 (54)7.5 存储设计 (55)八、经办公文查询模块设计 (55)8.1 程序描述 (55)8.2 界面设计 (56)九、收发文查询模块设计 (58)9.1 程序描述 (58)9.2 界面设计 (58)十、公文归档模块设计 (59)10.1 程序描述 (59)10.2 界面设计 (59)第一章引言1.1 编写目的1、编写本说明书的目的:本文档的目的在于让开发人员、系统维护人员全面了解本系统的功能设计。
[项目名称]详细设计说明书[V1.0(版本号)]拟制人______________________ 审核人______________________ 批准人______________________[一九九九年八月二十日]详细设计说明书1.引言1.1编写目的[说明编写这份详细设计说明书的目的,指出预期的读者。
]1.2背景a.[待开发系统的名称;]b.[列出本项目的任务提出者、开发者、用户。
]1.3定义[列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
]1.4参考资料[列出有关的参考资料。
]2.系统的结构[给出系统的结构框图,包括软件结构、硬件结构框图。
用一系列图表列出系统内的每个模块的名称、标识符和它们之间的层次结构关系。
]3.模块1(标识符)设计说明[从本章开始,逐个地给出各个层次中的每个模块的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。
]3.1模块描述[给出对该基本模块的简要描述,主要说明安排设计本模块的目的意义,并且,还要说明本模块的特点。
]3.2功能[说明该基本模块应具有的功能。
]3.3性能[说明对该模块的全部性能要求。
]3.4输入项[给出对每一个输入项的特性。
]3.5输出项[给出对每一个输出项的特性。
]3.6设计方法(算法)[对于软件设计,应详细说明本程序所选取用的算法,具体的计算公式及计算步骤。
] [对于硬件设计,应详细说明本模块的设计原理、元器件的选取、各元器件的逻辑关系,所需要的各种协议等。
]3.7流程逻辑[用图表辅以必要的说明来表示本模块的逻辑流程。
]3.8接口[说明本模块与其它相关模块间的逻辑连接方式,说明涉及到的参数传递方式。
]3.9存储分配[根据需要,说明本模块的存储分配。
]3.10注释设计[说明安排的程序注释。
Design Specification Review Checklist设计说明书评审检查单(DVPCHK01 / IPD-CMM V2.0 / for internal use only)Project ID 项目编号Owner 责任人Reviewer 检查者Date 检查日期yyyy-mm-dd Item 审查内容Comment 说明1Description 说明This checklist is consisted of two partitions, one is for HLD review, another is for LLDreview. When HLD and LLD are combined to one document, both checklists should be used.本检查单由两部分组成,一部分适用于概要设计评审,一部分适用于详细设计评审。
如果概要设计和详细设计合成一篇文档,应同时关注这两个检查单。
2For High Level Design specification 概要设计适用No. 序号Checklist检查项Status执行情况Comment说明1 Does the document conform to HLD templates as required by thePHB?文档是否符合项目过程手册中要求的概要设计模板?Yes 是[ ] No 否[ ] NA 免[ ]2 Is the purpose and function of each partioned sub-module definedclearly and unambiguously?每个已划分的子模块,其目的和功能是否已清晰定义且无歧义?Yes 是[ ] No 否[ ] NA 免[ ]3 Are the global data structures defined completely and rightly?全局数据结构是否已经完整定义并且正确?Yes 是[ ] No 否[ ] NA 免[ ]4 Are the interaction described completely in the dependency ?依赖性是否描述了主要的交互过程?Yes 是[ ] No 否[ ] NA 免[ ]5 Are the external interfaces (include function interfaces and datainterfaces) complete, correct and unambiguously?所有的外部接口(包括函数接口和数据接口)是否完整,正确且无歧义?Yes 是[ ] No 否[ ] NA 免[ ]6 Does the granularity accord with what is descripted in the Yes 是[ ]No. 序号Checklist检查项Status执行情况Comment说明spcecification's purpose section?概要设计说明书描述的内容是否达到的目的中所描述的功能分解粒度?No 否[ ]NA 免[ ]7 Does HLD meet perforamnce goal as per PPL and SRS ?HLD是否满足PPL和SRS中的性能目标?Yes 是[ ] No 否[ ] NA 免[ ]8 Has the software requirements track matrix been updatedcorrectly?是否已正确更新了软件需求跟踪矩阵?Yes 是[ ] No 否[ ] NA 免[ ]3 For Low Level Design specification 详细设计适用No. 序号Checklist检查项Status执行情况Comment说明1 Does the document conform to LLD templates as required by thePHB?文档是否符合项目过程手册中要求的详细设计模板?Yes 是[ ] No 否[ ] NA 免[ ]2 Are the interfaces between the submodules (including datainterfaces and function interfaces) stated clearly?对已划分的子模块,和其它子模块的接口和该子模块内部的接口(包括数据接口和函数调用接口)是否已明确描述?Yes 是[ ] No 否[ ] NA 免[ ]3 Are all the procedure/functions in each sub-module specified?是否列出了每个子模块包含的所有过程/函数?Yes 是[ ] No 否[ ] NA 免[ ]4 Are all data structures and global variables defined correctly?是否已经正确定义所有的数据结构和全局变量?Yes 是[ ] No 否[ ] NA 免[ ]5 Are all the pivotal procedures/functions is described by usingpseudocode/flow chart correctly?是否对每个子模块的各个关键过程/函数,都给出了正确的伪码/流程图描述?Yes 是[ ] No 否[ ] NA 免[ ]6 Does LLD meet performance goal as per PPL and SRS ?LLD是否满足PPL和SRS中的性能目标?Yes 是[ ] No 否[ ] NA 免[ ]7 Has the software requirements track matrix been updatedcorrectly?是否已正确更新了软件需求跟踪矩阵?Yes 是[ ] No 否[ ] NA 免[ ]。
《详细设计说明书》模板1.导言本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1目的本文档的目旨在推动软件工程的规范化,使设计人员遵循统一的详细设计书写规范,节省制作文档的时间,降低系统实现的风险,做到系统设计资料的规范性与全面性,以利于系统的实现、测试、维护、版本升级等。
详细设计的详细程度,应达到可以编写程序的程度。
1.2范围本文档用于软件设计阶段的详细设计,它的上游(依据的基线)是《概要设计说明书》,它的下游是源程序清单及单元测试计划,并为单元测试报告提供测试依据。
该范围应覆盖《概要设计说明书》中的功能点列表、性能点列表,接口列表。
软件详细设计的范围是:各子系统的公用模块实现设计、专用模块实现设计、存储过程实现设计、触发器实现设计、外部接口实现设计。
部门角色授权设计、其他详细设计等。
按照3层结构(B/A/S)的布局,详细设计应从下面3个方向进行、数据库服务器上的面向数据的设计:数据字典物理设计、基本表物理设计、中间表物理设计(报表设计)、临时表物理设计、视图物理设计、存储过程物理设计、触发器物理设计。
应用服务器上的面向业务逻辑的设计:接口数据设计、中间件设计、数据通信传输设计、可视构件设计、非可视构件设计、角色授权设计、功能点设计(功能点列表设计)。
浏览器上的面向对象的设计:录入修改界面设计、浏览查询界面设计、登录注册界面设计、信息发布界面设计。
1.3术语定义术语定义,如表1所示。
表1 术语定义1.4参考资料[1]《概要设计说明书》[2]《需求分析说明书》[3]《软件合同》[4]命名规范[5]程序设计规范[6]界面设计规范1.5相关文档[1]源程序清单[2]单元测试计划及报告[3]《用户使用于册》1.6版本更新记录版本更新记录,如表2所示。
表2 版本更新记录2.模块实现设计功能模块包括:登录注册模块、信息发布模块、菜单模块、录入修改模块、查询统计模块、数据处理模块、报表输出模块、前台网站模块、后台处理模块、数据传输与接收模块等等,详细设计是面向模块的,或者说是面向部件(或构件)的,不是面向组织结构或部门单位的。
课程设计评审表评审情况一、教学目标本课程的教学目标是让学生掌握XX学科的基本概念、原理和方法,能够运用所学知识解决实际问题。
具体分为三个层面:1.知识目标:学生能够准确理解并记忆XX学科的基本概念、原理,掌握相关领域的知识体系。
2.技能目标:学生能够运用所学的知识和方法,解决实际问题,提高分析问题和解决问题的能力。
3.情感态度价值观目标:培养学生对XX学科的兴趣和好奇心,增强学习动力,形成积极向上的学习态度和团队合作精神。
二、教学内容根据课程目标,本课程的教学内容主要包括以下几个部分:1.XX学科的基本概念和原理:介绍XX学科的基本概念、原理和方法,帮助学生建立系统的知识体系。
2.实际问题解决:通过案例分析和实验操作,让学生学会将所学知识应用于实际问题,提高解决问题的能力。
3.学科前沿动态:介绍XX学科的最新研究进展和应用领域,激发学生的学习兴趣和创新意识。
三、教学方法为了实现课程目标,我们将采用以下几种教学方法:1.讲授法:通过教师的讲解,让学生掌握基本概念和原理。
2.讨论法:学生进行小组讨论,培养学生的思考能力和团队合作精神。
3.案例分析法:通过分析实际案例,让学生学会将理论知识应用于实际问题。
4.实验法:开展实验操作,培养学生的动手能力和实践能力。
四、教学资源为了支持教学内容和教学方法的实施,我们将准备以下教学资源:1.教材:选用权威、实用的教材,为学生提供系统的学习资料。
2.参考书:提供相关领域的参考书籍,丰富学生的知识视野。
3.多媒体资料:制作课件、教学视频等多媒体资料,提高课堂教学的趣味性和效果。
4.实验设备:配备必要的实验设备,保证实验教学的顺利进行。
五、教学评估本课程的评估方式包括平时表现、作业、考试等多个方面,以全面客观地评价学生的学习成果。
具体评估方式如下:1.平时表现:通过观察学生在课堂上的参与程度、提问回答等情况,评估学生的学习态度和理解能力。
2.作业:布置适量的作业,要求学生在规定时间内完成,以检验学生对知识的掌握程度。