13.2.2 软件文档的分类
软件文档从形式上来看,大致可以分为两类:一类是开发过程中填写的各种图表,可称之为工作表格;另一类是编制的技术资料或技术管理资料,可称之为文档或文件。
软件文档可以用自然语言,特别设计的形式语言,介于两者之间的半形式语言(结构化语言),各类图形、表格来编制。文档可以书写,也可以在计算机支持系统中产生,但它必须是可阅读的。
按照文档产生和使用的范围,软件文档大致可分为如下三类。
(1)开发文档。这类文档是在软件开发过程中,作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明书、可行性研究报告、项目开发计划。
(2)管理文档。这类文档是在软件开发过程中,由软件开发人员制定的需提交管理人员的一些工作计划或工作报告。使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。(https://www.daowen.com)
(3)用户文档。这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料。包括用户手册、操作手册、维护修改建议、软件需求说明书。
各类文档的内容及软件生存周期如表13.4所示。
表13.4 各类文档内容及软件生存周期
