《软件工程》课件-第13章 软件工程标准与文档

第13章

软件工程标准与文档XX大学XX系XXX软件工程教程电子科技大学出版社学习目标l

理解软件工程标准和文档的定义；l

理解标准化的作用；l

理解软件工程的国家标准；l

掌握软件工程标准的类型、层次、制定与推行；l

掌握软件文档编写的要求；l

了解软件文档的作用、分类、管理维护要求；l

了解软件文档撰写规范指南。目录01020304软件工程标准软件文档与编写要求软件文档撰写规范指南本章小结软件工程标准01软件工程标准软件工程标准化就是一种“语言”，这种语言更接近于普通话，既便于人机交互，又便于软件开发的生存周期中，各阶段工作的承上启下以及不同人员之间的交流协作，进而保证软件质量。实践表明，采用先进的程序设计技术既可以提高软件的开发效率，又可以提高软件的维护效率。随着软件工程学科的发展，人们对计算机软件的认识逐渐深入。软件工作的范围从只是使用程序设计语言编写程序，扩展到整个软件生存期。软件工程标准软件工程标准的类型也是多方面的。它可能包括过程标准（如方法、技术、质量等）、产品标准（如需求、设计、部件、描述、计划、报告等）、专业标准（如职别、道德准则、认证、特许、课程等），以及记法标准（如术语、表示法、语言等）。FIPS135是美国国家标准局发布的《软件文档管理指南》

(National

Bureau

OfStandards，Guidelinefor

Software

Documentation

Management，FIPSPUB135，June1984)。软件工程标准NSAC—39是美国核子安全分析中心发布的《安全参数显示系统的验证与确认》(NuclearSafetyAnalysisCenter，Verification

andValidation

forSafetyParameterDisplaySystems，NSAC-39，December1981)。ISO

5807是国际标准化组织公布(现已成为我国国家标准)的《信息处理——数据流程图、程序流程图、系统流程图、程序网络图和系统资源图的文件编制符号及约定》。软件工程标准软件工程的标准化会给软件工作带来许多好处，比如：①可提高软件的可靠性、可维护性和可移植性。②可提高软件的生产率。③可提高软件人员的技术水平。④可提高软件人员之间的通信效率，减少差错和误解。⑤

有利于软件管理；有利于降低软件产品的成本和运行维护成本。⑥有利于缩短软件开发周期。表13.3中国的软件工程标准软件工程标准①

GB/T

8567-2006计算机软件文档编制规范本标准根据GB/T

8566-2001《信息技术

软件生存周期过程》的规定，主要对软件的开发过程和管理过程应编制的主要文档及其编制的内容、格式规定了基本要求。本标准原则上适用于所有类型的软件产品的开发过程和管理过程。软件工程标准本标准参考国际标准ISO/IEC

15910：1999《信息技术软件用户文档过程》等标准制定的。该标准代替GB/T8567-1988《计算机软件产品开发文件编制指南》。软件工程标准②

GB/T

11457-2006信息技术

软件工程术语本标准定义了软件工程领域中通用的术语。本标准适用于软件开发、使用维护、科研、教学和出版等方面。本标准规定了软件工程领域中的1859个中文术语，以及每个中文术语对应的英文词，还对每个术语给出了一个或一个以上的定义。标准最后附有英文索引和中文索引。软件工程标准本标准是对GB/T

11457-1995《软件工程术语》的修订，并代替GB/T11457-1995标准。在GB/T

11457-1995中规定了软件工程经常用到的545个中文术语。本标准吸收了IEEE

Std

610.12.1990IEEEStandard

Glossar

y

of

Software

EngineeringTerminology中的全部术语，并参考了软件工程有关标准方面的部分术语。软件工程标准③

GB/T

16260.1-2006软件工程产品质量

第1部分：质量模型该标准描述了关于软件产品质量的两部分模型，即a）内部质量和外部质量，b）使用质量。该标准定义的特性适用于每一类软件，包括固件中的计算机程序和数据。这些特性为确定软件的质量需求和权衡软件产品的能力提供了一个框架。软件工程标准该标准等同采用国际标准ISO/IEC

9126-1：2001。该标准代替国家标准GB/T

