计算机软件文档编写指南

二．计算机软件文档包括：

1）软件开发计划

2）软件需求规格说明

3）接口需求规格说明

4）接口设计文档

5）软件设计文档

6）软件产品规格说明

7）版本说明文档

8）软件测试计划

9）软件测试说明

10）软件测试报告

11）计算机系统操作员手册

12）软件用户手册

13）软件程序员手册

14）计算机资源综合保障文件







软件开发计划



一．引言

1． 编写目的（阐明编写软件计划的目的，指出读者对象。）

2． 项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。）

3． 定义（列出本文档中用到的专门术语的定义和缩略词的原文。）

4．
参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。）

二．项目概述

1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能 性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。)

2. 条件与限制（阐明为完成项目应具备的条件 开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作 完成期限及其它条件与限制。）

3. 产品

（1）程序（列出应交付的程序名称 使用的语言及存储形式。）

（2）文档（列出应交付的文档。）

（3）运行环境（应包括硬件环境 软件环境。）

4．服务（阐明开发单位可向用户提供的服务. 如人员培训 安装 保修 维护和其他运行支持。）