项目开发详细设计方案说明书超好用模板完整版.docx

资源描述

项目开发详细设计方案说明书超好用模板完整版.docx

《项目开发详细设计方案说明书超好用模板完整版.docx》由会员分享，可在线阅读，更多相关《项目开发详细设计方案说明书超好用模板完整版.docx（15页珍藏版）》请在冰豆网上搜索。

项目开发详细设计方案说明书超好用模板完整版.docx

项目开发详细设计方案说明书超好用模板完整版

详细设计说明书

ﻩ

XX有限公司

ﻬ修订记录

日期

修订版本

修改描述

作者

审核

ﻬ目录

第一章ﻩ概述5

1.1.ﻩ应用模块的目的５

１.2.ﻩ应用模块总体描述ﻩ５

1.3.ﻩ应用模块接口描述５

１．4.假设条件ﻩ5

第二章设计模式（Deｓｉｇnｐａttｅrn）ﻩ6

第三章类设计7

3.1．分块类图8

3.1.1.<类图1>ﻩ８

3.1．2.ﻩ<类图n>8

3.2.ﻩ整体继承关系8

３.3．ﻩ类描述９

3．3.１.ﻩ<类名1>　Cｌａsｓ　Deｓcｒiｐｔion９

3.３.２.＜类名n>　Claｓs　Descriptioｎﻩ１0

第四章ﻩ交互图ﻩ１2

４．1.<情景编号1:

情景名称>ﻩ１２

4．1.１.交互图12

4.1．2.例外情况及条件13

4．２.<情景编号ｎ:

情景名称>ﻩ1３

第五章状态图14

5.1.ﻩ<状态图编号１:

状态图名称>1４

5.2.ﻩ<状态图编号n:

状态图名称>ﻩ1５

第六章时序流程图ﻩ16

第七章用户界面设计说明ﻩ１8

7.1.ﻩ用户界面关系ﻩ18

7.2.用户界面具体描述ﻩ18

7．2.１.<界面编号1:

界面名称〉1８

７.2.２．ﻩ<界面编号N:

界面名称〉１9

第八章测试考虑ﻩ2０

第九章ﻩ附录ﻩ21

9．１.ﻩ附录A　代码举例２１

9．2.ﻩ附录B　设计问题２１

9.２.1.＜设计问题1＞ﻩ2１

9.2.2.<设计问题n>ﻩ2１

第一章概述

一.1.应用模块的目的

请明确客户建立应用模块的目的。

一.2.应用模块总体描述

描述应用模块的总体功能。

一.3.应用模块接口描述

简要描述本应用模块的公共接口，具体接口会在相应的类中进行具体描述。

建议采用列表的方式。

一.4.假设条件

列出在问题领域，项目方案及其它影响系统设计的可能方面内,应当成立的假设条件。

包括系统的约束条件和应遵循的标准。

第二章设计模式（Desiｇn　ｐaｔｔｅrn）

请列出本模块设计时使用的设计模式，请参考“DeｓiｇｎPatｔｅｒns”ByErich　Grａmmａ,Ｈeｌｍ,Ｊohｎson　&Vlissｉdes,ｇang　offourISＢN0－201-6３36１-ｚ（中文《设计模式》-机械工业出版社）。

第三章类设计

类图（ClａssＤiａgram）描述类和类之间的静态关系。

与数据模型不同,它不仅显示了信息的结构，同时还描述了系统的行为。

　在类图的基础上,利用状态图、关系图等进一步描述了系统其他方面的特性。

类图主要描述了：

∙类（包括类的实例）

∙属性（表示知识型责任或数据）

∙方法（表示操作责任或功能）

∙类之间的关联关系

∙类之间的聚合关系

∙在父类及子类之间的继承关系

∙正式或非正式的约束描述（可选）

本节针对每个构件的进行了详细描述，记录每个类的实例数，每个实例的占用数据库空间的平均大小等信息。

类图的设计在整个项目生命周期内通过迭代的方法得到。

方案的复杂程度决定迭代的次数。

∙在考虑初始（iｎiｔiａl）或概念（concｅptual）角度类图时,我们讨论系统作什麽,该阶段即传统意义上的分析阶段，通过理解业务模型的哪些业务模型应在软件系统中实现来定义问题和需求。

在这点上设计保持技术中立，但并不意味着丝毫不考虑技术,因为此时对于如何构造软件系统的决定不是首要的关注问题。

∙下一步，设计逻辑（logｉｃal）或具体（ｓpｅcｉfｉcａｔion）角度类图时,开始关心系统如何实施和定义方案的整体结构。

诸如并行及分发，协作及共享,交易及存储，用户界面性能,及系统接口例如通讯接口。

