创建用户手册的 13 条简单但强大的规则
用户手册主要是为了支持用户如何使用产品和解决问题而创建的。完美的用户指南和客户支持在许多购买中至关重要，这就是为什么创建用户手册不是一次性工作的原因。
恰恰相反，只要产品存在，它就是一个持续进行的项目。因此，最新且易于访问的手册和交互式用户指南对于任何企业都至关重要。我们将在另一篇文章中讨论用户手册生命周期，但在这篇文章中，我们将讨论影响技术文档的实用性和受欢迎程度的因素，这可能会导致您的服务和产品的知名度不断提高。
以下是任何技术作家在创建用户指南时必须考虑的13 个简单但强大的技巧。我们还将了解 Sonat 如何帮助我们做出巨大改变并创建出色的在线用户指南并为我们的客户提供出色的用户体验。
1. 确保您完全了解您的产品
必须对您所写的主题有全面的了解。
除非您完全了解该产品，否则您无法指导人们如何使用该产品并解决他们的问题。
虽然你总是可以向专家咨询更深入的知识，但你必须确保你熟悉产品并有实践经验来教授和给出明确的指示。
除非您完全了解产品，否则您无法指导人们如何使用该产品。
以下是一些提示，可帮助您编写易于理解的用户说明：
- 逐步执行您所写的过程。
- 教授一门学科是掌握该学科的明智方法。尝试教授该过程，寻求反馈，然后根据输入进行改进并消除歧义。
- 如果您对某些部分不能 100% 确定，请毫不犹豫地寻求专家意见。
2. 确定目标受众
在起草用户说明指南之前，确定目标受众并适应他们的需求是基础。您应该仔细确定您正在向谁讲话。考虑他们的背景、知识、专业水平以及他们向您推荐指南的原因。
您的用户可能是：
- 首次使用的用户；对你的产品不熟悉。
- 不熟悉某些功能的现有客户。
- 偶尔遇到一些意外问题或忘记如何使用某些特定功能的专业用户。
因此，您需要设身处地为用户着想，了解他们可能需要什么，以及如何最好地满足他们的需求。它还将帮助您明智地选择词语。
当您为一般用户写作时，您需要尽量减少使用技术术语、首字母缩略词和行话，这样您就不会混淆和恐吓您的客户。如果不可避免地要使用技术术语，那么提供术语表会很有帮助。
不要忘记，您正在为正在寻找获取产品的按钮的用户编写，而不是为开发人员或专家编写。再次强调，请记住，您创建用户手册并不是为了通过使用大词来给人们留下深刻印象；而是为了让用户印象深刻。这是为了通知您的用户。因此，您必须使其尽可能易于理解。
有些事情对您和其他专家来说可能是显而易见的，但对您的用户来说却是一个问号。观察实际用户使用你的产品可以让你更好地了解你忽略的具体事情。
识别你的受众，创建一个角色，设身处地为他们着想，并像他们一样思考。
以下是定义受众时需要考虑的一些提示：
- 考虑用户的规格、他们的需求以及他们可能有的问题。
- 如果您的受众不懂技术，请尽量减少使用技术术语，并在必须使用时向他们解释。
- 用简单的语言编写分步说明。
3. 使用合适且一致的写作风格
选择合适的写作风格。一般来说，遵循既定标准的半正式或正式风格可以帮助您在手册中有效地共享信息。
请记住，这是一份操作指南，其主要目的是告知读者并帮助他们解决可能遇到的问题。不宜使用幽默的语气或过多的非正式语气，这可能会导致失去要点。
用积极的语气写作并关注读者是你必须考虑的一个重要因素，因为它更容易理解。由于主动语态更清楚地指定主题，因此可以最大限度地减少混乱，尤其是当操作必须由用户自己完成时。
建立标准可以帮助您减少在有不同的使用文字或呈现插图和图表的方式时如何决定的担忧。
4. 使用通俗易懂的语言给出切中要点、准确的指示
您编写说明手册来帮助用户轻松回答问题、解决问题或学习如何正确、安全地使用产品。使用简单的语言给出清晰准确的指示。
以下是一些提示：
- 保持简洁。避免在句子中塞满过多无用的细节和重复的陈述。
- 使用清晰简单的词语。
- 将复杂的流程分成更小的部分，并提供分步且易于遵循的说明。
5. 构建和设计你的指南
用户手册的布局和设计对其功能有巨大影响。手册的格式应能够帮助用户轻松找到他们想要的内容。您可以通过在手册第一页上插入包含所有标题和副标题的目录来实现此目标。
Sonat 是一个免费的在线用户手册创建者。它会自动生成带有目录的用户手册的 PDF 版本。
在整个文本中使用一致的布局。设计和使用模板可以帮助遵循相同的标准。
避免使用塞满枯燥文字的令人生畏且令人困惑的手册。使用不同的颜色、字体、插图和视觉设计来帮助用户遵循步骤并区分多个过程、其他主题的重要性、警告等。
毕竟，手册的格式和设计应该使其具有用户友好的外观，以便您的客户发现它既易于理解又吸引眼球。
使用标准的用户手册模板可以为您提供准备好的格式和设计，以确保您走在正确的轨道上并且不会错过重要的标题。它可以节省您大量的时间和精力。
Sonat 还为您提供了多种选项来为您的用户手册进行交互式设计。您可以拥有无限的分层主题。您可以选择字体、样式、颜色、引用块、代码块等等。用户可以选择在深色模式或浅色模式下查看手册。
至于品牌，通过 Sonat，您可以为每个用户手册选择特定的主题、品牌颜色和徽标。您可以开始使用 Sonat 为您的受众免费编写产品文档、用户手册或教程。
6. 使用视觉效果更清晰
以清晰的视觉效果展示您的手册。通常，视觉内容说明，包括插图、照片、屏幕截图、符号和简短的教程视频，更容易理解和吸收。只有基于文本的手册可能会让用户感到厌烦或感到害怕。
此外，视觉设计还可以作为一种削减成本的措施，因为它减少了翻译工作。
添加视觉效果时需要记住以下一些提示：
- 使用高质量的照片。
- 使用简单的插图而不是复杂的图像。
- 插入短视频。
- 为您的视频添加字幕以进行索引和搜索。
用视觉效果丰富您的内容。
|
您可以使用 Sonat 插入和编辑各种视觉效果。它还允许您轻松地将 YouTube、Vimeo 和 DailyMotion 视频嵌入到用户指南中。
7. 重写、编辑和校对你的手册
大多数时候，您需要在发布之前阅读、重写、编辑和校对您创建的任何内容。用户手册也不例外。
风格和语言的不同方面可能需要编辑和修订，包括语法、拼写和标点符号。
通常，技术作家团队会共同努力创建出色的用户指南，同时不断征求专家的意见。此外，团队中还可能会增加一批翻译人员。当这样的团队正在处理一个项目时，没有什么比与团队共享不同类型的文档以供审阅和编辑更重要的了。以便所有成员能够合作，同时改进文本。
通过使用 Sonat，您可以享受一个集中的共享平台来工作、阅读、编辑和协作处理文档。我们将为它配备 18 种语言的拼写和语法检查。
 | 仍有疑问吗？阅读用户手册到底是什么以及它为何如此重要？这是满足用户需求的关键秘诀！ |
