什么是软件工程标准 软件工程标准的层次 中国的软件标准 ISO 9000-3标准及软件质量认证 软件文档的作用与分类 对文档编制的质量要求

软件工程标准的层次软件工程标准的层次(1) (1) 国际标准国际标准 由国际联合机构制定和公布，提供由国际联合机构制定和公布，提供各国参考的标准。各国参考的标准。 国际标准化组织国际标准化组织 ISOISO ( (International International

Standards OrganizationStandards Organization)) 这一国际机构有着广泛的代表性和这一国际机构有着广泛的代表性和权威性，它所公布的标准也有较大的权威性，它所公布的标准也有较大的影响。影响。

ISOISO 建立了“建立了“计算机与信息处理技术计算机与信息处理技术委员会委员会”” , , 简称简称 ISOISO ／／ TC97TC97 ，专门，专门负责与计算机有关的标准化工作。负责与计算机有关的标准化工作。

这一标准通常冠有这一标准通常冠有 ISOISO 字样，如字样，如 ISO 8631ISO 8631 －－ 86 Information processin86 Information processin

g_program constructs and conventions g_program constructs and conventions for their representationfor their representation 《《信息处理─信息处理──程序构造及其表示法的约定─程序构造及其表示法的约定》。该》。该标准现已由中国收入国家标准。标准现已由中国收入国家标准。

(2) (2) 国家标准国家标准 由政府或国家级的机构制定或批准，由政府或国家级的机构制定或批准，适用于全国范围的标准适用于全国范围的标准，如：，如： GB GB ── ── 中华人民共和国国家技术监督中华人民共和国国家技术监督局局公布实施的标准，简称“公布实施的标准，简称“国标国标”。现”。现已批准了若干软件工程标准。已批准了若干软件工程标准。

ANSI ANSI ((American National Standards IAmerican National Standards Institutenstitute) ── ) ── 美国国家标准协会。这美国国家标准协会。这是美国一些民间标准化组织的领导机是美国一些民间标准化组织的领导机构，构，

FIPS FIPS ((NBSNBS)) ｛｛ Federal Information PFederal Information Processing Standardsrocessing Standards ( (National Bureau National Bureau of Standardsof Standards)) ｝── 美国商务部国家｝── 美国商务部国家标准局联邦信息处理标准。标准局联邦信息处理标准。

BS BS ((British StandardBritish Standard) ── ) ── 英国国家标英国国家标准。准。

DIN DIN ((Deutsches Institut für Nor- munDeutsches Institut für Nor- mung g ) ── ) ── 德国标准协会德国标准协会

JIS JIS ((Japanese Industrial StandardJapanese Industrial Standard) ─) ── ─ 日本工业标准日本工业标准

(3) (3) 行业标准行业标准 由行业机构、学术团体或国防机构制由行业机构、学术团体或国防机构制定，适用于某个业务领域的标准。定，适用于某个业务领域的标准。 IEEE IEEE ( ( Institute of Electrical and ElecInstitute of Electrical and Elec

tronics Engineers tronics Engineers ) ) ── ── 美国电气与电美国电气与电子工程师学会子工程师学会。。

该学会有一个该学会有一个软件标准分技术委员软件标准分技术委员会会 ((SESSSESS)) ，负责软件标准化活动。，负责软件标准化活动。 IIEEEEEE 公布的标准常冠有公布的标准常冠有 ANSIANSI 的字头。的字头。例如，例如， ANSIANSI ／／ IEEE Str 828IEEE Str 828 －－ 19831983《《软件配置管理计划标准软件配置管理计划标准》。》。

GJBGJB──── 中华人民共和国国家军用标准。中华人民共和国国家军用标准。这是由这是由中国国防科学技术工业委员会中国国防科学技术工业委员会批批准，适合于国防部门和军队使用的标准。准，适合于国防部门和军队使用的标准。例如，例如， GJB 437GJB 437 －－ 8888 《《军用软件开发军用软件开发规范规范》。》。

DOD_STD DOD_STD ( ( Department Of Defense _SDepartment Of Defense _STanDardsTanDards) ── ) ── 美国国防部标准，适用美国国防部标准，适用于美国国防部门。于美国国防部门。

MIL_S MIL_S ( ( MILitary_StandardMILitary_Standard)──)── 美国美国军用标准，适用于美军内部。军用标准，适用于美军内部。

(4) (4) 企业规范企业规范 一些大型企业或公司，由于软件工一些大型企业或公司，由于软件工程工作的需要，制定适用于本部门的程工作的需要，制定适用于本部门的规范。规范。 例如，例如，美国美国 IBMIBM 公司通用产品部公司通用产品部 11

