软件文档写作-第2讲文档标准(完整)

你思考过吗? 软件危机的出路在于软件开发的工程化和标准 化。 程序设计语言的标准化：为某一程序设计语言 规定若干个标准子集，对于语言的实现者和用 户都带来了很大方便。 软件过程的标准化：软件生存期各个阶段的工 作建立标准或规范1

第二讲 软件工程标准化 和软件文档标准

2.1 软件工程标准化1. 什么是“标准”?1983年，我国颁布的国家标准(GB3935.1-83)对“标准”的定义是：“标 准是对重复性事物和概念所做的统一规定。它以科学、技术、实践经验和综合 成果为基础，经有关方面协商一致，由主管机构批准，以特定形式发布，作为 共同遵守的准则和依据”。 1983年，国际标准化组织发布的ISO第二号指南(第四版)对“标准”的重 新定义是：“由有关各方根据科学技术成就与先进经验，共同合作起草，一致 或基本一致同意的技术规范或其它公开文件，其目的在于促进最佳的公众利益， 并由标准化团体批准”。 2000年发布的GB/T1.1-2000“标准化工作导则”中，将“标准”定义为： “为在一定范围内获得最佳秩序，对活动或其结果规定共同的和重复的规则、 导则或特性文件。该文件经协商一致制定并经一个公认机构的批准。标准应以 科学、技术和经验的综合成果为基础，以促进最佳社会效益为目的。”

简单地说:标准就是完成一项工作必须遵循的统一的模板和技术指标3

2. 软件工程标准化

随着计算机科学技术的迅速发展和计算机应用领域的不断扩大，如 何高效开发软件产品，提高软件质量，越来越受到人们的重视。同时， 软件的规模和复杂度在持续的增加，人们对软件产品开发过程系统化、 规范化和标准化的要求也越来越严格。

因此，软件工程标准化、软件文档规范化，已经成为软件领域继软 件工程学后，影响软件行业发展的又一个重要因素，受到软件企业的 高度重视。而所有这些方面建立的标准或规范，即是软件工程标准化。 到1999年底，ISO/JTC1已制定出近40项软件工程国际标准。我国自 1983年起至今，也已陆续制定、发布了20余项软件工程国家标准。

3. 软件工程标准化的意义软件企业实施软件工程标准化后的益处，主要表现在以下几个方面： 1. 提高软件的可靠性、可维护性和可移植性；

2. 提高软件的生产率和软件人员的技术水平；3. 提高软件人员之间的通信效率，减少差错和误解； 4. 有利于软件管理；

5. 有利于降低软件产品的成本和运行维护成本；6. 有利于缩短软件开发周期。 在使用工程化的原理和方法来指导软件的开发和维护时，必须充分注意软件 文档的编制和管理。

4. 软件工程标准

化的类型参照其它工程领域对工程标准划分的方法，软件工程标准主要有两种划分 方法： 按标准的类型划分和按标准的范围划分。5

(1) 按标准的类型划分主要有过程标准、产品标准、行业标准、记法标准等。

过程标准与开发一个产品或从事一项服务的一系列活动或操作有关。过程标准使用一组方法、工具和技术，给出“谁来做”、“做什么”、“如何做”、“何时做”、 “何地做”及在软件工程活动中进行的不同层次工作的过程模型。

产品标准则涉及软件工程事务的格式和内容，如需求、设计、计划等。软件开发和维护活动文档化的结果就是软件产品，软件文档是软件工程活动进一步开展的基础。 软件开发作为一种行业，其 行业标准涉及软件工程的所有方面，如执业认证、职 业培训、产品许可等。行业标准可以等同于行业行为规范。 表示法、语言等。它其实是一种语境规范。

记法标准规定了在软件工程行业范围内，以唯一的方式进行交流的方法，如术语、

