个人体会,在一个软件项目的实施过程中,三份文档最重要:需求文档、设计文档和测试方案。这三份文档做好了,对整个软件项目高质量、高效率地实施有很大促进作用,可以说事半功倍。三份文档之间是有联系的,需求确定边界,设计决定实现,测试检验实现。
以前做项目也写过文档,大型国家工程化项目,项目做完了文档堆成山,但都是凑数,而小型项目,时间紧张,文档一般都是用于衔接工作,来不及写齐备地文档,更别说规范,高质量。最近刚好有一个项目,可以试试文档规范化,让写出来的东西有价值,能真正指导实施。在写的过程中,渐渐发现,要写一份规范、高水平的软件实施工程文档也不是那么容易的,先不说内容、语言水平,首先一点文档内容结构的确定,就很费心思。文档结构没定好,就会导致需求泛泛,不能服务设计、设计像需求,测试没着落。这里把最近自己定设计文档的一些思路记下来,是否正确,则是大家仁者见仁了。
CMM3有一套完整的软件实施工程文档规范,当然要基于这个结构来定,下面是一个以前项目的基于按照CMM3来设计内容结构的文档例子:
总共8章,其中第8章也有很多直接放在第1章,写为文档概述。通过观察2、3级目