引言

　　1 目的

　　一项计算机软件的筹划、研制及实现，构成一个软件开发项目。一个软件开发项目的进行，一般需要 在人力和自动化资源等方面作重大的投资。为了保证项目开发的成功，最经济地花费这些投资，并且便 于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。这些文件连同计算机程序及数据一起， 构成为计算机软件。文件是计算机软件中不可缺少的组成部分，它的作用是：

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

　　b.向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转 换成“可见的”文字资料。以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是 否已达到，还将继续耗用资源的种类和数量;

　　C.记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改;

　　d.提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相 互了解彼此的工作;

　　e.向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。

　　换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。

　　计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格;另一类 则是应编制的技术资料或技术管理资料，可称之为文件。本指南规定软件文件的编制形式，并提供对这 些规定的解释。本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。

　　2 范围

　　本指南是一份指导性文件。本指甫建议，在一项计算机软件的开发过程中，一般地说，应该产生十四 种文件。这十四种文件是：

　　可行性研究报告;

　　项目开发计划;

　　软件需求说明书;

　　数据要求说明书;

　　概要设计说明书;

　　详细设计说明书;

　　数据库设计说明书;

　　用户手册;

　　操作手册;

　　模块开发卷宗;

　　测试计划;

　　测试分析报告;

　　开发进度月报;

　　项目开发总结报告。

　　本指南将给出开发过程中建议产生的这十四种文件的编制指导，同时，本指南也是这十四种文件的 编写质量的检验准则。但是，本指南并未涉及软件开发过程中如何填写工作表格的问题。

　　一般地说，一个软件总是一个计算机系统(包括硬件、固件和软件)的组成部分。鉴于计算机系统的 多样性，本指南一般不涉及整个系统开发中的文件编制问题，本指南仅仅是软件开发过程中的文件编制指南。

　　3 文件的使用者

　　对于使用文件的人员而言，他们所关心的文件的种类，随他们所承担的工作而异。

　　管理人员：可行性研究报告，

　　项目开发计划，

　　模块开发卷宗，

　　开发进度月报，

　　项目开发总结报告;

　　开发人员：可行性研究报告，

　　项目开发计划，

　　软件需求说明书，

　　数据要求说明书，

　　概要设计说明书，

　　详细设计说明书，

　　数据库设计说明书，

　　测试计划，

　　测试分析报告;

　　维护人员：设计说明书，

　　测试分析报告，

　　模块开发卷宗;

　　用户：用户手册，

　　操作手册。

　　尽管本指南提出了在软件开发中文件编制的要求，但并不意味着这些文件都必须交给用户。一项软件的用户应该得到的文件的种类由供应者与用户之间签订的合同规定。

　　第一篇 文件的编制指导

　　4 软件生存周期与各种文件的编制

　　一项计算机软件，从出现一个构思之日起，经过这项软件开发成功投入使用，直到最后决定停止使 用，并被另一一项软件代替之时止，被认为是该软件的一个生存周期。一般地说这个软件生存周期可以分成以下六个阶段：可行性与计划研究阶段

　　需求分析阶段

　　设计阶段

　　实现阶段

　　测试阶段

　　运行与维护阶段

　　在可行性研究与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文件。

　　在需求分析阶段内，由系统分析人员对被设计的系统进行系统分析，确定对该软件的各项功能、性能需求和设计约束，确定对文件编制的要求，作为本阶段工作的结果，一般地说，软件需求说明书、数据要求说明书和初步的用户手册应该编写出来。

　　在设计阶段内，系统设计人员和程序设计人员应该在反复理解软件需求的基础上，提出多个设计，分析每个设计能履行的功能并进行相互比较，最后确定一个设计，包括该软件的结构、模块的划分、功能的分配以及处理流程。在被设计系统比较复杂的情况下，设计阶段应分解成概要设计阶段和详细设计阶段两个步骤。在一般情况下，应完成的文件包括：概要设计说明书、详细设计说明书和测试计划初稿。

　　在实现阶段内，要完成源程序的编码、编译(或汇编)和排错调试得到无语法错的程序清单，要开始编写模块开发卷宗，并且要完成用户手册、操作手册等面向用户的文件的编写工作，还要完成测试计划的编制。

　　在测试阶段，该程序将被全面地测试，已编制的文件将被检查审阅。一般要完成模块开发卷宗和测试分析报告，作为开发工作的结束，所生产的程序、文件以及开发工作本身将逐项被评价，最后写出项目开发总结报告。

　　在整个开发过程中(即前五个阶段中)，开发集体要按月编写开发进度月报。

　　在运行和维护阶段，软件将在运行使用中不断地被维护，根据新提出的需求进行必要而且可能的扩充和删改。

　　对于一项软件而言，其生存周期各阶段与各种文件编写工作的关系可见表互，其中有些文件的编写工作可能要在若干个阶段中延续进行。

　　表1软件生存周期各阶段中的文件编制

　　5 文件编制中的考虑因素

　　文件编制是一个不断努力的工作过程。是一个从形成最初轮廓，经反复检查和修改，直到程序和文件正式交付使用的完整过程。其中每一步都要求工作人员做出很大努力。要保证文件编制的质量，要体现每个开发项目的特点，也要注意不要花太多的人力。为此，编制中要考虑如下各项因素。

　　5.1 文件的读者

　　每一种文件都具有特定的读者。这些读者包括个人或小组、软件开发单位的成员或社会上的公众、从事软件工作的技术人员、管理人员或领导干部。他们期待着使用这些文件的内容来进行工作，例如设计、编写程序、测试、使用、维护或进行计划管理。因此，这些文件的作者必须了解自己的读者，这些文件的编写必须注意适应自己的特定读者的水平、特点和要求。

　　5.2 重复性

　　本指南第二篇中将列出的这十四种文件的内容要求中，显然存在某些重复。较明显的重复有两类。引言是每一种文件都要包含的内容，以向读者提供总的梗概。第二类明显的重复是各种文件中的说明部分，如对功能性能的说明、对输入和输出的描述、系统中包含的设备等。这是为了方便每种文件各自的读者，每种产品文件应该自成体系，尽量避免读一种文件时又不得不去参考另一种文件。当然，在每一种文件里，有关引言、说明等同其他文件相重复的部分，在行文上、在所用的术语上、在详细的程度上，还是应该有一些差别，以适应各种文件的不同读者的需要。

　　5.3 灵活性

　　鉴于软件开发是具有创造性的脑力劳动，也鉴于不同软件在规模上和复杂程度上差别极大，本指南认为在文件编制工作中应允许一定的灵活性。这种灵活性表现在如下各款。

　　5.3.1 应编制的文件种类

　　尽管本指南认为在一般情况下，一项软件的开发过程中，应产生的文件有十四种，然而针对一项具体的软件开发项目，有时不必编制这么多的文件，可以把几种文件合并成一种。一般地说，当项目的规模、复杂性和成败风险增大时，文件编制的范围、管理手续和详细程度将随之增加。反之，则可适当减少。为了恰当地掌握这种灵活性，本指南要求贯彻分工负责的原则，这意味着：