16260-1996《信息技术

软件产品评价质量特性及其使用指南》。软件工程标准④

GB/T

16260.2-2006软件工程产品质量

第2部分：外部度量该标准定义了依据GB/T

16260.1定义的特性和子特性来定量测量软件外部质量的外部度量，主要包括如何使用软件质量度量的解释、每个子特性的基本度量集、在软件产品生存周期内如何使用这些度量的实例。软件工程标准该标准可用于各种应用软件，主要针对软件产品的需方、评价者、开发者、维护者、供方、用户质量管理者使用。该标准等同采用国际标准ISO/IEC

9126-2：2003。软件工程标准⑤

GB/T

16260.3-2006软件工程产品质量

第3部分：内部度量该标准定义了依据GB/T

16260.1定义的特性和子特性来定量测量软件内部质量的内部度量，主要包括如何使用软件质量度量的解释、每个子特性的基本度量集、在软件产品生存周期内如何使用这些度量的实例。软件工程标准该标准可用于各种应用软件，主要针对软件产品的需方、评价者、开发者、维护者、供方、用户质量管理者使用。该标准等同采用国际标准ISO/IEC

9126-3：2003。软件工程标准⑥

GB/T

16260.4-2006软件工程

产品质量

第4部分：使用质量的度量该标准为GB/T

16260.1中所规定的质量特性定义了使用质量的度量，主要包括如何使用软件质量度量的解释、每个子特性的基本度量集、在软件产品生存周期内如何使用这些度量的实例。软件工程标准该标准可用于各种应用软件，主要针对软件产品的需方、评价者、开发者、维护者、供方、用户质量管理者使用。该标准等同采用国际标准ISO/IEC

9126-4：2004。软件工程标准⑦

B/Z

20156-2006软件工程软件生成周期过程ꢀ用于项目管理的指南该标准论述的项目管理的各方面，它们或是“软件特定的”，或是已知的在GB/T

8566-2001任一基本过程中引发软件项目问题的，包括将GB/T

8566-2001的7.1中的管理活动在每个基本过程中实施SPM进行一般指导，软件项目管理对每个基本过程的适用性，与软件项目管理的范围适当交叉的关键域，针对某些管理任务为软件项目经理（PM）扩充了指南。软件工程标准该标准为负责管理GB/T8566-2001软件生存周期基本过程：获取、供应、开发、运作和维护的执行的人员提供了指南。该标准修改采用国际标准ISO/IECTR16326：1999。软件工程标准⑧

GB/T

20157-2006信息技术

软件维护该标准比较详细地描述GB/T8566所述的维护过程的管理；定义了各种维护类型，并且提供了在维护过程的策划、执行、控制、评审和评价以及结束等方面的应用指南。本标准的范围涉及到对于具有相同维护资源的多种软件产品的维护。该标准等同采用国际标准ISO/IEC14764：1999。软件工程标准⑨

GB/T

20158-2006信息技术

软件生成周期过程

配置管理该标准是基于GB/T

8566的配置管理（CM）过程，规定了计算机软件配置管理的实施要求，以用于软件产品的开发、维护和运行。软件工程标准该标准适用于：任何形式的软件；软件产品的整个生存周期和生存周期内的单个开发、维护和运行项目，从分包商或销售商获得的软件；软件产品的供方和需方。适用于供、需双方的情况，并且双方属于同一组织时也同样适用。该标准等同采用国际标准ISO/IEC

15846：1998。软件工程标准软件工程标准的类型也是多方面的，根据中国国家标准GB/T15538－1995《软件工程标准分类法》给出软件工程标准的分类，涉及过程管理、产品管理、资源管理，以及确认与验证。软件工程标准的类型如下：”（1）过程标准。如方法、技术、度量等。（2）产品标准。如需求、设计、部件、描述、计划、报告等。（3）专业标准。如职别、道德准则、认证、特许、课程等。（4）记法标准。如术语、表示法、语言等。软件工程标准根据软件工程标准制定的机构和标准适用的范围有所不同，它可分为五个级别，即国际标准、国家标准、行业标准、企业(机构)标准及项目(课题)标准。以下分别对五级标准的标识符和标准制定(或批准)的机构做一简要说明：”（1）国际标准由国际联合机构制定和公布，提供各国参考的标准。如ISO(InternationalStandards

Organization)──国际标准化组织。该标准现已由中国收入国家标准。软件工程标准（2）国家标准由政府或国家级的机构制定或批准，适用于全国范围的标准，如：①GB──中华人民共和国国家技术监督局是中国的最高标”准化机构，它所公布实施的标准简称为“国标”。现已批准了若干个软件工程标准。②ANSI(AmericanNationalStandards

Institute)──美国国家标准协会。这是美国一些民间标准化组织的领导机构，具有一定的权威性。软件工程标准③

