软件文档国家标准与写作要求
软件设计文档国家标准 概要设计说明书(GB8567——88)
1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2总体设计 (2)2.1需求规定 (2)2.2运行环境 (2)2.3基本设计概念和处理流程 (3)2.4结构 (3)2.5功能器求与程序的关系 (3)2.6人工处理过程 (3)2.7尚未问决的问题 (3)3接口设计 (3)3.1用户接口 (3)3.2外部接口 (3)3.3内部接口 (4)4运行设计 (4)4.1运行模块组合 (4)4.2运行控制 (4)4.3运行时间 (4)5系统数据结构设计 (4)5.1逻辑结构设计要点 (4)5.2物理结构设计要点 (4)5.3数据结构与程序的关系 (4)6系统出错处理设计 (5)6.1出错信息 (5)6.2补救措施 (5)6.3系统维护设计 (5)概要设计说明书1引言1.1编写目的说明编写这份概要设计说明书的目的，指出预期的读者。
1.2背景说明：a.待开发软件系统的名称；b.列出此项目的任务提出者、开发者、用户以及将运行该软件的计算站（中心）。
1.3定义列出本文件中用到的专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有关的参考文件，如：a.本项目的经核准的计划任务书或合同，上级机关的批文；b.属于本项目的其他已发表文件；c.本文件中各处引用的文件、资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
2总体设计2.1需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求，详细的说明可参见附录C。
2.2运行环境简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定，详细说明参见附录C。
2.3基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。
2.4结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系.2.5功能器求与程序的关系本条用一张如下的矩阵图说明各项功能需求的实现同各块程序的分配关系：2.6人工处理过程说明在本软件系统的工作过程中不得不包含的人工处理过程（如果有的话）。
详解：软件开发的国家规定与行业准则
详解：软件开发的国家规定与行业准则软件开发作为信息技术领域的核心活动，其规范性和标准化对于保障软件质量、促进信息技术健康发展具有重要意义。
本文档将深入解析软件开发过程中需要遵守的国家规定与行业准则，帮助软件开发者和从业者更好地理解和实践这些规范。
一、国家规定根据中国法律和政策，软件开发应遵循以下国家规定：1. 《计算机软件保护条例》：该条例是中国软件产业的基础性法律文件，明确了软件著作权的保护范围、保护期限以及侵权责任等。
《计算机软件保护条例》：该条例是中国软件产业的基础性法律文件，明确了软件著作权的保护范围、保护期限以及侵权责任等。
2. 《信息安全技术软件开发规范》：该规范对软件开发过程中的信息安全提出了具体要求，包括软件设计、编码、测试等阶段的安全措施。
《信息安全技术软件开发规范》：该规范对软件开发过程中的信息安全提出了具体要求，包括软件设计、编码、测试等阶段的安全措施。
3. 《软件工程软件开发规范》：该规范对软件开发流程和方法提出了详细要求，包括需求分析、设计、实现、测试和维护等环节。
《软件工程软件开发规范》：该规范对软件开发流程和方法提出了详细要求，包括需求分析、设计、实现、测试和维护等环节。
4. 《信息技术软件工程软件开发规范》：该规范强调了软件开发过程中的工程化要求，包括项目管理、质量保证、配置管理等。
《信息技术软件工程软件开发规范》：该规范强调了软件开发过程中的工程化要求，包括项目管理、质量保证、配置管理等。
二、行业准则除了国家规定外，软件开发行业内部还形成了一系列的自律性准则，这些准则有助于提升软件质量、保护用户权益、维护行业秩序：1. 《软件工程协会软件开发规范》：该规范由国内外软件工程协会共同制定，对软件开发流程、工程方法和质量控制提出了建议。
《软件工程协会软件开发规范》：该规范由国内外软件工程协会共同制定，对软件开发流程、工程方法和质量控制提出了建议。
2. 《软件质量标准》：这些标准定义了软件产品质量的评价指标，如功能性、可靠性、性能等，帮助开发者提升软件的整体质量。
软件文档国家标准
徐婷
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. 可读性，国家标准软件开发文档应当具有良好的可读性，包括清晰的结构、简洁的语言、合理的排版等方面。
三、文档内容。
1. 需求分析文档，需求分析文档是国家标准软件开发文档中的重要组成部分，应当包括用户需求、功能需求、性能需求、安全需求等内容。
2. 设计文档，设计文档应当包括整体设计、详细设计、数据库设计、界面设计等内容，以确保软件开发过程中的设计合理、可行。
3. 编码规范，编码规范是国家标准软件开发文档中的重要内容，应当包括代码命名规范、代码风格规范、注释规范等内容，以提高代码的可读性和可维护性。
4. 测试文档，测试文档应当包括测试计划、测试用例、测试报告等内容，以确保软件开发过程中的质量和稳定性。
5. 用户手册，用户手册是国家标准软件开发文档中的重要组成部分，应当包括软件安装、操作指南、故障排除等内容，以提高用户的使用体验。
四、结论。
国家标准软件开发文档是软件开发过程中的重要组成部分，对于提高软件开发过程的规范化和标准化具有重要意义。
软件设计文档国家标准GB8567
软件设计文档国家标准GB8567-88一、文档编写标准化在整个项目开发及使用过程中,应该有完备的文档支持，文档编制要求具有针对性、精确性、清晰性、完整性、灵活性和可追溯性。
完备的文档对软件的开发及使用起了很大的作用。
一般要求编写好十三种文档。
1、可行性分析报告说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施方案，说明并论证所选定实施方案的理由。
2、项目开发计划为软件项目实施方案制订出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等.3、软件需求说明书（软件规格说明书）对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。
它是在用户与开发人员双方对软件需求取得共同理解并达成协议的条件下编写的，也是实施开发工作的基础。
该说明书应给出数据逻辑和数据采集的各项要求，为生成和维护系统数据文件做好准备。
4、概要设计说明书是概要设计阶段的工作总结。
主要包括功能分配、模块划分、程序总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理等，为详细设计作好准备。
5、详细设计说明书着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等.6、用户操作手册详细描述了该软件的功能、性能和用户界面,使用该软件的具体方法等.7、测试计划包括测试内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
8、测试分析报告测试计划的执行情况，对测试结果的分析,提出测试结论。
9、开发进度月报按月提交的项目进展情况报告。
包括计划与实际执行情况的对比、阶段成果、遇到的问题、解决的方法以及下一步的打算。
10、项目开发总结报告项目完成以后，总结实际执行情况。
如进度、成果、资源利用、成本和投入的人力,对项目开发作出评价，总结经验与教训.11、软件维护手册主要包括软件系统说明、程序模块说明、操作环境、支持软件说明、维护过程说明等.12、软件问题报告记录软件出现问题的日期、发现人、状态、问题所属模块等,为软件修改提供准备文档. 13、软件修改报告软件产品投入使用后，发现了需修改、更正的问题，要将出现的问题、修改意见、修改可能出现影响作出详细描述,提交审批。
软件设计文档国家标准 详细设计说明书(GB8567——88)
1引言 (2)1.1编写目的 (2)1.2背景 (2)1.3定义 (2)1.4参考资料 (2)2程序系统的结构 (2)3程序1（标识符）设计说明 (2)3.1程序描述 (3)3.2功能 (3)3.3性能 (3)3.4输人项 (3)3.5输出项 (3)3.6算法 (3)3.7流程逻辑 (3)3.8接口 (3)3.9存储分配 (4)3.10注释设计 (4)3.11限制条件 (4)3.12测试计划 (4)3.13尚未解决的问题 (4)4程序2（标识符）设计说明 (4)详细设计说明书1引言1.1编写目的说明编写这份详细设计说明书的目的，指出预期的读者。
1.2背景说明：a．待开发软件系统的名称；b．本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。
1.3定义列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1.4参考资料列出有关的参考资料，如：a．本项目的经核准的计划任务书或合同、上级机关的批文；b．属于本项目的其他已发表的文件；c．本文件中各处引用到的文件资料，包括所要用到的软件开发标准。
列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。
2程序系统的结构用一系列图表列出本程序系统内的每个程序（包括每个模块和子程序）的名称、标识符和它们之间的层次结构关系。
3程序1（标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。
以下给出的提纲是针对一般情况的。
对于一个具体的模块，尤其是层次比较低的模块或子程序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同，在这种情况下，只要简单地说明这一点即可。
3.1程序描述给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且，还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重人的还是不可重人的？有无覆盖要求？是顺序处理还是并发处理等）。
3.2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形式。
软件工程的国家标准 总结
软件工程的国家标准总结国际标准化组织（ISO）、国际电工委员会（IEC）、国际电信联盟（ITU）信息技术领域：电气电子工程师学会（IEEE）、Internet协会、国际Web联盟（W3C）在中国，按照国务院授权，在国家质量监督检验检疫总局管理下，国家标准化管理委员会（SAC）统一管理全国标准化工作。
全国信息技术标准化技术委员会在国家标管委领导下负责信息技术领域国家标准的规划和制订工作。
根据制定机构和适用范围的不同，标准按类型划分，可分为强制性标准和推荐性标准。
国际标准、国家标准、行业标准、区域/地方标准和企业标准1、国际标准：是指由国际联合机构制定和公布，提供各国参考的标准，ISO、IEC、ITU2、国家标准：是指由政府或国家级的机构制定或批准，适用于全国范围的标准，GB或GB/T：中华人民共和国国家标准，由国标委制定，国家质量监督检验检疫总局批准和公布FIPS-NBS：美国国家标准局联邦信息处理标准BS：英国国家标准JIS：日本工业标准3、行业标准：是指由行业机构、学术团队或国防机构制定，并适用于某个业务领域的标准，IEEE：电气电子工程师学会标准GJB：中华人民共和国国家军事标准，DOD-STD：美国国防部标准，适用于美国国防部门MIL-S：美国军用标准，适用于美国军队内部4、区域/地方标准：是指由区域性国际联合机构制定和公布，提供区域内各国参考和执行的标准ARS：非洲地区标准ASMO：阿拉伯标准EN：欧洲标准ETS：欧洲电信标准PAS：泛美标准国内地方标准是指由省、自治区、直辖市标准化行政主管部门制定，并报国务院标准化行政主管部门和国务院有关行政主管部门备案，仅适用于本地的标准。
5、企业标准：是指一些大企业或机构，由于工作需要制定的适用于本企业或机构的标准，企业标准以Q开头。
各级标准之间的关系：1、对需要在全国范围内统一的技术要求，应当制定国家标准。
2、对没有国家标准而又需要在全国某个行业范围内统一的技术要求，可以制定行业标准。
软件文档模板(国家标准)
软件文档模板(国家标准)一、引言。
软件文档是软件开发过程中不可或缺的一部分，它记录了软件的功能、设计、实现和维护等信息，为软件的开发、测试、维护和使用提供了重要的参考依据。
本模板旨在规范软件文档的格式和内容，以便于统一管理和使用。
二、文档概述。
1. 文档目的。
本文档旨在规范软件文档的编写，使之符合国家标准，提高软件文档的质量和可读性。
2. 文档范围。
本文档适用于所有软件的文档编写，包括但不限于需求规格说明、设计文档、测试文档、用户手册等。
3. 读者对象。
本文档适用于软件开发人员、测试人员、项目经理、用户等相关人员。
三、文档编写规范。
1. 文档格式。
（1）文档采用A4纸张，页边距设置为上下左右各2.5厘米；（2）文档标题采用宋体加粗，居中排列；（3）章节标题采用宋体加粗，居左排列；（4）正文内容采用宋体，行间距设置为1.5倍。
2. 文档内容。
（1）文档标题，需准确反映文档内容，简洁明了；（2）文档引言，简要介绍文档的目的和范围；（3）正文内容，按照需求规格说明、设计、测试等不同阶段，分别进行详细描述；（4）附录，包括相关图表、表格、术语表等。
3. 文档语言。
文档内容应使用规范的汉语表达，避免使用口语化、方言化的表达方式，保持专业性和准确性。
四、文档编写流程。
1. 需求分析，根据软件需求分析结果，确定文档的编写范围和内容；2. 文档编写，按照规范要求，逐步完成文档的编写；3. 审核修订，由相关人员对文档进行审核，确保文档的准确性和完整性；4. 发布使用，将经过审核修订的文档发布并提供给相关人员使用。
五、文档管理。
1. 文档版本管理，对文档进行版本管理，确保文档的更新和追踪；2. 文档备份，定期对文档进行备份，防止文档丢失或损坏；3. 文档归档，按照规定的归档流程，对文档进行归档管理。
六、文档验收标准。
1. 文档格式符合规范要求；2. 文档内容完整准确，无遗漏和错误；3. 文档语言表达清晰、简洁、规范。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
软件文档的编写原则
所有的章节都可以进一步细分或缩并，以适应实际需要。
程序的设计表现形式可以使用多种形式，如流程图、判定表、等其 他表现形式。
按规定：重量不超过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、软件文档的编写原则
软件文档的编写原则
文档编制的原则 文档编 写应适 应文档 的读者 文档编写 应有必要 的重复性 文档编写 应具有一 定灵活性
软件需求文档的基本要求
SRS是对要完成一定功能、性能的软件产品、程序或一组程序 的说明。因此对SRS的描述有两项基本要求： （1）必须描述一定的功能、性能； （2）必须用确定的方法叙述这些功能、性能。 SRS作为软件开发规范之一，对软件开发的所有阶段都起着非 常重要的作用，但是需要注意的是，SRS不能超出其作用范围， 即除了SRS正确地定义所有软件的需求之外，一般地SRS不描 述任何设计、验证或项目管理的细节。
3、软件文档的质量等级
测试文档的结构
软件测试文档的内容主要包括： 测试计划 测试设计说明 测试用例说明 测试规程说明 测试项传递报告 测试日志 测试事件报告以及测试总结报告
1、测试计划
1 测试计划名称 2 引言 3 测试项 4 被测试的特性 5 不被测试的特性 6 方法 7 项通过准则 8 暂停标准和再启动要求 9 应提供的测试文件 10 测试任务 11 环境要求 12 职责 13 人员和训练要求 14 进度 15 风险和应急 16 批准
软件产品开发文件编制指南
根据该指南，一项计算机软件的开发过程中，一般应产生如下十四种文档：
（1）可行性研究报告 （2）项目开发计划
（3）软件需求说明书
（4）数据要求说明书 （5）概要设计说明书
（8）用户手册 （9）操作手册 （10）模块开发卷宗 （11）测试计划 （12）测试分析报告 （13）开发进度月报 （14）项目开发总结报告
软件需求文档的编制目标
SRS对于软件客户来讲，应尽可能准确地描述其所需要的产品；而对于软 件开发者，应能准确地理解客户所需要的产品。 编制SRS的目标可以概括为如下六个方面： （1）在软件产品完成目标方面为客户和开发者之间建立共同协议创立一个基 础 （2）提高开发效率 （3）为成本计价和编制计划进度提供基础 （4）为确认和验证提供一个基准 （5）便于移植 （6）作为不断提高的基础
3、软件测试文档编制规范
软件测试文档编制规范
测试是软件生存周期中一个独立的、关键的阶段，也是 保证软件质量的重要手段。为了提高检测出错误的几率， 使测试能有计划地、有条不紊地进行，就必须要编制测 试文档。而标准化的测试文档就如同一种通用的参照体 系，可达到便于交流的目的。
计算机软件测试文档编制规范的目的就是规定一组软件 测试文档，定义每一种基本文档的目的、格式和内容。 测试文档中所规定的内容可以作为对测试过程完备性的 对照检查表，这将会提高测试过程的每个阶段的能见度， 极大地提高测试工作的可管理性。
2006年后 计算机软件产品开发文件编制指南 （GBT8567-2006） 计算机软件测试文件编制规范 （GBT9386-2008）
软件产品开发文件编制指南
计算机软件产品开发文档编制指南是一份指导性文档，目的是使得 所编制的软件文档确实能够起到应该发挥的作用。 指南对软件文档的意义和作用、文档与读者的关系、软件生存周期 与各种文档的编制、文档编制中的考虑因素、文档编制的管理工作 以及各种文档的内容要求都作了详细描述，并给出了各类文档的编 写提示。
5、测试项传递报告
1 传递报告名称 2 传递项 3 位置 4 状态 5 批准
6、测试日志
1 测试日志名称 2 描述 3 活动和事件条目
7、测试事件报告
1 测试事件报告名称 2 摘要 3 事件描述 4 影响
8、测试总结报告
1 2 3 4 5 6 7 8 测试总结报告名称 简述 差异 测试充分性评价 结果概述 评价 活动总结 批准
测试文档的编制
软件测试文档的内容主要包括测试计划、测试设计说明、 测试用例说明、测试规程说明、测试项传递报告、测试 日志、测试事件报告以及测试总结报告八项内容。 需要强调，软件测试包括对需求说明书的测试，因此， 在软件的需求分析阶段，就应开始测试文档的编制工作， 各种测试文档的编写应按一定的格式进行
软件文档写作
第三章 软件文档国家标准
浙江工业大学计算机学院
陆佳炜
主要内容
软件产品开发文档编制指南
软件需求说明编制指南
软件测试文档编制规范 软件文档管理指南
1、软件产品开发文档编制指南
软件文档国家标准
计算机软件产品开发文档编制指南 （GB 8567-1988） 计算机软件需求说明编制指南 （GB 9385-1988） 计算机软件测试文档编制规范 （GB 9386-1988） 软件文档管理指南 （GB 16680-1996）
软件测试文档内容
计算机软件测试文档编制规范主要定义了三种类型 软件测试文档： 测试计划 测试说明 测试报告
测试计划
测试计划描述测试活动的范围、方法、资源和进 度。它规定被测试的项、被测试的特性、应完成 的测试任务、担任各项工作的人员职责及与本计 划有关的风险等
测试说明
测试说明包括三个文档： （1）测试设计说明 详细描述测试方法，规定该设计及其有关测试所包括的特性(功能、性能、 可移植性等)，还规定完成测试所需的测试用例和测试规程，并规定特性 的通过准则。 （2）测试用例说明 列出用于输入的具体值以及预期的输出结果，并规定在使用具体测试用例 时，对测试规程的各种限制。将测试用例与测试设计分开，可以使它们用 于多个设计并能在其它情形下重复使用。 （3）测试规程说明 规定对于运行系统和执行指定的测试用例来实现有关测试设计所要求的所 有步骤。
测试报告
测试报告包括四类文档： （1）测试项传递报告 所谓的测试项是指作为测试对象的软件项（源代码、目标代码、作业控制 代码、数据等），该报告指明在开发组和测试组独立工作的情况下或者在 希望正式开始测试的情况下为进行测试而被传递的测试项。 （2）测试日志 测试组用于记录测试执行过程中发生的情况。 （3）测试事件报告 描述在测试执行期间发生并需进一步调查的一切事件。 （4）测试总结报告 总结与测试设计说明有关的测试活动。
测试文档的编制
文件 活动 验收 安装 系统 子系统 测试计 划 √ √ √ 测试设 计说明 √ √ √ 测试用 例说明 √ √ √ √ 测试规 程说明 √ √ √ 测试项 传递报 告 √ √ √ √ 测试日 志 √ √ 测试事 件 报告 √ √ √ √ 测试总 结 报告 √ √ √ √ √
模块
-
√
文档标准应被标识和使用
应规定支持工具
制定文档的编写策略
评估现有策略条款的有效性和完整性的文档检查表
——适当的文档的决策作出了吗？ ——涉及文档的策略声明发布了吗？ ——负责开发文档和产品文档编写工作的人员或部门落实了吗？ ——用于文档编制的资源落实了吗？ ——负责文档质量的人员或部门落实了吗？ ——各管理层次和组织各分支之间的各种关系确定了吗？ ——对于文档的编制、分发和维护等方面是否确定了职责、所需活动和联系 途径？ ——所有的文档要求已列入整个项目开发计划表中了吗？ ——适用的文档标准已确定了吗？ ——是否已考虑采用支持工具和自动化的文档编制？