TCQAE11008-2019软件产品说明编写指南.docx
ICS35.080
L77
T/CQAE
团 体 标 准
T/CQAE11008-2019
软件产品说明编写指南
Guidelinesforthewritingofsoftwareproductinstructions
2019-2-19发布 2019-3-19实施
中国电子质量管理协会 发布
T/CQAE
T/CQAE11008-2019
T/CQAE
T/CQAE11008-2019
PAGE
PAGE10
PAGE
PAGE11
目 次
前言 3
引言 4
范围 5
规范性引用文件 5
术语与定义 5
软件产品说明概述 5
软件产品说明编写要求及内容 5
附录A（资料性附录）产品说明示例 14
参考文献 19
前 言
本标准按照GB/T1.1-2009《标准化工作导则第1部分：标准的结构和编写》给出的规则起草。
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。
本标准由中国电子质量管理协会信息产品检测技术应用专业委员会提出并归口。
本标准起草单位：重庆市软件评测中心有限公司、厦门理工软件评测服务有限公司、江苏省软件产品检测中心、辽宁北方实验室有限公司、山东道普测评技术有限公司、福建省电子产品监督检验所、吉林省电子信息产品检验研究院、河北省电子信息产品监督检验院、珠海软件评测中心、福建省软件评测工程技术研究中心、四川赛闯检测股份有限公司。
本标准起草人：丁晓明、童鑫、赵欣、黄莹、李海涛、韩庆良、柳毓龙、辛士界、葛建新、王在炯、吴克寿、何志豪、冯丽。
引 言
为了提高供方编制软件产品说明的质量和效率，提供软件产品说明文档编写细则是必要的。
本标准以GB/T25000.51-2016《系统与软件工程系统与软件质量要求和评价（SQuaRE）第51部分：就绪可用软件产品（RUSP）的质量要求和测试细则》第5章为依据给出了软件产品说明的编制指南。
本标准规定了产品说明文档的格式和内容。对于不同类型的软件，适用的要求不同，若实际的软件产品不涉及部分内容的要求，则宜给出声明。
软件产品说明编写指南
范围
本标准给出了软件产品说明编写细则。
本标准适用于就绪可用软件产品（RUSP）。
本标准的预期用户为就绪可用软件产品（RUSP）生产者（供方）。附录A出了产品说明示例。
规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。
GB/T25000.10-2016系统与软件工程系统与软件质量要求和评价（SQuaRE）第10部分：系统与软件质量模型（ISO/IEC25010:2011,MOD）
GB/T25000.51-2016系统与软件工程系统与软件产品质量要求和评价（SQuaRE）第51部分：就绪可用软件产品（RUSP）的质量要求和测试细则（ISO/IEC25051:2014,MOD）
术语与定义
GB/T25000.10-2016和GB/T25000.51-2016中界定的术语和定义适用于本文件。
软件产品说明概述
产品说明的定义
产品说明是陈述软件性质的文档，其主要目的是帮助潜在需方在购买前对产品进行适用性评价。
注：潜在需方指对软件产品有需求且具有购买力但仍未计划购买的需方。
产品说明的作用
提供软件各方面的信息，使软件的潜在需方可以通过这些信息判断该软件是否符合其使用要求、达到其使用的目的，它是潜在需方购买软件的重要依据，也是使用者了解软件特性的渠道之一。
产品说明的使用对象
软件产品的潜在需方和用户。
产品说明的编写要求及内容
编写要求
可用性
产品说明对于软件的潜在需方和用户应是可用的。这里主要指产品说明的提供形式应是可获得的，一般分为纸质文档和电子文档两种。纸质文档可以是专门介绍软件的小册子；电子文档要求能够通过适宜渠道查阅(例如，光盘、WEB下载、FTP传输)。
适用性
产品说明中应包含潜在需方对软件进行适用性评价所需的信息。该信息必须是对潜在需方评价软件适用性有帮助的，不能出现诸如公司广告等无关的信息。
一致性
产品说明的内容中应排除内部的不一致，包括：软件质量特性的不一致、关键术语和术语表的不一致、产品名称和版本号的不一致，以及开发方、供应方、销售方和维护方信息的不一致等。
可测试或可验证性
产品说明中的陈述应是可测试的或可验证的，不应出现诸如“该软件采用了世界领先技术”、“该软件功能极其强大、处理速度非常快”等非量化的、现有技术不能测试或验证的表述，除非能够提供相关证明。
注：不能测试或不能验证的指不能够通过编制测试用例或检查来验证其内容的正确性。
产品说明组成
产品说明