第八章:文档
1.常见的开发源代码文档格式
文档两种类型:
- 二进制文件:他们的生成和阅读都要使用专利产品,如:Microsoft Word或Adobe FrameMaker;
- 文本文件:其中包含标记语言(markup language)形式的结构和格式化命令。
2.文档种类
- 系统的规格说明文档(system specification document):
详细描述系统的目标、系统的功能需求、管理和技术上的限制、以及成本和日程等要素,了解所阅读代码的运行环境. - 软件需求规格说明(software requirements specification):
提供对用户需求和系统总体结构的高层描述,并且详细记述系统的功能和非功能性需求,比如数据处理、外部接口、数据库的逻辑模式以及设计上的各种约束。由于软硬件环境和用户需求的不断改变,文档中还可能描述预期的系统演化。是阅读和评估代码的基准. - 系统的设计规格说明(system design specification):
一般描述系统的构架、数据和代码结构,还有不同模块之间的接口。面向对象的设计会勾画出系统的基本类型以及公开方法。细化的设计规格一般还包括每个模块(或类)的具体信息,比如它执行的处理任务、提供的接口,以及与其他模块或类之间的关系。另外,设计规格说明还会描述系统采用的数据结构,适用的数据库模式等。系统的设计规格说明作为认知代码结构的路线图, 阅读具体代码的指引。 - 系统测试规格说明(system test specification):
包括测试计划、具体的测试过程、以及实际的测试结果。每个测试过程