通常情况下认为产品包中的文档只包括帮助文件、产品规格说明书,但一款优秀的产品,其产 品包中的文档根本不止这些内容,一般一个产品包应该包括以下几大类文档: (1)用户手册。 (2)联机帮助文件。 (3)安装指导文件。 (4)错误提示信息。 (5)包装文字和图形。 (6)市场宣传材料、广告及其他插页。(7)授权/注册登记表。 (8)用户许可协议。 (9)标签和封条。 (10)向导、指南。 (11)教程、样例、示例和模板。
用户手册主要是指导用户如何使用本产品,介绍产品的功能及使用,需要注意的是,如果该产 品包括软件和硬件,用户手册中就不能只描述软件部分的内容还必须描述产品的硬件指标。 联机帮助文件是任何一个完备的应用软件所不可缺少的重要组成部分,一个好的联机帮助系统 可以使用户在软件使用过程中能够迅速掌握软件的操作和使用方法,使系统具备很强的自学习能 力,如 Microsoft Word 工具在帮助菜单就有专门的联机帮助文件。当然对于一个嵌入式产品来说, 就不存在联机文件了,主要是用户手册。 安装指导文件主要是用于指导用户如何安装系统,对于产品来说则是指导用户如何安装该产 品。安装说明书写得好坏将直接影响到用户的安装进展,如果安装说明书无法很好地指导用户安装 产品,企业将会接到用户的抱怨和投诉。 错误提示信息文档主要用于指导解决用户在使用过程中出现异常的情况,主要体现在两个方 面:一是方便沟通,例如家里的宽带,如果有一天突然不能正常上网,一般会给厂商的技术支持打 电话咨询,一般技术支持工程师都会想出错的代码,而不是内容,试想一下,通过一个错误代码沟 通顺畅还是一大堆的错误提示信息沟通顺畅呢?如图 19-1 所示为宽带连接错误的提示信息 678。
二是提高解决问题的效率,错误提示信息文档中会写明每种错误提示信息出现的原因和解决方 法,表 19-1 是关于 Microsoft Excel 错误提示信息表。
包装文字和图形主要用于传达商品信息,有的包装设计中可能没有图形图像,但必须有文字说 明,如图 19-2 所示。
市场宣传材料、广告及其他插页主要用于向客户宣传本公司的产品,宣传材料和广告中的数据 必须保证准确无误。 授权/注册登记表也是产品文档中的一部分,主要用于授权/注册客户填写。 用户许可协议(End User Licence Agreement,EULA),是指企业的软件与软件的使用者所达成 的协议,此协议一般出现在软件安装时。如果使用者拒绝接受这家企业的 EULA,便不能安装此软 件。EULA 主要规定用户不可以盗版软件,如图 19-3 所示为安装过程中的许可证协议。 标签和封条是用于标明物品的品名、重量、体积、用途等信息的简要标牌。 向导和指南是指产品功能的向导和指南,也可能是安装的向导和指南。 教程、样例、示例和模板用于指导用户如何使用某个功能,如函数说明和使用实例。