`

你知道制作用户手册的15条技巧吗

 
阅读更多

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

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

  • 了解你的读者

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

  • 采用面向任务的方法

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

  • 确保信息流程合乎逻辑

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

  • 应用模块

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

  • 应用目录

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

  • 应用有意义的一致标签

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

  • 以交谈式的语调书写

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

  • 仔细考虑重要信息的位置

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

  • 应用适当的插图

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

  • 尽可能将信息制成表格

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

  • 提供实例

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

  • 包含解决问题的提示

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

  • 建立很好的索引

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

  • 编辑与审核

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

  • 执行“现实检查”

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

顾客支持

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

分享到:
评论

相关推荐

    TRSWCM6.5用户手册

    本用户手册不但能帮助您快速了解TRS WCM从内容创建到发布的工作流程,并通过详细的讲解,让您全面掌握系统所有功能的使用方法和技巧。 手册包括以下各个部分: 第1章 系统概述 系统功能及特色简介。 第2章 开始使用 ...

    网页制作完全手册(HTML/CSS) 参考

    网页制作完全手册 -------------------------------------------------------------------------------- 通过下列链接访问参考资料,可帮助你创建引人注目的 Web 页面。 动态 HTML (DHTML) 对象模型参考 DHTML ...

    html参考手册+CSS参考手册+html资源等12个文件.rar

    网页制作完全手册 -------------------------------------------------------------------------------- 通过下列链接访问参考资料,可帮助你创建引人注目的 Web 页面。 动态 HTML (DHTML) 对象模型参考 DHTML ...

    DHTML 手册

    网页制作完全手册 -------------------------------------------------------------------------------- 通过下列链接访问参考资料,可帮助你创建引人注目的 Web 页面。 动态 HTML (DHTML) 对象模型参考 DHTML ...

    一份 Suno AI的操作手册-Suno V3推出全新版本,用户可自定义歌词,更准确表达情感

    内容概要: Suno V3是Suno AI推出的全新版本,这个版本的特点是允许...手册将提供详细的操作说明和有效的使用技巧,但用户可能还需要通过实践,不断试错并根据自己的实际需求进行调整,才能最大限度地利用这个功能。

    blender教程中文手册入门

    因此,我们为您推荐一份完整的Blender中文教程手册,从基础入门到实用技巧,详细教学Blender的框架逻辑、界面、功能操作等内容。 在这份免费教程里,您将从零开始学习Blender,掌握3D建模、材质贴图、动画制作、3D...

    javascript完全学习手册1 源码

    javascript完全自学手册 目 录 第1篇 JavaScript基础篇 第1章 JavaScript简介 1 1.1 JavaScript概述 1 1.1.1 什么是JavaScript 1 1.1.2 JavaScript的基本特点 2 1.1.3 常用的Web开发语言 3 1.2 JavaScript的应用 4 ...

    [2013Photoshop CS6完全自学手册].贾婷婷.电子音像出版社.扫描版(共2部分).part2

    贾婷婷编著的这本《2013Photoshop CS6完全自学手册》从实用的角度出发,以通俗易懂的语言对Photoshop CS6的基础知识和应用技巧进行了全面讲解,主要内容包括:初识Photoshop CS6、Photoshop CS6基础操作、选区的使用...

    IBM AIX 应用技巧

    AIX简介 AIX技巧: AIX 4.3.3 的中文输入 AIX 的许可权限---ACL AIX常用命令 AIX的版本号代表什么意思?...如何在WINDOWS下制作AIX安装盘在AIX4.3.3系统中,为什么oslevel命令的输出不是怎样查看RS/6000的物理内存

    MySQL中文参考手册.chm

    10.6 选择一种表类型 10.6.1 静态(定长)表的特点 10.6.2 动态表的特点 10.6.3 压缩表的特点 10.6.4 内存(In-memory table)表的特点 10.7 其他优化技巧 10.8 使用你自己的基准测试...

    PhotoshopCS6完全自学手册.pdf

    贾婷婷编著的这本《2013Photoshop CS6完全自学手册》从实用的角度出发,以通俗易懂的语言对Photoshop CS6的基础知识和应用技巧进行了全面讲解,主要内容包括:初识Photoshop CS6、Photoshop CS6基础操作、选区的使用...

    程序天下:JavaScript实例自学手册

    14.18 十六进制转换为十进制 14.19 将URL转化为16进制 14.20 小写金额转换为大写 14.21 通过两点坐标计算直线距离 14.22 随机抽取彩票 14.23 实时计算折扣 14.24 实用计算器 14.25 前面补0的方法 第15章 图形、图像...

    《程序天下:JavaScript实例自学手册》光盘源码

    14.18 十六进制转换为十进制 14.19 将URL转化为16进制 14.20 小写金额转换为大写 14.21 通过两点坐标计算直线距离 14.22 随机抽取彩票 14.23 实时计算折扣 14.24 实用计算器 14.25 前面补0的方法 第15章 图形、图像...

    DELPHI技巧集(集合各种开发源码)

    55 Jq10.htm Delphi编程技巧十则 7K 56 Jq2.htm Delphi实用编程经验二则 3K 57 Jump_com.htm 用Delphi设计拨动、跳线开关组件 3K 58 Line.htm 用Delphi编程时如何利用线程 5K 59 Link.htm Delphi3.0中连接...

    leetcode手册JAVA-tipsandtricks:技巧和窍门

    leetcode手册JAVA 日常 IT 日的提示 桌面工具 适用于 Windows、Max、Chrome、Firefox、Opera 的免费屏幕截图工具。 托管和部署 Netlify(前端) Jamstack 的强大无服务器平台。 Heroku(后端) 使用完全托管的数据...

    MySQL中文参考手册

    + 4.11.15 HP-UX 注意事项 o 4.12 Win32 注意事项 + 4.12.1 在 Win32 上安装 MySQL + 4.12.2 在 Win95 /Win98上启动 MySQL + 4.12.3 在 NT 上启动 MySQL + 4.12.4 在 Win32 上运行 MySQL + 4.12.5 用 SSH ...

    新片场从零开始学PR CC2022-视频教程网盘链接提取码下载 .txt

    从零开始带你全面体系化地学习剪辑详解Pr工作逻辑和操作技巧,本课程累积于新片场十年影视制作经验,并参考Pr官方用户手册,力图带给你更全面、更体系化的Pr剪辑知识,有很多教程能教你做各种视频效果但很少能从视频...

    Dreamweaver CS3中文版课程设计案例精编-素材

    为了使掌握了Dreamweaver CS3基础知识的读者能够更好的使用该... 本书适用于对Dreamweaver有一定的了解,希望掌握制作精美图案的制作方法和技巧的用户。适合做为学完该课程的学生和读者作为课程设计的参考手册使用。

    硬盘播出系统说明

    4:将SQL光盘数据复制到硬盘,从系统硬盘进行安装,需要一定技巧,方法是先将保存SQL数据的文件夹映射成为 一个盘,在这个虚拟盘上进行安装。 第四步:安装DirectX8.1或更高的9.0。 1:安装完成后重新启动计算机。...

    历时半年收集的电子资料,电子职业者和爱好者的福音

    STM32、C51设计的各种项目及其资料,Altium Designer学习资料—包括使用教程手册、元件封装库及设计技巧,信号放大、小信号测量、电源设计,电路城助力设计大赛,最经典的开发板资料聚集地【附用户手册、原理、材料...

Global site tag (gtag.js) - Google Analytics