写概要设计文档,是每个team leader或者研发组长必备的技能。
写好了,上可以报告给大经理,下可以演示给各个组员。
概要文档可以写成很多种样子,有不同的侧重点,但是 出不了下面所述的这个圈子,无非是更细,或者更多点而已。
1.总则
不同的公司,不同的项目,设计文档的形式和侧重点不一样。
但是不论什么文档,最终就是要解释三个问题:
是什么?
干什么?
怎么干?
2.细则
是什么,包含以下的因素说明:
2.1 组件描述
2.2 术语定义
2.3 模块构成
2.3.1 对内对外接口
2.4 范围边界
干什么,包含:
3.1 用例说明
3.2 UML图示应用逻辑
怎么做,包含:
4.1 数据流
4.2 程序结构
4.3 数据库操作
4.4 故障处理
4.5 可扩展性,兼容性,…