项目开发所需文档

来源：互联网发布：以太网调试软件编辑：程序博客网时间：2024/04/30 14:32

尽管软件开发在文件编制中存在着很多灵活性，然而，文件的编制确实是非常必要的。为了控制这种灵活性，保证文件编制能达到应该达到的目的，对于具体的软件开发任务，应编制的文件的种类、详细程度应取决于承担开发单位的管理能力、任务的规模、复杂性和成败风险等因素。一个软件开发单位应该根据本单位经营承包的应用软件的专业特点和本单位的管理能力，制定一个文件编制实施规定，说明在什么情况下应该编制哪些文件。由于国内目前在这方面还缺乏成熟的经验，这里提供参考国外经验制定的两个例子，用以向国内软件开发单位说明如何建立这种实施规定，使项目负责人能确定本项目开发过程中应编制的文件的种类。当然，例子毕竟只是例子，这两个例子各自都不免有其片面性，它们两者之间也不免有不一致之处，之所以列出来无非是供国内软件开发单位参考。

例1：

此例规定用求和法来确定应编制的文件。该方法的要点是提出十二个考虑因素来衡量一个应用软，件，每个因素可能取值的范围是互至5。任务负责人可用这十二个因素对所要开发的程序进行衡量，确定每个因素的具体值。把这十二个因素的值相加，得到一个总和。然后由这个总和的值来确定应该编制的文件的种类。使用这个方法的具体过程如下：

a. 按表OI中的十二个因素衡量所要开发的程序，得到每个因素的值；

b. 把衡量所得的各个因素的值相加，得总和之值；

c. 根据总和之值，从表OZ查出应编制的文件的种类。

表1文件编制的十二项衡量因素

序号

因素

因素取值准则

创造性要求

没有——在不同的设备上重编程序

很少——具有严格的要求

有限——具有新的接口

相当多——应用现有的技巧

重大的——应用先进的技巧

通用程度

很强的限制——单一目标

有限制——功能的范围是参量化的

有限的灵活性允许格式上有某些变化

多用途，灵活的格式有一个主题领域

很灵活——能在不同的设备上处理范围广泛的主题

工作范围

局部单位

分指挥部

单个指挥部

多个指挥部

国防部，世界范围

目标范围的变化

没有

极少

偶尔有

经常

不断

设备复杂性

单机，常规处理

单机，常规处理，扩充的外设系统

多机，标准外设系统

多机，复杂的外设系统

主机控制系统，多机，自动I/O和显示

人员

1～2人

3～5人

5～10人

10～18人

18人以上

开发投资

6人月以下

6人月至3人年

3人年至10人年

10人年至30人年

30人年以上

重要程度

数据处理

常规过程控制

人身安全

单位成败

国家安全

对程序改变的完成时间要求

2周以上

1～2周

3～7天

1～3天

24小时以内

对数据输入的响应时间要求

2周以上

1～2周

1～7天

1～24小时

60分钟内

程序语言

高级语言

高级语言带一些汇编

高级语言带相当多的汇编

汇编语言

机器语言

并行的软件开发

没有

有限

中等程度

很多

完全的并行开发

表1文件编制的十二项衡量因素

因素总和

可行性研究报告

项目开发计划

软件需求说明书

数据要求说明书

概要设计说明书

详细设计说明书

数据库设计说明书

用户手册（使用说明）

操作手册

模块开发卷宗

测试设计

测试分析报告

项目开发总结报告

开发制度月报

12～18*

14～24

24～38

38～50

48～60

√

***

√

***

√

*在因素总和较低的情况下,项目开发总结报告的内容应包括：程序的主要功能、基本流程、测试结果和使用说明。

**测试分析报告应该写，但不必很正规。

***数据要求说明和数据库设计说明是否需要编写应根据所开发软件的实际需要来决定。

例2：

为了避免在软件开发中文件编制的不足或过分，一个简便的办法是把对软件文件的编制要求同软件的规模大小联系起来，这就是本例的出发点。软件的规模不妨分为四级：

1. 小规模软件源程序行数小于5000的软件；

2. 中规模软件源程序行数为10000～50000的软件；

3. 大规模软件源程序行数为100000—500000的软件；

4. 特大规模软件源程序行数大于500000的软件。

对上述的四级软件的文件编制要求分别列于表3。

至于源程序行数为5000～10000，50000～100000的软件，其文件编制要求介于两级之间，可根据一个软件产品的具体情况，由项目负责人参照表3的规定，确定需要编制的文件种类。

对于源程序行数大于500000的特大规模软件，可进一步把本指南规定的十四种文件按实际需要扩展成更多种类。