Как добавить документацию в WordPress (шаг за шагом)

Вы ищете способ добавить документацию в WordPress?

Добавление документации на ваш веб-сайт облегчает пользователям понимание того, как использовать ваши продукты или услуги. Это может помочь повысить вовлеченность пользователей, улучшить SEO и сократить количество обращений в службу поддержки на вашем веб-сайте.

В этой статье мы покажем вам, как легко, шаг за шагом, добавить документацию в WordPress.

Зачем добавлять документацию в WordPress?

Документация — это контент на вашем веб-сайте WordPress, который предоставляет информацию о том, как использовать ваши продукты/услуги, включая их функции, новые выпуски, дополнения и многое другое.

Документация WordPress может включать практические руководства, руководства, часто задаваемые вопросы, базы знаний и документацию по API.

Например, если у вас есть интернет-магазин, продающий музыку, вы можете создать документацию с подробным описанием того, как загрузить музыку, продлить лицензии или создать список воспроизведения.

Добавив документацию в WordPress, вы можете улучшить взаимодействие с пользователем, упрощая клиентам обнаружение различных функций продукта или поиск причин их проблем и их отладку самостоятельно. Это может даже сократить количество обращений в службу поддержки вашего сайта.

Документация также может улучшить ваш рейтинг в SEO, предоставляя дополнительный контент, который Google и другие поисковые системы могут индексировать и отображать в результатах поиска.

Сказав это, давайте шаг за шагом посмотрим, как легко добавить документацию в WordPress.

Как добавить документацию в WordPress

Вы можете легко добавить документацию в WordPress с помощью плагина Heroic KB.

Это лучший плагин базы знаний WordPress на рынке, который добавляет базу знаний с возможностью поиска на ваш существующий сайт. Он оснащен функцией поиска AJAX, упорядочиванием контента с помощью перетаскивания, вложениями статей и многим другим.

Кроме того, этот инструмент также имеет встроенную аналитику и функцию обратной связи с пользователем, которая позволяет вам собирать информацию для улучшения существующей документации.

Шаг 1. Настройте общие параметры Heroic KB

Сначала вам необходимо установить и активировать плагин Heroic KB. Подробные инструкции можно найти в нашем пошаговом руководстве по установке плагина WordPress.

После активации посетите страницу Heroic KB »Настройки на боковой панели администратора WordPress и переключитесь на вкладку «Лицензия и обновления».

Здесь введите лицензионный ключ вашего плагина и нажмите кнопку «Сохранить изменения». Эту информацию вы можете получить из своей учетной записи на сайте Heroic KB.

После добавления лицензионного ключа перейдите на вкладку «Главная и общие» в левом столбце. Вам необходимо выбрать домашнюю страницу документации из раскрывающегося меню рядом с параметром «Домашняя страница базы знаний».

Если вы выберете опцию «Архив базы знаний», то Heroic KB создаст новую страницу для вашей документации по адресу www.example.com/knowledge-base .

Однако, если вы хотите добавить свою документацию на уже созданную страницу, вы можете выбрать этот вариант в раскрывающемся меню.

Затем вы также можете ввести текст заголовка, который будет отображаться вверху страницы документации.

Как только вы это сделаете, просто установите флажок «Хлебные крошки», чтобы включить его.

В базе знаний «хлебные крошки» — это своего рода средство навигации, которое позволяет пользователям видеть, как они попали на текущую страницу, и возвращаться к предыдущим страницам, например: Главная » Продукты » Установка .

Далее вы также можете выбрать количество столбцов категорий, которые будут отображаться на странице документации, из раскрывающегося меню.

Затем установите флажок «Показать количество категорий базы знаний», если вы хотите отображать количество статей, написанных для каждой категории.

Затем выберите количество статей, которые должны отображаться в каждой категории на домашней странице документации, в раскрывающемся меню «Статья категории базы знаний».

Затем вы можете установить флажки «Скрыть пустые категории» и «Скрыть статьи без категорий». Таким образом, ни пустые в данный момент категории, ни статьи без категорий не будут отображаться на домашней странице вашей документации.

Далее вы можете ограничить доступ к документации WordPress только для вошедших в систему пользователей из раскрывающегося меню «Ограничить доступ».

Когда вы закончите, просто нажмите кнопку «Сохранить изменения», чтобы сохранить настройки.

Шаг 2. Настройте категории, теги и настройки статей.

