面向对象方法系统设计说明书模板

1、项目名称设计说明小组名称：设计说明目录1 概述11.1 编写目的11.2 参考资料11.3 术语和缩写词*12 需求概述13 结构设计13.1 总体设计13.2 功能分配13.3 接口设计13.4 数据结构设计13.4.1 公共数据结构设计13.4.2 数据库设计23.4.3 数据结构同程序的关系*23.5 出错处理设计*23.6 其它*24 类的设计24.1 类1设计24.1.1 功能说明24.1.2 属性说明24.1.3 公有方法说明24.1.4 私有方法说明24.2 类2设计24.2.1 功能说明24.2.2 属性说明24.2.3 公有方法说明24.2.4 私有方法说明25 用例实现的设

2、计35.1 用例1设计35.1.1 功能说明35.1.2 界面设计35.1.3 交互设计35.2 用例2设计35.2.1 功能说明35.2.2 界面设计35.2.3 交互设计3【注】本编写指南中带有“*”标志的表示可选部分，即在文档编写过程中可以依据实际项目的具体情况进行取舍，文档完成后这些“*”标记应该去掉。设计说明1 概述1.1 编写目的本文档的编写目的是：详细定义软件的总体功能；给出系统的结构设计和过程设计，作为程序编写的依据。1.2 参考资料包括：a.项目来源；b.本文档中引用到的规范和资料等；c.列出这些规范和资料的作者、编号、标题、发表日期、出版单位或资料来源。1.3 术语和缩写词

3、*列出本文档中用到的专门术语的定义和缩写词，缩写词要给出中文译名和英文全称，常用的不需要定义。2 需求概述概述系统的特性和需求，扩充软件需求说明中的信息，给出增加的细节，详尽地指出对软件需求说明中有关特性和需求作出的变更。（本次大作业只写：需求详细说明见需求说明）。3 结构设计3.1 总体设计绘制类图（Class Diagram），必要时辅以包图（Package Diagram）和组件图（Component Diagram）。对系统体系架构和所绘制图形加以文字说明。3.2 功能分配说明需求分析文档当中各个用例和类的对应关系，参见下图。用例名功能简述参与类用例1用例1的功能描述类1、类2用例2用

4、例2的功能描述类2、类33.3 接口设计对和硬件及其他外部系统的接口进行说明。3.4 数据结构设计3.4.1 公共数据结构设计对程序当中所定义的全局变量、全局数据结构或类当中Public数据结构进行定义和说明。3.4.2 数据库设计对程序当中所采用的数据库相关的名称和标识符、在数据库当中的位置、定义、度量单位、格式和值域、敏感程度、数据项名、缩写词和代码，包括用于数据库的规格说明等进行定义。建议给出数据库表结构。表3-1 商品表(Product)字段名类型描述备注ProductIdint商品编号主键（自增）ProductName varchar(50)商品名称ProductTypevarcha

5、r(30)商品类别SubTypevarchar(30)商品子类别3.4.3 数据结构同程序的关系*数据结构影响最后的构件（模块）过程设计。因此，需要说明数据结构如何影响程序的数据组织、存取方式、结合程度和处理方法。3.5 出错处理设计*包括对出错输出信息、出错处理对策的说明。3.6 其它*说明设计当中对于安全保密、维护等情况的设计考虑。4 类的设计对系统当中主要的类逐一进行说明。4.1 类1设计4.1.1 功能说明用文字形式简单的描述该类的主要属性、公用接口和内部方法。4.1.2 属性说明4.1.3 公有方法说明详细描述类的Public方法，包括输入、输出和实现算法。4.1.4 私有方法说明详

6、细描述类的私有或保护方法，包括输入、输出和实现算法。4.2 类2设计4.2.1 功能说明用文字形式简单的描述该类的主要属性、公用接口和内部方法。4.2.2 属性说明4.2.3 公有方法说明详细描述类的Public方法，包括输入、输出和实现算法，复杂算法可以采用流程图、PDL等方式加以说明。4.2.4 私有方法说明详细描述类的私有或保护方法，包括输入、输出和实现算法，复杂算法可以采用流程图、PDL等方式加以说明。5 用例实现的设计对需求分析文档当中所有用例的具体实现逐一进行说明。5.1 用例1设计5.1.1 功能说明用文字形式简单的描述该用例的功能。5.1.2 界面设计采用用户界面原型（如VB窗口）描述该用例的操作界面，说明数据的输入形式和验证手段，特殊的界面操作控制流程可适当说明。5.1.3 交互设计用顺序图（时序图）描述该用例的具体实现，必要时可用多张交互图描述。5.2 用例2设计5.2.1 功能说明用文字形式简单的描述该用例的功能。5.2.2 界面设计采用用户界面原