2022年2022年计算机软件产品开发文件编制、管理的一般要求 .pdf

《2022年2022年计算机软件产品开发文件编制、管理的一般要求 .pdf》由会员分享，可在线阅读，更多相关《2022年2022年计算机软件产品开发文件编制、管理的一般要求 .pdf（7页珍藏版）》请在得力文库 - 分享文档赚钱的网站上搜索。

1、1 计算机软件产品开发文件编制、管理的一般要求1 引言随着信息技术的高速发展，我们公司研制开发的软件产品的数量与日俱增，即使是以硬件为主体的产品也无不与软件有着密切联系。按软件工程的技术和方法规范软件开发过程，加强软件开发全过程的质量控制，是保证软件开发质量的关键。软件技术文档是计算机软件的重要组成部分，单有编程而没有与之配套的技术文档,不能称为计算机软件。在开发的相应阶段及时形成软件文档并通过评审是非常重要的：软件文档是软件开发、设计、实现的依据和准则；是对软件开发过程及开发成果进行有效管理的手段；是对软件进行评审、验证和确认的依据；是使用、维护、修改的指南。软件文档应按有关标准和规范的要求

2、进行编写，软件文档的完整性及质量应是衡量软件开发成果和其质量的重要标志之一。软件开发应按软件生存周期的六个阶段进行：可行性与计划研究阶段（立项）；需求分析阶段；设计阶段；实现阶段；测试阶段；运行与维护阶段。应及时按各阶段形成相应文档并进行阶段性评审，确认后再进行下一阶段的工作，使开发各阶段的质量和进度处于受控状态，及时发现、解决和纠正开发各阶段存在的问题和潜在的缺陷，使软件产品在生存周期内的质量得到保证。2 范围本要求为承担软件开发的组织提供编制、管理软件文档的一般方法，适用于计算机软件文档的编制与管理。注：软件文档就是指软件文件, 这里只是沿用了计算机行业的一种习惯叫法。3 引用标准GB/T

3、 8567 计算机软件产品开发文件编制指南GB 9385 计算机软件需求说明编制指南GB 9386 计算机软件测试文件编制指南GB 11457 1995 软件工程术语GB/T 155321995计算机软件单元测试GB/T 1900.3(ISO9000-3) 质量管理和质量保证标准, 第三部分：GB/T19001名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 7 页 - - - - - - - - - 2 （ISO9001 ）在软件开发，供应和维护中的使用指南GJB437

4、军用软件开发规范 (可参照 ) GJB 军用软件文档编制规范 ( 可参照 ) 4 文档分类和组成4.1 文档分类一般分为两类 : 一类是开发过程中填写的标志软件开发进程的工作表格，如：开发计划，进度月报。另一类是开发各阶段应编制的体现软件技术内容及指导软件开发的技术性和管理性文件。4.2 文档的组成软件开发过程中一般编制14 种文档见表 1 4.2.1 文档的剪裁和合并一项软件在开发过程中 , 可根据项目的规模大小和复杂程度对14 项文件进行剪裁和合并。a) 软件规模分级软件的规模按源程序的行数可分为四级：小规模软件：源程序行数小于5000的软件；中规模软件：源程序行数为10，00050,00

5、0 的软件；大规模软件：源程序行数为 100，000500，000的软件；特大规模软件：源程序行数为大于500，000 的软件。 b) 文件的剪裁与合并见表2 表 2 按项目规模大小对 14 种文件的剪裁与合并、小 规 模中 规 模大 规 模特大软件需求说明与开发计划项目开发计划软件需求说明测试计划可行性研究报告项目开发计划软件需求说明数据要求说明测试计划可根据 14 种文件按实际需要量进一步细分。软件设计说明软件设计说明概要设计说明详细设计说明数据库设计说明使用说明使用说明用户手册操作手册测试分析报告模块开发卷宗测试分析报告模块开发卷宗测试分析报告项目开发总结开发进度月报项目开发总结开发进度

