计算机软件文档编制规范
- 格式：ppt
- 大小：335.01 KB
- 文档页数：244
下载文档原格式
合集下载
计算机行业软件开发标准
计算机行业软件开发标准计算机行业是一个快速发展和变化的行业，软件开发是计算机行业中的重要组成部分。
在这个行业中，制定并遵守一定的规范、规程和标准对于保障软件质量、提高开发效率以及提升用户体验非常重要。
本文将介绍计算机行业软件开发的一些重要标准和规范，帮助开发者和企业更好地进行软件开发工作。
一、需求分析阶段：需求分析是软件开发的关键阶段之一，它直接影响软件的最终质量。
在需求分析阶段，开发者需要明确软件需求，对用户的需求进行详细的了解和沟通。
为了规范需求分析工作，可以参考以下标准和规范：1.1 用户需求文档：用户需求文档是需求分析的基础，它详细描述了用户对软件的功能、性能、界面等各个方面的需求。
用户需求文档应包括以下内容：需求背景、需求描述、功能需求、非功能需求、界面设计等。
编写用户需求文档时，需要注意需求描述的准确性、完整性和可测试性，以便后续阶段的开发和测试工作。
1.2 用例规范：用例规范是对软件功能的进一步细化和描述，它详细说明了软件的功能、操作流程和预期结果。
用例规范应包括用例名称、前置条件、主要步骤、预期结果等。
编写用例规范时，需要结合用户需求文档，明确软件的功能和操作流程，以便开发人员、测试人员和用户更好地理解和验证软件需求。
1.3 数据流程图：数据流程图是描述系统中数据流动和处理的图形化工具。
它可以清晰地展示系统中的数据输入、输出、处理和存储过程等。
在需求分析阶段，开发人员可以借助数据流程图来了解系统中的数据流动，分析系统的复杂性和瓶颈，并为后续的设计和开发提供参考。
二、设计阶段：设计阶段是将需求转化为可执行代码的过程，它对软件开发的质量和效率起着决定性的作用。
在设计阶段，也有一些标准和规范可以参考：2.1 软件架构规范：软件架构规范是指在软件设计过程中应遵循的一些原则和规则，用于指导软件的结构和组织。
它主要包括软件的层次结构、模块划分、模块间的接口和通信方式等。
在制定软件架构规范时，需要考虑软件的可维护性、可扩展性、性能和安全性，以及满足用户需求的功能和用户体验。
GB8567-2006软件开发计划
GB/T 8567-2006《计算机软件文档编制规范》7.2软件开发计划（SDP）说明：1. 《软件开发计划》（SDP）描述开发者实施软件开发工作的计划，本文档中“软件开发”一词涵盖了新开发、修改、重用、再工程、维护和由软件产品引起的其他所有的活动。
2. SDP是向需求方提供了解和监督软件开发过程、所使用的方法、每项活动的途径、项目的安排、组织及资源的一种手段。
3. 本计划的某些部分可视实际需要单独编制成册，例如，软件配置管理计划、软件质量保证计划和文档编制计划等。
软件开发计划的正文的格式如下：1 引言本章分为以下几条。
1.1 标识本条应包含本文档适用的系统和软件的完整标识，（若适用）包括标识号、标题、缩略词语、版本号和发行号。
1.2 系统概述本条应简述本文档适用的系统和软件的用途，它应描述系统和软件的一般特性；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构；标识当前和计划的运行现场；列出其他有关的文档。
1.3 文档概述本条应概述本文档的用途和内容，并描述与其使用有关的保密性和私密性的要求。
1.4 与其他计划之间的关系（若有）本条描述本计划和其他项目管理计划的关系。
1.5 基线给出编写本项目开发计划的输入基线，如软件需求规格说明。
2 引用文件本章应列出本文档引用的所有文档的编号、标题、修订版本和日期，本章也应标识不能通过正常的供货渠道获得的所有文档的来源。
3 交付产品3.1 程序3.2 文档3.3 服务3.4 非移交产品3.5 验收标准3.6 最后交付期限列出本项目应交付的产品，包括软件产品和文档。
其中，软件产品应指明哪些是要开发的，哪些是属于维护性质的；文档是指随软件产品交付给用户的技术文档，例如用户手册、安装手册等。
4 所需工作概述本章根据需要分条对后续章描述的计划作出说明，（若适用）包括以下概述：a. 对所要开发系统、软件的需求和约束；b. 对项目文档编制的需求和约束；c. 该项目在系统生命周期中所处的地位；d. 所选用的计划/采购策略或对它们的需求和约束；e. 项目进度安排及资源的需求和约柬；f. 其他的需求和约束，如：项目的安全性、保密性、私密性、方法、标准、硬件开发和软件开发的相互依赖关系等。
软件文档国家标准与写作要求
软件文档的编写原则
所有的章节都可以进一步细分或缩并，以适应实际需要。
程序的设计表现形式可以使用多种形式，如流程图、判定表、等其 他表现形式。
按规定：重量不超过30公斤的行李可免费托运。重量超过30公斤时， 对超运部分，头等舱国内乘客收4元/公斤；其它舱位国内乘客收6元 /公斤；外国乘客收费为国内乘客的2倍；残疾乘客的收费为正常乘 客的1/2。
（6）详细设计说明书
（7）数据库设计说明书
本指南不仅给出了这十四种文档的编制指导，同时，本指南也是这十四种文 档编写质量的检验准则。
2、软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南
软件需求说明编制指南为软件需求的实践提供了一个规 范化的方法，主要描述了软件需求说明（Software Requirements Specifications，简称SRS）所必须的内容 和质量。
软件需求标准适用范围
1. 指南适用对象 软件客户（Customers），以便精确地描述他们想获得什么样的产品。 软件开发者（Suppliers），以便准确地理解客户需要什么样的产品。 2. 指南目的 对于任一单位和（或）个人，要实现下列目标： a. 要提出开发规范化的SRS提纲； b. 定义自己需要的具体的格式和内容； c.产生附加的局部使用条款，如SRS质量检查清单或者SRS作者手册等。
实例
4、软件文档管理指南
软件文档管理指南
软件文档管理指南是为那些对软件或基于软件的产品的开发负有职 责的管理者提供软件文档的管理指南。其目的在于协助管理者在他 们的机构中产生有效的文档。
（1）软件文档管理涉及策略、标准、规程、资源和计划，管理者必 须关注这些内容，以便有效地管理软件文档。 （2）软件文档管理期望应用于各种类型的软件，从简单的程序到复 杂的软件系统。并期望覆盖各种类型的软件文档，作用于软件生存 期的各个阶段。 （3）不论项目的大小，软件文档管理的原则是一致的。对于小项目， 可以不采用本标准中规定的有关细节。管理者可剪裁这些内容以满 足他们的特殊需要。 （4）软件文档管理是针对文档编制管理而提出的，不涉及软件文档 的内容和编排。
计算机软件工程国家标准
计算机软件工程国家标准计算机软件工程国家标准是指根据国家有关法律法规和标准化管理制度，对计算机软件工程领域的相关标准进行规范和统一的文件。
其制定的目的是为了提高计算机软件工程的质量、效率和可靠性，保障软件产品的安全性和稳定性，促进计算机软件产业的健康发展。
首先，计算机软件工程国家标准涵盖了软件开发、测试、维护、管理等方面的规范和要求。
在软件开发过程中，标准规定了需求分析、设计、编码、测试、部署等各个阶段的流程和方法，以及相应的文档和工件的编制要求。
在软件测试方面，标准规定了测试计划、测试用例设计、测试执行、缺陷管理等方面的规范和流程。
在软件维护方面，标准规定了变更管理、问题管理、配置管理等方面的要求。
在软件项目管理方面，标准规定了项目计划、进度控制、风险管理、质量管理等方面的规范和要求。
其次，计算机软件工程国家标准还涉及了软件工程领域的相关技术标准和方法标准。
例如，对于软件开发过程中的各种方法和工具，标准规定了其应用的要求和指导。
对于软件测试过程中的自动化测试、性能测试、安全测试等方面，标准规定了相应的技术标准和方法标准。
对于软件项目管理过程中的项目评估、过程改进、度量分析等方面，标准也规定了相应的技术标准和方法标准。
最后，计算机软件工程国家标准对软件工程领域的相关人员和组织也提出了一些要求。
例如，对于软件开发人员和测试人员，标准规定了其必须具备的知识和技能，以及相关的培训和认证要求。
对于软件开发组织和测试组织，标准规定了其应具备的资源和环境，以及相关的过程和管理要求。
综上所述，计算机软件工程国家标准是对计算机软件工程领域的相关标准进行规范和统一的文件，其制定的目的是为了提高软件工程的质量、效率和可靠性，保障软件产品的安全性和稳定性，促进计算机软件产业的健康发展。
希望通过不断完善和执行这些标准，能够推动我国软件工程领域的发展，提升软件产品的国际竞争力，为我国软件产业的腾飞做出贡献。
计算机软件开发规范
计算机软件开发规范计算机软件开发规范在计算机软件开发过程中，遵循一定的规范是十分重要的。
软件开发规范可以确保开发出高质量、可维护和可扩展的软件，并提高团队的开发效率。
下面是一些常见的计算机软件开发规范。
1. 命名规范- 使用有意义的变量、函数和类名，不使用缩写和单音字母命名。
- 使用驼峰命名法或下划线命名法，例如camelCase或snake_case。
- 避免使用保留字作为命名。
- 命名应具有描述性，可以清晰地表达其用途。
2. 代码风格规范- 使用适当的缩进和空格使代码易于阅读。
- 使用恰当的注释来解释代码的作用和功能。
- 避免使用过长的行，一般限制在80-120个字符之间。
- 代码结构应清晰，使用适当的空行和代码块。
- 考虑使用代码格式化工具来统一代码风格。
3. 错误处理规范- 在代码中及时捕获和处理异常，避免程序崩溃或不可预测的行为。
- 使用合适的异常处理机制，包括抛出和捕获异常。
- 记录错误和异常信息，以便后续分析和修复。
4. 安全规范- 避免使用硬编码的敏感信息，如密码和私钥。
- 对用户输入进行验证和过滤，防止SQL注入和跨站脚本攻击等安全问题。
- 对涉及到敏感数据的处理进行加密保护。
5. 版本控制规范- 使用版本控制系统来管理代码，如Git或SVN。
- 提交代码前进行代码审查，确保代码质量和一致性。
- 使用适当的分支管理策略，如主分支和开发分支。
- 使用有意义的提交消息来解释代码变更。
6. 文档规范- 编写清晰、易于理解的代码注释。
- 编写高质量的用户文档和技术文档，包括安装指南、使用说明和API文档。
- 在代码库中提供README文件，介绍项目背景、使用方法和贡献指南。
7. 测试规范- 编写单元测试、集成测试和系统测试来确保代码的功能和稳定性。
- 使用自动化测试工具进行自动化测试。
- 分析测试覆盖率并完善测试用例，提高测试效果。
8. 性能规范- 编写高效的代码，避免不必要的计算和资源浪费。
(完整版)软件公司文档规范
XXXX科技文档规范产品部年度产品规划（详见附件1）软件需求规格说明(SRS)说明：1.《软件需求规格说明》(SRS)描述对计算机软件配置项CSCI的需求，及确保每个要求得以满足的所使用的方法。
涉及该CSCI外部接口的需求可在本SRS中给出：或在本SRS引用的一个或多个《接口需求规格说明》(IRS)中给出。
2.这个SRS，可能还要用IRS加以补充，是CSCI设计与合格性测试的基础。
软件需求规格说明的正文的格式如下：1范围本章应分为以下几条。
1.1标识本条应包含本文档适用的系统和软件的完整标识，(若适用)包括标识号、标题、缩略词语、版本号和发行号。
1.2系统概述本条应简述本文档适用的系统和软件的用途，它应描述系统和软件的一般特性；概述系统开发、运行和维护的历史；标识项目的投资方、需方、用户、开发方和支持机构；标识当前和计划的运行现场；列出其他有关的文档。
1.3文档概述本条应概述本文档的用途和内容，并描述与其使用有关的保密性或私密性要求。
1.4基线说明编写本系统设计说明书所依据的设计基线。
2引用文件本章应列出本文档引用的所有文档的编号、标题、修订版本和发行日期，也应标识不能通过正常的供货渠道获得的所有文档的来源。
3需求本章应分以下几条描述CSCI需求，也就是，构成CSCI验收条件的CSCI的特性。
CSCI需求是为了满足分配给该CSCI的系统需求所形成的软件需求。
给每个需求指定项目唯一标识符以支持测试和可追踪性。
并以一种可以定义客观测试的方式来陈述需求。
如果每个需求有关的合格性方法(见第4章)和对系统(若适用，子系统)需求的可追踪性(见5.a条)在相应的章中没有提供，则在此进行注解。
描述的详细程度遵循以下规则：应包含构成CSCI验收条件的那些CSCI特性，需方愿意推迟到设计时留给开发方说明的那些特性。
如果在给定条中没有需求的话，本条应如实陈述。
如果某个需求在多条中出现，可以只陈述一次而在其他条直接引用。
计算机软件开发规范
计算机软件开发规范计算机软件开发规范是指在软件开发过程中，为了确保软件质量和开发效率，需要遵循的一系列规定和准则。
下面是一个关于计算机软件开发规范的1000字简要介绍：1.代码风格规范：开发人员需要统一遵循一套代码风格规范，包括缩进、命名规则、注释等。
这样做可以使代码更加易读、易理解，提高代码的可维护性。
2.版本控制规范：开发人员需要使用版本控制工具来管理软件开发过程中的代码变更。
每个开发人员都应该有自己的分支，同时还需要定期合并主干分支的代码。
3.代码复用规范：在软件开发过程中，尽量使用已有的模块和库，避免重复造轮子。
这样可以减少开发时间和成本，并提高软件的稳定性。
4.单元测试规范：在代码编写完成后，进行单元测试是非常重要的一步。
开发人员需要编写针对每个模块的单元测试用例，并确保单元测试覆盖率达到要求。
5.异常处理规范：在软件开发过程中，不可避免会遇到各种异常情况。
开发人员应该根据不同的异常情况编写相应的异常处理代码，并确保程序能够优雅地处理异常，避免中断。
6.文档编写规范：良好的文档编写是软件开发中不可或缺的一部分。
开发人员需要及时维护和更新项目文档，包括需求文档、设计文档、API 文档等。
7.代码审查规范：在代码编写过程中，开发人员需要定期进行代码审查。
通过代码审查可以发现潜在的问题并及时修复，提高代码质量。
8.安全规范：在软件开发过程中，安全是一个非常重要的考虑因素。
开发人员需要遵循安全规范，对用户输入进行有效的校验和过滤，防止代码注入等安全威胁。
9.性能规范：在软件开发过程中，性能是一个关键指标。
开发人员需要优化代码，减少资源消耗，提高软件的响应速度和并发能力。
10.团队协作规范：在团队开发中，良好的协作是非常重要的。
开发人员需要及时分享信息、交流问题，并遵循团队协作规范，确保各个开发任务能够按时完成。
总结起来，计算机软件开发规范包括代码风格规范、版本控制规范、代码复用规范、单元测试规范、异常处理规范、文档编写规范、代码审查规范、安全规范、性能规范和团队协作规范等方面。
软件工程国家标准
软件工程国家标准公司标准化编码 [QQX96QT-XQQB89Q8-NQQJ6Q8-MQM9N]GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。
这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。
一、可行性研究报告l 引言编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。
背景说明：a．所建议开发的软件系统的名称。
b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。
c．该软件系统同其他系统或其他机构的基本的相互来往关系。
定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
参考资料列出用得着的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文。
b．属干本项目的其他已发表的文件。
c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2 可行性研究的前提说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。
要求说明对所建议开发软件的基本要求，如：a．功能。
b．性能。
c．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。
d. 输入说明。
系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。
e．处理流程和数据流程。
用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。
f. 在安全与保密方面的要求。
g. 同本系统相连接的其他系统。
h. 完成期限。
目标说明所建议系统的主要开发目标，如：a. 人力与设备费用的减少。
b. 处理速度的提高。
c. 控制精度或生产能力的提高。
d．管理信息服务的改进。
e. 自动决策系统的改进。
软件需求文档格式标准写法计算机专业资料
软件需求文档格式标准写法计算机专业资料软科学与质检中心信息化框架需求说明书一．引言1.1编写目的（阐明开发本软件的目的）；为了保证软科学与质检中心信息化管理系统项目按时保质地完成项目目标，便于中心领导与成员更好地了解项目情况，使项目工作开展的各个过程合理有序，特此以文本的形式，将本项目周期内的工作任务范围、各项工作的任务分解和工作责任、开发进度、项目内外环境条件等内容做出的安排以书面的方式说明。
同时也作为项目生命周期内的所有项目活动的行动基础，以及项目检查工作的依据。
1.2项目背景（标识待开发软件产品的名称、代码；列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户；说明该软件产品与其他有关软件产品的相互关系。
）1.3术语说明（列出本文档中所用到的专门术语的定义和英文缩写词的原文。
）1.4参考资料（可有可无）1）《软科学与质检中心信息化建设项目计划书》2）《软科学与质检中心信息化运用框架》3）《软科学中心管理制度汇编》2月二．项目概述2.1待开发软件的一般描述(描述待开发软件的背景，所应达到的目标，以及市场前景等。
)2.2待开发软件的功能(简述待开发软件所具有的主要功能。
为了帮助每个读者易于理解，可以使用列表或图形的方法进行描述。
使用图形表示，可以采用：· 顶层数据流图；· 用例UseCase图；· 系统流程图；· 层次方框图。
)2.3用户特征和水平（是哪类人使用）(描述最终用户应具有的受教育水平、工作经验及技术专长。
)2.4运行环境（描述软件的运行环境，包括硬件平台、硬件要求、操作系统和版本，以及其他的软件或与其共存的应用程序等。
）2.5条件与限制(给出影响开发人员在设计软件时的约束条款，例如：· 必须使用或避免使用的特定技术、工具、编程语言和数据库；· 硬件限制；· 所要求的开发规范或标准。
软件文档写作要求
需求分析 差会付出高额代价。
设计
优点：支持结构化软件开 编 码 发、控制软件开发复杂性 、促进软件开发工程化。
缺点：阶段间具有顺序性，各阶 段依赖性强，缺乏灵活性。
测试 运行、维护
软件生存周期模型
2。演化模型—快速原型化方法
需求
需求
设计
开
设计
开
编码 测试
编码 反馈
发
测试
反馈 发
集成
集成
核心系统开发
3. 项目质量保证
文档是进行项目质量审查和评价的重要依据，有效文档的提 供，可以满足项目质量保证人员和审查人员的工作需要。
4. 支持培训与维护 合格的软件文档通常都提供有关软件运行、维护和培训的必
要信息，支持软件产品的应用和维护。 5. 支持软件维护
软件文档提供系统开发的全部必要技术资料，有利于维护人 员熟悉系统，开展维护工作；软件维护文档记载了软件维护过 程中软件及其环境变化的全部信息。 6. 记载软件历史
可行性研究与计划 √ √
需求分析
√ √ √ √
√
√
√
软件设计 编码与单元测试 集成与测试 运行与维护
√
√
√
√
√
√
√
√
√
√
√
√
√ √ √
√
软件文档最终需要回答读者关心的下列问题： 1. 为什么要开发、维护或修改这个软件？(Why) 2. 工作目标要满足哪些需求？(What) 3. 需求应如何实现？(How) 4. 开发、维护或修改的工作应由谁来完成？(Who) 5. 开发工作的时间如何安排？(When) 6. 开发工作在什么环境中实现，所需信息从何而来？(Where)
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
5.2 文档（编制）过程的关注点
• 文档编制计划 • 文档开发（编制） • 文档评审
@ by China Electronics Standardization Institute
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
五、文档（编制）过程 5.1 概述
有两种主要类型的标准： a. 产品标准，它规定产品的特征和功能需求； b. 过程标准，它规定开发产品的过程。
计算机文档编制
中国电子技术标准化研究所
ＧＢ／Ｔ８５６７新老版本的主要差异
ＧＢ／Ｔ８５６７－２００6原则上适用于各种类型的开 发方法 ＧＢ／Ｔ８５６７－２００6描述了文档编制过程 ＧＢ／Ｔ８５６７－２００6给出２５种文档的编制格式 要求
１）可行性分析（研究）报告 ２）软件开发计划 ３）软件测试计划
ＧＢ／Ｔ８５６７新老版本的主要差异
４）数据要求说明书 ５）概要设计说明书 ６）详细设计说明书 ７）数据库设计说明书 ８）用户手册 ９）操作手册 １０）模块开发卷宗 １１）测试计划 １２）测试分析报告 １３）开发进度月报 １４）项目开发总结报告
@ by China Electronics Standardization Institute
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
二、GB/T8567-2019制定的依据
主要依据： • ＧＢ／Ｔ８５６６－２００１ 信息技术 软
件生存周期过程 • ＳＪ／Ｔ２０７７８－２０００ 软件开发与
要求
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
四、ＧＢ／Ｔ８５６７－２００6标准结构
１、范围 ２、规范性引用文件 ３、术语和定义 ４、缩略语 ５、文档（编制）过程 ６、文档编制要求 ７、文档编制格式 附录Ａ 面向对象软件的文档编制
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
ＧＢ／Ｔ８５６７新老版本的主要差异
２１）软件产品规格说明 ２２）软件版本说明 ２３）软件用户手册 ２４）计算机操作手册 ２５）计算机编程手册 • 另外给出了面向对象的１０种文档的编制格式
计算机文档编制
中国电子技术标准化研究所
5.3 文档计划
5.3.1 概要 文档管理者应准备一文档计划，此计划规定
在文档创建中要执行的工作。此文档计划应经 需方正式同意，以预示它完全覆盖了需方的要 求。
l 文档计划通常将覆盖整个文档系列。 文档计划应正式地描述计划的文档的范围和 限制，以及重要的文档分析和设计决定。也应 规定在文档开发期间实现的过程和控制。
前准备与批准，以保证所有部门同意目标和所用的 方法。批准后，计划宜尽可能广泛地分发；分发宜 包括所有文档开发人员和可能包括需方人员及子合 同方。
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
j）项目依赖。 k）所要求的人时和成本。 l）项目资源需求，包括需方提供的信息和其 他资源。 m）在软件开发期间，软件变更传送信息给文 档管理者的方法。 n）文档的变更控制和维护的计划（任选）。 o）实现后评审的计划（任选）。
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
ＧＢ／Ｔ８５６７新老版本的主要差异
１４）数据库（顶层）设计说明 １５）软件测试说明 １６）软件测试报告 １７）软件配置管理计划 １８）软件质量保证计划 １９）开发进度月报 ２０）项目开发总结报告
中国电子技术标准化研究所
f）适当处，包括每个文档的安全或机密级。 g）管理文档开发过程的步骤和控制，包括存储、检索、 后备、处理和质量保证（若要求）。 h）所用的生产方法、工具和工具版本。 i）文档开发人员所在的队伍的结构，任选地，包括队 伍选择计划。
l 在文档编写和生产的不同阶段中的工作人员，需 要不同的技巧。编写人员可能要求对正在编写的系统 有好的知识加上写文档的经验；编辑人员可能要求有 编辑经验而对系统知识无要求；版面艺术家可能对所 用的版面工具外，无任何知识要求。
@ by China Electronics Standardiza技术标准化研究所
文档计划应包括（但不限于）以下内容：
a）计划的文档的工作名称、目的、范围和限 制。
b）文档的预定的读者，和使用的目的。
c）文档内容的草案表，带有估计的页数和其 他媒体的等效细节。
应用程序和计算机软件的复杂性日益增加，使得给 使用计算机的用户提供完整的、正确的和易懂的文档 的需要更加迫切。本标准通过规定影响软件文档的质 量的活动（做什么和由谁做），提供达到这些目的的 工具。
@ by China Electronics Standardization Institute
计算机文档编制
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
p）显示适当的里程碑的时间表，包括： 1）文档计划批准；
对于文档的每一项应重复。 l 文档计划宜2）每个草案的准备、评审和改正； 3）可用性测试； 4）打印、装订和发布。 若适当，这些活动的每一个在文档的开发开始以
d）交付：打印副本数，是否提供电子副本， 磁盘和文件格式（包括软件版本）和在何处交 付。
e）版权的拥有者和任何其他所有权。
l 这是复杂的问题，应在合同中规定。
@ by China Electronics Standardization Institute
计算机文档编制
评审宜由合适的有资格的人员执行，这些人员被授 权请求变更和批准文档的内容。
l 需方宜限止评审人员数为评审功能所必需的那些。 需方在批准每个用户文档草案之前，应保证文档的 安全和合法。 为评审交付的文档应包括从文档管理者来的说明书， 说明评审的目的和评审员的职责。
中国电子技术标准化研究所
GB/T 8567-2019
计算机软件文档编制规范
冯惠
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
目次
1 修订背景 ２ 修订依据 ３ 新老版本的差异 ４ 新版标准结构 ５ 文档编制过程 ６ 文档编制要求 ７ 文档编制格式 ８ 小结
5.3.2 文档计划控制 在正式同意后，文档管理者应控制文档计划
和它的发布。文档管理者应保持一份文档计划 副本的分发的清单。若以后文档计划变更了 （得到文档管理者和需方的同意），文档管理 者应保证所有得到文档计划副本的人员，应得 到变更通知。
l 因为，计划的过时的副本可能引起问题， 文档管理者宜禁止计划的未控制的副本并制订 计划的所有副本已经更新的审核过程。
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
用户文档的评审应由需方实现，包括当需要时与文 档管理者讨论。
l 评审的目的是保证提交的材料是完整的和正确的 并满足了在合同和文档计划中定义的需方的需要。
文档编制 • ＩＳＯ／ＩＥＣ１５９１０：１９９９ 信息
技术 软件用户文档过程
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
三、ＧＢ／Ｔ８５６７新老版本的主 要差异
• ＧＢ／Ｔ８５６７－１９８８主要适用于瀑布 模型开发方法
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
5.5 评审
5.5.1 概述
本节规定文档评审的要求和相关活动。本节 主要以用户文档的评审为例说明。对于开发文 档的评审，由供方组织和实施。而批准由开发 组织的上级技术机构实施。更要着重经常性的、 非正式的注重实效的评审。不是要追求形式。
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
一、本标准修订的背景
ＧＢ／Ｔ８５６７－１９８８版是参考英国某 公司的文档标准，结合当时国内软件开发的经 验，而且主要是针对瀑布模型的开发方法而制 定的。该标准的发布与实施对我国上世纪八十 年代、九十年代的软件开发发挥了重要作用。 但随着时间的推移，软件工程技术的发展与提 高，目前来看，８８版已经不适应软件产业发 展的需要，因此修订ＧＢ／Ｔ８５６６－１９ ８８版势在必行。
@ by China Electronics Standardization Institute
计算机文档编制
中国电子技术标准化研究所
5.4 文档开发
按文档计划规定进行文档开发。通常， 在进行文档开发前，要规定文档的格式 （风格）。在软件的开发和管理过程中 需要那些文档，每种文档的规范在下面 说明。