如何编写入门指南：初学者指南！

第一印象很重要。当用户第一次尝试您的产品时，精心制作的入门指南可以使一切与众不同。

这是友好的导游欢迎新用户，向他们展示绳索，并为他们提供成功。

在本指南中，我将探讨有关创建有效入门指南的所有信息。从其目的和关键要素到编写技巧，示例和模板。

为什么要打扰？明确的入门指南通常是登机的基石。它使用户能够自我服务，减少基本支持问题，并建立对您产品的信心和信任。

准备潜水了吗？让我们开始吧！

我们严格测试和研究我们通过赫洛塞姆推荐的每种产品。我们的审查过程。如果您通过我们的链接进行购买，我们也可能会赚取佣金。

什么是入门指南？

入门指南是一个简洁，用户友好的文档（印刷或数字），可帮助新用户成功使用产品或服务。

将其视为初学者的手册，专注于必需品。它通常涵盖初始设置步骤，用户应首先尝试的基本功能或任务，以及避免常见陷阱的提示。

目标是让用户进入他们的“啊哈！”尽快。

实际上，入门指南提供了基本的设置说明（通常是分步格式），简单的用法示例，以及一些有关即时问题的故障排除提示。

它向用户展示了如何立即从产品中获得价值。最初的手持量对于减少挫败感并鼓励用户进一步探索有很长的路要走。

简而言之，这是产品手册友好的小兄弟姐妹- 专注于激光，以帮助用户扎根。

入门指南有多种形式：

• 对于软件，这可能是在线帮助中的欢迎教程或“入门”部分。
• 对于物理小工具，它可能是一个小折叠的快速启动指南小册子或盒子中的表（通常伴随完整的手册供以后参考）。

关键是它可以理解和访问。用清晰的语言编写，假设先验知识最少，并且通常包括视觉效果以说明要点。

入门指南的目的

为什么要创建入门指南？简而言之，它的目的是使任何新产品具有陡峭的学习曲线。

以下是入门指南的一些主要好处和目的：

1。引导用户通过初始设置

每种产品都有独特的怪癖，可以让初次用户不知所措。入门指南会逐步通过初始设置或安装，因此他们不会首先猜测该怎么做。

这项直接指导可以快速满足，用户感到“很棒，我已经有效！”而不是“我不知道从哪里开始”。积极的第一经验可以将忠诚的用户与早期放弃的用户区分开。

2。减轻支持负担

当有明确的说明时，用户更喜欢自助。一个好入门指南回答了基本的“我如何……？”问题，因此用户无需联系有关简单问题的支持。

这种自助服务不仅使用户更加快乐，还可以减轻支持团队的负担。

您的指南成为第一条支持，处理简单的东西并释放团队以解决更复杂的问题。

3。建立信心和信任

从新工具开始可能会令人生畏。温和的介绍鼓励用户探索功能而不是回避。

通过突出一些核心功能并显示如何使用它们，该指南邀请用户玩耍并发现价值。

这就像给他们训练轮一样，他们有信心自行骑行。这鼓励您更深入地与您的产品互动，并可以将休闲用户转换为权力用户或忠实客户。

4。缩短学习曲线

使用新应用或设备时，没有人喜欢感到愚蠢。

入门指南通过以易于管理的步骤进行教学来使学习曲线保持浅。

用户首先学习基础知识，然后逐渐解决高级功能。这种逐步方法可以防止陡峭的学习曲线会引起的压倒性。

结果：用户坚持使用更长的时间，而不是出于挫败感。

5。标准化入职

从组织的角度来看，入门指南可确保每个新客户都会收到一致的入职信息。

这是您最好与每个用户一起前进的机会。

对于SaaS公司或软件团队来说，这也是一种早期展示重要功能或最佳实践的方式。

就实物产品而言，它可以涵盖安全警告或设置预防措施，因此用户不会错过它们。

入门指南的目的是增强用户能力。在那里说： “我们知道您是新手。这正是如何开始使用该产品。”

做得好后，它为用户提供积极的持续体验奠定了基础。

在入门指南中包括什么

那么，一个很棒的入门指南是什么呢？

尽管细节因产品而异，但最有效的指南具有共同的结构和成分。您可以将其视为一个简单的食谱：

1。简短概述或欢迎

从简短的介绍开始，该简介告诉用户本指南将帮助他们完成什么。