6、月报项目开发总结名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 7 页 - - - - - - - - - 3 表 1 软件生存周期各阶段中的文件编制阶使文用档段者名称可行性研究与计划需求分析设计实现测试使用与维护管理开发人员可行性研究报告管理开发人员项目发开发计划开发人员软件需求说明书开发人员数据要求说明书开发人员测试计划（大纲）开发维护人员概要设计说明书开发维护人员详细设计说明书开发维护人员数据设计说明书维护人员模块开发卷宗用户用户手册用户操作手册维护人员测试分析报告

7、管理人员开发进度月报管理人员项目开发总结名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 7 页 - - - - - - - - - 4 4.2.2 文件的详细程度14 种文件在 GB8567中都有相应的编写提示供参考， 各条款可根据实际情况进行增加，合并，删改。按同一份提示起草的文件的篇幅，允许有少到几页，也可长达几百页的差别，其详细程度取决于项目的规模，复杂性和项目负责人及项目管理部门对该软件的开发过程，运行环境，技术关键问题的诠释，维护和使用要求的判断。其前提是一定要

8、把技术内容及关键问题交待清楚。5 文档的编制要示和一般方法5.1 可行性研究报告说明该软件开发项目在技术、经济和社会条件等方面实现的可行性，评述可能选择的各种方案，说明并充分论证所选定的方案。其编制方法见 GB8567附录 A 可靠研究报告的编写提示。5.2项目开发计划把对开发过程中各方面工作的负责人，开发进度，所需开发经费的预算所需的硬件及软件资源等问题做出安排，用文件的形式记载下来，以便根据本计划开展和检查项目的开发工作。其编写方法见 GB8567附录 B项目开发计划的编写提示。5.3软件需求说明书 (ISO9000-3 中称为软件需求规格说明 ) 软件需求说明书是软件开发文档中最重要,

9、最关键的文档 , 软件系统的全部功能，性能，用户接口，环境要求，安全性，可靠性，保密性应在软件需求说明中详细的得到体现，这些需求应该精确到足以成为产品测试，验收确认的依据，是软件设计实现的依据，整个开发工作的基础，也是与用户进行交流的指南。其编写方法见 GB8567附录 C软件需求说明书的编写提示和GB9385 计算机软件需求说明编制指南。5.4数据要求说明书应完整地说明在整个开发时期必须处理的所有数据元素, 并向用户说明输入数据的采集要求。其编写方法见 GB8567附录 D数据要求说明书的编写提示。5.5概要设计说明书应说明对程序系统的设计考虑，包括基本流程，组织结构，模块划分，功能分配，接

10、口设计，运行环境，数据结构设计和出错处理设计等，为详细设计提供基础，需要名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 4 页，共 7 页 - - - - - - - - - 5 时也可与详细设计说明合在一起。其编写方法见GB8567附录 E概要设计说明书的编写提示。5.6 详细设计说明书详细设计说明书可根据需要与概要设计说明书合在一起编写。应详细说明程序中各个成分（每个模块或子程序） 的设计细节，以利于程序员编制程序。 其编写方法见 GB8567附录 F详细设计说明书的编写提示。5

11、.7 数据库设计说明书详细规定待设计数据库的所有标识，逻辑结构和物理结构， 此文件通常是为很多软件人员编写各种程序时用到的同一批数据而准备的。其编写方法见 GB8567附录 G数据库设计说明书编写提示。5.8 用户手册应采用比较通俗的语言， 清楚地说明该软件所具有的功能和使用方法，使用户能够了解软件的用途， 使用环境，各种限制 , 及输入输出要求。 其编制方法见 GB8567 附录 H 用户手册的编写提示。5.9 操作手册应向计算机操作人员或维护人员提供该软件各种可能情况的运行过程，包括操作方法的细节，着重帮助他们理解从输入数据到输出信息的数据处理过程，面不是程序的内部逻辑流程。其编写方法见G