在设计阶段,设计依赖于技术和架构，同时设计决策也会影响技术和架构。

∙最后的迭代是设计物理或实施角度类图，基于所选的实施语言细化架构设计。

为了处理特定的实施细节,我们可能引入新的类或对现有的类进行重新定制。

请明确本节描述的是何种角度的类图。

类图的目的在于通过研究业务、用户及系统的需求,制定全面的软件模型。

创建完善的类图有助于完成如下工作:

∙通过研究系统中包含的对象，优化并精简系统。

∙是系统应用架构某些层次设计的出发点，如用户界面、数据库建模。

∙通过分析问题所在及其相关领域,恰当建立对象模型,有助于明确分工，以支持并行开发。

∙通过使用简洁明了的表示方法,进一步确认系统设计。

∙全面考虑使用合适的应用设计模型、方法,避免不必要的重复工作。

∙遵循正确的设计原则,方法以提高设计质量。

在开发组合客户中更好的理解系统的设计有助于系统的重复利用和增量开发。

使用ＣAＳE工具生成图表。

三.1.分块类图

本段按照模块的不同部分的分块描述类图。

对于小的模块不须分块。

三.1.1.<类图1>

画一个类图仅描述与该部分相关的那些特征。

三.1.2.<类图n>

对每个部分重复上面的段落要求。

三.2.整体继承关系

下面的图表描述整个应用模块的类图,在此仅显示类名及类型的。

三.3.类描述

本章描述上述章节中提到类的详细信息。

若有可能，使用CＡSＥ工具生成这些类描述。

类列表:

请在类名出提供连接指向类的具体描述。

类名

简要描述

是否为接口类

三.3.1.<类名1>ＣｌaｓsＤesｃrｉｐtioｎ

Clａｓｓ

CＳａmpｌｅＸXXX

Pacｋage

ClａssFormat

ｐuｂliｃ　class　CＳaｍpｌeXXＸX

Ｅｘｔeｎds

Imｐlemenｔｓ

Properties

Name

Type

Defaｕlt　Value

Ｐuｂ/Prv／Pｒo

Get

Seｔ

Pｕrpｏse

Metｈoｄs

Naｍe（Pｕb／Pｒv/Pro）

Paｒaｍeｔeｒs

ReｔｕｒnValue

Ｅxceptｉｏｎs

Ｄescrｉpｔiｏｎ

Evenｔs

Name

Cｏnditioｎ

Ｐaｒametｅrs

Purｐose

约束条件（可选）

实例个数（可选）

实例平均大小　（可选）

psｅudo-CodeforImportant　Metｈod（重要方法伪码）

注：

Ｐub/Prv/Ｐro　代表prｉｖate,prｏtectｅd,pｕbliｃ

三.3.2.<类名ｎ>ClａｓsＤｅscrｉptｉｏn

Cｌasｓ

ＣＳampｌeXXＸX

Packａge

ＣｌａssFoｒmat

pubｌｉcclasｓCＳamｐｌeXXXX

Exｔends

Imｐlemeｎts

Pｒopertieｓ

Namｅ

Ｔype　

DefａultVaｌue

Ｐub/Prv／Pｒo

Get

Ｓｅt

Ｐurpose

Ｍethods

Ｎamｅ（Pｕb／Prv/Ｐro）

Paｒａmeterｓ

ＲｅｔｕrnVａlue

Excｅｐｔionｓ

Descｒipｔion

Events

Naｍe

Ｃｏnｄition

Paｒameterｓ

Puｒpｏsｅ

约束条件（可选）

实例个数　（可选）

实例平均大小（可选）

psｅudo-Codｅ　forIｍporｔaｎtＭethｏd（重要方法伪码）

注:

Pub/Prｖ/Pro代表privaｔe,ｐｒotectｅd，　public

第四章交互图

交互图以图形方式描述了系统之间的交互关系。

初始的交互图仅显示分析阶段主要业务对象间主要的消息流动。

后续的交互图中包含更多的控制类,接口类，通讯，分布和存储等功能类。

初始行为仅描述使用案例或具体情景中所描述的功能，后续交互图中会描述更多系统内部的行为。

交互图是实例级的图，它描述了具体对象实例间消息的沟通及参数的传递,描述了系统动态交互。

交互图作为功能性需求说明和类图之间的桥梁，帮助确定对象行为，发现问题，协助设计决定，选择其他设计方法。

作为类图的补充。

交互图也可帮助评估类的设计是否能满足功能性需求,交互图和类图都是叠代开发的。

本文仅对复杂情况使用交互图描述。

请为不同的情景进行编号。

并在交互图列表的情景编号处提供联接。

交互图列表：

情景编号

情景名称

情景描述