预先设定期望。例如，一两个句子可能会解释： “本指南将帮助您安装该应用程序并在5分钟内发送第一条消息。”

保持非常简洁。用户可能想快速潜水。您可能会列出他们将要完成的主要步骤或部分。概述本质上回答： “我将在本指南中学到什么？”

这有助于激励用户跟随，因为他们知道最终目标。 （这也是祝贺他们选择您的产品的好地方 - 积极性永远不会受伤！）

2。初始任务的分步说明

该指南的核心是针对最重要的入门任务的清晰，逐步的教程。

这通常包括安装或设置，帐户创建或登录，以及在软件/服务中执行第一个基本操作（或设备的基本操作）。

以逻辑顺序提供说明，并保持每个步骤咬合大小和面向动作。

编号列表是您的朋友。每个步骤都应说出该怎么做以及如何做到这一点，而没有歧义。

例如：“1。下载应用程序：访问explay.com/download并单击“安装”。2。创建您的帐户：打开应用程序并填写注册表格……”，等等。

如果步骤太复杂或长时间，请考虑将其分解为子步骤或简化任务。经验法则：每个步骤一个明确的行动。

3。屏幕截图或视觉辅助工具

当您看到所描述的内容时，遵循说明要容易得多。

出色的入门指南包括相关图像：软件接口的屏幕截图，硬件设置的照片或图表，甚至是小的GIF/视频，以进行棘手的步骤。

例如，如果步骤3是“单击设置图标”，则显示带有设置图标或突出显示的设置图标的屏幕快照。

4。关键功能突出显示或下一步

一旦完成基本设置，入门指南通常会简要指出“下一步” 。

这可能是一个简短的部分，例如“探索下一步”或“尝试尝试的关键功能” 。

这个想法是介绍一些最重要的功能或用户在初始设置后应做的事情。

5。链接到进一步的资源和支持

一个好的入门指南认识到其范围，它涵盖了基础知识，但是有些用户会有更多问题。

始终为需要更多帮助的人提供简单的途径。

这可能是最终段落或框： “需要更多详细信息？请参阅用户手册以进行高级设置和故障排除。”或“访问我们的知识库获取有关每个功能的详细文章”。包括指向您的文档网站，常见问题解答，视频教程，社区论坛的链接 - 无论您拥有什么支持渠道。

对于物理产品，您可以参考完整的印刷手册或支持电话号码。

目的是向用户保证，如果快速指南中未涵盖某些内容，则可以找到答案。

此外，鼓励他们与指南未解决的任何问题联系客户支持。

通过预先共享文档并支持资源，您可以平整整个入职经验。用户知道，如果他们卡住了，超越了第一步。

可以根据您的指南是单页快速参考，简短小册子还是交互式在线教程进行调整。

核心想法是将其集中在初学者的需求上。

正如技术作家所说：

不要以为用户已经知道任何东西- 在他们的水平上会见他们。

最后，格式可以大大变化。

• 为指南的每个部分使用清晰的标题（以便用户可以轻松浏览或返回部分）。
• 子弹点和编号步骤可提高扫描性与长段落。
• 在数字指南中，您甚至可以为每个步骤将内容分解为选项卡或可折叠部分。
• 该指南应该一眼易于阅读 - 友好而不是压倒性的。
• 许多成功的指南甚至包括每个步骤或清单的复选框，因此用户在进步时会感到成就感。

它在眼睛和大脑上越容易；用户越可能遵循。

入门指南模板（概述示例）

让我们将上面的内容固化为具体的模板。以下是您可以适应您的需求的通用入门指南模板结构。

为了例如，该模板假定数字软件产品，但是您也可以调整物理产品的概念。将其用作起点：

此模板有意简单。实际上，您可能会根据上下文结合或省略某些部分。

例如，某些指南将“下一步”提示集成为标注框或主要步骤旁边的侧面注释。

物理快速启动指南通常没有明确的“下一步” - 相反，它们严格坚持设置，然后说“请参阅用户手册以获取操作说明”。

另一个提示：保存模板并重复使用以保持一致性。如果您制作多个入门指南（例如，对于不同的产品线或针对不同的用户角色），则具有标准轮廓确保所有指南都具有熟悉的感觉。

需要一个平台来托管和组织所有这些指南吗？

尝试英雄知识基础，以创建美丽，可搜索的文档网站。

这样，您的入门指南可以与您的常见问题解答，教程和其他帮助文章一起生活。它还可以轻松更新内容，跟踪用户搜索的内容并不断改进您的文档。