984984 年制定的《年制定的《程序设计开发指南程序设计开发指南》，》，仅供该公司内部使用。仅供该公司内部使用。

(5) (5) 项目规范项目规范 由某一科研生产项目组织制定，为由某一科研生产项目组织制定，为该项任务专用的软件工程规范。该项任务专用的软件工程规范。

中国的软件标准中国的软件标准 从从 19831983 年起，中国已陆续制定和发年起，中国已陆续制定和发布了布了 2020 项国家标准。这些标准可分为项国家标准。这些标准可分为44 类：类：

① ① 基础标准基础标准 GB/T 11457-89GB/T 11457-89 软件工程术语软件工程术语 GB 1526-891GB 1526-891 （（ ISO 5807-1985ISO 5807-1985 ）信）信息处理息处理 ---- 数据流程图、程序流程图、数据流程图、程序流程图、系统结构图、程序网络图和系统资源系统结构图、程序网络图和系统资源图的文件编制符号及约定图的文件编制符号及约定

GB/T 15538-1995GB/T 15538-1995 软件工程标准分类软件工程标准分类法法

GB 13502-92GB 13502-92 （（ ISO 8631ISO 8631 ）信息处）信息处理理 ---- 程序构造及其表示法的约定程序构造及其表示法的约定

GB/T 15535-1995GB/T 15535-1995 （（ ISO 5806ISO 5806 ）信息）信息处理处理 ---- 单命中判定表规范单命中判定表规范

GB/T 14085-93GB/T 14085-93 （（ ISO 8790ISO 8790 ）信息处）信息处理系统 计算机系统配置图符号及其理系统 计算机系统配置图符号及其约定约定

② ② 开发标准开发标准 GB 8566-88GB 8566-88 软件开发规范软件开发规范 GBGB 计算机软件单元测试计算机软件单元测试 GBGB 软件支持环境软件支持环境 GBGB （（ ISO 6593-1985ISO 6593-1985 ）信息处理）信息处理 ----按记录组处理顺序文卷的程序流程按记录组处理顺序文卷的程序流程

GB/T 14079-93GB/T 14079-93 软件维护指南软件维护指南③ ③ 文档标准文档标准

GB 8567-88GB 8567-88 计算机软件产品开发文计算机软件产品开发文件编制指南件编制指南

GB 9385-88GB 9385-88 计算机软件需求说明编计算机软件需求说明编制指南制指南

GB 9386-88GB 9386-88 计算机软件测试文件编计算机软件测试文件编制规范制规范

GBGB 软件文档管理指南软件文档管理指南④ ④ 管理标准管理标准

GB/T 12505-90GB/T 12505-90 计算机软件配置管理计算机软件配置管理计划规范计划规范

GBGB 信息技术 软件产品评价信息技术 软件产品评价 ---- 质量质量特性及其使用指南特性及其使用指南

GB 12504-90GB 12504-90 计算机软件质量保证计计算机软件质量保证计划规范划规范

GB/T 14394-93GB/T 14394-93 计算机软件可靠性和计算机软件可靠性和可维护性管理可维护性管理

GB/T 19000-3-94GB/T 19000-3-94 质量管理和质量保质量管理和质量保证标准 第三部分：证标准 第三部分：

在软件开发、供应和维护中的在软件开发、供应和维护中的使使

用指南 。用指南 。

ISO 9000-3ISO 9000-3 标准及软件质量认证标准及软件质量认证 ISO 9000ISO 9000 国际标准发源于欧洲经济共同国际标准发源于欧洲经济共同体，但很快就波及美国、日本及世界各体，但很快就波及美国、日本及世界各国。到目前为止，已有国。到目前为止，已有 7070多个国家在多个国家在它们的企业中采用和实施这一系列标准。它们的企业中采用和实施这一系列标准。

中国对此也十分重视，确定对其中国对此也十分重视，确定对其等同采等同采用用，发布了与其相应的，发布了与其相应的质量管理国家标质量管理国家标准系列准系列 GBGB ／／ T 19000T 19000；同时积极组织；同时积极组织实施和开展质量认证工作。实施和开展质量认证工作。

ISO 9000ISO 9000 系列标准系列标准如此迅速地在国际如此迅速地在国际上广为流行，其原因主要在于：上广为流行，其原因主要在于： 市场经济，特别是国际贸易的驱动市场经济，特别是国际贸易的驱动。。 ISO 9000ISO 9000 系列标准系列标准客观地对客观地对生产生产者者(( 也称供方也称供方 )) 提出了全面的提出了全面的质量管理要质量管理要求求、、质量管理办法质量管理办法，并且还规定了，并且还规定了消费消费者者 (( 也称需方也称需方 )) 的的管理职责管理职责，使其得到，使其得到双方的普遍认同，从而将符合双方的普遍认同，从而将符合 ISO 900ISO 90000 标准标准的要求作为的要求作为国际贸易活动中建立国际贸易活动中建立互相信任关系的基石互相信任关系的基石。。

