GJB438B用软件开发文档通用要求.pptVIP

GJB438B 概述 GJB438B 课题组 2010.07 提纲 背景 全貌 适用范围 一般要求 详细要求 修订背景（续1） 软件文档是整个软件开发工作的重要产品，是实行管理、监督、控制软件开发的重要的方式。 软件文档把软件开发过程中的一些不可见的事物转化成为可见的文字资料，便于管理人员在各个阶段检查开发计划的进展情况，以提高软件生产过程的可见性和可控性。 软件文档作为软件产品的一部分，文档的质量在很大程度上决定了软件的质量。 软件的种类、文档的多少、文档的内容要求，对软件开发效率、开发成本以及将来的维护都产生重要的影响。 在软件开发中不论是软件承制方还是软件订购方对文档都极为重视。 GJB 438B更名原因 本标准是与GJB 2786A（修订中）配套使用 GJB 2786在修订过程中，专家建议将名称改为《军用软件开发通用要求》 本标准修订时也将名称作了相应变化，改为《军用软件开发文档通用要求》。 概貌 适用范围 在GJB 438B范围一节中明确指出：本标准规定了军用软件开发文档编制的种类、结构、格式和内容等要求。 本标准适用于军用软件开发过程中文档的编制。 而在GJB2786A的范围一节中指出，该标准规定了军用软件开发的通用要求，包括软件开发过程的开发、支持和管理等方面的要求。 本标准适用于需方和开发方获取、开发及维护军用软件（含固件中的软件）。 适用范围（续1） 本标准中所涉及的“系统”有两类： 一类是硬件－软件系统（例如一个雷达系统），对于这种系统，本标准只适用于系统中的软件部分；另一类是软件系统（例如一个地理信息系统），对这类系统，本标准适用于其整个系统。 本标准规定了执行GJB2786A所产生的军用软件开发文档，适用于军用软件开发过程中文档的编制。 GJB438B 其他说明 本标准代替GJB 438A-1997。 与GJB 438A-1997相比，本次修订将标准的名称更改为《军用软件开发文档通用要求》。 依据GJB 2786A，从软件开发和管理的角度，规定了相应的文档编制要求。 考虑承研单位的实际要求，对测试计划的部分内容也进行了充实和调整。 文档编制 文档的内容是根据GJB 2786A各活动描述的工作任务而产生的，描述了军用软件开发过程中的主要活动信息和要求。 开发方应按照本标准的要求记录有关信息，编写有关文档，并按合同（或软件研制任务书）的要求交付。 文档若为电子文档，应规定电子文档的格式（如DOC文件、PDF文件等）。 软件开发活动分类 文档表示方式 表示形式：为使各文档章条的信息更加清晰可读，可采用图、表、矩阵或其它形式的表示方式进行说明。 页码编制 文档正文的目录使用小写罗马数字编号； 文档正文和附录均使用阿拉伯数字顺序编号； 若一个文档分为若干卷，则每一卷应重新开始按顺序编号。 自变量：字母X和Y为各文档小条编号的自变量。标题上圆括号中的文字在编写时要用实际内容替换。 文档结构 封面。封面宜包括文档标识及版本号、密级、编制/修订日期、文档名称、编制单位、编写、审核、批准。 修改页。修改页应包括修改时间、修改内容以及修改人等。 目录。目录应包括章、条、图表、注释和附录的编号、标题及其所在页码。 正文。正文为各文档的具体内容，详细要求见标准的第5章。 附录。文档的附录应提供文档维护的详细信息（例如：图、表、分类数据等）。每个附录都应在文档的正文中被引用。为方便起见，附录可单独装订成册。 文档剪裁 承制方可根据项目所选择的生存周期、合同（或软件研制任务书）的要求以及实际活动，确定项目产生的文档种类，并根据实际情况对文档的种类进行合并、拆分。 例如，可以在《软件开发计划》中描述了软件质量保证计划和软件配置管理计划的内容，也可不产生单独的《软件质量保证计划》、《软件配置管理计划》。 根据需要，也可以对文档内容进行剪裁。 按文档标题顺序与本标准规定的标题顺序相同的原则，若剪裁了某章条或某小条，则在被裁去的章条（或小条）的标题下将其标识为“不适用”，并说明理由。 若剪裁的是整章条（包括其所有小条），则仅需在最高层的章条标题下加以说明。 详细要求 该标准规定了对军用软件开发过程中主要活动产生的文档，指出哪些文档可以合并或剪裁。 下面按照管理和工程两类简要说明文档的概述和主要内容。 管理类文档 软件研制任务书（SDTD） 软件开发计划（SDP） 软件配置管理计划（SCMP） 软件质量保证计划（SQAP） 软件安装计划（SIP） 软件移交计划（STrP） 软件测试计划（STP） 软件配置管理报告（SCMR） 软件质量保证报告（SQAR) 软件研制任务书（SDTD） 描述软件开发的目的、目标、主要任务、功能及性能指标等要求。 SDTD的主要内容 范围：包括系统和软件的标识、系统概述和文档概述等。