软件详细设计说明模板包设计版.docx
- 文档编号:9457874
- 上传时间:2023-05-19
- 格式:DOCX
- 页数:10
- 大小:139.97KB
软件详细设计说明模板包设计版.docx
《软件详细设计说明模板包设计版.docx》由会员分享,可在线阅读,更多相关《软件详细设计说明模板包设计版.docx(10页珍藏版)》请在冰点文库上搜索。
软件详细设计说明模板包设计版
软件详细设计说明V4.0-1
XX-XXX-XX
标记
数量
修改单号
签字
日期
编制
XX
XX
会签
软件详细设计说明
校对
XX
XX
标检
XX
XX
共10页
第1页
审核
批准
XX
XX
中国船舶工业系统工程研究院
会签
XX
XX
修订记录
版本号
修订状态
简要说明修订内容和范围
修订日期
修订人
批准日期
注:
修订记录在体系文件发布后换版时使用,修订状态栏填写:
A—增加,M—修改,D—删除
目次
图序
表序
1 范围
1.1 标识
本条应描述本文档所适用系统和软件的完整标识,适用时,包括其标识号、名称、缩略名、版本号和发布号。
简要说明软件的标识号、发布号、名称、缩略名、版本号。
a)软件标识号:
b)发布号:
V01
c)名称:
d)缩略名:
e)版本号:
V1.0
1.2 系统概述
本条应概述本文档所适用系统和软件的用途。
分别简要说明系统的用途、软件用途标识需方、用户、开发方等。
a)需方:
b)用户:
c)开发方:
1.3 文档概述
本条应概述本文档的用途和内容,并描述与它的使用有关的保密性方面的要求。
2 引用文档
本章应列出引用文档的编号、标题、编写单位、修订版及日期,还应标识不能通过正常采购活动得到的文档的来源。
示例:
a)《文档名称1》,编号(若有),编写单位,版本(若有),日期;
b)《文档名称2》,编号(若有),编写单位,版本(若有),日期。
3 CSCI详细设计
设计人员确定软部件/包命名规则,确保软件设计文档的风格与代码的风格保持一致。
可以从机构的编程规范中摘取或引用(如果存在的话)。
另外,描述类的开发类型,包括新研、改进、安全重用、采购等。
详细说明类的具体信息。
3.1 XX包(包唯一标识)
详细描述CSCI包/组件的功能。
3.1.1 类汇总表
表1XX包内类汇总表
序号
标识
名称
说明
开发类型
1
2
3.1.1.1 类关系图
画出该包的所有类图,类只写类名称,不写具体变量和操作。
图1XX包内类关系图
3.1.1.2 类内部接口设计
表2 软件内部接口表
序号
接口名称
接口标识
接口提供者
接口使用者
类关系
1
XXX
PAK2_PAK1_**_01
Pak1
Pak2
2
3.1.1.3 类的唯一标识(XX类)
本包/组件详细描述的类列表如所示。
序号
类标识
类名称
备注
1.
2.
3.
注释:
1.软件项目负责人根据项目实际情况,选择主要的类进行详细描述。
类列表中的类需进行跟踪。
2.该列表中至少包含概要设计中的类。
3.1.1.3.1 类说明
给出该类的简要描述。
3.1.1.3.2 类数据
对类变量/数据进行说明。
表3类变量/数据说明表
数据名称
标识
可见性
数据类型
数据说明
发送业务信息界面
m_form_sendInfo
private
3.1.1.3.3 类操作
描述类的具体操作函数,对函数输入输出参数进行说明,对函数处理过程可以采用活动图的方式进行描述。
表4类操作描述表
序号
操作标识
操作名称
可见性
功能描述
4.
Init_Ywxx_Interface
初始化业务信息查询界面
private
显示业务信息查询界面控件
5.
6.
7.
注释:
使用者可以根据习惯选择使用3.1.1.3.3.1章节形式(建议逻辑流程复杂,活动图较多时使用)或者3.1.1.3.3.2章节表格形式(建议逻辑流程简单,活动图较少或者不需要使用活动图描述时使用)对类的操作进行描述。
3.1.1.3.3.1操作标识(操作名称)
a)数据元素
对该操作的输入、输出参数进行定义和描述。
如此内容已在前面描述可在此引用或省略。
b)逻辑流程(可选)
以活动图的形式对该操作的顺序、动态控制序列,异常与错误处理等内容进行描述。
图2XX类活动图
c)所用算法
表5所用算法
输入数据:
算法:
输出数据:
d)其它设计
如有需要,给出类设计中的约束、限制或非常规特征;要使用的规定CSCI语言之外的编程语言和它的使用原理等。
3.1.1.3.3.2
表6 函数描述表
函数定义
返回值函数名称(参数)
所属接口名称
接口标识
简单描述
描述一下这个函数的功能和作用。
参数说明
名称
in/out
类型
简短描述
参数名称
填写in(输入)或者out(输出)
类型
描述参数的相关说明,可以包括数据值的有效范围,输出的形式、数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。
若是数据结构类型,则在4.1.6中描述。
返回值
示例:
true:
配置站位成功;
false:
配置站位失败。
逻辑流程
(可选)
以活动图的形式对该操作的顺序、动态控制序列,异常与错误处理等内容进行描述。
算法描述
对使用的算法进行简单描述,包括输入、输出及算法本身。
其它设计
如有需要,给出类设计中的约束、限制或非常规特征;要使用的规定CSCI语言之外的编程语言和它的使用原理等。
3.2 执行方案
必须覆盖需求中的业务流程。
3.2.1 XX功能/业务
3.2.1.1 实现流程
图3XX时序图
3.2.1.2 流程说明
对序列图配以适当的文字说明。
3.2.1.3 补充说明(可选)
对复杂的流程附以活动图进行详细说明。
3.3 数据库表设计(可选)
若是有数据库设计说明或者在概要设计文档中已说明,则本节可选。
示例:
表6 数据库表结构
序号
字段名称
字段标识
字段类型
长度
主键
外键
非空
注释
1
是/否
是/否
是/否
默认值等
2
4 需求可追踪性
表7 需求追踪表(正向)
软件详细设计说明
软件概要设计说明
类标识/名称
章条号
包标识/名称
章条号
XX
3.2.1
XX
3.1.1
表8 需求追踪表(逆向)
软件概要设计说明
软件详细设计说明
包标识/名称
章条号
类标识/名称
章条号
XX
3.2.1
XX
3.1.1
5 注释
本章应包括有助于了解文档的所有信息(例如:
背景、术语、缩略语或公式)。
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 软件 详细 设计 说明 模板