软件开发文档是软件开发使用和维护过程中必备资料。它能提高软件开发的效率,保证软件的质量,而且在软件的使用过程中有指导,帮助,解惑的作用,尤其在维护工作中,文档是不可或缺的资料。
文档的编制有十二项衡量因素,他们分别是:可行性研究报告,项目开发计划,软件需求说明书,数据要求说明书,概要设计说明书,详细设计说明书,数据库设计说明书,用户手册(使用手册),操作手册,模块开发卷宗,测试计划,测试分析报告,项目开发总结报告,开发制度月报。当然不同规模的软件工程量,有不同的文档要求如:
传统的软件工程有四个步骤会产生相应的文档:
1、系统分析阶段
1)制定计划。产生可行性研究报告。要求给出软件功能、性能、可靠性以及接口等方面的要求,具体阐述技术可行性、法律可行性、经济可行性以及操作可行性
2)需求分析和定义。产生软件需求规格说明书。要求对软件提出的需求进行分析并给出详细的定义,需要使用图表和数据流图以及数据字典。
另外这个阶段要产生测试计划,指导后期软件的测试工作。
2、软件设计阶段
1)概要设计。产生概要设计说明书,要求把各项需求转化成软件的体系结构,划分模块。
2)详细设计。产生详细设计说明书和数据库设计说明书。要求确定模块内容和模块间的接口。
另外这个时候要着手考虑编写用户使用手册。
3、软件测试阶段
产生测试分析报告,包括模块开发卷宗和测试分析报告
4、安装运行维护阶段
最后就是对项目开发的一个总结,总结经验和教训,为下一次的软件开发积累解决问题的方式方法。为此我们需要编写项目开发总结报告。
软件开发文档是以书面形式对软件工程进行的规范,目的也是能够是开发工程更加高效,避免各方产生分析,同时也有力的督促和规范了程序各开发小组的工作,是避免软件危机的有力武器。一个好的软件开发者不仅要熟练掌握代码编写等基本技能,而且也要熟练掌握软件文档的编写。