详细设计文档模板
文档编号:[文档编号]
[项目名称]
详细设计说明书
版本号:[版本号]
受控编号:[受控编号]
编写部门:[编写部门]
编写人:[编写人]
审核人:[审核人]
审核日期:2005年3月10日
批准人:[批准人]
日期:2005年3月10日
目 录
1.引言……………………………………………………………………….. 1
编写目的
背景
定义
参考资料
2.程序系统结构…………………………………………………………….. 1
3.元素索引表……………………………………………………………….. 1
4.程序设计………………………………………………………………….. 1
元素名
元素名
==================请使用本模板者自己补充此目录==================
1.引言
1.1) 编写目的
[在此说明编写这份概要设计说明书的目的,指出预期的读者。]
1.2) 背景
[系统名称]
[项目提出者、开发者、用户、运行地点]
1.3) 定义
[术语和缩写说明]
1.4) 参考资料
[本项目的计划任务书或合同、上级机关批文]
[本项目已发布文档]
[本文引用的其它文档资料(包括各种开发标准)]
2.程序系统结构
[用一系统图表列出模块内名元素的名称、标识及相互间的层次结构关系]
3.元素索引表
[元素索引(元素名,及其详细说明部分在本文中的起止页码)
4.程序设计
4.1) [元素名(与索引表中对应)]
a) 程序描述
[元素的目的/意义/常驻内存/可重入/并发/覆盖要求等等]
b) 功能
[该元素应具有的功能(可用IPO图)]
c) 性能
[对元素性能的要求(精度/灵活性/时间特性等)]
d) 输入项
[每一输入项的特性(名称/标识/类型/取值范围/输入方式/来源/安全等)]
e) 输出项
[每一输出项的特性(名称/标识/类型/取值范围/输入方式/来源/安全等)]
f) 算法
[元素使用的算法,具体计算公式及计算步骤]
g) 流程逻辑
[元素的完整流程图(必须有完整的说明)]
h) 接口
[用图形方式说明本元素在系统中的定位及赋值/参数/数据等信息
i) 存储分配
[若有需要,说明元素的存储分配方式]
j) 注释设计
[元素首部的注释内容]
[各节点的注释(变量功能/变量范围/缺省条件等)]
[为所使用的逻辑加的注释内容]
k) 限制条件
[本元素正常运行所必需的条件(如,必需有某文件)]
l) 测试计划
[本元素的详细测试计划(人员/环境/标准/反馈机制/评价方式/目标等)
m) 尚未解决的问题
[元素设计中尚未解决需系统完成前必需解决的问题]
4.2) [元素名(与索引表中对应)]
……内容与格式同 4.1
……同上,直至所有元素描述完毕