Теперь перейдите на вкладку «Категории и теги» в левом столбце. Здесь вы можете выбрать, как сортировать категории и теги, а также количество статей, которые будут отображаться для каждой таксономии.

Вы также можете установить флажок «Отрывок статьи», если хотите отображать фрагмент статьи под каждым архивом таксономии в вашей документации.

Затем просто нажмите кнопку «Сохранить изменения» и перейдите на вкладку «Статья».

Отсюда вы можете установить различные флажки, чтобы активировать раздел комментариев под статьями документации, отобразить биографию автора или показать другие связанные статьи в каждом руководстве.

Сделав свой выбор, просто нажмите кнопку «Сохранить изменения», чтобы сохранить настройки.

Шаг 3. Настройте поиск в базе знаний и настройки слагов

Теперь перейдите на вкладку «Поиск» и установите флажок «Фокус поиска», если вы хотите, чтобы мышь пользователя автоматически попадала в поле поиска документации при загрузке страницы.

Далее вы также можете добавить текст-заполнитель для поля поиска, отображать отрывки статей в результатах поиска и даже включить плагин для выделения поискового запроса в результатах.

Сделав это, нажмите «Сохранить изменения» и переключитесь на вкладку «Слаги».

Здесь вы можете добавить ярлыки для статей, категорий и тегов вашей документации.

Сделав свой выбор, нажмите кнопку «Сохранить изменения», чтобы сохранить настройки.

Шаг 4. Настройка боковой панели базы знаний и параметров стиля

Затем перейдите на вкладку «Боковые панели», чтобы выбрать макет боковых панелей на страницах документации.

Вы можете выбрать разные позиции для главной боковой панели, боковой панели категорий и боковой панели статей. Вы даже можете проверить боковую панель «Прилепленная статья»? возможность активировать прикрепленную боковую панель для страниц.

После этого нажмите «Сохранить изменения» и перейдите на вкладку «Стили».

Отсюда вы можете выбрать ширину документации, цвет ссылок, стиль заголовка и цвет текста по своему вкусу.

Затем просто нажмите кнопку «Сохранить изменения».

Шаг 5. Настройте параметры обратной связи по статье и электронной почты.

Затем вам нужно переключиться на вкладку «Отзывы о статьях» и установить флажок «Включить обратную связь», чтобы пользователи могли оценивать ваши статьи.

Вы даже можете добавить систему голосований «за» и «против» в свою документацию WordPress, установив эти флажки. Это позволяет пользователям сообщать вам, полезна ли ваша документация для решения их проблем.

Теперь нажмите кнопку «Сохранить изменения», чтобы сохранить настройки.

Теперь перейдите на вкладку «Отчеты по электронной почте» в левом столбце и установите флажок «Включить отчеты по электронной почте?». вариант, если вы хотите, чтобы Heroic KB отправлял вам еженедельные отчеты о вашей документации.

Этот отчет будет включать общее количество просмотров и средний рейтинг ваших статей документации, а также список самых популярных и рейтинговых статей за эту неделю.

После этого добавьте адрес электронной почты администратора в поле «Получатели отчета». Если хотите, вы даже можете добавить несколько адресов электронной почты.

После этого нажмите кнопку «Сохранить изменения», чтобы сохранить настройки.

Теперь, когда вы настроили все параметры плагина Heroic KB, пришло время приступить к созданию документации для вашего сайта.

Шаг 6. Создайте документацию для вашего сайта WordPress

Вы можете создавать статьи с практическими рекомендациями, базу знаний, руководства и часто задаваемые вопросы для своей документации.

Чтобы начать создавать статью для своей документации, посетите страницу Heroic KB »Добавить новую статью на панели управления WordPress.

Откроется редактор контента WordPress, где вы сможете добавить заголовок для своей статьи документации и начать писать контент. Вы также можете нажать кнопку «+» добавления блока в левом верхнем углу, чтобы добавить различные блоки к вашему контенту.

После того, как вы написали статью для документации, вам необходимо развернуть вкладку «Категории» на панели блоков и нажать ссылку «Добавить новую категорию статьи».

Затем просто создайте категорию для статьи, которую вы пишете.

После этого разверните раздел «Теги» на панели блоков и добавьте столько тегов, сколько захотите, для своей статьи документации.

Вы даже можете добавить отрывок из статьи, развернув вкладку «Отрывок».

Затем разверните вкладку «Обсуждение» и снимите флажок «Разрешить комментарии», если вы хотите отключить комментарии к этой статье. Если вы хотите, чтобы пользователи могли добавлять комментарии, вы можете оставить этот параметр как есть.

