终极指南,为任何插件开发人员提供更好的WordPress文档

如果您是为WordPress制作插件的开发人员,请设置一个 WordPress文档 或知识库应该是您的客户支持策略的重要组成部分。毕竟,使用您自己的插件可能很容易,但是潜在的客户或最终用户可能需要适当的指南才能真正了解您的插件如何工作。

betterdocs wordpress文档插件开发人员

因此,您绝对应该考虑花费时间来建立适当,有用和有用的信息 插件文档 为您的产品用户。没有提供 插件文档 对于您的用户而言,您和您的团队将很难获得成功,因为您将不断获得大量支持票。

试想一下,如果您购买了全新的洗衣机,但由于不附带任何说明或用户手册,却不知道如何使它工作,您会感觉如何。您可以打电话给客户服务,但是您必须排队很长时间,而客户服务却要回答其他所有查询。

所以,如果你是一个 WordPress插件开发人员 并希望您的客户对您的产品有良好的体验,然后考虑设置一个资源丰富的WordPress文档,使他们易于使用和理解。

谈到WordPress插件文档的重要性, Vova Feldman, 的创始人 Freemius 共享: 

"With proper documentation, you & your support team can work more efficiently by referring users to documented topics instead of writing them over and over again. It improves the UX for users that are comfortable finding solutions in a self-serve approach which naturally reduces the support load."

Vova Feldman - ​Founder & CEO, Freemius 鸣叫

目录

您需要了解的有关WordPress文档的所有信息

主要的 文件目的 is to provide your users with detailed information about how they can use your product. 

It is much more comprehensive than a simple 常问问题 (常见问题)页面,即使对于不了解您产品的技术知识的人也应该易于阅读和理解。

To sum it up in a nutshell, your WordPress documentation acts as the user manual for your product and should make your end-users feel like an expert when they are using your plugins. 

从教用户如何安装和激活插件到配置设置和使用不同功能进行调整,请确保您的插件文档尽可能回答所有问题。

让我们看一下为什么这对任何插件开发人员都如此重要。下面,我们将为您简要概述插件文档可以使您受益的所有方式。

👉Assist Non-Technical Users To Understand Your WordPress Plugin: 虽然您的某些最终用户可能具有技术知识,  WordPress上的用户往往来自非技术背景。这意味着您需要为WordPress插件提供易于非技术用户理解的文档。

👉Enhance User Experience With A Detailed WordPress Documentation: 如果您的用户仅通过阅读您提供给他们的插件文档就能弄清楚如何使用您的WordPress插件,他们将对您的WordPress插件感到满意并感到满意。

👉Reduce Support Tickets & Workload On Your Team: 好的WordPress文档可以大大帮助您减少支持团队的支持流程和工作量。如果您的最终用户可以通过阅读插件文档解决大多数问题,则无需联系您的支持团队。

👉Safeguard Yourself From Negative Reviews: 没有正确的WordPress文档,您的用户可能无法理解您的插件如何工作。这很可能会使您的用户感到沮丧,以至于他们最终可能会对您的插件留下负面评价。因此,为了保护自己免受负面评价,请提供内容丰富的WordPress文档。

👉SEO Benefits of Documentation: 虽然拥有适当的文档可以帮助您向客户提供他们所需的所有信息,但是如果客户找不到从何处访问信息,这将是无效的。在这里,如果您针对搜索引擎访问量进行了适当的优化,那么知识库可以相对容易地在Google搜索中排名第一。

内容是Google SEO算法的四个主要排名因素之一,而文档是您网站内容的来源之一,因为它经过适当的优化后更有可能在首页上排名。

✅设置资源丰富的WordPress文档指南

要设置内容丰富的有用的WordPress文档,您必须遵循一些基本准则。我们现在来看一下它们。

对您的插件文档使用简单的语言

记住WordPress文档的目的是使用户更容易理解如何使用您的插件 没有 needing technical expertise. 

Avoid using technical jargons as users who do not have technical knowledge will not be familiar with those terms.

确保用户易于阅读

内容丰富且内容丰富的WordPress文档可能包含很多内容。为了使您的用户轻松快速地阅读插件文档中的所有内容,请使用简短的段落,图像,列表,项目符号,目录等。所有这些都将使您的WordPress文档更易于阅读。