在各国企业中形成了在各国企业中形成了不通过这一不通过这一标准认证就不具备参与国际市场竞争标准认证就不具备参与国际市场竞争实力实力的潮流，并且在国际贸易中，的潮流，并且在国际贸易中，把把生产者是否达到生产者是否达到 ISO 9000ISO 9000 质量标准作质量标准作为购买产品的前提条件为购买产品的前提条件，取得，取得 ISO 90ISO 900000 质量标准认证被人们当做进入国际质量标准认证被人们当做进入国际市场的通行证。市场的通行证。

ISO 9000ISO 9000 系列标准适用领域广阔系列标准适用领域广阔。。1) 1) 硬件硬件：具有特定形状的产品，：具有特定形状的产品，

如机械、电子产品，包括计算机硬件。如机械、电子产品，包括计算机硬件。2) 2) 软件软件：通过媒体表达的信息所：通过媒体表达的信息所

构成的智力产品。包括计算机软件。构成的智力产品。包括计算机软件。3) 3) 流程性材料流程性材料：将原料转化为某：将原料转化为某

一特定状态的产品。如，流体、粒状、一特定状态的产品。如，流体、粒状、线状等，通过瓶装、袋装等或通过管道线状等，通过瓶装、袋装等或通过管道传输交付。传输交付。

4) 4) 服务服务：为满足客户需求的更为：为满足客户需求的更为广泛的活动。广泛的活动。

ISO 9000ISO 9000 系列标准的内容系列标准的内容 ISO 9000ISO 9000 质量管理和质量保证标准质量管理和质量保证标准───选择和使用的导则─选择和使用的导则

ISO 9001ISO 9001 质量体系质量体系────设计／开发、设计／开发、生产、安装和服务中的质量保证模式生产、安装和服务中的质量保证模式

ISO 9002ISO 9002 质量体系质量体系──生产和安装中──生产和安装中的质量保证模式的质量保证模式

ISO 9003ISO 9003 质量体系质量体系──最终检验和测──最终检验和测试中的质量保证模式试中的质量保证模式

ISO 9004ISO 9004 质量管理和质量体系要素质量管理和质量体系要素───导则─导则

ISO 9000ISO 9000 系列标准系列标准的主体部分可以分的主体部分可以分为两组：为两组： 一组是用于“一组是用于“需方对供方要求质量需方对供方要求质量保证保证”的标准── ”的标准── 90019001～～ 90039003；；

一组是用于“一组是用于“供方建立质量保证体供方建立质量保证体系系”的标准── ”的标准── 90049004 。。

90019001 、、 90029002 和和 90039003之间的区别，在之间的区别，在于其对象的工序范围不同于其对象的工序范围不同：： 90019001 范围最广，包括从设计直到售后范围最广，包括从设计直到售后服务；服务； 90029002 为为 90019001 的子集，而的子集，而 90039003又是又是 90029002 的子集。的子集。

ISO 9000-3ISO 9000-3 标准标准 ISO 9000ISO 9000 系列标准系列标准原本是为制造硬件原本是为制造硬件产品而制定的标准，不能直接用于软产品而制定的标准，不能直接用于软件制作。件制作。

曾试图将曾试图将 90019001改写用于软件开发方改写用于软件开发方面，但效果不佳。面，但效果不佳。

以以 ISO 9000ISO 9000 系列标准系列标准的追加形式，另的追加形式，另行制定出行制定出 ISO 9000-3ISO 9000-3 标准标准。。

ISO 9000-3ISO 9000-3成为“成为“使使 90019001 适用于软适用于软件开发、供应及维护件开发、供应及维护”的“”的“指南指南”。”。

制定与实施制定与实施 ISO 9000ISO 9000 系列标准系列标准的主导思想的主导思想(1) (1) 强调质量并非在产品检验中得到，强调质量并非在产品检验中得到，而是形成于生产的全过程。而是形成于生产的全过程。 ISO 9000-3ISO 9000-3叙述了需方和供方叙述了需方和供方应如应如何进行何进行有组织的质量保证活动，才有组织的质量保证活动，才能得到较为满意的软件；规定了能得到较为满意的软件；规定了从从双方签订开发合同到设计双方签订开发合同到设计、、实现以实现以至维护整个软件生存期中至维护整个软件生存期中应当实施应当实施的质量保证活动的质量保证活动

