《详细设计说明书模板.doc》由会员分享，可在线阅读，更多相关《详细设计说明书模板.doc（7页珍藏版）》请在金锄头文库上搜索。
1、详细设计说明书版本 修订历史记录日期版本说明作者贡献者、目录1.引言41.1功能概述41.2名词术语41.3参考资料42.界面设计42.142.242.343.概念模型43.1用例模型图43.2概念关联类图43.2.143.2.253.2.354.用例实现54.154.1.1参与类图54.1.2类接口清单54.1.3修改类的项目目录结构清单64.1.464.1.564.1.664.1.764.1.864.265.数据库设计65.1表清单65.2视图清单65.3存储过程清单65.4触发器清单75.5ER图76.关键算法71. 引言1.1 功能概述使用自然语言概述拟建系统的功能。1.2 名词术语列
2、举该文档包含的或者为理解该文档需要的任何词汇，比如：英文缩略语、英文全称、对应中文、简短注解等。1.3 参考资料本小节应完整列出此详细设计中其他部分所引用的任何文档。每个文档应标有标题、报告号（如果适用）、日期和出版单位。列出可从中获取这些参考资料的来源。这些信息可以通过引用附录或其他文档来提供。支持点击超连接指向相应文档2. 界面设计2.1 绘制出界面的形状，该界面应能指导程序员的编码工作，它常常被映射为一个边界类。详细设计人员可以参考需求文档中的相应界面。界面对拟建系统的边界进行可视化建模。2.2 绘制出界面的形状，该界面应能指导程序员的编码工作，它常常被映射为一个边界类。详细设计人员可以
3、参考需求文档中的相应界面。界面对拟建系统的边界进行可视化建模。2.3 3. 概念模型3.1 用例模型图使用 UML工具绘制拟建系统的用例模型图，支持点击超连接指向相应的模型文件。用例模型图对拟建系统的参与角色、系统边界和系统功能进行建模。3.2 概念关联类图3.2.1 使用 UML工具绘制拟建系统的关联概念类图。用中文名命名“概念关联类图”,用英文命名概念类，如果可能，列出概念类的主要属性，支持点击超连接指向相应的模型文件。概念关联类图对拟建系统的关键抽象及其关系进行建模。关键抽象常常承载了非常重要的实体信息，关键抽象间的关系常常搭建了拟建系统的核心框架。3.2.2 使用 UML工具绘制拟建系
4、统的关联概念类图。用中文名命名“概念关联类图”,用英文命名概念类，如果可能，列出概念类的主要属性，支持点击超连接指向相应的模型文件。概念关联类图对拟建系统的关键抽象及其关系进行建模。关键抽象常常承载了非常重要的实体信息，关键抽象间的关系常常搭建了拟建系统的核心框架。3.2.3 4. 用例实现4.1 4.1.1 参与类图绘制参与实现一个用例的所有参与对象的关联类图。参与类图旨在对参与实现一个用例的元素间的关联关系进行建模，它存在的唯一理由是从各种交互图组中捕获参与用例实现的元素间的关联关系。4.1.2 类接口清单使用单独的一份清单文件并支持点击超链接到达指定文件清单文件使用如下三种方式之一1)
5、使用建模工具生成接口清单文件2) (对.Net程序)可以对接口代码使用NDOC生成接口清单文件，但是必须满足.Net的注释规范3) 手工编写，使用如下接口模板：1类名1.1数据成员说明1.1.1private string code文字描述 1.1.2 1.2属性说明1.2.1 public string Code文字描述 1.2.21.3方法说明 1.3.1 public int Add(int a,int b)l 功能描述方法的含义l 参数描述每个参数的含义l 返回值描述返回值的含义4.1.3 修改类的项目目录结构清单用单独的一份文件列出，并支持点击超链接到达指定文件只对修改的类，用清单列
6、出修改类、所属项目、以及类文件的映射关系4.1.4 绘制实现一个用例的系统内主要行为。4.1.5 绘制不能在基本交互序列中表达的子交互序列，即子过程。4.1.6 绘制实现一个用例的系统内异常行为。4.1.7 绘制实现一个用例的系统内常驻内存行为，比如：该行为是一个物理进程内的监控线程。4.1.8 4.2 5. 数据库设计5.1 表清单列举拟建系统要新增、修改的表名称概述5.2 视图清单列举拟建系统要新增、修改的视图名称概述5.3 存储过程清单列举拟建系统要新增、修改的存储过程名称概述5.4 触发器清单列举拟建系统要新增、修改的触发器名称概述5.5 ER图此处用超连接指向数据库ER总图,包括所有表。6. 关键算法使用伪代码或者图来描述，不允许粘贴实际编程代码。可以用单独文档，并用超连接引用。