12、B8567附录 I 操作手册编写提示。5.10模块开发卷宗记录和汇总低层次开发的进度和结果，编写模块结构说明（附程序框图），便于对模开发工作进行管理和复审， 并为将来的维护提供有用信息。其编制方法见 GB8567附录J 模块开发卷宗的编写提示。5.11 测试计划（大纲）主要指组装和确认测试计划，提供测试活动的内容，和进度安排，测试设计考虑，测试过程，测试方法，测试用例等测试方案，以及整理测试结果的方法和评估准则，应按需求说明记录测试结果。其编制方法见：GB8567 附录 K测试计划的编写提示； GB9386 计算机软件测试文件编制指南；GB/T15532 计算机软件单元测试5.12 测试分析报

13、告把组装测试和确认测试的每一项结果，问题及其分析写成文档，说明被测试软件经过验证的性能和缺陷。其编写方法见GB8567附录 L 测试分析报告的编写提示。名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 5 页，共 7 页 - - - - - - - - - 6 5.13 开发进度月报及时向项目主管部门汇总进展情况,以便及时发现问题和处理问题。其GB8567 附录M 开发进度月报的编写提示。5.14 项目开发总结报告总结本项目开发经验，说明实际开发结果，全面评估整个开发工作。其编写方法见

14、GB8567 项目开发总结报告的编写提示。6 文档编制和管理的一般要求受控文档一般都是受控的软件配置项，文档控制与配置管理目的基本一致，因此可以把这两项任务结合起来，由同一个机构或人员负责按统一的计划进行，对文件的管理必须贯穿于整个开发过程，才能使所编制的文件真正发挥作用。6.1 文档的形成项目负责人制定计划 ,明确何时形成何文档，由谁负责；内容要求；审批手续；全组分工完成；及时组织内部的和正式的评审或审查；必须有编写者、评审者和批准者签署，并说明相应日期。6.2 文档的分类与标识应由技术部门对文档的分类与标识做出统一规定, 划定文档的密级和具体的放范围。相关人员应严格按规定对文档进行标识。6

15、.3 文档的控制（1）开发部门设专职文档管理人员，集中保管两套主文本及源程序执行程序载体，源程序文件名清单（标出字节数和日期） ，并经文档管理人员确认是可执行程序，检查无病毒后填写软件文件履历表(其格式尚待讨论 )，方可归档；（2）交给文档管理人员的每份文档必须签署齐全；（3）两套主文本内容必须完全一致，其中一套绝对不出借，另一套借、还要执行一定手续；（4）开发组成员可拥有所需或所编制的文档作为个人应用文档，但必须是主文本的复制品，保持与主文本一致，若需修改，先改主文本；（5）开发组成员的个人文档组成子集，文档管理人员有各子集清单，并按清单把有关文档及时分发给有关人员；（6）及时注销已被新文档

16、替代的原文档（注销必须办理审批手续）；随时整理主文档，及时反映其变化情况，并及时分发；名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 6 页，共 7 页 - - - - - - - - - 7 (7) 在软件开发的每个阶段结束时,应将该阶段经过评审的技术文档及时交文档管理人员归档。（8）开发工作结束时（或软件确认测试通过，作为正式产品发放），应将本软件有关的全部文档及开发成果（含完整的源程序，执行程序载体，全部文字性材料）交文档管理员归档。文档管理员认真检查其内容，发现与主文本不一致

17、时，必须监督有关人员修正。文档归档应履行严格的交接手续，对归档材料的完整性，一致性，正确性应经过评审，验证，确认后交接双方签字。6.4 文档的修改由于软件在开发过程中修改频繁，且一处修改可能影响到其它多处也要作相应修改，所以 GB8567 指出按如下步骤：a) 提议：向项目负责人提出建议，说明修改的文档部位，内容及理由；b) 评议：由项目负责人审查修改的必要性，确定影响范围，研究修改方法和具体步骤；c) 审核：由项目负责人负责；d) 批准：由主管部门负责人批准；e) 实施：由项目负责人组织实施修改， 直到最后取代原文档， 并写出修改更新说明，交文档管理员。拟制：审核：批准：名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 7 页，共 7 页 - - - - - - - - -