ISO 9000-3ISO 9000-3没有规定具体的质量管没有规定具体的质量管理和质量检验方法和步骤。理和质量检验方法和步骤。

ISO 9000-3ISO 9000-3 的核心思想是“的核心思想是“将质量将质量制作入产品之中制作入产品之中”。软件产品的质”。软件产品的质量量取决于软件生存期所有阶段的活取决于软件生存期所有阶段的活动动。。

(2) (2) 为把握产品的质量， 为把握产品的质量， ISO 9000-3ISO 9000-3要求“要求“必须使影响产品质量的全部因必须使影响产品质量的全部因素在生产全过程中始终处于受控状素在生产全过程中始终处于受控状态态”。”。

为使软件产品达到质量要求，为使软件产品达到质量要求， ISO ISO 9000-39000-3 要求软件开发机构建立要求软件开发机构建立质量保质量保证体系证体系。。

首先要求首先要求明确供需双方的职责明确供需双方的职责，针，针对对所有可能影响软件质量的各个因素所有可能影响软件质量的各个因素都要采取有力措施，作出如何加强管都要采取有力措施，作出如何加强管理和控制的决定。理和控制的决定。

对与质量有关的人员规定其对与质量有关的人员规定其职责职责和和职权职权，责任落实到人，产品质量真正，责任落实到人，产品质量真正得到控制。得到控制。

(3) (3) ISO 9000ISO 9000 标准标准要求证实：“要求证实：“企业具企业具有持续提供符合要求产品的能力有持续提供符合要求产品的能力”。”。 质量认证质量认证是取得这一证实的有效方是取得这一证实的有效方法。法。

产品质量若能达到标准提出的要求，产品质量若能达到标准提出的要求，由由不依赖于供方和需方的第三方权威不依赖于供方和需方的第三方权威机构机构对生产厂家审查证实后出具合格对生产厂家审查证实后出具合格证明。证明。

如果认证工作是公正的、可靠的，如果认证工作是公正的、可靠的，其公证的结果应当是可以信赖的。其公证的结果应当是可以信赖的。

为了达到质量标准，取得质量认为了达到质量标准，取得质量认证，必须多方面证，必须多方面开展质量管理活动开展质量管理活动。。其中，负责人的重视以及全体人员其中，负责人的重视以及全体人员的积极参与是取得成功的关键。的积极参与是取得成功的关键。

(4) (4) ISO 9000ISO 9000 标准标准强调“强调“质量管理必须质量管理必须坚持进行质量改进坚持进行质量改进”。”。 贯彻贯彻 ISO 9000ISO 9000 标准标准就是企业加强就是企业加强质量管理，提高产品质量的过程质量管理，提高产品质量的过程，，这个过程包含许多工作，决非轻而这个过程包含许多工作，决非轻而易举，一蹴而就所能奏效的。易举，一蹴而就所能奏效的。

即使已经取得了质量认证也不能认即使已经取得了质量认证也不能认为一劳永逸而放松质量管理。为一劳永逸而放松质量管理。

实际上认证通常以半年为有效期。实际上认证通常以半年为有效期。取得认证之后尚需接受每年取得认证之后尚需接受每年 11 －－ 22次的定期检查，其目的在于促使企次的定期检查，其目的在于促使企业坚持进行质量改进。业坚持进行质量改进。

软件文档的作用与分类软件文档的作用与分类

什么是文档 软件文档的作用 文档的分类 软件文档的工作

(1) (1) 什么是文档什么是文档 文档文档 ((documentdocument)) 是指某种数据媒是指某种数据媒体和其中所记录的数据。体和其中所记录的数据。

它具有它具有永久性永久性，并可以由人或机，并可以由人或机器阅读，通常仅用于描述人工可读器阅读，通常仅用于描述人工可读的东西。的东西。

在软件工程中，文档常常用来表在软件工程中，文档常常用来表示对示对活动活动、、需求需求、、过程过程或或结果结果进行进行描述描述、、定义定义、、规定规定、、报告报告或或认证认证的的任何书面或图示的信息。任何书面或图示的信息。

(2) (2) 软件文档的作用软件文档的作用 在软件生产过程中，总是产生和使用在软件生产过程中，总是产生和使用大量的信息。软件文档在产品的开发大量的信息。软件文档在产品的开发过程中起着重要的作用。过程中起着重要的作用。 提高提高软件开发过程的能见度软件开发过程的能见度。把开。把开发过程中发过程中发生的事件发生的事件以某种可阅读以某种可阅读的形式的形式记录在文档中记录在文档中。。