遵循正确的WordPress文档结构

有效且有用的WordPress文档将具有适当的结构。这意味着您的插件文档中的所有内容将遵循循序渐进的说明。

例如,安装后需要激活所有WordPress插件。如果您跳过有关激活插件的步骤,许多用户可能不明白为什么您的插件对他们不起作用。 因此,在编写插件文档时,请确保遵循对最终用户有意义的适当的顺序结构。

要更好地了解高质量WordPress插件文档的外观,请查看这些文档页面,其中包含一些流行的WordPress插件。

组织 带有正确类别和标签的插件文档

这是编写插件文档时要记住的非常重要的规则。一律使用 适当的类别和标签 组织WordPress文档的内容。

这是 特别重要 如果您的插件具有大量功能,这些功能可以为您的用户带来独特的好处。当用户位于文档主页上时,它使用户更容易找到他们的相关内容。

定期更新和改进WordPress文档

每次更新和改进插件时,还必须更新WordPress文档,以确保该信息可用于最终用户。否则,您的用户将无法理解插件文档,因此会感到困惑和沮丧。

通过遵循这些准则,您将能够创建与用户相关且内容丰富的高质量WordPress文档。  

🚀Create WordPress Documentation With BetterDocs: The Most Powerful Knowledge Base Solution

既然您知道拥有插件文档的重要性以及需要遵循的准则,您可能会想知道 怎么样 您完全可以创建自己的信息量大,内容丰富的WordPress文档。 

创建高质量WordPress文档的最先进的解决方案是 BetterDocs.

BetterDocs 是功能最强大的文档插件,因为它可以极大地帮助您 减少时间和支持票 通过创建漂亮的,可搜索的WordPress文档。它被带给你 WPDeveloper, the WordPress product company that serving more than 700,000+ WordPress用户 from 180+ countries. It’s the same team behind Essential Addons专用的Essential Addons,NotificationX等。

🔝 Key Features Of BetterDocs That Help You Create Better WordPress Documentation

There are several special features that make BetterDocs stand out among all other similar plugins. From a collection of beautiful, 预制模板,易于使用 内置定制器, BetterDocs has everything you could need to create an attractive, organized documentation page in a matter of minutes. These features include:

✔️ A collection of premade, ready-to-use template designs 
✔️ A built-in 定制样式 您的文档页面
✔️ Automatically create sticky 表中的内容 便于导航

✔️ Advanced 即时搜寻 快速找到相关内容
✔️ Keep track of performance with 分析与报告 
✔️ 即时答案 ChatBot可增强用户体验 
✔️ SEO friendly 使用适当的架构标记的文档

🔥How To Use BetterDocs To Quickly Create Your WordPress Documentation

在本节中,我们将教您如何使用BetterDocs快速创建WordPress文档。我们将从基础知识开始,例如如何为WordPress安装BetterDocs插件,然后我们将向您展示如何使用前面提到的所有很酷的功能来创建插件文档。

安装并激活用于WordPress的BetterDocs插件

您需要做的第一件事是通过导航到WordPress来找到BetterDocs插件 wp-admin->插件->添加新 从您的WordPress仪表板。然后,您必须在搜索框中输入“ BetterDocs”。

找到插件后,只需 安装并激活 它。

使用BetterDocs配置文档主页和单页

安装并激活BetterDocs之后的下一步是 配置文档主页。

这很容易做到。默认情况下,BetterDocs带有其自己的文档主页,您可以根据需要自定义该主页。但是,如果要分配自己的页面布局,可以通过禁用默认主页并使用短代码或页面构建器小部件来实现。

要配置和自定义BetterDocs随附的默认主页,请导航至 BetterDocs->设置->布局。 选择列数,启用或禁用实时搜索和砌体布局,后计数等。

如果您要配置各个文档页面,则只需选择 “单文档” 标签,而您在 '布局' 标签,直到找到“单个文档”选项。调整选项以设置文档单页样式。

如果需要,还可以完全相同的方式设置WordPress文档“存档页面”。只需点击 “存档页面”'布局' 标签。

分配和管理用户角色以简化工作量

此步骤是完全可选的。如果您是插件开发人员,并且想要分配其他人来创建和管理插件文档,则可以 管理BetterDocs中的用户角色 通过去 BetterDocs->设置->高级设置 从WordPress仪表板。

