软件文档

软件工程知识

软件文档(Document)也称文件，通常是指的是一些记录的数据和数据媒体，它具有固定不变的形式，可被任何计算机阅读。在软件工程中，文档常常用来表示对活动、需求、过程或结果进行描述、定义、规定或认证的任何书面或图示的信息，他们描述和规定了软件设计和实现细节，说明使用软件的操作命令。

文档是软件产品的一部分，没有文档的软件就不称其为软件。软件文档的编制在软件开发工作中占有突出的地位和相当大的工作量。高质量和高效的开发、分发、管理和维护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软件产品的效益有着重要的意义。

然而，在实际工作中，软件开发人员普遍对编制文档不感兴趣。

基本信息

在软件的生产过程中，总是伴随着大量的信息要记录、使用。因此，软件文档在产品的开发过程中起着重要的作用。

1. 提高软件开发过程的能见度；

2. 记录开发过程的相关信息；

3. 提高开发效率；

4. 作为开发人员在一定阶段的工作成果和结束标志；

5. 便于潜在用户了解软件的功能、性能等各项指标。

更具形式，软件文档可大致分为两类：

1. 工作表格：包括开发过程中填写的各种图标；

2. 文档或文件：包括应编辑的技术资料或技术管理资料。

根据文档产生和使用范围，软件文档大致可分为三类：

1. 开发文档；

2. 管理文档；

3. 用户文档。

根据文档类容，软件文档又可分为两类：

1. 用户文档；

2. 系统文档。