从英雄知识基础开始

入门指南写作提示

撰写入门指南是一部分艺术和一部分科学。

您需要技术写作的清晰度，客户支持的同理心以及少量的营销热情 - 所有这些都以与读者联系的对话语调包裹。

以下是一些撰写指南时要牢记的主要技巧：

1。使用简单的，无术的语言

请记住，许多读者是完整的初学者。写作好像您正在向没有背景知识的人解释您的产品域。

除非您绝对必须使用它们（然后用简单的语言定义），否则避免行业行话或首字母缩写词。

简单是关键。

例如，不要说“初始化配置参数”；说“设置您的基本设置。”清晰的日常单词。

如果您必须包含一个技术术语（例如您的产品是API，并且需要提及“ API密钥”），请提供简短的解释或类比。

一个好诀窍是让某人不熟悉您的产品草稿，如果他们对任何句子感到困惑，请对其进行修改。

指南不是炫耀词汇的地方。这是关于沟通的。语气应该是友好而令人鼓舞的，就像一个有用的同事指导用户一样。

2。直接并以动作为导向

入门指南应以当务之急。本质上，您正在指示用户做什么。

在您的步骤中使用主动语音并带有动词（例如，“单击下一步要继续”，而不是“下一个按钮应单击”）。这使指示清晰。

另外，将句子简短而专注。漫长而蜿蜒的句子可能会失去一个初学者。针对每个句子的一个想法，甚至在适当的情况下使用片段进行说明（“选择文件>导入。选择数据文件。单击“打开”。” - 如果在这些情况下不是完整的正式句子，则可以）。

瞄准大约80岁左右的验收分数，大约是6年级的阅读水平，这非常适合广泛的可访问性。

这通常意味着较短的句子和通用单词。

不用担心，您的指南听起来不会“愚蠢”，这听起来很清楚。

清晰度是一种专业美德！

3。保持逻辑流

在自然顺序上构建您的说明，新用户需要做事。

例如，如果有关键序列，则必须在导入数据之前创建一个帐户，请确保指南清楚地反映了该顺序。

用户永远不必跳来跳去或执行心理体操才能跟随您。

编号的步骤执行逻辑序列。

此外，使用标题和小标题将指南分解为可消化的部分（设置，首次使用，下一步）。

这不仅可以帮助用户，而且可以改善SEO，因为搜索引擎可以更好地识别内容层次结构和关键字。

逻辑流也可能意味着以明智的顺序介绍概念 - 例如，在告诉用户创建一个“项目”之前定义“项目”是什么。

如果您发现自己需要提前解释太多，请考虑是否属于单独的“概念”文档而不是QuickStart。

4。显示，不要只是告诉

我们较早地谈到了视觉效果，但它具有重复：在可能的情况下，向用户展示该怎么做，而不仅仅是告诉他们。

这可以通过屏幕截图，图表，甚至是嵌入式的简短视频或动画作为在线指南。

视觉学习者会感谢您。

例如，您可以在“设置菜单”中使用，而是包含UI的微小图像，并指向“设置齿轮图标”的箭头 - 现在的歧义为零。

同样，使用标注框或注释突出显示UI元素。

Slack的用户指南通过标记界面的一部分来帮助用户定向自己，从而做得很好。

如果您要记录物理产品，清晰的线图或每个步骤的照片（例如，显示如何将SIM卡插入手机中）非常有用。

确保您的视觉效果高质量并适当尺寸。模糊或微小的图像比他们帮助的更多。并始终将视觉效果与文本联系起来，以便用户知道他们在看什么。

5。介意用户的观点

将自己放在新用户的鞋子上。他们想实现什么？他们每一步都会感觉到什么？

解决这些。

有时，初学者甚至可能不知道为什么他们必须迈出一步。简短的理由可以帮助您，例如“此步骤确保您的数据正确同步”，如果它增加了清晰度。

另外，请注意假设：不要假设他们知道某个按钮在哪里或术语是第一次曝光的含义。

如果您的指南是针对略有技术受众（例如开发人员）的，则可能会假设一些知识（例如命令行基础知识），但要阐明新开发人员可能不知道的任何内容。

对于更广泛的受众来说，在解释（用简单的话）方面而不是留出差距。

一种策略是快速进行用户研究或收集常见的新手问题，并确保您的指南回答它们。