管理人员可把这些记载下来的材料管理人员可把这些记载下来的材料作为检查软件开发进度和开发质量作为检查软件开发进度和开发质量的依据的依据，，实现对软件开发的工程管实现对软件开发的工程管理理。。

提高开发效率提高开发效率。软件文档的编制，使。软件文档的编制，使得开发人员得开发人员对各个阶段的工作对各个阶段的工作都进行都进行周密思考周密思考、、全盘权衡全盘权衡、、减少返工减少返工。并。并且可且可在开发早期发现错误和不一致性在开发早期发现错误和不一致性，，便于及时加以纠正。便于及时加以纠正。

作为开发人员在一定作为开发人员在一定阶段的阶段的工作成果工作成果和和结束标志结束标志。。

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

提供对软件的提供对软件的运行运行、、维护维护和和培训培训的有的有关信息，关信息，便于管理人员、开发人员、便于管理人员、开发人员、操作人员、用户之间的协作、交流和操作人员、用户之间的协作、交流和了解了解。使软件开发活动更科学、更有。使软件开发活动更科学、更有成效。成效。

便于潜在用户了解软件的功能、性能便于潜在用户了解软件的功能、性能等各项指标等各项指标，为他们选购符合自己需，为他们选购符合自己需要的软件提供依据。要的软件提供依据。

文档的桥梁作用文档的桥梁作用

从某种意义上来说，从某种意义上来说，文档是软件开发文档是软件开发规范的体现和指南规范的体现和指南。。

按规范要求生成一整套文档的过程，按规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件就是按照软件开发规范完成一个软件开发的过程。开发的过程。

所以，在使用工程化的原理和方法来所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分指导软件的开发和维护时，应当充分注意软件文档的编制和管理。注意软件文档的编制和管理。

(3) (3) 文档的分类文档的分类 软件文档从形式上来看，大致可分为软件文档从形式上来看，大致可分为两类：两类： 一类是开发过程中填写的各种图表，一类是开发过程中填写的各种图表，称之为称之为工作表格工作表格；；

一类是应编制的技术资料或技术管一类是应编制的技术资料或技术管理资料，称之为理资料，称之为文档文档或或文件文件。。

软件文档的编制，可以用软件文档的编制，可以用自然语言自然语言，，特别设计的特别设计的形式语言形式语言，介于两者之间，介于两者之间的的半形式语言半形式语言 (( 结构化语言结构化语言 )) ，各类，各类图图形表示形表示、、表格表格来编制文档。来编制文档。

文档可以书写，也可以在计算机支持文档可以书写，也可以在计算机支持系统中产生，但必须系统中产生，但必须可阅读可阅读。。

按照文档产生和使用的范围，软件文按照文档产生和使用的范围，软件文档大致可分为三类：档大致可分为三类： 开发文档开发文档 软件需求说明书 数据要求说明书软件需求说明书 数据要求说明书 概要设计说明书 详细设计说明书概要设计说明书 详细设计说明书 可行性研究报告 项目开发计划可行性研究报告 项目开发计划

管理文档管理文档 项目开发计划 测试计划项目开发计划 测试计划 测试报告 开发进度月报测试报告 开发进度月报 项目开发总结项目开发总结 用户文档用户文档 用户手册 操作手册用户手册 操作手册 维护修改建议 软件需求说明书维护修改建议 软件需求说明书

(4) (4) 软件文档的工作软件文档的工作 国家标准局在国家标准局在 19881988 年年 11月发布了月发布了

《计算机软件开发规范》《计算机软件开发规范》 《软件产品开发文件编制指南》《软件产品开发文件编制指南》

作为软件开发人员工作的准则和规程。作为软件开发人员工作的准则和规程。它们它们基于软件生存期方法基于软件生存期方法，把软件产，把软件产品品从形成概念开始从形成概念开始，，经过开发经过开发、、使用使用和不断增补修订和不断增补修订，，直到最后被淘汰直到最后被淘汰的的整个过程整个过程应提交的文档归于以下十三应提交的文档归于以下十三种。种。

可行性研究报告可行性研究报告 说明该软件项目的实现在说明该软件项目的实现在技术上技术上、、经济上经济上和和社会因素上社会因素上的的可行性可行性 ;;

评述为合理地达到开发目标评述为合理地达到开发目标可供选可供选择的择的各种可能的实现方案各种可能的实现方案 ;;

说明并论证所选定实施方案的理由。说明并论证所选定实施方案的理由。