Вы также можете добавлять вложения к своим статьям в документации. Для этого прокрутите вниз до раздела «Параметры статьи» в редакторе блоков и нажмите кнопку «Добавить или загрузить файлы».

Откроется медиатека, из которой вы сможете добавить любое вложение по своему усмотрению.

Затем установите флажок «Вложения в новом окне», если вы хотите, чтобы вложения в статье открывались в новом окне при нажатии.

Вы также можете отключить функцию «за» или «против» для определенных статей, если хотите, прокрутив вниз до раздела «Параметры голосования».

Здесь установите флажок «Отключить голосование», чтобы отключить систему голосования «за» или «против» для этой конкретной статьи.

Наконец, нажмите кнопку «Опубликовать» вверху, чтобы опубликовать статью в виде документации.

Теперь повторите процесс еще раз, чтобы добавить несколько записей для вашей документации в разных категориях.

После этого вы сможете легко просмотреть документацию, посетив страницу www.example.com/knowledge-base , или посетить пользовательскую страницу, которую вы выбрали для своей документации.

Шаг 7. Измените порядок статей и категорий в вашей документации.

С помощью Heroic KB вы также можете изменить порядок статей, которые будут отображаться в вашей базе знаний WordPress. Для этого вам необходимо посетить страницу Heroic KB » Заказ статей на панели управления WordPress.

Здесь выберите категорию, для которой вы хотите изменить порядок статей. После этого просто перетащите статьи, чтобы расположить их по своему вкусу.

Когда вы закончите, не забудьте нажать кнопку «Сохранить заказ», чтобы сохранить настройки.

Чтобы изменить порядок категорий, отображаемых на странице документации, посетите страницу Heroic KB » «Порядок категорий» на боковой панели администратора WordPress.

Оказавшись там, вы можете изменить порядок категорий, перетаскивая их. После внесения изменений нажмите кнопку «Сохранить заказ», чтобы сохранить настройки.

Теперь вы успешно создали документацию для своего веб-сайта и изменили его категорию и порядок статей.

Бонус: добавьте раздел часто задаваемых вопросов на свой сайт WordPress.

Добавление документации WordPress — отличный способ помочь вашим пользователям найти нужную им информацию. Вы также можете добавить FAQ (часто задаваемые вопросы) к своим сообщениям в блоге, чтобы ответить на часто задаваемые вопросы, связанные с вашим контентом.

Это может повысить вовлеченность пользователей в вашем блоге WordPress и укрепить доверие и авторитет среди ваших пользователей, дав им понять, что вы понимаете их вопросы и опасения.

Кроме того, часто задаваемые вопросы также могут улучшить ваш рейтинг в SEO, позволяя использовать ключевые слова с длинным хвостом, которые пользователи обычно ищут в поисковых системах.

Вы можете легко добавить часто задаваемые вопросы на свой веб-сайт, используя All in One SEO (AIOSEO). Это лучший SEO-плагин WordPress на рынке, который позволяет легко оптимизировать ваш сайт для повышения рейтинга в поисковых системах.

AIOSEO даже включает в себя блок часто задаваемых вопросов, который можно добавить непосредственно в редактор блоков, где вы можете вводить вопросы и ответы для своего раздела часто задаваемых вопросов.

Плагин также позволяет вам настраивать раздел часто задаваемых вопросов с панели блоков, включая цвет текста, цвет фона, типографику и обертку заголовка, что делает AIOSEO лучшим плагином часто задаваемых вопросов для WordPress на рынке.

Кроме того, плагин поставляется с разметкой схемы часто задаваемых вопросов, которая может повысить рейтинг вашего веб-сайта и органический рейтинг кликов, благодаря чему ваши часто задаваемые вопросы появляются непосредственно в результатах поиска Google.

Более подробные инструкции можно найти в нашем руководстве о том, как добавить раздел «Часто задаваемые вопросы» в WordPress.

Мы надеемся, что эта статья помогла вам научиться добавлять документацию в WordPress. Вы также можете ознакомиться с нашим руководством для начинающих о том, как создать сайт вопросов и ответов в WordPress, а также с нашими лучшими плагинами-аккордеонами для WordPress.

Если вам понравилась эта статья, подпишитесь на наш канал YouTube с видеоуроками по WordPress. Вы также можете найти нас в Twitter и Facebook.