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

附件4：产品说明的提交要求明的项目。斜体字是对国家标准条款的解读或举例，仅供使用者参考。一、产品说明：【定义】陈述软件各种性质的文档，目的是帮助潜在的需方在采购前对该软件进行适用性评价。【要求】产品说明对于需求方是可用的，包含潜在需方所需的信息，信息内容应排除内部的不一致，且与用户文档集和软件实际情况一致，产品说明的内容应该是可要有封面和目录，方便使用者进行内容查找。【内容】1、软件产品应以其名称、版本和日期指称；解读：软件产品要用名称+版本或名称+日期命名。例如：城市水资源管理系统软件V1.0或城市水资源管理系统软件2011。2、产品说明应显示唯一的标识；解读：产品说明在封面或卡片的显著位置显示唯一的产品标识。例如：城市水资源管理系统软件V1.0产品说明。3、产品说明应包含供方和至少一家销售商（当适用时）电子商务销售商或分销商的名称和地址（邮政的或网络的）。4、产品说明应标识该软件能够完成的预期的工作任务和服务；解读：此项描述软件的销售方向，适用的行业，潜在的客户群，概要介绍软件的用途。5、供方想要声称软件产品符合由法律或行政机构界定的要求时，产品说明应标识出这些法律或行政机构界定的要求的需求文档；SL475-20106（或硬件；或（例如：本软件在对水资源处理装置进行远程动态监控及实时处理时如传输距离超过50米需要信号放大器或无线信号发射器与无线信号接收器7、产品说明引证已知的对其他软件的用户可调用的接口时，应标识出这些接口或软件；例如：本软件运行时需要调用水资源信息实时处理业务系统V1.08级别上可行的最大并发最终用户数例如：当软件支持并发时，此处可进行如下类似描述：本软件在单一系统上可供多个并发最终用户使用，在服务器主频大于3.0GHZ、内存大于2GB、响应时间小于5秒的情况下最大100并发最终用户。9、产品说明应陈述是否对运行COTS软件产品提供支持；10述所提供的维护服务。11、产品特性说明：、功能性GB/T16260.1-2006、产品说明应提供该产品中最终用户可调用的功能的概述；、产品说明应说明所有的关键功能；、当有软件组件的选项和版本时，应予指明；例如：本软件的无线数据处理组件为可选项，用户可根据实际情况决定是否购买该组件或，其版本。、对用户功能性的所有已知的限制均应加以说明；例如：本软件登录的用户名和密码为数字和字母组合，长度大于6位，小于18位，单个文件记录的最大数目为100条，可连接的外围设备小于100个。、当提供对软件的未授权访问（不管是偶然的还是故意的）预防措施时，则产品说明应包含这种信息；例如：登录窗口在三次输入错误密码的情况下自动关闭。可靠性GB/T16260.1-2006（即是可用的）能力作出说明；数据备份由操作系统的功能来执行也是可接受的。、易用性GB/T16260.1-2006、产品说明应规定用户接口的类型；解读：规定用户使用软件产品时通过什么方式与系统进行信息交互这些方式可以是命令行、菜单、视窗、web浏览器、功能键、帮助功能等。、产品说明应规定使用和操作该软件所要求的专门知识；具或规程及其使用条件；护；户和存在语言差异的用户。解读：软件在与用户进行信息交互的时候，需要操作人员能够正确理解软件输出的各种信息，、效率GB/T16260.1-2006式写出能够证实可验证的依从性证据。、维护性GB/T16260.1-2006、产品说明应包括用户所需的维护信息。、可移植性GB/T16260.1-2006置（硬件，软件）；解读：软件运行需要其它硬件和软件的支持，因此产品说明需要对这些硬件和软件进行描述，（、产品说明应提供安装规程信息。解读：软件安装可以由供方完成，也可由用户完成，因此安装规程必须指明安装由谁进行，且提供安装过程的操作信息。、使用质量GB/T16260.1-2006注：使用质量的陈述主要取决于使用周境。尽管不可能考虑到COTS的所有可能的用户，最好还是能说明典型的预期用户及其预定的用途。有关效率、有效性和满意度测试的信息参见ISO/IEC25062：《软件工程软件产品质量要求和评价(SQuaRE)易用性测试报告的通用行业格式》。）、应给出测试报告的引用文件。注：测试报告的格式在GB/T16260.4解读：对产品质量进行陈述须依据测试报告，产品说明应指出这些测试报告的引用文件。附件5：用户文档集提交说明一、需提交的资料及要求录，用户文档集中应至少包括以下几项内容：1、软件产品运行的软、硬件环境说明信息；2、安装说明发单位的技术人员完成；3、所有功能的具体操作说明即详细的用户操作手册，应详尽地说明能够完成的所有功能，及如何在系统中操作才能完成相应的功能(应配以软件实图加以说明)；4、软件产品所完成业务的详细流程；5、测试用例：企业内部测试系统时使用的测试用例。6、计算机软件产品功能列表产品名称版本功能项功能描述功能1一级子功能1二级功能1…二级功能n一级子功能2二级功能1…二级功能n…二级功能1…二级功能n功能2……功能n注：软件功能项目列表需列出与测试相关的所有功能（包括各级子功能）。7、计算机软件产品功能列表(填写示例)产品名称中小学学校信息管理系统V1.0版本V1.0软件功能项功能描述设置学校基本信息设置学校基本信息和属性年级设置设置学校开设年级、学制等班级设置对班级进行编码，设置班级开班时间等基本属性课程设置对不同年级开设课程进行设置系统参数设置设置图片存放路径等参数学生信息管理基本信息学籍档案试成绩等毕业对毕业生进行毕业处理，记录学生毕业去向等信息学生调班重新分班配到同年级各个不同的