项目开发计划项目开发计划为软件项目实施方案制定出的具体计为软件项目实施方案制定出的具体计划。它包括划。它包括 各部分工作的负责人员各部分工作的负责人员 开发的进度开发的进度 开发经费的概算开发经费的概算 所需的硬件和软件资源等所需的硬件和软件资源等项目开发计划应提供给管理部门，并项目开发计划应提供给管理部门，并作为开发阶段评审的基础作为开发阶段评审的基础。。

软件需求说明书软件需求说明书对目标软件的对目标软件的功能功能、、性能性能、、用户界面用户界面及及运行环境运行环境等等作出详细的说明作出详细的说明。。它是用户与开发人员它是用户与开发人员双方对软件需求双方对软件需求取得共同理解基础上达成的协议取得共同理解基础上达成的协议，也，也是是实施开发工作的基础实施开发工作的基础。。

数据要求说明书数据要求说明书给出给出数据逻辑描述数据逻辑描述和和数据采集数据采集的各项的各项要求要求 , , 为生成和维护系统的数据文件为生成和维护系统的数据文件做好准备。做好准备。

概要设计说明书概要设计说明书该说明书是概要设计工作阶段的成果。该说明书是概要设计工作阶段的成果。它应当说明它应当说明 系统的功能分配系统的功能分配 模块划分模块划分 程序的总体结构程序的总体结构 输入输出及接口设计输入输出及接口设计 运行设计运行设计 数据结构设计数据结构设计 出错处理设计等出错处理设计等为详细设计奠定基础。为详细设计奠定基础。

详细设计说明书详细设计说明书着重描述着重描述每一个模块是如何实现的每一个模块是如何实现的，，包括包括实现算法实现算法、、逻辑流程逻辑流程等。等。

用户手册用户手册 详细描述软件的详细描述软件的功能功能、、性能性能和和用户界用户界面面，使用户了解，使用户了解如何使用该软件如何使用该软件。。

操作手册操作手册 为操作人员提供为操作人员提供软件各种运行情况的软件各种运行情况的有关知识有关知识，特别是操作方法细节。，特别是操作方法细节。

测试计划测试计划针对针对组装测试组装测试和和确认测试确认测试，需要，需要为组为组织测试制定计划织测试制定计划。计划应包括。计划应包括 测试的内容测试的内容 进度安排进度安排 条件条件 人员人员 测试用例的选取原则测试用例的选取原则 测试结果允许的偏差范围等测试结果允许的偏差范围等

测试分析报告测试分析报告测试工作完成后，应测试工作完成后，应提交测试计划执提交测试计划执行情况的说明行情况的说明。。对测试结果加以分析对测试结果加以分析，，并并提出测试的结论性意见提出测试的结论性意见。。

开发进度月报开发进度月报该月报是软件人员该月报是软件人员按月向管理部门提按月向管理部门提交的项目进展情况的报告交的项目进展情况的报告。报告应包。报告应包括括进度计划与实际执行情况的比较进度计划与实际执行情况的比较、、阶段成果阶段成果、、遇到的问题和解决的办法遇到的问题和解决的办法以及以及下个月的打算下个月的打算等。等。

项目开发总结报告项目开发总结报告 软件项目开发完成之后，应当软件项目开发完成之后，应当与项与项目实施计划对照目实施计划对照，，总结实际执行的情总结实际执行的情况况，如，如进度进度、、成果成果、、资源利用资源利用、、成本成本和和投入的人力投入的人力。。

还需还需对开发工作作出评价对开发工作作出评价，，总结经总结经验和教训验和教训。。

维护修改建议维护修改建议软件产品投入运行之后软件产品投入运行之后，，可能有修正可能有修正、、更改等问题更改等问题，应当，应当对存在的问题对存在的问题、、修修改的考虑改的考虑以及以及修改的影响估计修改的影响估计等等做详做详细的描述细的描述，写成维护修改建议，提交，写成维护修改建议，提交审批。审批。

以上软件文档是在软件生存期中，随以上软件文档是在软件生存期中，随着各个阶段工作的开展适时编制的。着各个阶段工作的开展适时编制的。其中，有的仅反映某一个阶段的工作，其中，有的仅反映某一个阶段的工作，有的则需跨越多个阶段。有的则需跨越多个阶段。

软件生存期各阶段与各种文档编制的关系软件生存期各阶段与各种文档编制的关系

软软件件计计划划

需需求求分分析析

软软件件设设计计

编编码码与与单单元元测测试试

集集成成与与测测试试

运运行行与与维维护护

可可行行性性研研究究报报告告项项目目开开发发计计划划软软件件需需求求说说明明书书数数据据要要求求说说明明书书

软软件件计计划划

需需求求分分析析

软软件件设设计计

编编码码与与单单元元测测试试