FIPS(NBS)

(Federal

Information

ProcessingStandards(National

Bureau

of

Standards))──美国商务部国家标准局联邦信息处理标准。它所公布的标”准均冠有FIPS字样。如1987年发表的FIPS

PUB132－87Guidelineforvalidationandverificationplanof

computersoftware

(软件确认与验证计划指南)。软件工程标准④BS(BritishStandard)──英国国家标准。⑤

DIN(DeutschesInstitut

für

Normung)──”德国标准协会。⑥

JIS(Japanese

Industrial

Standard)──日本工业标准。软件工程标准（3）行业标准由行业机构、学术团体或国防机构制定，并适用于某个业务领域的标准，如：”①

IEEE(Institute

of

Electrical

andElectronics

Engineers)──美国电气与电子工程师学会。软件工程标准②

GJB──中华人民共和国国家军用标准。这是由中国国防科学技术工业委员会批准，适合于国防部门和军队使用的标准。例如，1988年实施的GJB437－88《军用软件开发规范》；GJB438－88《军用软件文档编制规范》。”③

D

O

D

_

S

T

D

(

D

e

p

a

r

t

m

e

n

t

O

fDefense_STanDards)──美国国防部标准，适用于美国国防部门。④

MIL_S(MILitary_Standard)──美国军用标准，适用于美军内部软件工程标准（4）企业规范一些大型企业或公司，由于软件工程工作的需要，制定适用于本部门的规范。例如，美国”IBM公司通用产品部(General

ProductsDivision)1984年制定的《程序设计开发指南》，仅供该公司内部使用。软件工程标准（5）项目规范由某一科研生产项目组织制定，且为该项”任务专用的软件工程规范。例如，计算机集成制造系统(CIMS)的软件工程规范。软件工程标准软件工程标准的制定与推行通常要经历一个环状的生存周期,如图13.1所示。最初，制定一”项标准仅仅是初步设想，经发起后沿着环状生存周期，顺时针进行要经历以下的步骤。软件工程标准（1）建议——拟定初步的建议方案。（2）开发——制定标准的具体内容。（3）咨询——征求并吸取有关人员的意见。”（4）审批——由管理部门决定能够推出。（5）公布——公开发布，使标准生效。软件工程标准（6）培训——为推行标准准备人员条件。（7）实施——投入使用，须经历相当期限。（8）审核——检验实施效果，决定修改还是”撤销。（9）修订——修改其中不适当的部分，形成标准的新版本，进入新的周期。”图13.1软件工程标准的环状生存期软件工程标准为使标准逐步成熟，可能在换环状生存周期上循环若干圈，需要做大量的工作。事实上，软件工程标准在制定和推行的过程中还会遇到许多实际问”题。其中影响软件工程标准顺利实施的一些不利因素应当特别引起重视，这些影响因素可能有：（1）标准制定得有缺陷，或是存在不够合理，不够恰当的部分。软件工程标准（2）标准文本编写得有缺点。如文字叙述可读性差、难于理解、缺少实例供读者参阅。（3）主管部门未能坚持大力推行，在实施过”程中遇到问题又未能及时加以解决。（4）未能及时做好宣传、培训和实施指导。（5）未能及时修订和更新。软件文档与编写要求02软件文档与编写要求软件文档在整个软件生存周期的各个阶段起到了重要的桥梁作用，可以说，没有文档”就没有现代的软件工程，我们必须高度重视软件文档技术的作用。软件文档与编写要求（1）文档的概念文档是指某种数据媒体和其中记录的数据。它具有永久性，并可以由人或机器阅读。”文档也是软件产品的一部分，没有文档的软件就不称其为软件。软件文档的编址在软件开发工作中占有突出的地位和相当大的工作量。软件文档与编写要求（2）文档的作用软件文档在产品的开发生产过程中有重要的作用，具体如下：”①提高软件开发过程的能见度。②提高开发效率。③