BetterDocs

创建和发布WordPress文档

这是有趣的部分。这是我们向您展示的步骤 如何 创建并发布新文档 在BetterDocs中。

你必须去 BetterDocs->添加新 从WordPress仪表板。这将为您打开编辑器,您可以在其中编写文档的内容,还可以选择类别和标签。

使用类别和标签对WordPress文档进行排序和组织

我们已经在指南中提到使用类别和标签来设置资源丰富的WordPress文档非常重要。在本节中,我们将向您展示 如何整理和整理文件 在BetterDocs中。要设置类别,您需要转到 BetterDocs->类别 从WordPress仪表板中,您可以根据需要创建任意多个类别。

稍后,当您编写插件文档时,可以分配这些类别,并查看它们如何帮助您在发布文档后使文档井井有条.

为WordPress文档提供高级实时搜索

使用BetterDocs,您可以选择 添加和自定义文档实时搜索。 导航 wp-admin-> BetterDocs->设置。之后,打开 '设计' 标签。现在,点击 “自定义BetterDocs” 按钮,您将被重定向到“自定义”页面。

现在,通过此定制程序,您可以为文档设置实时搜索。试一下样式选项,并实时观察您的更改。对样式满意时,请确保保存更改。

更好的文档

添加即时答案ChatBot,以获得更好的用户体验

如果您想进一步减少支持服务单并增强用户体验,则需要了解 如何提供即时答案 WordPress中的功能,并通过BetterDocs改善用户体验。 您可以在任何喜欢的页面中添加此Instant Answers ChatBot。要启用它,您必须导航到 wp-admin-> BetterDocs->设置 然后点击“即时答案”标签。

接下来,您必须根据自己的喜好设置Instant Answers ChatBot。您可以使用“聊天设置”部分,“外观设置”部分中的选项进行调整。

即时答案ChatBot可以进行广泛的自定义,以创建一个交互式对话ChatBot,它将立即解决用户的问题。 

要更好地了解BetterDocs的Instant Answers ChatBot如何使您的文档页面真正脱颖而出,请参阅如何 轻松工作 在他们的网站上使用Instant Answers ChatBot。

WordPress文档

如您所见,每当用户单击即时答案ChatBot时,它都会立即响应用户的查询。通过这种方式,BetterDocs可以通过其Instant Answers ChatBot帮助您增强用户体验,同时减少支持票。

通过分析和报告评估WordPress文档的性能

我们提到改善WordPress文档是建立更好文档的重要部分。最好的方法是通过分析和报告评估插件文档的性能。 

您可以配置 分析以评估绩效 通过导航到您的知识库 wp-admin-> BetterDocs->设置。在“常规”标签中,您可以设置希望应用Google Analytics(分析)的方式,还可以选择启用或禁用Bot Analytics。

BetterDocs

您可以从以下位置查看来自Google Analytics(分析)的见解 BetterDocs->分析。这将使您对WordPress文档的性能进行清晰,深刻的评估。

BetterDocs

轻松从现有文档插件迁移到BetterDocs

即使您已经在使用其他文档插件,也不必担心!只需单击几下即可轻松迁移到BetterDocs。有关更多详细信息,请查看此详细信息帮助指南和 了解如何迁移 到BetterDocs。 

🎁 Grab An Exclusive for only WordPress Plugin Developer: BetterDocs Pro​ for FREE

总结了我们的指南,该指南为所有插件开发人员提供了更好的WordPress文档。

如果您是插件开发人员,并且想要独家查看BetterDocs提供的所有功能,那么今天您很幸运!我们正在放弃 BetterDocs Pro的免费许可证 仅适用于拥有免费增值WordPress插件并想要建立文档页面的WordPress插件开发人员,然后 在下面填写此表格,我们将与您联系。

获得对BetterDocs PRO许可证的访问
Afshana Diya

Afshana Diya

Afshana is CMO at WPDeveloper where she is helping to accelerate business growth & the company is currently reached 800,000+ users from 190+ countries. She is also co-organizer of WordCamp Dhaka & Product Hunt Meetup, Global Community Deputy for WordPress.

分享这个故事

分享到facebook
分享到twitter
分享到linkedin
分享到pinterest
分享到whatsapp