您好,欢迎来到标准下载网!

【电子行业标准(SJ)】 软件文档管理指南

本网站 发布时间: 2024-07-05 03:40:31
  • SJ20523-1995
  • 现行

基本信息

  • 标准号:

    SJ 20523-1995

  • 标准名称:

    软件文档管理指南

  • 标准类别:

    电子行业标准(SJ)

  • 标准状态:

    现行
  • 发布日期:

    1995-05-25
  • 实施日期:

    1995-12-01
  • 出版语种:

    简体中文
  • 下载格式:

    .rar.pdf
  • 下载大小:

    1,004.38 KB

标准分类号

  • 中标分类号:

    机械>>机械综合>>J01技术管理

关联标准

出版信息

  • 页数:

    21页
  • 标准价格:

    19.0 元

其他信息

标准简介标准简介/下载

点击下载

标准简介:

标准下载解压密码:www.bzxz.net

SJ 20523-1995 软件文档管理指南 SJ20523-1995

标准内容标准内容

部分标准内容:

中华人民共和国电子行业军用标准FL0137
SJ20523-1995
软件文档管理指南
Guideline for software documentation management1995-05-25发布
1995-12-01实施
中华人民共和国电子工业部
3批准
1范围
1.1主题内容
1.2适用范围
2引用文件
3定义
4一般要求
5详细要求
5.1软件文档
5.2文档管理
5.3所需资源·
附录A文档政策检查表(参考件)附录B文档计划检查表(参考件)目
附录C文档管理规程检查表(参考件)附录D
软件文档编制时间(参考件)
附录E各评审点评审内容(参考件)附录F
软件文档签署者(参考件)
中华人民共和国电子行业军用标准软件文档管理指南
Guideline for software documentation management1范围
1.1主题内容
SJ20523-1995
本指导性技术文件规定了软件文档种类、质量等级以及文档管理的详细要求。1.2适用范围
本指导性技术文件适用于软件的开发、使用和维护。2引用文件
GB8566--88
GB8567-88
GB/T11457—89
GJB437-88
GJB438—88
3定义
计算机软件开发规范
计算机软件产品开发文件编制指南软件工程术语
军用软件开发规范
军用软件文档编制规范
除下列定义外,其它定义见GB/T11457。3.1文档计划documentationplan一个描述文档编制工作方法的管理用文档。该计划主要描述要编制佬类型的文档,这些文档的内容是什么,何时编写,由谁编写,如何编写,以及什么是影响期望结果的可用资源和外界因素。
3.2文档等级levelofdocumentation对所需文档的一个说明,它指出文档的范围、内容、格式及质量。可以根据项目、费用、预期用途、作用范围或其它因素选择文档等级。4一般要求
软件文档是描述软件产品开发及开发结果、使产品能有效地使用或在合适的时候使产品能转换或移植到其它环境的所有可复制又便于人们使用的资料。软件文档有六个重要功能:管理依据;任务之间联系的工具;质量保证;教育与参考:软件维护支持;历史档案。
软件文档分为开发文档和产品文档两类。1995-05-25发布
中华人民共和国电子工业部
1995-12-01实施
SJ20523—1995
软件文档是计算机软件开发的一个关键部分。如果文档有错,有遗漏,或未完成,则开发工作必将受到损害,并且这类损害多半无法补救。好的文档依赖两个因素:较好的文档技术和管理工作。一且管理人员清楚地理解软件文档是什么,他们就能更好地计划,支持和监督文档工作。软件文档编制涉及整个软件开发生存周期,是面向用户的软件产品的一个必需的组成部分。管理人员把文档工作提交给某个组织,并且按照他们制订的政策和过程对承担的义务提供具体根据。管理人员帮助制订文档计划,确定需要哪些文档类型,提出文档内容的要点,确定文档的质量要求,以及如何达到和保证质量要求。安排文档编制工作的优先次序,支撑文档的制作、分发和更新,使文档要求和整个项目的要求相平衡。对有关软件开发的文档进行管理需要人员、设备和资金。管理人员负责分配资源,并在项目开发的各个阶段维持这些资源。5详细要求
5.1软件文档
5.1.1文档用途
文档具有六个重要功能:
a.管理依据;
b.任务之间联系的工具;
c.质量保证;
d,教育与参考;
e.软件维护支持;
f.历史档案。
5.1.1.1管理依据
在系统开发过程中,管理部门必须了解开发进度,存在的问题和预期目标。根据进度表跟踪进度,并根据下一阶段计划安排的定期报告提供了项目的可见性。定期报告还提醒各级管理部门注意该部门对项目承担的责任以及它对该部门效率的重要性。开发文档规定若干个检查点和进度表,使管理人员可以评定项目的进度。如果开发文档有遗漏,不完善,或内容陈旧,则管理人员将失去个跟踪和控制项目的重要工具。5.1.1.2任务之间联系的工具
大多数软件开发项目通常被划分成若干个任务,并由不同的小组去完成。学科方面的专家建立项目,分析员闸迷系统需求,设计员为程序员制定总体设计,程序员提供详细的程序代码,质量保证专家和审查员评价整个系统的完整性和性能,负责维护的程序员改进各种操作或增强、扩充功能。
这些人员需要以某种方式互相联系,从而提供了需要时可以复制、分发和引用的资料,因而,任务之间的联系是文档的一个重要功能。大多数系统开发方法为任务之间的联系规定了一些正式文档。分析员向设计员提供正式需求说明,设计员向程序员提供正式设计规格说明,等等。
5.1.1.3质量保证
那些负责软件质量保证和评估系统性能的人员需要程序规格说明、测试和评估计划、测试该系统用的各种质量标准,以及关于期望系统完成什么功能和系统怎样实现这些功能的清晰—2-
SJ20523-1995
说明。必须制订测试计划和测试规程,并报告测试结果。必须说明和评估安全控制、计算、检验数(位)例行程序及其它控制技术。这些文档的提供可满足质量保证人员和审查人员的需要。
5.1.1.4教育与参考
软件文档的另一个功能是使系统管理员、操作员、用户、管理人员和其它有关人员了解系统如何工作,以及为了达到他们的各自的目的,如何使用系统。5.1.1.5软件维护支持
维护人员需要软件系统的详细说明以帮助他们熟悉系统、找出并修正错误、改进系统以适应用户需求的变化或适应系统环境的变化。5.1.1.6历史档案
一个常被忽视的软件文档功能是软件文档可用作将来项目的一种资源。通常文档记载系统的开发历史,以使有关系统结构的基本思想可供以后的项目利用。由于技术发展如此迅速,系统开发人员可以审阅以前的那些系统以查明什么部分已试验过了,什么部分运行得很好,什么部分因某种原因难以实行而被剔除。良好的系统文档有助于把程序移植和转移到各种新的系统环境中。文档还能通过图解说明软件和组织问题的有效和无效的解决方法,以避免各种错误启动。
5.1.2文档种类
一套完整的系统文档包含系统开发和系统操作两方面的描述。为此,把文档划分成两类是有益的:
开发文档
b.产品文档-
一描述开发过程本身;
一描述开发过程的产物。
图1是这两类软件文档的一个图示,它展示每类文档所包含的各种文档。开发文档
测试计划
项目开发计划
质量保证计划
设计规格说明
需求和功能
规格说明
可行性研究报告
产品文档
用户培训和参考资料
系统管理员手册/操作员手册
维护手册
程序文档
图1软件文档的类型
SJ20523-—1995
图1给出了主要的软件文档类型。文档名称可能随不同的方法学稍有改变。5.1.2.1开发文档
描述系统开发的开发文档,详细说明用户需求和该系统的计算机程序的功能。开发文档还详细说明这些程序应如何构造、如何测试、及如何保证程序的质量。开发文档与软件“系统生存周期”的概念密切相关。生存周期把开发过程划分成若干阶段,每个阶段有它自已的里程碑。管理人员利用这些阶段去监督进度,并安排工作使项目按照进度表进行。
5.1.2.1.1典型的开发文档
开发文档包含以下内容:
可行性研究报告及立项申请;
需求和功能规范说明(系统执行什么功能);b.
设计规范说明,包括数据存储和程序编制规格说明;c.
开发计划;
每个阶段的进度表及进度表修改记录;e.
f.测试和实现计划;
质量保证计划、准则及进度;
h,当系统开发时用于记录对系统作各方同意的修改的修改控制表或备忘录(备忘录中记载的信息还应反映到更新后的开发文档内)5.1.2.1.2管理人员在开发文档编制工作中的作用管理人员保证各个开发阶段是经严格定义的,各个阶段的任务表达清楚、有进度安排、并形成文档。
严格定义的阶段和任务为管理人员提供一系列检查点。根据各个阶段的名称和标志,管理人员能够监督开发工作进度,同时确保按时完成系统的开发文档。有关开发文档的约定通常被作为开发方法学的一部分。这些约定是表明意图、提出目标、确立最后期限的文档。如果这些文档是最新的,且编写得很好,那么就能保证开发过程的全体参加者了解他们的工作处于哪个阶段,下一步将进展到何处。最初的良好打算必须后随以各种行动,例如提供书面材料,并坚持在下一阶段可以开始之前按照标准完成本阶段的相应文档。5.1.2.2产品文档bzxz.net
开发文档是跟踪项目进度最重要的管理工具,而产品文档为软件系统的有效使用、运行、维护、转换及移植提供必需的资料。一个程序产品或软件产品是由某个单位负责支撑的一组文档完备、经过严格测试的计算机程序。产品可能在市场上买到,也可能是由非商业性的机构生产,但其目的是供广泛应用和使用。产品与供私人或个人使用的试验性程序或临时用程序不同,对于后者而言,由于程序是暂时性的,且限于开发者使用,所以文档要求可能是最低限度的。如果一个程序要供开发者以外的人使用,则必须作为一个产品来编写文档;否则,大量的问题可能使产品失败。
产品文档通常供以下三类用户使用:a.维护或改进产品的程序员;
b.在计算机系统上运行该产品的操作员4
SJ20523-1995
c.用该产品录入数据或检索信息的最终用户。产品文档还可以包含监督产品使用的管理人员用的手册和资料,介绍产品用途及评述有关该产品使用的软、硬件环境的宣传资料,以及就公众关心的方面描述该产品的公共关系信息。
5.1.2.2.1程序文档
负责维护或改进一个现有程序的程序员需要那些描述该程序应该完成什么功能、何时完成的资料。程序员需要有关程序逻辑、最终的数据存储设计规格说明、及功能描述方面有图解和叙述。
虽然程序文档的形式不如文档实体那么重要,但是通常有以下几类程序文档编制形式。直接插人的注释为了使别人能读懂,任何编写得好的计算机程序都应包含数量充分的注释。开发程序员在编写程序时应准备这些注释,当程序改变时应对这些注释进行更新。有关这类程序文档的准则通常反映在各种程序编制标准内。一般而言,每个程序模块包含该模块的逻辑、用途、及基本原理的描述。这种注释还可包含子程序引用及条件处理的描述。
对特定代码行作特定注释,这对特殊的编码也是必要的。例如,在关于某个计算的一个算法(公式)之前可以加一条说明公式来源、所需的数据、计算结果及程序如何利用该结果的注释。保证开发程序员利用程序设计语言的各种功能把注释插入到程序中并更新那些注释,这是健全的软件开发管理的一个重要方面。图形表示法程序逻辑的词语描述通常过于复杂,以至难于理解。描述贯穿个程序或系统的数据流的示意图或流程图向维护程序员展示他们正在分析研究的那个程序段与系统内别的程序或模块的联系。
存储说明维护程序员必须了解数据存储在何处,按何种格式存储。没有这些基本信息,就不可能执行他们的维护任务。正式系统文档有时候维护程序员不仅需要直接插入的注释和说明、图示描述及存储说明,而且需要附加的方案描述。软件产品越复杂,越需要正式的、文字描述的系统或程序文档。显然,某些程序员用的文档也是开发文档。功能规格说明,数据存储规格说明等,都是作为开发文档的一部分产生的,由于它们包含了维护程序员使系统保持有效运行所需要的信息,因而成为产品文档的一部分。
5.1.2.2.2系统管理员手册/操作员手册系统管理员手册/操作员手册告诉负责运行系统软、硬件的人员:为了支撑该系统他们必须了解什么。
具体可供使用的资料要随软件产品本身而定。但是,必须确定为系统管理员和操作员提供详细资料的任务,使该任务按计划完成,并使资料始终反映最新的情况。5.1.2.2.3用户培训和参考资料
如果没有足够供用户使用的资料,产品文档就不完整。用户至少需要两类资料:。培训资料——帮助用户迅速熟悉系统的使用;b,参考资料一一帮助用户找到有关系统使用的一些具体问题的答案。此外,用户可能想知道他们怎样使用系统才能适应本单位的所有业务。为此,用户需要一些说明系统各个部分相互如何配合以及他们所使用的部分会对系统其余部分产生什么影响的系统综述和一览表。
SJ20523-1995
满足上述要求的文档的格式可能改变。但是,必须对这些文档制订计划、组织编写、并在该系统提交用户单位使用之前完成。5.1.3确定文档编制的职责
在软件产品开发过程中:
a.对单位负责项目的专家来说,要提供有关该单位的各项职能的信息;b.对单位内部或外部的计算机专家来说,要提供数据处理专门技术。系统开发方法学通常为这两类人员规定明确的任务。作为系统开发活动定义的一部分,每一类人员充分理解和履行自己的文档编制职责是非常重要的。设计人员和程序员负责描述他们各自任务的文档。单位的项目负责专家负责某些文档。这些专家为下述文档提供信息,并可以编写其中的一部分内容:a.可行性研究报告;
测试和质量保证计划;
c.需求规格说明。
他们通常负责:
a:把系统结合到本单位的业务中去的计划;b.各类进度表;
c.用户培训和参考材料。
软件生存周期的文档写制
在软件产品开发和运行的各个阶段都需要文档。应把文档的编制看作贯穿该产品整个生存周期的一项连续性工作。从项目启动初期的草案开始,经多方面审查后进行更新,再在开发过程中加以修改。在接下来的程序编制、测试和运行过程中,由于用户反馈、已改变的用户需求和系统环境而引起产品的修改过程中都有相应的文档编制工作。在整个软件生存周期中需要确定:a.
要产生哪些文档;
这些文档应采用什么格式;
这些文档应何时完成;
如何使这些文档始终反映最新的情况;d.
由谁编写这些文档;
由谁维护这些文档;
如何分发原始文档及其更新后的版本。g
5.1.5文档的质量等级
仅仅因为规章、传统的做法或合同的要求去制作文档是不够的。管理人员还必须确定文档的质量要求以及如何达到和保证质量要求。质量要求的确定取决于可得到的资源、项目的大小和风险,可以对该产品全部文档中的每个文档的格式及详细程度作出明确的规定。每个文档的质量必须在文档计划期间就有明确的决断。文档的质量可以按文档的形式和陈列要求划分为四级。
最底限度文档(1级文档)1级文档适合开发工作量低于二个人月的开发者自用程序。该文档应包含程序清单,开发记录,测试数据和程序简介。内部文档(2级文档)2级文档可用于在精心研究后被认为似乎没有与其它用户共享潜6
SJ20523-1995
力的专用程序。除1级文档提供的信息外,2级文档还包括程序清单内足够的注释以帮助用户安装和使用程序。正式文档工作量极小。工作文档(3级文档)3级文档适合于由同一单位内若干人使用的程序,或可被其它单位使用的程序。
正式文档(4级文档)4级文档适合那些要正式发行供普遍使用的软件产品。关键性程序或具有重复管理应用性质(如工资计算)的程序需要4级文档。4级文档应遵守GJB438的有关规定。
质量方面需要考虑的问题既适合文档的结构,也适合文档的内容。文档内容可以根据正确性、完整性和明确性来判断。而文档结构由各个组成部分的顺序和总体安排的简单性来测定。要达到这四个质量等级,需要的投入和资源逐级增加,质量保证机构必须处于适当的行政地位以保证达到期望的质量等级。5.1.6文档标准和指南
标准和指南为评判开发文档和产品文档的完整性、有效性和适用性提供了依据。还没有标准或希望评定他们现有标准的那些单位可从GJB438中得到帮助。无论是单位内部制订的还是选用现存的,大多数标准和指南提供适用于许多不同情况的概括性指示。为了使标准和指南适用具体的项目,需要有管理方面的判断能力。管理人员帮助确定需要哪几类文档,要提供多少文档,文档要包含什么内容,要达到哪一个质量等级,以及文档何时产生。因此,一些标准和指南仅起建议的作用,而不是严格的规范。如果订一个软件合同,则该合同应要求文档不仅符合现有的标准和指南,而且应规定所需文档的类型、文档的质量等级、审查及确认的方法。5.2文档管理
技术指导和管理指导都能为各种文档问题提供解决办法。鉴于它的重要性,本指南着重于建立在以下三个要素基础上的管理指导:a.管理部门和人员对文档工作的责任。这种责任不但要认识到正式或非正式文档是重要的,而且要认识到文档工作必须包括计划、编写、修改、形成、分发和维护;b,管理部门对文档工作的支持。管理人员可以为开发文档的人员提供指导和实际鼓励,可以指定开发文档的编写人员,可以使各种资源有效地用于文档开发:c.这种责任和支持包括:
1)关于建立、登记、出版系统文档和软件文档的各种政策;2)把文档计划作为整个开发工作的一个组成部分;3)为确定文档质量、测试质量、以及提供达到和审查质量的各种方法而建立的各种规程;4)为文档的各个方面确定和准备的各种标准和指南;5)有益于文档工作的团体风气,以及管理人员明显支持把文档工作结合到开发工作中;6)不断检查已建立起来的处理过程,以保证符合政策和各种规程并遵守有关标准和指南。5.2.1文档政策
由单位内最高层制定和支持的各项政策指导所有较低层次的决策人员。政策仅提供宏观指导,不提供做什么或如何做的详细指示。政策可以是非正式的、非文字书写的、不公开的,但是正式的、文宇书写的、众所周知的政策清楚地规定高质量软件文档工作所需要的规范。本指南论述了文档在软件系统的计划、开发及运行期问所起的极其重要的作用。在系统-7
SJ20523-1995
升级、维护、转换或移植时文档也是最重要的。鉴于软件文档政策的重要性,应该制定一些有关软件文档政策的正式条款,并通知所有与该政策有关的人员,使他们了解政策内容。政策应支持文档工作的基本要点:a.文档编制工作涉及整个软件生存周期。在项目的早期阶段需要文档,必须对文档加以维护,在开发过程中文档必须是有效的。在完成开发后,只要程序还在使用,文档对该程序的应用、维护、增强、转换或移植也是有效的;b。对文档编制工作应加以管理。管理人员和文档开发人员应制订一个概述文档产品、进度表、负责人、资源、评审和质量保证措施的详细计划。为了得到文档和维护文档,指导和控制是必需的;
c,文档应该是为各种类型的用户编写的。用户可以是管理人员,分析员,不具备计算机专业知识的专业人员,维护程序号,事务员。根据所承担的任务,用户需要详细程度不一和不同表示形式的文档。文档专业人员应该完完全全地负起为不同用户设计不同类型的文档的责任;
d,应把文档工作结合到整个系统开发过程中,这样的开发过程应加以明确定义;e,为了有助于开发和维护软件产品(包括文档在内),在整个软件生存周期内应该规定支撑工具,只要经济上可行,任何阶段都应使用支撑工具;I.应该确定和使用现有的各项标准,或开发一组符合项目的规模、范围和陈列要求等特点的标准。
附录A(参考件)中的检查表为制定一个政策条款或评估现有政策条款的有效性和完整性提供帮助。
5.2.2文档计划
文档计划可以是整个项目计划的一部分或是一个独立的文档。应该编写文档计划并把它分发给全体开发组成员,作为文档重要性的具体证据和管理部门文档工作责任的备忘录。对于小的、非正式的项目,文档计划可能只有一页纸,对于较大的项目,文档计划可能是一个综合性的正式文档,这样的文档计划遵循各项严格的标准及正规的审查和批准过程。5.2.2.1文档编制计划
计划应及早开始,对计划的审查应贯穿项目的全过程。如同任何别的计划一样,文档计划指出未来的各项活动,当需要修改时必须加以修改。导致对计划作适当修改的常规审查应作为该项目工作的一部分,所有与该计划有关的人员都应得到文档计划。文档计划一般包括以下几方面内容:列出应编制文档的目录;
b.提示编制文档应参考的标准。GJB438规定了编制每个文档包括的内容和格式;指定文档管理员;
d.提供编制文档所需要的条件。落实文档编写人员、所需经费以及编制工具等;e。明确保证文档质量的方法。为了确保文档内容的正确性、合理性;应采取一定的措施,如评审、鉴定等等;
f.绘制进度表。以图表形式列出在软件生存周期各阶段应产生的文档、编制人员、编制日期、完成日期、评审日期等。附录B(参考件)中的检查表为制定一个文档计划或评估现有文档计划的完整性提供帮助。
SJ20523-1995
此外,文档计划规定每个文档要达到的质量等级,以及为了达到期望的结果必须考虑哪些外部因素。
文档计划还确定该计划和文档的分配,并且明确叙述参与文档工作的所有人员的职责。5.2.2.2文档管理员
对于较大的项目,应指定一个项目文档管理员负责收集项目开发资料,维护基本的文档集及维护一个项目文档的索引。根据项目的范围及复杂程度,文档管理员的工作可由某个工作人员兼管,或由个专职人员来负责。除了收集文档和制作个供查找文档用的索引以外,项目文档管理员还应维护:a。简短的重大事件记录;
b。每月的计算机时间估算值、实际值;每月的工作人员时间估算值、实际值;c.
d.修改估算值的列表;
e.实际所耗时间的一览表。
这些记录和编入进度表内的审查点和其它常规审查一起,为管理人员提供项目控制所需要的信息。
5.2.3文档管理规程
文档管理规程必须符合5.2.1概述的那些政策,并适用于整个软件产品生存周期内的文档的编制和使用。这些规程提出关于文档的计划、编制、审查、制作和分发的逻辑顺序。这些规程内含审批、质量保证、及若干控制点,概述修改步骤、存储和维护要求、以及更新方法。附录C(参考件)中的检查表能帮助设计合适的规程或有助于评定现有规程的有效性。5.2.3.1计划制定
软件项目一旦确定,就应制订项目开发计划(包括文档计划)。文档计划的制定应遵照5.2.2.1的规定。5.2.3.2文档编写
文档的编写是件非常细致的工作,从最初提出文档编写提纲开始,经过逐步充实、完善,并经反复检查和修改,直至正式交付使用为止的整个过程。编写文档应注意以下几点:
a。文档编写时间应与软件开发同步,在软件生存周期的每一个阶段都应完成相应的文档编写工作,详见附录D(参考件);b。按文档计划规定的文档数量和质量要求编写文档;c。按GJB438,或GB8567,或本单位指定的标准内容和格式,编写相应文档;d.文档用纸的格式由各单位按有关标准规定执行;e.每个文档必须装订成册,并加封面和目次;f。归档用的文档还应有页,用于各责任者的鉴署。5.2.3.3文档编号
为便于管理,软件文档应按编号法进行编号。编号方法有十进分类法、隶属法等,各单位可根据本单位实际情况确定一种编号方法。不论何种方法,编号应具有唯一性。5.2.3.4文档审查
文档审查十分重要,文档审查必须与技术审查结合起来。为了提高软件产品的质量,一个有效的方法就是在软件开发的每个阶段,对该阶段所形成-9-
SJ20523-1995
的文档进行严格的审查,这样可尽早发现问题,并及时采措施予以解决,从而确保文档内容的正确性,避免或减少大的返工,同时为进入下一阶段的工作做好组织上和技术上的准备。对一些大项目,正规审查通常在开发方法学指导下进行。正规审查应包括文档审查,这是为了保证文档不但正确,而且内容是最新的。如果对文档与开发工作的其它方面同样重要这一点强调不够,各种问题可能随之而来。对所有描述开发工作和产品的文档进行审查是正规审查过程的组成部分。一开始特别重要的是需求规格说明和设计规格说明的审查。需求审查需求审查进一步确认开发者和设计者已了解用户要求什么,及用户从开发者一方了解某些限制和约束。
需求审查(可能需要一次以上)产生一个被认可的需求规格说明。基于对系统要做些什么的共同理解,才能着手详细设计。用户代表必须积极参与开发和需求审查,参与对需求文档的认可。
设计审查通常安排两个主要的设计审查:概要设计审查,和详细设计审查。在概要设计审查过程中,主要详细审查每个系统组成部分的基本设计方法和测试计划。系统规格说明应根据概要设计审查的结果加以修改。详细设计审查审查计算机程序和程序单元测试计划。设计审查产生的最终文档规定系统和程序将如何设计、开发和测试,以满足一致同意的需求。正规备忘录提供一份有关所有会议的记录。无论项目大小或项目管理的正规化程度,需求审查和设计审查是必不可少的。需求必须说明清楚,用户和开发者双方都必须理解需求,为了能把需求转换成程序及程序成分,设计的细节须经同意并写成文档。
其它审查其它文档的正规审查也是必需的。产品文档的计划应包括对下述内容的审查和认可:
a.编排方式;
b.技术准确度;
覆盖范围的完整性;
d。对读者的适合程度;
图表设计思想及最终因系(也应接受关于技术准确度、适合程度和完整性的单独审查);
f.在语法、标点、及其它构文技巧方面的正确性;g。对格式和别的标准的遵守程度。如果有标准和指南(现有的或制定的),则可以对照这些标准来评判文档。正规审查要保证产品文档是准确的,完整的,而且是适合读者的。附录E(参考件)提供软件开发过程各评审点评审内容。审查一般采用评审会的方式进行,其步骤为:a。由软件开发单位负责人、用户代表、开发小组成员、科技管理人员和标准化人员等组成评审小组,必要时还可邀请外单位的专家参加。b。开会前,由开发单位负责人确定评审的具体内容,并将评审材料发给评审小组成员,要求做好评审准备。
c.由开发单位负责人主持评审会,根据文档编制者对该文档的说明和评审条目,由评审-10
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。
标准图片预览标准图片预览

标准图片预览:






  • 热门标准
  • 电子行业标准(SJ)
  • 行业新闻
设为首页 - 收藏本站 - - 返回顶部
请牢记:“bzxz.net”即是“标准下载”四个汉字汉语拼音首字母与国际顶级域名“.net”的组合。 ©2009 标准下载网 www.bzxz.net 本站邮件:bzxznet@163.com
网站备案号:湘ICP备2023016450号-1