集集成成与与测测试试

运运行行与与维维护护

测测试试计计划划

概概要要设设计计说说明明书书详详细细设设计计说说明明书书用用户户手手册册

操操作作手手册册

软软件件计计划划

需需求求分分析析

软软件件设设计计

编编码码与与单单元元测测试试

集集成成与与测测试试

运运行行与与维维护护

测测试试分分析析报报告告开开发发进进度度月月报报项项目目开开发发总总结结程程序序维维护护手手册册 ((维维护护修修改改建建议议 ))

文档最终要向文档最终要向软件管理部门软件管理部门，或向，或向用用户户回答下列问题回答下列问题 哪些需求要被满足哪些需求要被满足（（ WhatWhat ）；）； 软件在什么环境中实现，所需信息软件在什么环境中实现，所需信息从哪里来从哪里来（（ WhereWhere ）；）；

开发时间如何安排开发时间如何安排（（ WhenWhen ）；）； 开发开发 (( 或维护或维护 )) 工作打算由谁来做工作打算由谁来做（（ WhoWho ）；）；

需求应如何实现需求应如何实现（（ HowHow ）；）； 为什么要进行这些软件开发或维护为什么要进行这些软件开发或维护修改工作修改工作（（ WhyWhy ）。）。

文档要回答的问题文档要回答的问题wwhhaatt wwhheerree wwhheenn wwhhoo hhooww wwhhyy

可可行行性性研研究究报报告告项项目目开开发发计计划划软软件件需需求求说说明明书书数数据据要要求求说说明明书书测测试试计计划划

wwhhaatt wwhheerree wwhheenn wwhhoo hhooww wwhhyy概概要要设设计计说说明明书书详详细细设设计计说说明明书书用用户户手手册册

操操作作手手册册

测测试试分分析析报报告告开开发发进进度度月月报报

wwhhaatt wwhheerree wwhheenn wwhhoo hhooww wwhhyy项项目目开开发发总总结结程程序序维维护护手手册册 ((维维护护修修改改建建议议))

对文档编制的质量要求对文档编制的质量要求 如果不重视文档编写工作，或是对文档如果不重视文档编写工作，或是对文档编写工作的安排不当，就不可能得到高编写工作的安排不当，就不可能得到高质量的文档。质量的文档。

质量差的文档质量差的文档 使读者难于理解使读者难于理解，，给使用者造成许给使用者造成许多不便多不便

会削弱对软件的管理会削弱对软件的管理（难以确认和（难以确认和评价开发工作的进展情况评价开发工作的进展情况 )) ，，提高软提高软件成本件成本 (( 一些工作可能被迫返工一些工作可能被迫返工 ))

造成造成误操作误操作

对编制高质量文档的要求对编制高质量文档的要求(1) (1) 针对性针对性

文档编制以前文档编制以前应分清读者对象应分清读者对象。按。按不同的类型、不同层次的读者，决定不同的类型、不同层次的读者，决定怎样适应他们的需要。怎样适应他们的需要。

管理文档主要面向管理人员管理文档主要面向管理人员 用户文档主要面向用户用户文档主要面向用户 这两类文档不应像开发文档这两类文档不应像开发文档 ((面向面向开发人员开发人员 ))那样过多使用软件的专用那样过多使用软件的专用术语。术语。

(2) (2) 精确性精确性 文档的行文应当文档的行文应当十分确切十分确切，，不能出不能出现多义性的描述现多义性的描述。同一课题几个文档。同一课题几个文档的内容应当是协调一致，没有矛盾的。的内容应当是协调一致，没有矛盾的。

(3) (3) 清晰性清晰性 文档编写应文档编写应力求简明力求简明，如有可能，，如有可能，配以适当的图表，以增强其清晰性。配以适当的图表，以增强其清晰性。

(4) (4) 完整性完整性 任何一个文档都应当是任何一个文档都应当是完整的完整的、、独独立的立的，它应，它应自成体系自成体系。。

例如，例如，前言部分应做一般性介绍，前言部分应做一般性介绍，正文给出中心内容，必要时还有附录，正文给出中心内容，必要时还有附录，列出参考资料等。列出参考资料等。

同一课题的几个文档之间可能有些同一课题的几个文档之间可能有些部分内容相同，这种重复是必要的。部分内容相同，这种重复是必要的。

不要在文档中出现转引其它文档内不要在文档中出现转引其它文档内容的情况容的情况。。如，一些段落没有具体描如，一些段落没有具体描述，用“见述，用“见 ×××× 文档文档 ××××节”的方式节”的方式 ..

