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

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

说明：红字条款可根据软件产品实际情况进行剪裁，黑字条款为标准要求必须说明的项目。斜体字是对国家标准条款的解读或举例，仅供使用者参考。

一、产品说明：

【定义】

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

解读：产品说明为供方在进行产品销售时对产品性质的宣传资料，目的是让采购方获得产品概况，判断该产品是否能够满足自己的需求，进而决定是否采购该产品。

【要求】

产品说明对于需求方是可用的，包含潜在需方所需的信息，信息内容应排除内部的不一致，且与用户文档集和软件实际情况一致，产品说明的内容应该是可以验证或测试的，产品说明应有唯一性标识，当产品说明内容超出一页文档时，要有封面和目录，方便使用者进行内容查找。

【内容】

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

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

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

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

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

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

3、产品说明应包含供方和至少一家销售商（当适用时）电子商务销售商或分销商的名称和地址（邮政的或网络的）。

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

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

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

例如：本软件为水务行业管理软件，适用于各供水公司、净水厂、水污染处理企业、政府水资源行业管理部门，可完成水资源相关业务的管理及实施对水资源处理装置的动态监控和实时处理。

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

解读：供方为加大产品的宣传力度，增强产品竞争力，更好的销售其软件产品，可表明其产品符合法律或行政机构界定的要求。但必须将符合的内容在产品说明中进行详细说明。

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

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

解读：当产品在某些情况下需要依赖于特定的软件和（或）硬件才能实现其生成的产品性质时，要对这些特定的软件和（或）硬件进行描述，以便采购方在采购产品时能够合理评价采购成本。

例如：本软件在对水资源处理装置进行远程动态监控及实时处理时如传输距离超过50米需要信号放大器或无线信号发射器与无线信号接收器

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

解读：如果软件再使用过程中需要调用其他软件许可的接口时，应说明这些接口或软件从而使采购方在选择该产品时，明确还需购买其他接口许可或软件。

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

8、产品说明应指明产品期望在单一系统上供多个并发最终用户使用或供一个最终用户使用，并且应说明在所要求的系统的所陈述的性能级别上可行的最大并发最终用户数；

例如：当软件支持并发时，此处可进行如下类似描述：本软件在单一系统上可供多个并发最终用户使用，在服务器主频大于3.0GHZ、内存大于2GB、响应时间小于5秒的情况下最大100并发最终用户。

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

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

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

11、产品特性说明：

11.1、功能性

（1）、适用时，产品说明应根据GB/T16260.1-2006包含有关功能性的陈述，要考虑适合性、准确性、互操作性、安全保密性以及功能性的依从性，并以书面形式展示可验证的依从性证据；

（2）、产品说明应提供该产品中最终用户可调用的功能的概述；

例如：本软件由人事管理功能、水资源实时处理功能、行政审批功能、取水管理功能、供水管理功能、污水处理管理功能组成。

（3）、产品说明应说明所有的关键功能；

例如：本软件的关键功能为：水资源实时处理功能、取水管理功能、供水管理功能、污水处理管理功能。

（4）、当有软件组件的选项和版本时，应予指明；

解读：软件在销售时某组件存在可选项或存在不同版本时，产品说明应明确说明，进而降低采购方采购成本。

例如：本软件的无线数据处理组件为可选项，用户可根据实际情况决定是否购买该组件或，其版本。

（5）、对用户功能性的所有已知的限制均应加以说明；

解读：说明哪些限制会对用户使用软件功能造成影响，比如最大值或最小值、密钥长度、单个文件中记录的最大数目、搜索准则的最大数目、最小样本规模等。

例如：本软件登录的用户名和密码为数字和字母组合，长度大于6位，小于18位，单个文件记录的最大数目为100条，可连接的外围设备小于100个。

（6）、当提供对软件的未授权访问（不管是偶然的还是故意的）的预防措施时，则产品说明应包含这种信息；

例如：登录窗口在三次输入错误密码的情况下自动关闭。

11.2可靠性

（1）、适用时，产品说明应根据GB/T16260.1-2006包含有关可靠性的陈述，要考虑成熟性、容错性、易恢复性以及可靠性的依从性，并以书面形式展示可验证的依从性证据；注：开发者不宜作出可靠性声称的陈述，除非能以服务的数据或其他可验证的数据证实所做的声称；

在遇有用户接口出错、应用程序自身的逻辑出错、系统或网络资源可用性引发差错的情况下，产品说明应就软件的继续运行（即是可用的）能力作出说明；

（2）、产品说明应包括关于数据保存和恢复规程的信息；注：指明数据备份由操作系统的功能来执行也是可接受的。

11.3、易用性

（1）、适用时，产品说明应根据GB/T16260.1-2006包含有关易用性陈述，要考虑易理解性、易学性、易操作性、吸引性以及易用性的依从性，并以书面形式写出能够证实可验证的依从性证据。

（2）、产品说明应规定用户接口的类型；

解读：规定用户使用软件产品时通过什么方式与系统进行信息交互这些方式可以是命令行、菜单、视窗、 web浏览器、功能键、帮助功能等。