软件开发文档编制指南(国标)

黑色领带

计算机软件产品开发文件编制指南     GB 8567-88  
Guidelines for computer software product development documentation
中华人民共和国国家标准         UDC681．3


引言

1 目的

  一项计算机软件的筹划、研制及实现，构成一个软件开发项目。一个软件开发项目的进行，一般需要 在人力和自动化资源等方面作重大的投资。为了保证项目开发的成功，最经济地花费这些投资，并且便 于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。这些文件连同计算机程序及数据一起， 构成为计算机软件。文件是计算机软件中不可缺少的组成部分，它的作用是：
    a．作为开发人员在一定阶段内的工作成果和结束标志；
    b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些“不可见的”事物转 换成“可见的”文字资料。以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是 否已达到，还将继续耗用资源的种类和数量；
    C．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；
    d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相 互了解彼此的工作；
    e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。

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

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

2 范围

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

   可行性研究报告；
   项目开发计划；
   软件需求说明书；
   数据要求说明书；
   概要设计说明书；
   详细设计说明书；
   数据库设计说明书；
   用户手册；
   操作手册；
   模块开发卷宗；
   测试计划；
   测试分析报告；
   开发进度月报；
   项目开发总结报告。

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

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

3 文件的使用者

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

    管理人员：
可行性研究报告，
              项目开发计划，
              模块开发卷宗，
              开发进度月报，
              项目开发总结报告；

    开发人员：
可行性研究报告，
              项目开发计划，
              软件需求说明书，
              数据要求说明书，
              概要设计说明书，
              详细设计说明书，
              数据库设计说明书，
              测试计划，
              测试分析报告；

    维护人员：
设计说明书，
              测试分析报告，
              模块开发卷宗；

    用户：
用户手册，
操作手册。

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

linuxarm

支持

okokok

88年的国家标准，谢谢。

zhanghehejn

支持，要是每种文档有模版的话就更好了！！

dajianshi

no use