作为开发人员在一定阶段的工作成果和结束标志。软件文档与编写要求④

记录开发过程中的有关信息，便于协调以后的软件开发、使用和维护。⑤

提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用”户之间的协作、交流和了解。⑥

便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。软件文档与编写要求软件文档从形式上来看，大致可以分为两类：一类是开发过程中填写的各种图表，可称”之为工作表格；另一类是应编制的技术资料或技术管理资料，可称之为文档或文件。软件文档与编写要求①

开发文档。这类文档是在软甲开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档。包括软件啊需”求说明书、数据要求说明书、总体设计说明书、详细设计说明书、可行性研究报告、项目开发计划。软件文档与编写要求②

管理文档。这类文档是在软甲开发过程中，由软件开发人员制定的需提交管理人员的一些工作计划或工作报告。使管理人员能够通过这些”文档了解软件开发项目安排、进度、资源使用和成果等。包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结。软件文档与编写要求③

用户文档。这类文档是软甲开发人员为用户准备的有关该软件使用、操作、维护的资”料。包括用户手册、操作手册、维护修改建议、软件需求说明书。表13.4各类文档内容及软件生存周期表13.4各类文档内容及软件生存周期软件文档与编写要求高质量的文档应体现在以下几个方面：（1）针对性。文档编制以前应分清读者对象。”（2）精确性。文档的行文应当十分确切，不能出现多义性的描述。软件文档与编写要求（3）清晰性。文档的编写应力求简明，如有可能，配以适当的图表，以增强其清晰性。”（4）完整性。任何一个文档都应当是完整的、独立的，它应自成体系。软件文档与编写要求（5）灵活性。各个不同软件项目，其规模和复杂程度有着许多实际差别，不能一律看待。（6）

可追溯性。由于各开发阶段编制的文档与”各个阶段完成的工作有密切的关系，前后两个阶段生成的文档，随着开发工作的逐步延伸，具有一定的继承关系，在一个项目各开发阶段之间提供的文档必定存在着可追溯的关系。软件文档与编写要求在整个软件生存期中，各种文档作为半成品或是最终产品，会不断生成、修改或补充。为了”最终得到高质量的产品，达到上面提出的质量要求，必须按下面的要求加强对文档的管理。软件文档与编写要求（1）软件开发小组应设一位文档保管员，负责集中保管本项目已有文档的两套主文本。这两套主文本的内容完全一致。其中一套可按一定手续办理借阅。”（2）软件开发小组的成员可根据工作需要在自己手中保存一些个人文档。这些一般都应是主文本的复制件，并注意与主文本保持一致，在做必要的修改时，也应先修改主文本。软件文档与编写要求（3）开发人员个人只保存着主文本中与他工作有关的部分文档。（4）在新文档取代旧文档时，管理人员应及”时注销旧文档。在文档的内容有更动时，管理人员应随时修订主文本，使其及时反映更新了的内容。软件文档与编写要求（5）项目开发结束时，文档管理人员应收回开发人员的个人文档。发现个人文档与主文档有差别时，应立即着手解决。这往往是在开发过程中没有及时修订主文本造成的。”（6）在软件开发过程中，可能发现需要修改已完成的文档。修改以前要充分估计修改可能带来的影响，并且要按照如下步骤加以严格的控制：提议→评议→审核→批准→实施。软件文档撰写规范指南03软件文档撰写规范指南在项目开发过程中，应该按要求编写好十三种文档，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性、可追溯性。(文档的模板看书)（1）可行性分析报告。说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。软件文档撰写规范指南（2）项目开发计划。为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。（3）软件需求说明书（软件规格说明书）。对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。软件文档撰写规范指南（4）概要设计说明书。该说明书是概要实际阶段的工作成果，它应说明