软件产品开发文件编制指南.docx

《软件产品开发文件编制指南.docx》由会员分享，可在线阅读，更多相关《软件产品开发文件编制指南.docx（2页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、软件产品开发文件编制指南任何工程工程都要经过计划、设计、施工、检验等一系列步骤，在这些步骤中，资料和 图纸是绝对必要的，其中记载了大量的数据、方案、报表、图示和文字说明等有关工程工程 的重要信息。而与之相比，软件工程的文件资料在软件生存周期中的地位和作用就显得更加 突出了。一项计算机软件的筹划、研制及实现，构成一个软件开发工程，它一般需要在人力和资 源等方面做重大的投资。为了保证工程开发的成功，最经济地花费这些投资，并且便于运行 和维护，在开发工作的每一阶段，都需要编制一定的文件。这些文件连同计算机程序及数据 一起，构成为计算机软件。这些文件作为软件产品的主要形式，集中表达了软件开发人员的 大

2、量脑力劳动成果，是软件的不可缺少的组成局部。1.目的和作用软件文件(document,通常又称为文档)，是指与软件研制、维护和使用有关的材料， 是以人们可读的形式出现的技术数据和信息。软件文件的作用可概括为：1)提高软件开发过程的能见度。把软件开发过程中一些“不可见的”事物转变为“可 见的”文字资料，以使管理人员在软件开发各阶段进行进度控制及软件质量管理。2)提高开发效率。软件文件的编制将使开发人员对各个阶段的工作都进行周密思考、 全盘权衡，从而减少返工，并可在开发早期发现错误及不一致性，便于及时纠正。3)作为开发人员在一定阶段内的工作成果和结束标志。4)记录开发过程中的有关技术信息，便于协调

3、以后的软件开发、使用和维护。5)提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员 和用户之间的协作、交流和了解，使软件开发活动更加科学、更有成效。6)便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需求的软件 提供依据。在有关软件工程的各项国家标准中，对软件文件的编制做出了具体而详尽的表达。例如， 计算机软件产品开发文件编制指南(GB/T8567-1988)建议在软件的开发过程中编制下述14 种文件，即：可行性研究报告、工程开发计划、软件需求说明书、数据要求说明书、概要设 计说明书、详细设计说明书、数据库设计说明书、用户手册、操作手册、模块开发卷宗、测 试

4、计划、测试分析报告、开发进度月报以及工程开发总结报告等；计算机软件需求说明编制 指南(GB/T9385-1988)和计算机软件测试文件编制规范(GB/T9386-1988)等那么对上述中 的一些文件的编制有更为详尽的阐述；软件文档管理指南(GB/T16680-1996)为那些对软件 或基于软件的产品的开发负有职责的管理者提供了软件文档的管理指南。2.文件编制的质量要求计算机软件产品开发文件编制指南(GB/T8567-1988)给出的14种软件文件的编制提示, 同时也是这14种文件编写质量的检验准那么。高质量的文件应当表达在以下一些方面：1)针对性：应分清读者对象，按不同类型、不同层次的读者，决

5、定怎样适应他们的需 要。2)精确性：文件的行文应当十分确切，不能出现多义性的描述。3）清晰性：文件编写应力求简明，如有可能，配以适当图表，以增强其清晰性。4）完整性：任何一个文件都应是完整的、独立的，它应自成体系。5）灵活性：各个不同的软件工程，其规模和复杂程度有着许多实际差异，不能一概而 论。6）可追溯性：由于各开发阶段编制的文件与各阶段完成的工作有着紧密的关系，前后 两个阶段生成的文件，随着开发工作的逐步扩展，具有一定的继承关系。在一个工程各开发 阶段之间提供的文件必定存在着可追溯的关系。实验目的1）熟悉和掌握国家标准GB/T8567.1988。2）掌握软件工程规模与软件文档实施关系的处理方法。3） 了解软件文档管理的基本要求。