(2) 按标准的范围划分主要是根据软件的任务功能和软件生存期进行比较、判定、评价和确定软件工程 标准的范围和内容。任务功能可以表示软件工程过程，可以划分为产品工程功能、验证 与确认功能以及技术管理功能3个部分。 产品工程功能包括定义、生产和支持最终产品所必须的过程。验证和确认功能是检 查产品质量的活动。技术管理功能是构造和控制产品工程的过程。 这3个部分并不集中在单个的软件生存周期里，而是并行进行的生产、检查和控制 6 活动。

根据以上两种分类方法，软件工程标准可用一张二维表格来表示。标准范围 标准类型 方法 过 程 技术 度量 需求 GB/T 9385-1988 概念 需求 设计 软 件 生 存 期 实现 测试 制造 安装与 检验 运行/ 维护 引退

设计产 品 部件 描述 计划 报告 职业 道德准则 行 业

认证特许 课程 术语

记 法

表示法 语言

GB/T 1526-19897

标准范围 标准类型 方法 过程管理 GB/T 8566-1995 产品管理 资源管理 评审与审计 产品分析 测试

过 程

技术 度量 需求 设计

产 品

部件描述 计划

报告职业 道德准则 行 业 认证 特许 课程 术语 记 法 表示法 语言8

上述两表给出了二维表的大致格式。其中，给出了GB/T 93851988、GB/T 1526-1989、GB/T 8566-1995这3个标准的例子，用于说 明各个标准的类型及其作用。1. GB/T 9385-1988是原电子工业部批准的《计算机软件需求说 明编制指南》,用于指导软件需求规格说明书的编写。 2. GB/T 1526-1989是国家标准总局批准的信息处理——数据流 图、程序流程图、系统结构图、程序网络图、系统资源图的文件编制 符号及

约定。 3. GB/T 8566-1995是国家标准总局批准的信息技术——软件生 存期过程标准，它规定了在获取、供应、开发、操作、维护软件时， 要实施的过程、活动和任务。目的是为用户提供一个公共的框架，使 软件从业人员可以使用“相同的语言”创作和管理软件。 从表中可以看到软件工程标准的范围和标准如何分类，因此对相 关标准的编制、开发具有指导作用，而已经制定的标准也都可以在表 中找到相应的位置。所以，该表还可以启发制定新的标准。9

2.2 软件工程标准编制的层次根据软件工程标准制定的机构和标准适用的范围，可分为5个层次：国 际标准、国家标准、行业标准、企业(机构)标准、项目(课题)标准。1. 国际标准：由国际联合机构制定和公布的标准，供各国参考。

如ISO——国际标准化组织。2. 国家标准：由政府或国家级的机构制定或批准，适用于全国范围。 如GB——中国国标、ANSI_美国国家标准协会、BS——英国国家标准、 JIS——日本工业标准。 3. 行业标准：由行业机构、学术团体或国防等机构制定，适用于某个业务 领域。 如IEEE——美国电气和电子工程师学会、GJB——中国国家军用标准。 4. 企业规范：企业因软件工程工作的需要制定的适用于本企业的规范。 如IBM通用产品部于1984年制定的《程序设计开发指南》。 5. 项目规范：由某一科研生产项目组织制定，仅为该项目任务服务的软件 工程规范。 如CIMS——计算机集成制造系统——软件工程规范。10

2.3 中国的软件标准1983年起，我国陆续制定和发布了20余项软件工程国家标准。 这些标准可以分为以下四类： 1. 基础标准：规定了信息加工处理和软件工程领域的术语、符 号、表示、构造、分类级约定； 2. 开发标准：规定了软件生存期过程、软件支持环境、软件记 录处理流程、软件维护等的工作规范； 3. 文档标准：规定了软件产品、需求、测试、管理等文档的编 制规范； 4. 管理标准：规定了软件配置管理计划、质量保证计划、产品 质量特性、软件可靠性和可维护性管理等的规范和工作要素。 下表列出了我国部分软件工程标准的名称及其标准号：

类型 软件工程术语 …… 此处隐藏：3215字，全部文档内容请下载后查看。喜欢就下载吧 ……