编写帮助文档除了内容之外，如何呈现给用户也很重要，专业的形象有助于帮助用户更快的上手使用，并且建立专业形象，可能你的帮助文档内容来源各个地方，但最终，每个知识库都需要自己的样式指南，你可以在内容上保持一致性和专业性。对于 SaaS 知识库，有一些特定的内容需要囊括，包括：教程、操作指南、说明和参考，下面我将从这几方面进行简单分析。
教程是分步指南，重点是介绍一个主题或一小组紧密相关的内容。它以学习为导向，并允许初学者开始使用您的软件。教程就像一堂课，教用户如何做某事。您决定要教给用户什么，目的是使他们尽快安装并运行您的软件。每个教程都应该为您的用户带来切实的结果，向他们介绍使用软件的基本过程。应该以分步格式编写。与纯理论学习相反，每个步骤都应切实可行并导致用户可见的进步。
这里是一些教程编写的基本规则：
在本教程的开头部分包含简单介绍，告诉您的用户他们期望学习什么，以及完成本教程所需的先决条件，专注于提供一种使您的用户开始使用该软件的方法。
尝试按照难度从轻到重的顺序排列必要的步骤， 仅包括用户完成任务所需采取的步骤，在教程中仅包括具体步骤，并避免与实际学习无关的抽象概念， 控制教程步骤的长度–使它们简洁明了。
确认您已经创建了一个有效的教程，包括检查它是否在不同的环境中运行，提供教程的工作示例，以便用户可以边做边学. 在整个教程中包括用户可见的结果，以提供有关任务的反馈，测试您的教程对用户是可重复的。
教程的风格不要太长或者太复杂，不要链接到外部网站，让用户专注于手头的任务，在教程末尾包括 “后续步骤” 或进一步阅读，以供需要了解更多信息的用户使用。
接下来，我们将研究如何编写操作指南，入门指南类似教程，但实际上旨在解决软件中的特定问题，操作指南以目标为导向，通过一系列的步骤进行介绍，通常针对想要了解软件的特定方面如何工作的更有经验的用户。 以下是编写操作指南的一些规则：
为你的指南选择一个描述性的名称，告诉用户此内容主要解决的问题，采用步骤式的方式在开头汇总解决方案，方面用户直接跳转至重要部分，为用户解决特定问题。
设定统一的格式，帮助用户进行查阅，步骤尽量不要太多，避免信息过载，每个步骤中包括确定步骤的操作，可以通过直角括号缩短简单的序列，例如选择帐户 > 其他帐户 > 添加新帐户。
使用正确的语法和标点完整的句子撰写你的指南，在正文中标注突出显示必要的信息，通过链接到其他地方来解释避免概念性的描述。
实用指南的一些示例包括：
在知识库中添加的内容还包括说明，这种文档散布在你的其余内容中，为用户提供有关软件的关键知识，并且对相应主题提供更多背景和上下文，并在 “需要了解” 基础上提供更多的信息。
- 提供所需的尽可能多的上下文并解释 “为什么”
- 请勿指导用户或提供任何技术参考
- 使用此类内容可以扩大用户对软件整体的了解
- 使用浅显易懂的语言
参考指南是面向信息的技术文档，描述了软件或用户需要了解的软件的任何相关方面。
它可能包括参考资料，例如您的知识库中使用的术语表，或者包括 API 和 Webhooks 文档，其中包括软件的主要界面 / 属性 / 方法。您可以列出软件的技术规格，当前的集成等。
编写参考文档的一些规则：
- 力求结构，音调和格式的一致性
- 仅描述相关的技术组件，避免指导或解释
- 使用简单明了的语气
- 严格检查准确性
在指南中可以包含多个部分，但最终的结果取决于知识库中需要包含的信息量，在指南中你可能会填写很多内容，可以参考一些做的比较好的帮助文档，比如网易，根据自己的产品进行洁面优化。
Baklib，专业的知识库、帮助中心、产品手册制作软件，帮您轻松解决产品售前售中售后服务、知识管理问题。
使用地址：http://www.baklib-free.com/?utm\_content=7&utm\_source=zhihu
https://aqianqian.baklib-free.com/f9eb/0c7e