计算机软件产品开发文件编制指南
〔GB8567-88〕
国家有关计算机软件产品开发文件编制指南〔GB8567-88〕只是一个国家标准,并不一定适合每一个企业,各企业〔组织〕应该按照标准,制订出符合自身软件过程标准的文档要求。引言1目的
一项计算机软件的筹划、研制及实现,构成一个软件开发工程。一个软件开发工程的进行,一般需要在人力和自动化资源等方面作重大的投资。为了保证工程开发的成功,最经济地花费这些投资,同时便于运行和维护,在开发工作的每一时期,都需要编制二定的文件。这些文件连同计算机程序及数据一起,构成为计算机软件。文件是计算机软件中不可缺少的组成局部,它的作用是:
a.作为开发人员在一定时期内的工作成果和结束标志;
b.向治理人员提供软件开发过程中的进展和情况,把软件开发过程中的一些"不可见的"事物转换成“可见“的文字资料。
以便治理人员在各个时期检查开发方案的实施进展,使之能够判定原定目标是否已到达,还将接着耗用资源的种类和数量;
C.记录开发过程中的技术信息,便于协调以后的软件开发、使用和修改;
d.提供对软件的有关运行、维护和培训的信息,便于治理人员、开发人员、操作人员和用户之间相互了解彼此的工作;
e.向潜在用户报导软件的功能和性能,使他们能判定该软件能否效劳于自己的需要。
换言之,本指南认为:文件的编制必须习惯计算机软件整个生存周期的需要。
计算机软件所包含的文件有两类:一类是开发过程中填写的各种图表,可称之为工作表格;另一类那么是应编制的技术资料或技术治理资料,可称之为文件。本指南规定软件文件的编制形式,并提供对这些规定的解释。本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发扬的作用。2范围
本指南是一份指导性文件。本指南建
议,在一项计算机软件的开发过程中,一般地讲,应该产生十四种文件。这十四种文件是:*〔1〕可行性研究报告;*〔2〕工程开发方案;
*〔3〕软件需求讲明书;
*数据要求讲明书;
*〔4〕概要设计讲明书;
*具体设计讲明书;
*数据库设计讲明书;
用户手册;
操作手册;
模块开发卷宗;
〔2〕测试方案;
测试分析报告;
开发进度月报;工程开发总结报告。
本指南将给出开发过程中建议产生的这十四种文件的编制指导,同时,本指南也是这十四种文件的编写质量的检验准那么。然而,本指南并未涉及软件开发过程中如何填写工作表格的咨询题。
一般地讲,一个软件总是一个计算机系统〔包括硬件、固件和软件〕的组成局部。
鉴于计算机系统的多样性,本指南一般不涉及整个系统开发中的文件编制咨询题,本指南仅仅是软件开发过程中的文件编制指南。3文件的使用者关于使用文件的人员而言,他们所关怀的文件的种类,随他们所担当的工作而异。
治理人员:可行性研究报告,工程开发方案,模块开发卷宗,开发进度月报,工程开发总结报告;
开发人员:可行性研究报告,工程开发方案,软件需求讲明书,数据要求讲明书,概要设计讲明书,具体设计讲明书,数据库设计讲明书,测试方案,测试分析报告;
维护人员:设计讲明书,测试分析报告,模块开发卷宗;
用户:用户手册,操作手册。
尽管本指南提出了在软件开发中文件编制的要求,但并不意味着这些文件都必须交给用户。一项软件的用户应该得到的文件的种类由需求者与用户之间签订的合同规定。
第一篇文件的编制指导4软件生存周期与各
种文件的编制
一项计算机软件,从出现一个构思之日起,通过这项软件开发成功投进使用,直到最后决定停止使用,并被另一一项软件代替之时止,被认为是该软件的一个生存周期。一般地讲那个软件生存周期能够分成以下六个时期:
可行性与方案研究时期
需求分析时期
设计时期
计算机软件开发培训
实现时期
测试时期
运行与维护时期
在可行性研究与方案时期内,要确定该软件的开发目标和总的要求,要进行可行性分析、投资一收益分析、制订开发方案,并完成应编制的文件。
在需求分析时期内,由系统分析人员对被设计的系统进行系统分析,确定对该软件的各项功能、性能需
求和设计约束,确定对文件编制的要求,作为本时期工作的结果,一般地讲,软件需求讲明书、数据要求讲明