(5) (5) 灵活性灵活性各个不同软件项目，其规模和复杂程度各个不同软件项目，其规模和复杂程度有着许多实际差别，不能一律看待。有着许多实际差别，不能一律看待。

应根据具体的软件开发项目，决定编制应根据具体的软件开发项目，决定编制的文档种类。的文档种类。 软件开发的管理部门应该软件开发的管理部门应该根据本单根据本单位承担的应用软件的专业领域和本单位承担的应用软件的专业领域和本单位的管理能力位的管理能力，，制定一个对文档编制制定一个对文档编制要求的实施规定要求的实施规定。。

对于一个具体的应用软件项目，项对于一个具体的应用软件项目，项目负责人应根据上述实施规定，确定目负责人应根据上述实施规定，确定一个文档编制计划。其中包括：一个文档编制计划。其中包括： 编制哪几种文档，详细程度如何编制哪几种文档，详细程度如何 各文档的编制负责人和进度要求各文档的编制负责人和进度要求 审查审查 // 批准负责人和时间进度安排批准负责人和时间进度安排 在开发时期内各文档的维护、修在开发时期内各文档的维护、修改和管理的负责人，以及批准手续改和管理的负责人，以及批准手续

有关的开发人员必须严格执行这个有关的开发人员必须严格执行这个文档编制计划。文档编制计划。

当所开发的软件系统非常大时，一种文当所开发的软件系统非常大时，一种文档可以分成几卷编写。档可以分成几卷编写。例如，例如， 项目开发计划项目开发计划可分写为：可分写为：

质量保证计划质量保证计划 配置管理计划配置管理计划 用户培训计划用户培训计划 安装实施计划等安装实施计划等。。

系统设计说明书系统设计说明书可分写为：可分写为： 系统设计说明书系统设计说明书 子系统设计说明书。子系统设计说明书。

程序设计说明书程序设计说明书可分写为：可分写为： 程序设计说明书程序设计说明书 接口设计说明书接口设计说明书 版本说明。版本说明。

操作手册操作手册可分写为：可分写为： 操作手册操作手册 安装实施过程。安装实施过程。

测试计划测试计划可分写为： 可分写为： 测试计划测试计划

测试设计说明测试设计说明 测试规程测试规程 测试用例。测试用例。

测试分析报告测试分析报告可分写为：可分写为： 综合测试报告综合测试报告 验收测试报告。验收测试报告。

项目开发总结报告项目开发总结报告也可分写成：也可分写成： 项目开发总结报告项目开发总结报告 资源环境统计。资源环境统计。

应根据应根据任务的规模任务的规模、、复杂性复杂性、、项目负责项目负责人对该软件的开发过程及运行环境所需人对该软件的开发过程及运行环境所需详细程度的判断详细程度的判断，，确定文档的详细程度确定文档的详细程度。。

对国标对国标 GB8567-88GB8567-88 《《计算机软件产品开计算机软件产品开发文件编制指南发文件编制指南》所建议的所有条款都》所建议的所有条款都 可以扩展可以扩展，进一步细分，以适应需要；，进一步细分，以适应需要； 如果条款中有些细节并非必需，如果条款中有些细节并非必需，也可也可以根据实际情况压缩合并以根据实际情况压缩合并。。

程序的设计表现形式程序的设计表现形式，可以使用，可以使用程序流程序流程图程图、、判定表判定表、、程序描述语言程序描述语言 ((PDLPDL)) 、、或或问题分析图问题分析图 ((PADPAD))等。等。

对于对于文档的表现形式文档的表现形式，没有规定或限制。，没有规定或限制。可以使用可以使用自然语言自然语言、也可以使用、也可以使用形式化形式化的语言的语言或或半形式化的语言半形式化的语言。。

当国标《当国标《计算机软件产品开发文件编制计算机软件产品开发文件编制指南指南》中规定的文档种类不能满足某些》中规定的文档种类不能满足某些应用部门的特殊需要时，应用部门的特殊需要时，可以建立一些可以建立一些特殊的文档种类要求特殊的文档种类要求，这些要求可以包，这些要求可以包含含在本单位的文档编制实施规定在本单位的文档编制实施规定中。中。

为使软件文档能为使软件文档能 起到多种桥梁的作用起到多种桥梁的作用 有助于程序员编制程序有助于程序员编制程序 有助于管理人员监督和管理软件的有助于管理人员监督和管理软件的开发开发

有助于用户了解软件的工作和应做有助于用户了解软件的工作和应做的操作，的操作，

有助于维护人员进行有效的修改和有助于维护人员进行有效的修改和扩充扩充

文档的编制必须保证一定的质量。文档的编制必须保证一定的质量。