软件文档
| 软件开发 |
|---|
| 核心行动 |
| 范式与模式 |
| 方法论与框架 |
| 支持行为 |
| 实践 |
| 工具 |
| 标准与知识体系 |
软件文档或者原始码文档是指与软件系统及其软件工程过程有关联的文本实体。文档的类型包括软件需求文档，设计文档，测试文档，用户手册等。其中的需求文档，设计文档和测试文档一般是在软件开发过程中由开发者写就的，而用户手册等非过程类文档是由专门的非技术类写作人员写就的。
早期的软件文档主要指的是用户手册，根据Barker[1]的定义，文档是用来对软件系统界面元素的设计、规划和实现过程的记录，以此来增强系统的可用性。而Forward[2] 则认为软件文档是被软件工程师之间用作沟通交流的一种方式，沟通的资讯主要是有关所开发的软件系统。Parnas[3]则强调文档的权威性，他认为文档应该提供对软件系统的精确描述。
综上，我们可以将软件文档定义为：
- 文档是一种对软件系统的书面描述；
- 文档应当精确地描述软件系统；
- 软件文档是软件工程师之间用作沟通交流的一种方式；
- 文档的类型有很多种，包括软件需求文档，设计文档，测试文档，用户手册等；
- 文档的呈现方式有很多种，可以是传统的书面文字形式或图表形式，也可是动态的网页形式
参考文献
[编辑]- ^ T. T. Barker, "Software documentation: from instruction to integration," IEEE Transactions on Professional Communication, vol. 33, no. 4, 1990.
- ^ A. Forward, "Software Documentation – Building and Maintaining Artefacts of Communication," in Ottawa-Carleton Institute for Computer Science. vol. Master in Computer Science: University of Ottawa, 2002.
- ^ D. L. Parnas, "Precise Documentation: The Key To Better Software," in The Future of Software Engineering: Springer-Verlag Berlin Heidelberg, 2011, pp. 125-148.