软件工程中的文档就像一把雨伞,包含软件产品开发和使用所需的所有书面文档和材料。
有四种不同类型的文档手册。每个文档手册都是在软件开发的不同阶段准备的。
文件手册分类:
1.分析/规范手册:
本手册是在软件开发的分析阶段准备的。在本手册中,描述了指定软件要求的所有信息。本手册中的信息如下:
- 正式规格–
在此,详细描述了软件的所有要求。 - 上下文图–
此图描述了软件的上下文。 - 数据流程图–
数据流程图是软件中信息流的直观表示。
2.设计手册:
在本手册中,有关软件设计以及软件外观的所有信息。本手册包括以下内容:
- 流程图–
它是表示软件工作过程的直观表示。 - 实体关系图–
这是一种流程图,说明了诸如人物,物体等“实体”的方式。
3.实施手册:
本手册是在软件开发的开发阶段编写的。在本手册中,有关软件中使用的程序代码,算法和数据结构的所有信息。本手册包括以下内容:
- 源代码清单–
它描述了为该软件开发的代码。 - 交叉引用清单–
它描述了代码模块的参考。
4.测试手册:
本手册是在软件的测试阶段准备的。该测试仪用于检查软件的最佳和最坏情况,并存储结果。本手册包括以下内容:
- 测试数据 –
这些是用作在软件中处理任务的输入的数据。 - 测试结果 –
这些数据是软件为提供的测试数据生成的输出。