多语言展示
当前在线:805今日阅读:176今日分享:34

用户手册编写攻略

用户手册的编制是要使用非专业术语的语言,充分地描述软件系统所具有的功能及基本的使用方法。用户通过阅读用户手册,对我们产品的功能、操作有一定的认识,按照用户手册上的说明,通过实际操作,能够掌握我们产品的操作方法及解决过程中出现的各种问题。
编写指南
2

编写要求2.1.编写内容(1).完整性质量良好的用户手册,至少应该是能够包括软件产品的所有相关内容,能够指导用户顺利的安装、设置和使用软件。保证内容的全面性和完整性是把握用户手册质量的重要方面。(2).一致性用户手册的内容不仅要保证其全面性和完整性,还要确保它与一起发行的软件版本的实际功能相一致。(3).准确性用户手册编写完毕后最好能安排人员进行审核,保证它遵守完整性、语言、拼写与语法、连贯性与格式方面的规则,及时发现和纠正手册中的错误,如错别字、图片序号与描述不匹配等等。(4).统一性整份用户手册的描述语言、描述风格尽量统一,方便用户的阅读。2.2.编写风格(1).描述规范准确,在描述内容、说明方法、提出见解时都应准确无误,恰如其分。用词应标准、统一、规范。(2).假设用户什么都不懂,应该详细地描述操作过程中的每一步。(3).尽可能将信息制成表格,表格可改善信息的可读性。在需要根据不同的基础描述对象,或在不同的维度间比较对象时,可应用表格。(4).通俗易懂,尽量不使用较深奥的计算机术语,如果不可避免,应该给予适当的解释和说明。(5).层次分明,每节的内容必须明确,这样用户可以通过目录很方便地查到自己所需要的内容;注意段的划分,每段不要太长,突出重点,否则用户不容易获得其中的精华。(6).前后一致,在用户手册中使用的概念、术语的用词要前后保持一致。(7).分析可能的失败情形并告诉用户如何处理发生的问题。如果你有一本独立的解决问题的手册,指导用户去那里寻找更多的信息。(8).图文并茂,适当举例,实例有助于用户迅速掌握概念,并更好地理解其内容。

推荐信息