产品说明书和用户文档集撰写要求.pdfVIP

文档来源为:从网络收集整理.word版本可编辑.欢迎下载支持.

附件4：产品说明的提交要求

说明：红字条款可根据软件产品实际情况进行剪裁，黑字条款为标准要求必须说

明的项目。斜体字是对国家标准条款的解读或举例，仅供使用者参考。

一、产品说明：

【定义】

陈述软件各种性质的文档，目的是帮助潜在的需方在采购前对该软件进行适用

性评价。

解读：产品说明为供方在进行产品销售时对产品性质的宣传资料，目的是让采购方获得产品

概况，判断该产品是否能够满足自己的需求，进而决定是否采购该产品。

【要求】

产品说明对于需求方是可用的，包含潜在需方所需的信息，信息内容应排除内

部的不一致，且与用户文档集和软件实际情况一致，产品说明的内容应该是可

以验证或测试的，产品说明应有唯一性标识，当产品说明内容超出一页文档时，

要有封面和目录，方便使用者进行内容查找。

【内容】

1、软件产品应以其名称、版本和日期指称；

解读：软件产品要用名称+版本或名称+日期命名。

例如：城市水资源管理系统软件V1.0或城市水资源管理系统软件2011。

2、产品说明应显示唯一的标识；

解读：产品说明在封面或卡片的显著位置显示唯一的产品标识。

例如：城市水资源管理系统软件V1.0产品说明。

3、产品说明应包含供方和至少一家销售商（当适用时）电子商务销售商或分销

商的名称和地址（邮政的或网络的）。

解读：产品说明在封面或卡片的显著位置显示供方和销售商信息一般包括名称和地址且供，

方和销售商可以为同一企业或个人。

4、产品说明应标识该软件能够完成的预期的工作任务和服务；

解读：此项描述软件的销售方向，适用的行业，潜在的客户群，概要介绍软件的用途。

1

文档来源为:从网络收集整理.word版本可编辑.欢迎下载支持.

例如：本软件为水务行业管理软件，适用于各供水公司、净水厂、水污染处理企业、政府水

资源行业管理部门，可完成水资源相关业务的管理及实施对水资源处理装置的动态监控和实

时处理。

5、供方想要声称软件产品符合由法律或行政机构界定的要求时，产品说明应标

识出这些法律或行政机构界定的要求的需求文档；

解读：供方为加大产品的宣传力度，增强产品竞争力，更好的销售其软件产品，可表明其产

品符合法律或行政机构界定的要求。但必须将符合的内容在产品说明中进行详细说明。

例如：本软件符合中华人民共和国水利行业标准SL475-2010水利信息公用数据元标准，该

标准的详细信息参见附录一

6、产品说明应以适当的引用文档指名产品在何处依赖于特定软件和（或）硬件；

解读：当产品在某些情况下需要依赖于特定的软件和（或）硬件才能实现其生成的产品性质

时，要对这些特定的软件和（或）硬件进行描述，以便采购方在采购产品时能够合理评价采

购成本。

例如：本软件在对水资源处理装置进行远程动态监控及实时处理时如传输距离超过50米需

要信号放大器或无线信号发射器与无线信号接收器

7、产品说明引证已知的对其他软件的用户可调用的接口时，应标识出这些接口

或软件；

解读：如果软件再使用过程中需要调用其他软件许可的接口时，应说明这些接口或软件从而

使采购方在选择该产品时，明确还需购买其他接口许可或软件。

例如：本软件运行时需要调用水资源信息实时处理业务系统V1.0

8、产品说明应指明产品期望在单一系统上供多个并发最终用户使用

或供一个最终用户使用，并且应说明在所要求的系统的所陈述的性能

级别上可行的最大并发最终用户数；

例如：当软件支持并发时，此处可进行如下类似描述：本软件在单一系统上可供多个并发最

终用户使用，在服务器主频大于3.0GHZ、内存大于2GB、响应时间小于5秒的情况下最大

100并发最终用户。

当软件不支持并发时，此处可进行如下类似描述：本软件在单一系统上只供一个最终用户使

用，不支持并发操作。

2

文档来源为:从网络收集整理.word版本可编辑.欢迎下载支持.

9、产品说明应陈述是否对运行COTS软件产品提供支持；

10、产品说明应陈述是否提供维护。如果提供维护，则产品说明应陈

述所提供的维护服务。

11、产品特性说明：

11.1、功能性

（1）、适用时，产品说明应根据GB/T16260.1-2006包含有关功能性

的陈述，要考虑适合性、准确性、互操作性、安全保密性以及功能性

的依从性，并以书面形式展示可验证的依从性证据；

（2）、产品说明应提供