如果许多初次用户问“我如何节省进度？”然后在适当的位置主动将其包括在指南中。

与用户知识水平相处是良好的入职的一部分。您既不与他们交谈，也不会让他们迷失在树林中，从而尊重用户。

6。保持鼓励和人类

入门指南不是干燥的规格表。随意注入个性和鼓励。

诸如“你们都设定的短语！”或“让我们下一步做X”使用户感到由一个人而不是机器人引导。

如果适合您的品牌，您甚至可以使用温和的幽默或相关比较。例如，“创建发票就像填写Facebook帖子一样容易，只需输入文本并点击发送即可。”

一点兴趣可以减轻用户焦虑。

但是，不要过度使用它，也不要分散实际说明的注意力。专业但温暖是一个很好的平衡。

7。强调要点（但不要压倒）

如果某些步骤至关重要，则可以使用大胆的文本或注释突出显示它们。

例如：“重要：请确保写下您的恢复代码。如果忘记密码，则需要它。”这表明用户要额外关注。

您还可以使用斜体来偶尔重点或引入一个术语（例如定义的项目或广告系列）。

另一种策略是使用标注框或彩色亮点以获取技巧，警告或笔记。

例如，一个黄色的“提示：”框可以共享快捷方式或替代方法，而红色的“配x：”框可能会警告常见错误（ “在更新过程中不要拔下设备。” ）。

但是，在快速启动时将它们保持在最低水平 - 太多的侧音会淹没。

8。与真实用户一起测试指南

有了草稿后，如果可能的话，请在真正的新用户上尝试一下。

这可能是一个可用性测试会议，或者只是为新员工或朋友提供指南，看看他们是否可以在没有其他帮助的情况下成功地遵循它。

他们的反馈是黄金。他们可能会偶然发现您认为很明显的步骤，这意味着您应该澄清这一步骤。或者他们可能会问：“这是什么意思？”通过一定的指示，这意味着您可能需要重新命名或添加简短的说明。

测试还将显示您的指南流是否与用户自然设置的方式匹配。

如果面对面测试不可行，即使仅观察新客户的支持请求也可以照亮差距。

例如，如果许多用户与指南应该回答的问题联系，则该指南可能需要该信息更加突出。

使用此反馈来迭代并不断改进指南。

诸如英雄知识基础之类的文档工具提供功能，使您可以收集用户反馈并提供其他有用的见解。明智地使用这些工具来改善您的指南。

9。保持短暂而专注

值得重申的是 - 简短是快速入门指南的关键。

当用户渴望开始使用该产品时，通常不会阅读中篇小说。

如果您的指南长期运行，例如，多几页或屏幕审核并问： “入门时确实需要此细节，还是可以将其移至文档的后续部分？”

修剪不必要的脂肪。文档专家的一个指南是我们提到的1/10规则：快速启动仅包含大约10％的完整手册信息。这不是一门精确的科学，但它加强了这样的观念，即这不是详尽的细节的地方。

保持关注直接需求。如果您发现指南变得笨拙，因为您的产品具有大量功能，请考虑按用户目标或角色分配指南。

例如，单独的“管理员快速设置”与“最终用户的快速启动”，因此每个受众都会获得更精美的体验。

在文档中，就像在UI设计中一样，更少的是入职。

通过遵循这些写作技巧，您将制作一份不仅内容丰富的指南，而且引人入胜。

入门指南示例

让我们看一些现实世界中开始指南和快速起步指南以查看这些原则的现实示例。

这些示例涵盖了数字软件入职和物理产品指南：

1。UPWORK入门页面

自由职业平台UpWork为新移民提供了出色的入门指南。

首先要祝贺用户加入，然后列出了一些关键任务，以使其配置文件启动并运行：完成清单，为新的自由职业者提供在线课程，设置其个人资料，等等。

该语言令人鼓舞，并且将步骤作为符号点提出，以便于扫描。 UPWORK还提供了指向更深层次的资源的链接，例如“ 9个技巧，可帮助您创建一个脱颖而出”。

本指南不会对每个站点功能不堪重负；它专注于新自由职业者在平台上获得成功机会的关键事情。

通过这样做，它可以推动用户参与度（完全设置的自由职业者配置文件）并减少混乱。

2。谷歌文档快速启动指南

对于Google文档，帮助文章“如何使用Google Docs”本质上是快速入门指南。

一个整洁的方面是它可以满足不同的平台：它具有用于计算机， Android ， iPhone/iPad的选项卡或部分，并认识到启动可能会因设备而略有不同。