奏鸣曲为你提供了两个不同的世界； “草稿世界”实际上是在幕后，只有您和您的团队可以访问，并且在发布您的作品之前，您可以根据需要多次编辑和编辑。
然后是向用户公开的“发布世界”，也是您的受众最终看到的。但是，由于通过 Sonat 发布手动更新就像单击发布按钮一样简单，因此您可以编辑、更新和发布新版本。您始终可以访问草稿世界，历史记录功能可以帮助您跟踪所有更改。
8.考虑翻译和语言本地化
为了发展您的业务，您肯定希望给世界各地的客户留下深刻的印象并满足他们的期望。因此，您通常决定将说明手册翻译成其他语言。
Sonat 让您有机会在一本手册中介绍多达 184 种语言。
Sonat 创建的手册将根据用户浏览器上的本地语言向他们显示。但是，如果您尚未提供该特定语言的翻译，则将为您的用户显示手册的默认语言。
尝试提供内容翻译时请记住以下注意事项：
不要忘记注意语言本地化以进行有效沟通。语言本地化不仅仅是翻译，它涉及对目标文化的深入了解，以便产品能够有效适应当地需求。这可以作为翻译后的单独步骤来完成。然而，首先招募对目标语言和文化有深入了解的专业翻译人员，最好是母语人士，总是会让这个过程变得更加容易。
9. 包含参考文献并提供其他资源的链接
关键的一步是提供指向您组织资源的链接，以便您的用户可以轻松访问相关信息。这可以在在线手册中提供，这使得搜索信息变得容易。 Sonat允许您轻松地在在线手册中创建内部和外部链接。
10.寻求反馈
您编写用户手册来帮助客户轻松使用您的产品。这就是为什么在获得产品使用者的反馈之前，您无法创建完美的操作指南。
发布前
在您的用户指南公开之前，请与您组织中的一些真实用户、Beta 测试人员甚至是对您的产品最不熟悉的员工一起测试该手册，并寻求反馈。它可以帮助您发现自己在满足他们的需求时的弊病。
请注意他们在遵循您的指南时可能遇到困难的部分。如果您还向专家和开发人员寻求反馈，将会有所帮助。他们最了解产品，可以从专业人士的角度为您提供宝贵的建议。
这又是奏鸣曲可以成为你的黄金工具的时候了。还记得我们之前讨论过的奏鸣曲中的两个不同的世界吗？起草并发布。选秀世界可以让编剧团队进行无数的编辑和改进。嗯，这个世界不仅限于技术作家和编辑。您可以向一组 Beta 测试人员授予访问权限，并在发布您的作品之前寻求反馈。
发布后
发布手册后您将收到反馈。用户可以对每个案例发表评论，并分享他们对您的产品的体验。它可以帮助您不断监控用户的意见，认识到自己的缺点，并立即改进相关部分。
11. 使其易于访问
创建完用户手册后，就可以将其呈现给最终用户了。分发说明手册的最佳方法是在线发布。尽管您也可以提供印刷版本，但在线手册比纯印刷指南具有许多优势。 
仅举几例，许多人使用在线搜索来查找信息。毫无疑问，在线手册也更容易更新和共享。此外，最好考虑残疾客户的无障碍环境；电子版本为视力障碍或手动操作技能较弱的残障用户提供了更好的可用性。
您应该在手册中提供搜索选项，应用友好的用户界面 (UI)，并确保它在平板电脑和手机上看起来不错。 Sonat 可以为您提供所有这些功能，同时它还为用户提供下载 PDF 版本并保存以供日后使用的机会。因此，即使您的用户无法访问互联网，他们也可以访问该手册。
12. 保持手册最新
保持手册内容最新。鼓励您的用户分享他们的经验、建议和想法。使用有用的反馈和建议来改进您的内容，以便更好地理解。它向你的用户表明你在不断改进你的产品，更重要的是，关心和尊重他们的想法。
考虑到每个人都可以一键获得更新版本，在线手册在这方面具有显着的优势。
13.不要低估它的营销潜力
虽然用户说明的主要目标是分享有用的信息，但不要忽视其营销潜力。当然，手册中应避免直接营销和销售信息，但良好的用户支持将带来更多购买。
您的在线手册和产品文档可能是提高搜索排名和为您的网站产生潜在客户的主要工具之一。
Sonat 可以通过强大的 SEO 功能来满足您的营销目标，包括但不限于：
- 谷歌搜索控制台集成
- Bing 搜索控制台集成
- 描述元标签
- 文档、文档变体和主题的友好 URL
- 使用标题
- 谷歌分析集成
- CDN，Sonat使用强大的内容分发网络，可以减少内容的加载时间，并对搜索引擎产生更好的效果，从而获得更好的搜索排名。
- 将您的在线手册作为实现您的营销目标的宝贵工具。
- 使用用户手册提高您的搜索排名并为您的网站产生潜在客户。
你下一步怎么做？
准备好开始编写手册了吗？让我们更深入地了解它的部分、标题、组件和内容。阅读此处：如何创建专业的用户手册。
害怕从头开始写作？模板创造奇迹。报名 使用免费的用户手册模板编写专业手册。