软件文档

更新时间:2024-05-21 17:21

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

作用和分类

作用

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

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

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

3. 提高开发效率;

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

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

分类

根据形式,软件文档可大致分为两类:

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

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

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

1. 开发文档;

2. 管理文档;

3. 用户文档。

根据文档内容,软件文档又可分为两类:

1. 用户文档;

2. 系统文档。

管理和维护

在整个软件生存期中,各种文档作为半成品或是最终成品,会不断生成、修改或补充。为了最终得到高质量的产品必须加强对文档的管理,一下几个方面是应该做到的:

1. 软件开发小组应当设立一位文档管理员,管理所有文档;

2. 软件开发小组成员可根据工作需要在自己手中保存一些个人文档;

3. 开发人员只保存着主文档中与它工作有关的部分文档;

4. 在新文档取代旧文档时,管理人员应随时修订主文本,使其及时反应更新了的类容;

5. 项目开发结束时,文档管理人员应收回开发人员的个人文档,与主文档对比差异,着手解决有差异的地方;

6. 在开发过程中,严格控制修改已经完成的文档。

免责声明
隐私政策
用户协议
目录 22
0{{catalogNumber[index]}}. {{item.title}}
{{item.title}}