`
sundful
  • 浏览: 1253247 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

开发者必知 制作标准用户手册的15条技巧

阅读更多
用户手册声称可解决问题,但实际上不仅不能提供帮助,反而让你愈加迷惑,这种情形你多久会遇到一次呢?如果你是一个典型的用户,这种情形可能会经常发生。设计得如此糟糕的内容会让用户产生不满与沮丧情绪,对产品质量留下不良印象;而且还会(对出售产品的公司来说)增加售后服务时间与成本。

  于是智能文本管理应运而生。智能文本管理理解终端用户的行为,并在多数可能的实际行为中与用户需求保持一致。在本文中,我将提供一些实际技巧,帮助你建立合适、易懂、可读性强的用户手册。

  了解你的读者

  了解手册的读者是谁,读者需要了解什么内容。这样你就可以决定手册内容的深度与广度,以及编写手册应使用何种语言(例如,针对专家与初学者的语言与内容都有所不同)。关键在于只提供用户需要的信息——不多也不少。

  采用面向任务的方法

  多数产品的功能体现在允许用户实现特殊的任务。采取面向任务的方法,根据应用产品能够执行的任务来安排手册内容。例如,如果产品帮助你配置网络,你的手册目录应包含这样的标题,如“建立一个网络”、“配置网络设置”及“删除网络”。

  确保信息流程合乎逻辑

  仔细研究一下产品,以循序渐进的方式了解先做什么、接着做什么、最后做什么。这样做可以大大改进文件信息的易读性。

  应用模块

  把信息分解成易于管理的小块,每个部分解释一个特定的用途或主题。这样的小块让读者阅读起来很轻松,各部分的思路也很清晰。模块式的写作方式易于维护,并可通过内部链接实现信息再利用。

  应用目录

  目录可帮助我们了解手册的整体内容。保证手册内容全面、结构完整、并拥有一个模块化的布局。这种方法可帮助用户方便找到他们所需要的信息。

  应用有意义的一致标签

  清晰且提供信息的标签可帮助用户快速而正确的找到信息。避免使用一般的标签标题,标签应简明扼要。

  以交谈式的语调书写

  采用常见问答(FAQ)的编写方法。这种方法允许你轻而易举地缩短用户与产品之间的差距,并提供许多用户需要的通用信息。

  仔细考虑重要信息的位置

  首先查看页面或屏幕的中部,然后是左上角,是人类的本性。尽量将材料的重点内容安排在布局的物理中心附近,并将主标题安排在左上角。

  应用适当的插图

  令人惊奇的是,人们往往低估了图片在文本中的作用。外观吸引人的文本总能发挥更大的作用。插图(图例、表格、工艺流程图)是手册内容的主要组成部分,它不但能吸引读者的注意力,还可强化阅读效果。

  尽可能将信息制成表格

  表格可改善信息的可读性。在需要根据不同的基础描述对象,或在不同的维度间比较对象时,可应用表格。

  提供实例

  用类推、实例或个案研究来证明你的概念与说明。实例有助于用户迅速掌握概念,并更好地理解其内容。

  包含解决问题的提示

  在为程序作注解时,分析可能的失败情形并告诉用户如何处理发生的问题。如果你有一本独立的解决问题的手册,指导用户去那里寻找更多的信息。

  建立很好的索引

  人们通常认为,如果材料设计很糟糕的话,用户就会在索引中寻找所需的信息。在索引中通过重要的关键词来包含基本信息,以方便信息恢复。

  编辑与审核

  对材料进行编辑,保证它遵守完整性、语言、拼写与语法、连贯性与格式方面的规则。

  执行“现实检查”

  确保对材料与产品进行协同测试,以揭示书面材料与现实应用之间的差异。对揭示的差异进行纠正,并重复测试过程,保证在纠正过程中不会出现新错误。

  顾客支持

  记住,用户手册的主要目的在于提高用户的生产效率,减少顾客支持时间、成本与努力。优质的材料可作为新用户的培训材料,以及返回用户的支持材料。遵守上述指导方针可保证信息的访问性与可用性,减少支持时间,提高顾客满意度。

分享到:
评论

相关推荐

    jQuery开发者手册

    《jQuery开发者手册》是一份详尽的资源,旨在帮助开发者深入了解和熟练运用jQuery库进行Web开发。这份手册包含了从基础到高级的jQuery语法、方法和技巧,尤其适合那些JavaScript基础知识较为薄弱的学习者。 jQuery...

    chm手册制作器

    离线手册对于软件开发者、技术支持人员以及需要技术文档的用户来说非常有用,因为它可以确保他们即使在没有互联网的情况下也能访问所需的指导信息。手册制作则涉及到文档的组织、排版和格式化,确保内容清晰易读。...

    ok6410开发用户手册

    《OK6410-A开发板LINUX2.6.36用户手册.pdf》是手册的核心部分,它涵盖了从Linux内核编译到根文件系统制作的全过程。首先,手册将引导开发者了解如何获取并编译适合OK6410的Linux内核源码,这涉及到内核配置、编译和...

    网页制作完全手册网页制作完全手册

    网页制作完全手册是一本全面介绍网页制作的资源,旨在帮助初学者和有一定基础的开发者深入理解和掌握网页制作的各个环节。手册可能涵盖了HTML基础、CSS样式、JavaScript编程、响应式设计以及网页布局等多个方面。 ...

    开发人员手册大全

    这份手册可能涵盖了HTML、CSS、JavaScript以及DOM的结合使用,是前端开发者了解动态页面制作的关键资料。 3. **C++Primer4E.chm**:C++ Primer第四版是C++初学者和进阶者的权威指南,涵盖了C++的基础和高级特性,...

    帮助手册制作工具

    在IT行业中,帮助手册制作工具是开发者和文档编写者的重要辅助工具,用于创建详细、易于理解的用户指南或产品说明书。这些工具简化了手册制作流程,使得非专业设计师也能快速生成高质量的文档,大大提高了工作效率。...

    独立游戏开发者电子书及其他

    4. **项目管理**:独立开发者往往需要身兼多职,时间管理和项目规划技巧尤为重要。电子书可能涵盖敏捷开发方法、任务优先级设定以及如何有效地平衡资源。 5. **市场推广与发行**:发布游戏后,如何吸引玩家并获得...

    金蝶K3 WISE BOS系统用户手册

    金蝶K3 WISE BOS系统用户手册 本手册为金蝶K3 WISE BOS系统用户提供了详细的使用指南,涵盖了系统的总述、操作建议、操作流程、系统功能和特点、系统设置等方面的内容。 系统总述部分介绍了金蝶K3 WISE BOS系统的...

    蛮牛Unity3D离线用户手册

    《蛮牛Unity3D离线用户手册》是一本详尽的资源,专为那些希望深入理解和精通Unity3D游戏引擎的用户设计。手册涵盖了从入门到高级的各个层面,是学习和提升Unity技能的重要参考资料。 Unity3D是全球广泛使用的跨平台...

    HTML网页制作完全手册.7z

    这本“HTML网页制作完全手册”无疑是一份详尽的指南,旨在帮助初学者和有经验的开发者全面掌握HTML的各种元素、属性和技巧。 HTML的基础在于其结构化标记,通过一系列标签来定义网页的各个部分。例如,`<html>`标签...

    [网页制作]网页制作完全手册(lemon)

    9. 最新趋势与标准:随着技术的发展,网页制作的标准和最佳实践也在不断更新,手册可能会关注最新的Web标准,如Web Components,以及如何适应未来的技术变化。 通过《网页制作完全手册》,读者可以系统学习网页制作...

    网页制作必备,script必备手册

    10. **调试技巧**:学习使用开发者工具进行代码调试,找出并修复错误,是成为一个熟练JavaScript开发者的必备技能。 这个"网页SCRIPT完全手册.chm"很可能是详尽的电子教程,包含了以上提到的所有概念,甚至可能更...

    css中文参考手册+w3school+网页制作完全手册

    红黑软件使用帮助.txt可能是某款与网页制作相关的软件的用户指南,它会包含如何安装、配置、操作该软件的步骤和技巧,对于提高网页制作效率至关重要。而红黑联盟软件说明.url可能指向一个网站,提供关于特定软件或...

    网页制作完全手册(DHTML)

    《网页制作完全手册(DHTML)》是一本...通过阅读《网页制作完全手册(DHTML)》,读者不仅可以掌握DHTML的基础,还能深入理解网页动态化的设计理念和实现方法,从而成为一名能够创建互动性强、用户体验优秀的网页开发者。

    自己用VS2008制作项目的操作手册及数据库说明书

    本压缩包包含的“自己用VS2008制作项目的操作手册及数据库说明书”就是一个全面的项目支持材料,旨在帮助用户理解和操作由Visual Studio 2008(VS2008)开发的应用程序以及与其相关的SQL数据库。 首先,让我们详细...

    html网页制作完全手册

    HTML(HyperText Markup Language)是用于创建网页的标准标记语言,它是Web前端开发的基础。本《HTML网页制作完全...无论你是网页设计师、开发者还是对网页制作感兴趣的学习者,这本手册都将是你不可或缺的参考资料。

    非常好用的网页制作完全手册

    网页制作完全手册是一份详尽的资源,旨在帮助初学者和有一定基础的用户掌握网页制作技术。这份手册可能涵盖了HTML、CSS、JavaScript等核心语言的基础和高级应用,以及与网页设计相关的各种概念和技巧。 首先,HTML...

    做网页必备的全套手册

    "做网页必备的全套手册"提供了一个全面的学习资源,涵盖了从基础到高级的各种主题,旨在帮助设计师和开发者提升他们的网页制作能力。手册可能包括了以下几个核心知识点: 1. **网页设计基础**:这部分可能会介绍...

    ECSHOP 模板制作引导手册.rar

    这份手册详细解释了每一个步骤,从模板的基础知识到高级技巧,对于初学者和有经验的开发者来说都是一份宝贵的参考资料。在实践中不断探索和学习,你将能够充分利用ECSHOP的模板系统,创建出独特的电商网站。

    网页制作完全手册(相当经典)

    网页制作完全手册是一本经典的学习资源,主要涵盖了网页制作的基础知识和进阶技巧。这个压缩包中的"js.chm"文件很可能是一个关于JavaScript编程的帮助文档,因为JavaScript是网页制作中不可或缺的一部分,尤其是在...

Global site tag (gtag.js) - Google Analytics