在这几年的开发中,越来越发现编写文档的重要性。其实文档,是你在开发过程中思考的产物。在设计过程中一边设计一边编写文档,有助于理清思路,记录思考的成果。接下来,我自己统计了一下在开发项目的过程所写的文档。
需求文档:由于目前我主要是作为乙方,所以需求文档一般都不是由我编写;但从以往项目开发的经验来看,需求文档是根基,没有清晰明了的需求文档,往后的工作将是事倍功半。
概要设计文档:
概要设计文档包括数据库概要设计文档和软件概要设计文档。
但概要文档,它所涉及的粒度,我就不好定义。目前我很少编写概要文档。基本就直接编写详细设计文档。
详细设计文档:
数据库详细设计文档:
本文档主要描述本系统包含多少个表,每个表的字段定义,表之间的约束关系。
系统详细设计文档:
本文档描述本系统包含那几个功能模块,每个模块包含哪几个类,类对象之间的调用关系,每个类的属性和方法定义。
软件安装手册:
在一个管理规范的IT公司里,系统的开发人员和部署人员都不是同一个人。因此为了使方便其他人拿到你编写的软件后,能够知道怎么部署,必须提供一份具体明了的安装手册。本安装手册主要包括系统安装环境的配置以及安装步骤。
用户手册:
一份清楚的用户手册可以帮助用户尽快地熟悉你写的系统,减少用户学习的时间。