1、修改内容审核时间V0.00创建文档表目录图目录1. 简介1.1. 编写目的这部分要描述文档的目的,并指明文档的读者。1.2. 适用范围1.2.1. 软件名称1.2.2. 软件功能解释软件产品将完成或不完成的功能1.2.3. 软件应用描述软件的应用领域1.3. 定义及关键词表1. 关键词关键词英文全名中文解释1.4. 参考资料1 2. 第0层设计描述2.1. 软件系统上下文定义本节描述待开发软件系统与外部实体的关系,可以使用系统结构图来描述系统结构和交互关系。外部实体属性描述只限于描述与本系统软件设计相关的属性。图1 软件架构图2.2. 设计思路(可选)2.2.1. 设计可选方案对本软件系统的几
2、种设计方案进行分析、比较,并确定所采用的方案。图2 软件体系结构图2.2.2. 设计约束1. 遵循标准2. 硬件限制3. 技术限制2.2.3. 其他2.3. 系统结构2.3.1. 系统结构描述这里要描述软件系统的总体结构,可以使用结构图、层次分解图或包图来描述,并应说明系统结构划分的原则(例如,基于标准、协议所规定的体系结构,来自于分析模型的方案,或者基于原有体系结构的限制)。图3 基本包依赖关系图2.3.2. XXX模块1. 简介这里要描述本文档所设计的模块,其功能简介,与其它模块的关系。图4 与其它模块关系图2. 接口描述本文档设计的模块与其它模块之间的接口。3. 第一层设计描述3.1.
3、模块的系统结构3.1.1. 模块内部结构这里要描述本文档所设计的模块的总体结构,可以使用结构图、层次分解图或包图来描述,并应说明结构划分的原则(例如,基于标准、协议所规定的体系结构,来自于分析模型的方案,或者基于原有体系结构的限制)。图5 模块内部结构图3.1.2. 业务流程说明描述该模块用例模型中的典型用例场景,以体现其功能是如何实现的。建议采用Sequence图、Collaboration图等来描述。3.2. 分解描述3.2.1. XXX子模块1. 简介 2. 功能列表3.2.2. 数据设计本节描述本文档所设计的模块中的数据结构,外部数据实体不必描述。1. 数据实体1描述1) 标识:2)
4、类型:3) 目的:3.3. 依赖性描述本节描述本文档所设计的模块的子系统,数据结构,模块,进程等设计实体间的关系。依赖关系描述可以使用文字,结构图,(交互)事务图。3.4. 接口描述3.4.1. 子模块1的接口描述该子模块与其它子模块之间的接口描述。名称:接口名称说明:对接口的简短说明定义:接口原型定义,说明接口类型及相关参数4. 第二层设计描述4.1. XXX子模块4.1.1. 子模块设计描述描述子模块的功能定义。定义出具体的设计类,用类图来描述其相互关系,并说明所采用的设计模式。图6 模块结构图1. 类名XXX1) 标识说明该类的配置项标识(用于需求跟踪,配置项的命名方式在CMP中已定义)
5、2) 简介简单介绍该类的功能3) 类定义如果该类在前面没有定义,使用类图、伪代码描述该类的类定义,需说明该类的所有public属性和public方法。图7 类XXX4.1.2. 功能实现说明1. XXX功能图8 时序图5. 数据库设计本节列出所有的数据存储类的实体(表、存储过程、触发器等),详细描述实体的内容和并列出全部属性。对每个属性,详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。5.1. 实体定义5.1.1. 分解描述阐述设计思路及约束规则。详细定义每个关键数据表、视图中的各个字段属性、存储要求、完整性约束、功能、注意事项,对静态数据表应考虑定义初始配置记录。
6、5.1.2. 内部依赖性描述使用E-R图描述实体间的关联依赖关系,分析对存取空间、性能、完整性的要求。5.2. 行为定义5.2.1. 分解描述根据功能或其他方式对存储过程/触发器进行归类,便于进一步细化和分解,并说明每类存储过程/触发器主要功能。详细定义每个存储过程(触发器)的功能、输入输出参数、返回值、返回的记录集、依赖的数据表和存储过程,以及一些特殊要求(比如需要启用事务等)。5.2.2. 外部依赖性描述描述与其它模块之间的依赖关系。5.2.3. 内部依赖性描述描述存储过程间、存储过程和数据表/视图间依赖关系。6. 组件视图6.1. 系统运行组件使用Component图、deployment图来描述系统的运行组件(EXE文件、DLL等),及其网络部署情况。6.2. 文件组织形式描述源代码文件的目录结构(文件夹中各个目录下应存放什么文件)7. 进程视图本节描述将系统分解为轻量级进程(单个控制线程)和重量级进程(成组的轻量级进程)的过程。本节按照各个通信或交互的进程组来加以组织。说明进程之间的主要通信模式,例如消息传递、中断和会合。
copyright@ 2008-2023 冰点文库 网站版权所有
经营许可证编号:鄂ICP备19020893号-2