该指南非常逐步。它首先要简要说明Google文档（在线文字处理器等），然后迅速进入“开始步骤”，例如创建新文档，共享它，等等。

每个步骤通常都有插图或图标。 Google的指南还链接到技巧（例如，对于那些想学习更多高级技巧的人来说，“获取使用Google Docs的最重要技巧”）。

该语言很简单，并且没有对Google Drive或Docs的先验知识。通过将其分解为每个设备，它立即解决了用户的上下文。移动用户不会被桌面说明淹没，反之亦然。

此示例显示了识别用户环境并相应地量身定制指南的重要性（这是了解受众的一种形式）。

3. Slack的帮助中心房屋

流行的消息传递应用程序Slack通常因其出色的文档和入职而受到称赞。在Slack的Help Center首页上，有一个明显的“入门”类别与其他类别（例如使用Slack，您的个人资料等）一起使用。

Slack的此入门部分包括指导新用户通过基础知识的文章。

Slack的一位入门指南实际上可以直接跳入解释界面- 因此新用户可以熟悉术语和布局。

Slack经常使用带注释的屏幕截图和“这是您的频道出现的位置”之类的标注，依此类推，从而非常容易将描述与实际应用程序连接起来。

Slack示例演示了入门部分如何定向用户，然后用户可以自我选择他们需要什么帮助。也许一个用户想知道如何发送消息，另一个用户想安装桌面应用程序 - Slack的文档为每个文档提供了单独的快速指南。

这种模块化方法使每个指南都集中在同时覆盖很多基础的同时。

这些例子教给我们一些事情：

• 量身定制的受众和环境： UPWork的指南是针对自由职业者，HubSpot的开发人员，Slack的办公室工作人员以及设备所有者的小工具指南量身定制的。音调，详细级别和格式都与用户的上下文匹配。例如，开发人员获得了更技术性的基调，普通用户会获得更多的视觉手工握力。
• 保持简洁和以任务为重点：所有指南都专注于启用前几个任务，而不是一次解释一切。他们充当发射台。
• 巧妙地使用视觉效果：从Slack的带注释的屏幕截图到Google的平台图标到硬件插图，可以在可以替换或加强文本的任何地方使用视觉效果。
• 如果需要，提供多种格式：同时提供在线和PDF版本（Microsoft）或分开快速启动与完整手册（GOPRO）确保用户可以选择消耗信息的方式。 PDF快速启动指南对于打印或离线访问特别有用 - 如果您的用户可以欣赏它，请考虑提供。
• 与更大的文档集合集成：入门指南通常链接到或与更全面的资源链接。它们不孤立地存在。

快速启动指南（PDF）与完整入门指南

您可能想知道“快速入门指南”和完整的“入门指南”之间的区别 - 它们不是一样吗？

这些术语有时会互换使用（实际上，它们是在目的上重叠的），但是内涵和范围存在细微的差异。

让我们澄清差异和相似性，尤其是与格式相关（例如PDF）和内容深度时：

最后的想法

撰写《入门指南》似乎是很多工作，但这是您为产品的成功而进行的最有价值的投资之一。

这是一个好奇的新用户和满意，自信的客户之间的桥梁。

正确完成后，您的指南将在背景中悄悄地执行奇迹：

• 大规模入职用户
• 减少支持门票
• 通过表明您从第一阶段开始关心用户体验来建立商誉。

我在本指南中介绍了很多。总结一下，这是一个快速清单，可以在完成您的入门指南时考虑：

• 它有明确的开始，中间，结束吗？ （概述→步骤→下一个/支持）
• 它尽可能短但不短吗？ （剪裁绒毛，保留必要的指导）
• 说明是否明确和新手友好？ （如果可能的话进行测试）
• 您包括有用的视觉效果吗？ （它们标记/放置好吗？）
• 语气友好和自信吗？ （对话，不屈服或太简短）
• 如果指南还不够，您是否提供帮助的途径？ （链接到文档，支持）
• 它可以访问且易于阅读吗？ （良好的格式，简单的语言，高可读性得分）
• 您是否将其集成到整体文档或入职流中？ （用户可以轻松找到它）

如果您可以检查所有这些，那么您的手上可能会有出色的入门指南。

现在，出去创建指南，欢迎您的用户像英雄一样。祝您好运，也许您的用户永远不会丢失！