GB T 8567-1988 计算机软件产品开发文件编制指南.pdf
《GB T 8567-1988 计算机软件产品开发文件编制指南.pdf》由会员分享,可在线阅读,更多相关《GB T 8567-1988 计算机软件产品开发文件编制指南.pdf(55页珍藏版)》请在麦多课文档分享上搜索。
1、中华人民共和国国家标准计算机软件产品开发文件编制指南发布实施国家标准局发布中华人民共和国国家标准计算机软件产品开发文件编制指南国家标准局批准实施引言目的一项计算机软件的筹划研制及实现构成一个软件开发项目一个软件开发项目的进行一般需要在人力和自动化资源等方面作重大的投资为了保证项目开发的成功最经济地花费这些投资并且便于运行和维护在开发工作的每一阶段都需要编制一定的文件这些文件连同计算机程序及数据一起构成为计算机软件文件是计算机软件中不可缺少的组成部分它的作用是作为开发人员在一定阶段内的工作成果和结束标志向管理人员提供软件开发过程中的进展和情况把软件开发过程中的一些不可见的事物转换成可见的文字资料
2、以便管理人员在各个阶段检查开发计划的实施进展使之能够判断原定目标是否已达到还将继续耗用资源的种类和数量记录开发过程中的技术信息便于协调以后的软件开发使用和修改提供对软件的有关运行维护和培训的信息便于管理人员开发人员操作人员和用户之间相互了解彼此的工作向潜在用户报导软件的功能和性能使他们能判定该软件能否服务于自己的需要换言之本指南认为文件的编制必须适应计算机软件整个生存周期的需要计算机软件所包含的文件有两类一类是开发过程中填写的各种图表可称之为工作表格另一类则是应编制的技术资料或技术管理资料可称之为文件本指南规定软件文件的编制形式并提供对这些规定的解释本指南的目的是使得所编制的软件文件确实能够起
3、到软件文件应该发挥的作用范围本指南是一份指导性文件本指南建议在一项计算机软件的开发过程中一般地说应该产生十四种文件这十四种文件是可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书用户手册操作手册模块开发卷宗测试计划测试分析报告开发进度月报项目开发总结报告本指南将给出开发过程中建议产生的这十四种文件的编制指导同时本指南也是这十四种文件的编写质量的检验准则但是本指南并未涉及软件开发过程中如何填写工作表格的问题一般地说一个软件总是一个计算机系统包括硬件固件和软件的组成部分鉴于计算机系统的多样性本指南一般不涉及整个系统开发中的文件编制问题本指南仅仅是软件
4、开发过程中的文件编制指南文件的使用者对于使用文件的人员而言他们所关心的文件的种类随他们所承担的工作而异管理人员可行性研究报告项目开发计划模块开发卷宗开发进度月报项目开发总结报告开发人员可行性研究报告项目开发计划软件需求说明书数据要求说明书概要设计说明书详细设计说明书数据库设计说明书测试计划测试分析报告维护人员设计说明书测试分析报告模块开发卷宗用户用户手册操作手册尽管本指南提出了在软件开发中文件编制的要求但并不意味着这些文件都必须交给用户一项软件的用户应该得到的文件的种类由供应者与用户之间签订的合同规定第一篇文件的编制指导软件生存周期与各种文件的编制一项计算机软件从出现一个构思之日起经过这项软件
5、开发成功投入使用直到最后决定停止使用并被另一项软件代替之时止被认为是该软件的一个生存周期一般地说这个软件生存周期可以分成以下六个阶段可行性与计划研究阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段在可行性研究与计划阶段内要确定该软件的开发目标和总的要求要进行可行性分析投资收益分析制订开发计划并完成应编制的文件在需求分析阶段内由系统分析人员对被设计的系统进行系统分析确定对该软件的各项功能性能需求和设计约束确定对文件编制的要求作为本阶段工作的结果一般地说软件需求说明书数据要求说明书和初步的用户手册应该编写出来在设计阶段内系统设计人员和程序设计人员应该在反复理解软件需求的基础上提出多个设计分析
6、每个设计能履行的功能并进行相互比较最后确定一个设计包括该软件的结构模块的划分功能的分配以及处理流程在被设计系统比较复杂的情况下设计阶段应分解成概要设计阶段和详细设计阶段两个步骤在一般情况下应完成的文件包括概要设计说明书详细设计说明书和测试计划初稿在实现阶段内要完成源程序的编码编译或汇编和排错调试得到无语法错的程序清单要开始编写模块开发卷宗并且要完成用户手册操作手册等面向用户的文件的编写工作还要完成测试计划的编制在测试阶段该程序将被全面地测试已编制的文件将被检查审阅一般要完成模块开发卷宗和测试分析报告作为开发工作的结束所生产的程序文件以及开发工作本身将逐项被评价最后写出项目开发总结报告在整个开发
7、过程中即前五个阶段中开发集体要按月编写开发进度月报在运行和维护阶段软件将在运行使用中不断地被维护根据新提出的需求进行必要而且可能的扩充和删改对于一项软件而言其生存周期各阶段与各种文件编写工作的关系可见表其中有些文件的编写工作可能要在若干个阶段中延续进行表软件生存周期各阶段中的文件编制文件阶段可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段可行性研究报告项目开发计划软件需求说明书数据要求说明书测试计划概要设计说明书详细设计说明书续表文件阶段可行性研究与计划阶段需求分析阶段设计阶段实现阶段测试阶段运行与维护阶段数据库设计说明书模块开发卷宗用户手册操作手册测试分析报告开发进度月
8、报项目开发总结文件编制中的考虑因素文件编制是一个不断努力的工作过程是一个从形成最初轮廓经反复检查和修改直到程序和文件正式交付使用的完整过程其中每一步都要求工作人员做出很大努力要保证文件编制的质量要体现每个开发项目的特点也要注意不要花太多的人力为此编制中要考虑如下各项因素文件的读者每一种文件都具有特定的读者这些读者包括个人或小组软件开发单位的成员或社会上的公众从事软件工作的技术人员管理人员或领导干部他们期待着使用这些文件的内容来进行工作例如设计编写程序测试使用维护或进行计划管理因此这些文件的作者必须了解自己的读者这些文件的编写必须注意适应自己的特定读者的水平特点和要求重复性本指南第二篇中将列出的
9、这十四种文件的内容要求中显然存在某些重复较明显的重复有两类引言是每一种文件都要包含的内容以向读者提供总的梗概第二类明显的重复是各种文件中的说明部分如对功能性能的说明对输入和输出的描述系统中包含的设备等这是为了方便每种文件各自的读者每种产品文件应该自成体系尽量避免读一种文件时又不得不去参考另一种文件当然在每一种文件里有关引言说明等同其他文件相重复的部分在行文上在所用的术语上在详细的程度上还是应该有一些差别以适应各种文件的不同读者的需要灵活性鉴于软件开发是具有创造性的脑力劳动也鉴于不同软件在规模上和复杂程度上差别极大本指南认为在文件编制工作中应允许一定的灵活性这种灵活性表现在如下各款应编制的文件种
10、类尽管本指南认为在一般情况下一项软件的开发过程中应产生的文件有十四种然而针对一项具体的软件开发项目有时不必编制这么多的文件可以把几种文件合并成一种一般地说当项目的规模复杂性和成败风险增大时文件编制的范围管理手续和详细程度将随之增加反之则可适当减少为了恰当地掌握这种灵活性本指南要求贯彻分工负责的原则这意味着一个软件开发单位的领导机构应该根据本单位经营承包的应用软件的专业领域和本单位的管理能力制定一个对文件编制要求的实施规定主要是在不同的条件下应该形成哪些文件这些文件的详细程度该开发单位的每一个项目负责人必须认真执行这个实施规定这种规定的两个例子可见本指南的附录参考件对于一个具体的应用软件项目项目
11、负责人应根据上述实施规定确定一个文件编制计划其中包括应该编制哪几种文件详细程度如何各个文件的编制负责人和进度要求审查批准的负责人和时间进度安排在开发时期内各文件的维护修改和管理的负责人以及批准手续每项工作必须落实到人这个文件编制计划是整个开发计划的重要组成部分有关的设计人员则必须严格执行这个文件编制计划文件的详细程度从同一份提纲起草的文件的篇幅大小往往不同可以少到几页也可以长达几百页对于这种差别本指南是允许的此详细程度取决于任务的规模复杂性和项目负责人对该软件的开发过程及运行环境所需要的详细程度的判断文件的扩展当被开发系统的规模非常大例如源码超过一百万行时一种文件可以分成几卷编写可以按其中每一
12、个系统分别编制也可以按内容划分成多卷例如项目开发计划可能包括质量保证计划配置管理计划用户培训计划安装实施计划系统设计说明书可分写成系统设计说明书子系统设计说明书程序设计说明书可分写成程序设计说明书接口设计说明书版本说明操作手册可分写成操作手册安装实施过程测试计划可分写成测试计划测试设计说明测试规程测试用例测试分析报告可分写成综合测试报告验收测试报告项目开发总结报告亦可分写成项目开发总结报告和资源环境统计节的扩张与缩并在有些文件中可以使用本指南所提供的章条标题但在条内又存在一系列需要分别讨论的因素本指南认为所有的条都可以扩展可以进一步细分以适应实际需要反之如果章条中的有些细节并非必需也可以根据实
13、际情况缩并此时章条的编号应相应地改变程序设计的表现形式本指南对于程序的设计表现形式并未作出规定或限制可以使用流程图的形式判定表的形式也可以使用其他表现形式如程序设计语言问题分析图等文件的表现形式本指南对于文件的表现形式亦未作出规定或限制可以使用自然语言也可以使用形式化语言文件的其他种类当本指南中规定的文件种类尚不能满足某些应用部门的特殊需要时他们可以建立一些特殊的文件种类要求例如软件质量保证计划软件配置管理计划等这些要求可以包含在本单位的文件编制实施规定中文件编制的管理工作文件编制工作必须有管理工作的配合才能使所编制的文件真正发挥它的作用文件的编制工作实际上贯穿于一项软件的整个开发过程因此对文
14、件的管理必须贯穿于整个开发过程在开发过程中必须进行的管理工作是以下四条文件的形成开发集体中的每个成员尤其是项目负责人应该认识到文件是软件产品的必不可少的组成部分在软件开发过程的各个阶段中必须按照规定及时地完成各种产品文件的编写工作必须把在一个开发步骤中作出的决定和取得的结果及时地写入文件开发集体必须及时地对这些文件进行严格的评审这些文件的形成是各个阶段开发工作正式完成的标志这些文件上必须有编写者评审者和批准者的签字必须有编写评审完成的日期和批准的日期文件的分类与标识在软件开发的过程中产生的文件是很多的为了便于保存查找使用和修改应该对文件按层次地加以分类组织一个软件开发单位应该建立一个对本单位文
15、件的标识方法使文件的每一页都具有明确的标识例如可以按如下四个层次对文件加以分类和标识文件所属的项目的标识文件种类的标识同一种文件的不同版本号页号此外对每种文件还应根据项目的性质划定它们各自的保密级别确定他们各自的发行范围文件的控制在一项软件的开发过程中随着程序的逐步形成和逐步修改各种文件亦在不断地产生不断地修改或补充因此必须加以周密的控制以保持文件与程序产品的一致性保持各种文件之间的一致性和文件的安全性这种控制表现为就从事一项软件开发工作的开发集体而言应设置一位专职的文件管理人员接口管理工程师或文件管理员在开发集体中应该集中保管本项目现有全部文件的主文本两套由该文件管理人员负责保管每一份提交给
16、文件管理人员的文件都必须具有编写人审核人和批准人的签字这两套主文本的内容必须完全一致其中有一套是可供出借的另一套是绝对不能出借的以免发生万一可出借的主文本在出借时必须办理出借手续归还时办理注销出借手续开发集体中的工作人员可以根据工作的需要在本项目的开发过程中持有一些文件即所谓个人文件包括为使他完成他承担的任务所需要的文件以及他在完成任务过程中所编制的文件但这种个人文件必须是主文本的复制品必须同主文本完全一致若要修改必须首先修改主文本不同开发人员所拥有的个人文件通常是主文本的各种子集所谓子集是指把主文本的各个部分根据承担不同任务的人员或部门的工作需要加以复制组装而成的若干个文件的集合文件管理人员
17、应该列出一份不同子集的分发对象的清单按照清单及时把文件分发给有关人员或部门一份文件如果已经被另一份新的文件所代替则原文件应该被注销文件管理人中要随时整理主文本及时反映出文件的变化和增加情况及时分发文件当一个项目的开发工作临近结束时文件管理人员应逐个收回开发集体内每个成员的个人文件并检查这些个人文件的内容经验表明这些个人文件往往可能比主文本更详细或同主文本的内容有所不同必须认真监督有关人员进行修改使主文本能真正反映实际的开发结果文件的修改管理在一个项目的开发过程中的任何时刻开发集体内的所有成员都可能对开发工作的已有成果文件提出进行修改的要求提出修改要求的理由可能是各种各样的进行修改而引起的影响可
18、能很小也可能会牵涉到本项目的很多方面因此修改活动的进行必须谨慎必须对修改活动的进行加以管理必须执行修改活动的规程使整个修改活动有控制地进行修改活动可分如下五个步骤进行提议开发集体中的任何一个成员都可以向项目负责人提出修改建议为此应该填写一份修改建议表说明修改的内容所修改的文件和部位以及修改理由评议由项目负责人或项目负责人指定的人员对该修改建议进行评议包括审查该项修改的必要性确定这一修改的影响范围研究进行修改的方法步骤和实施计划审核一般由项目负责人进行审核包括核实修改的目的和要求核实修改活动将带来的影响审核修改活动计划是否可行批准在一般情况下批准权属于该开发单位的部门负责人在批准时主要是决断修改
19、工作中各项活动的先后顺序及各自的完成日期以保证整个开发工作按原定计划日期完成实施由项目负责人按照已批准的修改活动计划安排各项修改活动的负责人员进行修改建立修改记录产生新的文件以取代原有文件最后把文件交文件管理人员归档并分发给有关的持有者第二篇各种文件的内容要求本篇将对引言中提到的十四种文件提供内容要求作为文件编制的技术标准可行性研究报告可行性研究报告的编写目的是说明该软件开发项目的实现在技术经济和社会条件方面的可行性评述为了合理地达到开发目标而可能选择的各种方案说明并论证所选定的方案可行性研究报告的编写内容要求如下引言编写目的背景定义参考资料可行性研究的前提要求目标条件假定和限制进行可行性研究
20、的方法评价尺度对现有系统的分析数据流程和处理流程工作负荷费用开支人员设备局限性所建议的系统对所建议系统的说明数据流程和处理流程改进之处影响对设备的影响对软件的影响对用户单位机构的影响对系统运行的影响对开发的影响对地点和设施的影响对经费开支的影响局限性技术条件方面的可行性可选择的其他系统方案可选择的系统方案可选择的系统方案投资及收益分析支出基本建设投资其他一次性支出非一次性支出收益一次性收益非一次性收益不可定量的收益收益投资比投资回收周期敏感性分析社会条件方面的可行性法律方面的可行性使用方面的可行性结论项目开发计划编制项目开发计划的目的是用文件的形式把对于在开发过程中各项工作的负责人员开发进度所
21、需经费预算所需软硬件条件等问题作出的安排记载下来以便根据本计划开展和检查本项目的开发工作编制内容要求如下引言编写目的背景定义参考资料项目概述工作内容主要参加人员产品及成果程序文件服务非移交产品验收标准完成项目的最迟期限本计划的审查者与批准者实施总计划工作任务的分解接口人员进度预算关键问题支持条件计算机系统支持需要用户承担的工作需由外单位提供的条件专题计划要点软件需求说明书软件需求说明书的编制是为了使用户和软件开发者双方对该软件的初始规定有一个共同的理解使之成为整个开发工作的基础编制软件需求说明书的内容要求如下引言编写目的背景定义参考资料任务概述目标用户的特点假定与约束需求规定对功能的规定对性能
22、的规定精度时间特性要求灵活性输入输出要求数据管理能力要求故障处理要求其他专门要求运行环境规定设备支持软件接口控制数据要求说明书数据要求说明书的编制目的是为了向整个开发时期提供关于被处理数据的描述和数据采集要求的技术信息编制数据要求说明书的内容要求如下引言编写目的背景定义参考资料数据的逻辑描述静态数据动态输入数据动态输出数据内部生成数据数据约定数据的采集要求和范围输入的承担者处理影响概要设计说明书概要设计说明书又可称系统设计说明书这里所说的系统是指程序系统编制的目的是说明对程序系统的设计考虑包括程序系统的基本处理流程程序系统的组织结构模块划分功能分配接口设计运行设计数据结构设计和出错处理设计等为
23、程序的详细设计提供基础编制概要设计说明书的内容要求如下引言编写目的背景定义参考资料总体设计需求规定运行环境基本设计概念和处理流程结构功能需求与程序的关系人工处理过程尚未解决的问题接口设计用户接口外部接口内部接口运行设计运行模块组合运行控制运行时间系统数据结构设计逻辑结构设计要点物理结构设计要点数据结构与程序的关系系统出错处理设计出错信息补救措施系统维护设计详细设计说明书详细设计说明书又可称程序设计说明书编制目的是说明一个软件系统各个层次中的每一个程序每个模块或子程序的设计考虑如果一个软件系统比较简单层次很少本文件可以不单独编写有关内容合并入概要设计说明书对详细设计说明书的内容要求如下引言编写目
24、的背景定义参考资料程序系统的组织结构程序标识符设计说明程序描述功能性能输入项输出项算法流程逻辑接口存储分配注释设计限制条件测试计划尚未解决的问题程序标识符设计说明数据库设计说明书数据库设计说明书的编制目的是对于设计中的数据库的所有标识逻辑结构和物理结构作出具体的设计规定其内容要求如下引言编写目的背景定义参考资料外部设计标识符和状态使用它的程序约定专门指导支持软件结构设计概念结构设计逻辑结构设计物理结构设计运用设计数据字典设计安全保密设计用户手册用户手册的编制是要使用非专门术语的语言充分地描述该软件系统所具有的功能及基本的使用方法使用户或潜在用户通过本手册能够了解该软件的用途并且能够确定在什么情
- 1.请仔细阅读文档,确保文档完整性,对于不预览、不比对内容而直接下载带来的问题本站不予受理。
- 2.下载的文档,不会出现我们的网址水印。
- 3、该文档所得收入(下载+内容+预览)归上传者、原创作者;如果您是本文档原作者,请点此认领!既往收益都归您。
下载文档到电脑,查找使用更方便
5000 积分 0人已下载
下载 | 加入VIP,交流精品资源 |
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- GB 8567 1988 计算机 软件产品 开发 文件 编制 指南
