设计文档模板。 对今后思考“如何更好的编写设计文档"有一个的从出发点
xx系统,xx模块
设计文档v0.1
部门:xx
作者:崔超<cuichao@boco.com.cn>
版权说明: ××拥有本文档的全部版权,没有经过明确的书面说明,任何人不能复制,转载本文档的所有内容.
可以把上面的内容放在一个好看的封面页上.
文档更新记录
版本 | 说明 | 完成日期 | 修改人 |
0.1 | 创建文档 |
| 崔超 |
|
|
|
|
|
|
|
|
1.概述
1.1.术语表
编号 | 缩写 | 全写 | 定义 |
1 |
|
|
|
2 |
|
|
|
1.3引用文档
编号 | 文档名称 | 作者 | 说明 |
1 |
|
|
|
2 |
|
|
|
1.4文档说明
本设计文档作为XX模块的设计文档,为编码的依据。也作为代码的说明,在代码开发过程中应该保持本文档的更新。
1.5项目背景
对项目的背景进行介绍
1.3系统说明
对整个系统的情况进行介绍。列举参考的文档
1.4模块说明
从功能角度模块进行简单的说明
2.工具和方法论
对使用的设计方法,关键的概念和工具进行说明。比如:是否使用面向对象的方法,组件技术?是否使用到某种开发框架?最终使用哪种编码语言?
3.分析
3.1.本模块在整个系统中的地位
最好使用结构图的形式并补充详细的说明。
3.2.功能说明
使用列表或描述的形式对功能进行详细的说明。对强调数据处理类型的模块,这里可以使用数据流图进行说明。对强调交互过程的模块,可以使用用例图进行说明。
3.3.非功能需求
性能的要求,从异常中恢复的要求等非功能的要求.
4.概要设计
4.1外部接口
4.1.1接口要求
对外部接口进行精确的描述。如果更上层的文档已经有了这个模块的接口要求,对文档进行引用.
4.1.2界面设计
如果存在界面设计
4.1.3配置文件
如果这个模块有自己的配置文件
4.2模块划分
使用软件结构图(结构化设计)。或使用包图,类图(面向对象设计)作为说明的主体。并且补充详细的文字说明.关键要说明每个子模块的(或类)的功能和职责。(对面向对象的设计,应该更多使用职责这样的词汇)。如果结构明显的呈现出层次,要对每个层次进行说明。
5.详细设计
对每个模块,或者每一个类,进行详细的说明.说明内容包括(1)接口定义 (2)关键算法。可能使用到,类图,流程图,顺序图,交互图,等.如果是多线程程序,还可能堆同步模型进行说明。
5.1子模块/类1
... ...
5.2子模块/类2
... ...
6.测试考虑
这节内容主要提供给测试人员使用,主要说明测试的重点。
7.总结
开发完成后,自己有什么体会,对近一步的改进有什么好的想法,好好的写一下总结。对软件今后改进,扩展.对自己进步都有好处.
update 2007-3-16 修改错字
转自: http://www.cublog.cn/u/31756/showart_259400.html