Лучшие плагины и темы для документации WordPress в 2022 году
Опубликовано: 2022-09-16Ищете лучшие плагины и темы для документации WordPress, которые помогут вам предлагать документацию или вспомогательный контент на вашем сайте?
Если вы хотите предложить документацию, вы можете пойти несколькими путями:
- Вы можете использовать готовый плагин документации WordPress, чтобы добавить базу знаний/центр документации к существующему сайту.
- Вы можете использовать специальную тему документации WordPress, чтобы создать новую установку WordPress исключительно для вашей документации. Например, вы можете предложить свою документацию на docs.yoursite.com , что является подходом, который используется на многих сайтах.
- Вы можете использовать подход «сделай сам» и добавить свою документацию в виде постов, страниц или выделенного пользовательского типа постов. В этом случае вам все равно могут понадобиться некоторые плагины для улучшения работы, например, добавление оглавления в вашу документацию.
В этом посте мы поделимся лучшими плагинами и темами, которые могут помочь вам реализовать любой из вышеперечисленных вариантов использования.
Для этого мы разделим эти инструменты на три категории:
- Универсальные плагины для документации WordPress
- Темы базы знаний WordPress
- Отдельные плагины для улучшения сайтов, ориентированных на документацию.
Давайте копать!
Лучшие плагины документации WordPress для универсальной функциональности
Если вы просто хотите использовать один плагин, чтобы добавить все важные функции, необходимые для документации, плагины в этой первой категории — это то, с чего вы хотите начать.
Поскольку это плагины для документации, вы можете легко добавить их в существующую установку WordPress. Они также адаптируют стиль вашей существующей темы, чтобы обеспечить целостный дизайн, хотя вы, возможно, захотите что-то изменить здесь и там.
Например, вы можете использовать эти плагины для создания специального центра документации на yoursite.com/docs , который использует тот же дизайн, что и остальная часть вашего сайта.
Для более глубокого изучения этих типов плагинов вы также можете ознакомиться с нашим сравнением лучших плагинов базы знаний WordPress.
Героическая база знаний
Heroic Knowledge Base — это универсальная база знаний и плагин для документации, который предлагает все необходимое для добавления удобного центра документации на ваш сайт.
В бэкенде вы можете использовать собственный редактор WordPress для добавления своей документации. Вы можете классифицировать статьи с помощью категорий и тегов и использовать перетаскивание, чтобы упорядочить все.
Затем плагин автоматически создаст удобный центр документации по внешнему интерфейсу со следующими функциями:
- Живые поисковые подсказки, чтобы помочь людям найти то, что они ищут.
- Встроенное оглавление.
- Выделенные блоки для выделения выносок и предупреждений.
Вы также можете добавить виджет справочного помощника, который позволяет пользователям получать доступ к документации из виджета, похожего на чат.
Помимо создания приятного опыта для ваших посетителей, база знаний Heroic также предлагает аналитику и функции, которые помогут вам улучшить вашу документацию:
- Оценка полезности/бесполезности для отдельных статей документации (с необязательным текстовым отзывом)
- Аналитика поиска, чтобы увидеть, какие темы ищут люди (и какие поиски не дают результатов).
- Аналитика передачи поддержки в режиме реального времени (если вы предлагаете каналы поддержки в режиме реального времени)
Цена : от $149
BetterDocs Pro
BetterDocs Pro — еще один универсальный плагин для документации WordPress, который помогает создавать качественные статьи документации и отображать их в удобной для пользователя базе знаний.
Вы можете добавлять статьи документации, используя собственный редактор WordPress.
Затем во внешнем интерфейсе пользователи получают множество полезных функций, в том числе следующие:
- Предложения по поиску в реальном времени
- Встроенное оглавление
- Организация категории
Вы также получаете аналитику для отслеживания полезности документации и поиска, хотя в ней отсутствует аналитика передачи поддержки в реальном времени из базы знаний Heroic.
Цена : от $149
weDocs
В отличие от двух предыдущих плагинов, weDocs — это более легкий плагин для документации, который предлагает все основные функции, которые вам нужны, но не имеет некоторых более продвинутых функций и инструментов аналитики.
Он может хорошо работать для простых случаев использования документации, но предыдущие плагины могут быть лучшими вариантами, если вы готовы платить за создание абсолютно наилучшего опыта работы с документацией для ваших пользователей.
Вы можете добавлять свой контент с помощью собственного редактора WordPress и организовывать статьи с помощью категорий и перетаскивания.
Затем weDocs организует их во внешнем интерфейсе, который по-прежнему включает в себя некоторые полезные функции, такие как рейтинги полезности статей.
Однако в нем отсутствуют такие функции, как подсказки для поиска в реальном времени, расширенная аналитика поиска и некоторые другие.
Цена : 100% бесплатно
Лучшие темы документации WordPress для создания отдельной документации
Приведенные выше плагины документации отлично подходят, если вы хотите добавить центр документации на свой существующий сайт.
Однако многие компании предпочитают использовать для документации отдельные сайты. Например, вы увидите, что многие компании используют поддомены, такие как docs.yoursite.com . Хотя эти центры документации поддоменов ссылаются на основной сайт, они являются отдельными объектами.
Этот подход к субдоменам мы используем для документации нашего плагина Spotlight, а также нашего плагина WP RSS Aggregator.
В этой ситуации вы можете предпочесть использовать специальную тему документации WordPress, так как это позволяет вам на 100% сфокусировать дизайн вашего сайта на предоставлении документации.
ЗнайВсе
KnowAll — это специальная тема документации WordPress от того же разработчика, что и плагин Heroic Knowledge Base, описанный выше.
Фактически, он опирается на плагин Heroic Knowledge Base для поддержки основных функций документации, поэтому вы получаете доступ ко всем тем же функциям, которые вы видели в разделе Heroic Knowledge Base выше.
Однако ключевое отличие заключается в том, что эти функции интегрированы в готовый дизайн, основанный на теме.
В принципе:
- Если вы хотите добавить документацию на свой существующий сайт, используйте плагин Heroic Knowledge Base.
- Если вы хотите создать автономный центр документации с собственным дизайном, лучше подойдет тема KnowAll.
Вы получаете KnowAll бесплатно при покупке базы знаний Heroic, так что вы всегда можете подождать, прежде чем принять решение.
Цена : от 149 долларов за Heroic Knowledge Base ( при покупке тема предоставляется бесплатно ).
Доси
Docy — это специальная тема документации WordPress, доступная через ThemeForest.
В дополнение к стильному дизайну он также предлагает встроенные функции, которые помогут вам управлять всеми статьями документации в бэкэнде.
Во внешнем интерфейсе вы также получаете расширенные функции, такие как встроенное оглавление и предложения по поиску в реальном времени.
Он также обеспечивает глубокую совместимость с плагином форума bbPress, что полезно, если вы хотите включить форум поддержки в свой центр документации.
Цена : $69
Лучшие плагины WordPress для улучшения сайтов документации
В этой последней категории мы рассмотрим некоторые более узкие плагины, которые не предлагают комплексную функциональность документации, как первая группа плагинов, но, тем не менее, могут быть удобны для сайтов, ориентированных на документацию.
В некоторых случаях вы можете захотеть соединить эти плагины с вашим выделенным плагином или темой документации, чтобы предложить улучшенную функциональность для пользователей во внешнем интерфейсе или администраторов в бэкенде.
Или вы также можете использовать эти плагины для улучшения решения DIY. Например, вы можете создать свой собственный тип записи для содержимого документации, а затем использовать эти плагины для добавления полезных функций. Чтобы помочь вам в этом, плагин пользовательского контента, такой как Toolset, может быть очень удобным.
Таблица сообщений Pro
Posts Table Pro — это действительно отличный вариант для создания внешнего интерфейса, который люди могут использовать для просмотра ваших статей документации.
На высоком уровне плагин позволяет отображать любой контент с вашего сайта (сообщения, страницы, пользовательские типы сообщений) в табличном представлении с возможностью поиска и фильтрации.
Таким образом, клиенты смогут не только просмотреть список всей вашей документации, но и:
- Поиск статей по ключевому слову
- Используйте фильтры для фильтрации по категориям, тегам или пользовательским таксономиям.
- Просматривайте любую пользовательскую информацию в таблице, например настраиваемые поля, которые вы добавили с помощью Toolset или ACF. Например, если у вас разные версии продукта, вы можете отобразить, относится ли статья документации к версии 1.0 или версии 2.0.
Авторы плагина создали руководство о том, как использовать Posts Table Pro для создания онлайн-документации, которое включает полные инструкции по настройке.
Цена : от $79
SimpleTOC
Наличие оглавления является ключевым моментом для сайтов документации, поскольку оно позволяет читателям быстро перейти к той части статьи, которая наиболее актуальна для их проблемы.
Несмотря на то, что существует множество качественных плагинов оглавления, нам нравится SimpleTOC, потому что он… ну, простой (и легкий).
Вы можете легко добавить свое оглавление в редактор контента или на боковую панель, используя специальный блок, включая параметры для управления максимальной глубиной заголовков.
Если вам нужно что-то с большим количеством функций (или если вы не используете редактор блоков), вы можете рассмотреть такие варианты, как Easy Table of Contents или LuckyWP Table of Contents.
Цена : 100% бесплатно
Папки
Папки — это внутренний плагин, который может помочь вам организовать содержимое вашей документации и мультимедиа.
В двух словах, он позволяет вам организовать свой контент с помощью виртуальных папок на панели инструментов, так же, как вы используете папки для организации файлов на вашем компьютере.
Внутри Медиатеки вы можете использовать папки для организации изображений и видео, которые вы используете в своей документации.
Кроме того, вы также можете использовать папки для упорядочивания самих статей документации, независимо от того, добавили ли вы их в виде сообщений или настраиваемого типа сообщений.
Цена : Бесплатная версия. Про от 39 долларов.
Простой заказ страниц
Simple Page Ordering — еще один бесплатный вариант, который поможет вам упорядочить статьи документации.
Он позволяет вам использовать перетаскивание для изменения порядка страниц или иерархических настраиваемых типов записей внутри вашей панели управления WordPress. Это может быть очень удобно для организации ваших статей и управления структурой вашей документации.
Цена : 100% бесплатно
Включить замену носителя
Enable Media Replace — действительно полезный бесплатный плагин, если вам нужно обновить изображения в вашей документации, что часто происходит при внесении изменений в ваш продукт.
Плагин имеет две основные функции, облегчающие вашу жизнь:
- Вы можете загрузить новое изображение, чтобы заменить существующее изображение, не изменяя URL-адрес изображения .
- В качестве альтернативы вы можете изменить URL-адрес, но плагин все равно будет обновлять все остальные экземпляры этого изображения, чтобы избежать испорченных изображений.
Цена : 100% бесплатно
Начните создавать лучшую документацию сегодня
Предоставление высококачественной документации — отличный способ обучить ваших пользователей/клиентов и предоставить им лучший опыт.
Однако, если вы хотите создать эффективную документацию, вам понадобятся специальные инструменты, которые помогут вам выполнить эту работу.
В этом посте мы поделились несколькими плагинами и темами документации WordPress, которые помогут вам создавать лучшие сайты WordPress, ориентированные на документацию.
Если вам нужен универсальный плагин, который вы можете просто установить на свой сайт и начать создавать документацию, вы можете рассмотреть такой плагин, как Heroic Knowledge Base.
Кроме того, вы можете использовать одну из тем или более узкие плагины для создания собственной системы документации DIY.
Например, вы можете создать пользовательский тип записи документации с помощью Toolset, добавить оглавление к статьям с помощью SimpleTOC, а затем отобразить их во внешнем интерфейсе с помощью Posts Table Pro.
Начните сегодня, и ваша документация будет запущена в кратчайшие сроки.