计算机软件文档编制规范
(国内标准)GB-软件开发主要文档编写规范
231 GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。
这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。
一、可行性研究报告l 引言1.1 编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。
1.2 背景 说明：a ．所建议开发的软件系统的名称。
b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。
c ．该软件系统同其他系统或其他机构的基本的相互来往关系。
1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4 参考资料列出用得着的参考资料，如：a ．本项目的经核准的计划任务书或合同、上级机关的批文。
b ．属干本项目的其他已发表的文件。
c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2 可行性研究的前提说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。
2.1 要求说明对所建议开发软件的基本要求，如： a ．功能。
b ．性能。
c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。
d. 输入说明。
系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。
e ．处理流程和数据流程。
用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。
f. 在安全与保密方面的要求。
g. 同本系统相连接的其他系统。
h. 完成期限。
2.2 目标说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。
b. 处理速度的提高。
c. 控制精度或生产能力的提高。
232 d ．管理信息服务的改进。
计算机软件文档编制规范3
3.10 保密性和私密性需求 （若有）本条应指明保密性和私密性的 CSCI需求，包括：CSCI运行的保密性/私密性 环境、提供的保密性或私密性的类型和程度、 CSCI必须经受的保密性/私密性的风险、减少 此类危险所需的安全措施、CSCI必须遵循的保 密性/私密性政策、CSCI必须提供的保密性/私 密性审核、保密性/私密性必须遵循的确证/认 可准则。 3.11 CSCI环境需求 （若有）本条应指明有关CSCI必须运行的 环境的需求。例如，包括用于CSCI运行的计算 机硬件和操作系统（其它有关计算机资源方面 的需求在下条中描述）。
3.5.x （接口的项目唯一标识符） 本条（从3.5.2开始）应通过项目唯一标 识符标识CSCI的外部接口，简单地标识接口实 体，根据需要可分条描述为实现该接口而强加 于CSCI的需求。该接口所涉及的其它实体的接 口特性应以假设或“当（未提到实体）这样做 时，CSCI将……”的形式描述，而不描述为其 它实体的需求。本条可引用其它文档（如：数 据字典、通信协议标准、用户接口标准）代替 在此所描述的信息。（若适用）需求应包括下 列内容，它们以任何适合于需求的顺序提供， 并从接口实体的角度说明这些特性的区别（如 对数据元素的大小、频率或其它特性的不同期 望）：
d. CSCI必须提供、存储、发送、访问、接收 的数据元素集合体（记录、消息、文件、显示 和报表等）的特性，如： l）名称/标识符； a）项目唯一标识符； b）非技术（自然语言）名称； c）技术名称（如代码或数据库的记录或 数据结构）； d）缩写名或同义名； 2）数据元素集合体中的数据元素及其结构 （编号、次序、分组）； 3）媒体（如盘）和媒体中数据元素/数据元 素集合体的结构；
3.6 CSCI内部接口需求 本条应指明CSCI内部接口的需求（如有的 话）。如果所有内部接口都留待设计时决定， 则需在此说明这一事实。如果要强加这种需求， 则可考虑本文档的3.5给出的一个主题列表。 3.7 CSCI内部数据需求 本条应指明对CSCI内部数据的需求，（若 有）包括对CSCI中数据库和数据文件的需求。 如果所有有关内部数据的决策都留待设计时决 定，则需在此说明这一事实。如果要强加这种 需求，则可考虑在本文档的3.5.x.c和3.5.x.d 给出的一个主题列表。
软件文档国家标准
徐婷
1-16
3.3 计算机软件测试文档编制规范
3.3.1 标准的适用对象及范围
该规范是为软件管理人员、软件开发、测试和维 护人员、软件质量保证人员、审计人员、客户及用户 制定的。 用于描述一组与软件测试实施方面有关的基本测 试文档，该标准定义每一种基本文档的目的、格式和 内容。尽管标准所描述的文档侧重于动态测试活动， 但是有些文档仍适用于其他种类的测试活动（例如： 测试计划可用于设计和代码评审）。
徐婷
1-21
3.3 计算机软件测试文档编制规范
3.测试报告 测试报告包括4个文档： （1）测试项传递报告 指明在开发组和测试组独立工作的情况下或在希 望正式开始测试的情况下为进行测试而被传递的测试 项。 （2）测试日志 测试组用于记录测试执行过程中发生的情况。
软件文档
郑州大学信息工程学院
徐婷
1-22
软件文档 郑州大学信息工程学院 徐婷 1-9
3.2 计算机软件需求规格说明规范
3.2.2 软件需求文档的基本要求
SRS是对要完成一定功能、性能的软件产品、程 序或一组程序的说明。因此对SRS的描述有两项基本 要求： 1. 必须描述一定的功能、性能； 2. 必须用确定的方法叙述这些功能。 SRS作为软件开发规范之一，对软件开发的所有 阶段都起着非常重要的作用。但是，需要注意的是： SRS不能超出其作用范围，即除了SRS正确地定义所 有软件的需求之外，一般地SRS不描述任何设计、验 证或项目管理的细节，这是对SRS的另外两个要求。
软件文档
郑州大学信息工程学院
徐婷
1-20
3.3 计算机软件测试文档编制规范
2.测试说明 （3）测试规程说明 详细说明执行一组测试用例的各个步骤，或者 更广泛的说明为了评估一组特征而用于分析软件项的 各个步骤。 测试规程是与设计分开的，主要明确要遵循的 步骤，而不宜含有无关的细节。
计算机软件开发文档编制规范
计算机软件开发文档编制规范篇一：计算机软件文档编制规范《计算机软件文档编写指南》一．计算机软件文档由封面、目录、正文、注释和附录组成。
封面格式：密级：编号：文档名称：项目名称：编制：审核：批准：×××××××××××××研究所年月日二．计算机软件文档包括：1）软件开发计划2）软件需求规格说明3）接口需求规格说明4）接口设计文档5）软件设计文档6）软件产品规格说明7）版本说明文档8）软件测试计划9）软件测试说明10）软件测试报告11）计算机系统操作员手册12）软件用户手册13）软件程序员手册14）计算机资源综合保障文件软件开发计划一．引言1．编写目的（阐明编写软件计划的目的，指出读者对象。
）2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。
）3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。
）4．参考资料（可包括：（1）项目经核准的计划任务书、合同或上级机关的批文；（2）文档所引用的资料、规范等；列出资料的、标题、编号、发表日期、出版单位或资料来源。
）二．项目概述1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。
)2. 条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。
）3. 产品（1）程序（列出应交付的程序名称使用的语言及存储形式。
）（2）文档（列出应交付的文档。
）（3）运行环境（应包括硬件环境软件环境。
）4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。
）5．验收标准三．实施计划1．任务分解（任务的划分及各项任务的负责人。
计算机软件产品开发文件编制指南(GB8567
计算机软件产品开发文件编制指南（GB8567国家有关计算机软件产品开发文件编制指南（GB 8567-88）只是一个国家标准，并不一定适合每一个企业，各企业（组织）应该按照标准，制订出符合自身软件过程规范的文档要求。
引言1 目的一项计算机软件的筹划、研制及实现，构成一个软件开发项目。
一个软件开发项目的进行，通常需要在人力与自动化资源等方面作重大的投资。
为了保证项目开发的成功，最经济地花费这些投资，同时便于运行与保护，在开发工作的每一阶段，都需要编制二定的文件。
这些文件连同计算机程序及数据一起，构成为计算机软件。
文件是计算机软件中不可缺少的构成部分，它的作用是：a．作为开发人员在一定阶段内的工作成果与结束标志；b．向管理人员提供软件开发过程中的进展与情况，把软件开发过程中的一些"不可见的"事物转换成“可见“的文字资料。
以便管理人员在各个阶段检查开发计划的实施进展，使之能够推断原定目标是否已达到，还将继续耗用资源的种类与数量；C．记录开发过程中的技术信息，便于协调以后的软件开发、使用与修改；d．提供对软件的有关运行、保护与培训的信息，便于管理人员、开发人员、操作人员与用户之间相互熟悉彼此的工作；e．向潜在用户报导软件的功能与性能，使他们能判定该软件能否服务于自己的需要。
换言之，本指南认为：文件的编制务必习惯计算机软件整个生存周期的需要。
计算机软件所包含的文件有两类：一类是开发过程中填写的各类图表，可称之为工作表格；另一类则是应编制的技术资料或者技术管理资料，可称之为文件。
本指南规定软件文件的编制形式，并提供对这些规定的解释。
本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。
2 范围本指南是一份指导性文件。
本指南建议，在一项计算机软件的开发过程中，通常地说，应该产生十四种文件。
这十四种文件是：* （1）可行性研究报告；* （2）项目开发计划；* （3）软件需求说明书；* 数据要求说明书；* （4）概要设计说明书；* 全面设计说明书；* 数据库设计说明书；用户手册；操作手册；模块开发卷宗；（2）测试计划；测试分析报告；开发进度月报；项目开发总结报告。
GB8567-88软件开发主要文档编写规范
GB8567－88软件开发主要文档编写规范GB8567－88软件开发主要文档编写规范233GB 8567－88软件开发主要文档编写规范本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。
这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。
一、 可行性研究报告l 引言1.1 编写目的说明：说明本可行性研究报告的编写目的，指出预期的读者。
1.2 背景说明：a ．所建议开发的软件系统的名称。
b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。
c ．该软件系统同其他系统或其他机构的基本的相互来往关系。
1.3 定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
2341.4 参考资料列出用得着的参考资料，如：a ．本项目的经核准的计划任务书或合同、上级机关的批文。
b ．属干本项目的其他已发表的文件。
c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。
列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2 可行性研究的前提说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。
2.1 要求说明对所建议开发软件的基本要求，如：a ．功能。
b ．性能。
c ．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。
d. 输入说明。
系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频235度。
e ．处理流程和数据流程。
用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。
f. 在安全与保密方面的要求。
g. 同本系统相连接的其他系统。
h. 完成期限。
2.2 目标说明所建议系统的主要开发目标，如：a. 人力与设备费用的减少。
b. 处理速度的提高。
计算机软件文档编制规范4
4 软件配置管理活动
本章描述配置标识、配置控制、配置状态 记录与报告以及配置检查与评审等四方面的软 件配置管理活动的需求。 4.1 配置标识
4.1.1 本条必须详细说明软件项目的基线（即 最初批准的配置标识），并把它们与本计划的 3.2条描述的生存周期的特定阶段相联系。在 软件生存周期中，主要有三种基线，它们是功 能基线、分配基线和产品基线。对于每个基线， 必须描述下列内容：
c. 描述软件库控制的规程，其中包括库存软 件控制、对于适用基线的读写保护、成员保护、 成员标识、档案维护、修改历史以及故障恢复 等七项规程；
d. 如果有必要修补目标代码，则要描述其标 识和控制的方法。
4.2.3 对于各个不同层次的配置控制组和其他 修改管理机构，本条必须：
a. 定义其作用，并规定其权限和职责；
a. 软件媒体和媒体文档的标识。
b. 把文档和媒体置于软件配置管理的控制之下，并 把它正式地交付给用户。例如，要给出对软件库内的 源代码和目标代码进行控制的工具、技术和方法的描 述；如果用到数据库管理系统，则还要对该系统进行 描述。又如，要指明怎样使用软件库工具、技术和方 法来处理软件产品的交付。
c. 编制关于程序及其有关文档的修改状态的文档。 因此必须进一步定义用于准备多种级别（如项目负责 人、配置控制小组、软件配置管理人员和用户）的管 理报告的工具、技术和方法。
4.4 配置的检查和评审
本条必须：
a. 定义在本计划的3.2条所定义的软件生存 周期的特定点上执行的检查和评审中软件配置 管理计划的作用；
b. 规定每次检查的评审所包含的配置项；
c. 指出用于标识和解决在检查和评审期间发 现的问题的工作流程。
5 工具、技术和方法
本章必须指明为支持特定项目的软件配置管理所 使用的软件工具、技术和方法，指明它们的目的，并 在开发者所有权的范围内描述其用法。例如，可以包 括用于下列任务的工具，技术和方法：
计算机软件产品开发文件编制指南GB
计算机软件产品开发文件编制指南（GB8567-88）国家有关计算机软件产品开发文件编制指南（GB 8567-88）只是一个国家标准，并不一定适合每一个企业，各企业（组织）应该按照标准，制订出符合自身软件过程规范的文档要求。
引言1 目的一项计算机软件的筹划、研制及实现，构成一个软件开发项目。
一个软件开发项目的进行，一般需要在人力和自动化资源等方面作重大的投资。
为了保证项目开发的成功，最经济地花费这些投资，并且便于运行和维护，在开发工作的每一阶段，都需要编制二定的文件。
这些文件连同计算机程序及数据一起，构成为计算机软件。
文件是计算机软件中不可缺少的组成部分，它的作用是：a．作为开发人员在一定阶段内的工作成果和结束标志；b．向管理人员提供软件开发过程中的进展和情况，把软件开发过程中的一些"不可见的"事物转换成“可见“的文字资料。
以便管理人员在各个阶段检查开发计划的实施进展，使之能够判断原定目标是否已达到，还将继续耗用资源的种类和数量；C．记录开发过程中的技术信息，便于协调以后的软件开发、使用和修改；d．提供对软件的有关运行、维护和培训的信息，便于管理人员、开发人员、操作人员和用户之间相互了解彼此的工作；e．向潜在用户报导软件的功能和性能，使他们能判定该软件能否服务于自己的需要。
换言之，本指南认为：文件的编制必须适应计算机软件整个生存周期的需要。
计算机软件所包含的文件有两类：一类是开发过程中填写的各种图表，可称之为工作表格；另一类则是应编制的技术资料或技术管理资料，可称之为文件。
本指南规定软件文件的编制形式，并提供对这些规定的解释。
本指南的目的是使得所编制的软件文件确实能够起到软件文件应该发挥的作用。
2 范围本指南是一份指导性文件。
本指南建议，在一项计算机软件的开发过程中，一般地说，应该产生十四种文件。
这十四种文件是：* （1）可行性研究报告；* （2）项目开发计划；* （3）软件需求说明书；* 数据要求说明书；* （4）概要设计说明书；* 详细设计说明书；* 数据库设计说明书；用户手册；操作手册；模块开发卷宗；（2）测试计划；测试分析报告；开发进度月报；项目开发总结报告。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
计算机软件文档编制规范
针对计算机软件文档的编制规范，本文旨在通过深入研究与讨论，介绍计算机软件文档编制规范中的重要内容。
首先，要针对计算机软件文档编制规范讨论，首先要明确什么是软件文档，以及它们的作用。
软件文档是指计算机软件的说明书，用户指南，操作手册，参考手册，教程等文件形式的文档。
它包含软件的特性，技术支持信息，安装，调试，维护，操作，以及计算机软件及相关服务的详细信息。
软件文档被认为是软件安全可靠运行的一个重要手段，因此编写软件文档至关重要。
其次，要讨论计算机软件文档编制规范，就必须先决定文档内容的组织形式。
计算机软件文档编制规范建议，文档内容应具有一定的结构，结构上可以分为三个层次：一级为大纲，二级为文档正文，三级为附录。
由于文档内容的不同，一级大纲的结构也可以根据文档的实际情况进行调整。
另外，在文档内容的组织上，计算机软件文档编制规范建议分为三个部分：介绍，操作，附录。
介绍的内容包括软件的定义，软件的功能，软件的安装，调试，软件的维护等；操作的部分包括如何使用软件，如何操作，如何调试，如何维护等；附录包括具体的附件，技术支持信息，技术技术文档，历史版本，例程等。
此外，在文档的排版上，计算机软件文档编制规范认为要将文字所占的篇幅和空间尽可能减少，以便达到简明，清晰，美观的目的。
计算机软件文档排版样式除了具有一定的空间控制格式外，还要求字
体大小，字体颜色，字体格式等多种排版要求，以达到清晰，美观，易读的目的。
最后，计算机软件文档编制规范除上述内容外，还应针对文档的标识，语言，版本等内容进行统一的规定，以保证软件文档的可更新，可迭代，可控性，可恢复性，可重复性等。
综上所述，计算机软件文档编制规范讨论包括文档内容组织，文档排版，文档标识，语言及版本等多个方面，它是一个复杂的话题。
因此，编写计算机软件文档的过程需要专业的技术和丰富的经验，可以有效地保证文档的质量，适应软件的发展变化。