Создание подробной документации на сайте WordPress необходимо, если хотите эффективно помогать и поддерживать своих пользователей. Правильное руководство позволит им понять, как применять продукты или услуги. Это приведет к улучшению общего впечатления от использования.
За последние 16 лет я создал множество сайтов. И на них я всегда добавлял подробную документацию для поддержки пользователей. Охватывалось все, от процесса установки продуктов и руководств по функциям до подробной информации о дополнениях, чтобы упростить устранение неполадок.
Я заметил, что это помогает людям решать проблемы и укрепляет доверие к товарам. Они чувствуют себя уверенно, зная, что я четко организовал всю ключевую информацию.
Вот почему я рекомендую добавлять документацию, независимо от того, занимаетесь ли вы бизнесом, ориентированным на продукты, сайтом членства или образовательной платформой.
В данной статье я покажу, как это легко сделать в WordPress, шаг за шагом. Мое руководство будет очень простым для понимания и не потребует никаких знаний в области программирования.
- Зачем добавлять документацию в WordPress
- Как добавить документацию в WordPress
- Шаг 1: Настройте общие параметры плагина
- Шаг 2: Настройте категории, теги и параметры статей
- Шаг 3: Настройка поиска в базе знаний и настроек слагов
- Шаг 4: Настройте сайдбар базы знаний и параметры стиля
- Шаг 5: Настройка обратной связи по статьям и параметров электронной почты
- Шаг 6: Создание документации для сайта WordPress
- Шаг 7: Изменение порядка статей и категорий в документации
- Заключение
Зачем добавлять документацию в WordPress
Документация — это контент на сайте WordPress. Он предоставляет информацию о том, как использовать продукты/услуги, включая их функции, новые версии, дополнения и многое другое.
Документация может включать учебные пособия, руководства, часто задаваемые вопросы, базы знаний и руководства по API.
Например, если есть интернет-магазин, который продает музыку, то возможно создать вариант с подробным описанием того, как загружать контент, продлевать лицензии или создавать плейлисты.
Добавление документации в ВордПресс может улучшить пользовательский опыт, упростив для клиентов обнаружение различных функций продукта, поиск проблем и их устранение самостоятельно. Это также уменьшит количество обращений в службу поддержки сайта.
Документация может улучшить рейтинг SEO, предоставляя дополнительный контент, который Google и другие ПС индексируют и отображают в результатах поиска.
Как добавить документацию в WordPress
Вы можете легко добавить документацию в WP с помощью плагина Heroic KB.
Это лучший специализированный инструмент ВордПресс на рынке. Он добавляет базу знаний с возможностью поиска к существующему сайту. Плагин поставляется с функцией AJAX, упорядочиванием контента с помощью перетаскивания, вложениями статей и многим другим.
Кроме того, инструмент имеет встроенную аналитику и опцию обратной связи с пользователями. Она позволяет собирать информацию для улучшения существующей документации.
Плагин даже поставляется с функцией Heroic AI Assistant. Опция позволяет легко добавить на сайт кастомизируемый чат-бот. Он обучается непосредственно из вашей базы знаний, чтобы предоставлять точные и персонализированные ответы клиентам.
Шаг 1: Настройте общие параметры плагина
Сначала необходимо установить и активировать плагин Heroic KB.
После запуска перейдите на страницу Heroic KB > «Настройки» в сайдбаре на дашборде WordPress. Далее переключитесь на вкладку «Лицензия и обновления».
Здесь введите лицензионный ключ и нажмите «Сохранить изменения». Эту информацию можно получить в своем аккаунте на сайте Heroic KB.
После добавления лицензионного ключа перейдите на вкладку «Главная и общие» слева. Вы должны определить домашнюю страницу документации из раскрывающегося меню рядом с опцией «Домашняя страница KB».
Если выберете опцию «Архив базы знаний», плагин создаст новый раздел для руководства по адресу www.example.com/knowledge-base.
Однако, если хотите добавить свою документацию на страницу, которую уже разработали, то возможно выбрать эту опцию из раскрывающегося меню.
Далее можете ввести текст заголовка. Он будет отображаться в верхней части страницы документации.
После этого просто установите флажок «Хлебные крошки», чтобы включить эту функцию.
В базе знаний «Хлебные крошки» — это тип навигационной помощи. Она позволяет людям видеть, как они попали на текущую страницу, и переходить на предыдущие, например: «Главная» > «Продукты» > «Установка».
Далее можете выбрать количество столбцов категорий из раскрывающегося меню. Они будут отображаться на вашей странице документации.
Затем установите флажок «Отображать количество категорий KB», если хотите показывать количество статей, написанных для каждой.
Далее выберите число материалов из раскрывающегося меню «Статьи категории базы знаний». Они должны отображаться в каждой категории на главной странице документации.
Затем возможно установить флажки «Скрыть пустые категории» и «Скрыть статьи без категории». Таким образом, ни пустые категории, ни статьи без них не будут отображаться на главной странице руководства.
После этого можете ограничить доступ к документации WP только для авторизованных пользователей в раскрывающемся меню «Ограничить доступ».
Когда закончите, просто нажмите кнопку «Сохранить изменения».
Шаг 2: Настройте категории, теги и параметры статей
Теперь перейдите на вкладку «Категории и теги» в левом столбце. Здесь можете выбрать способ сортировки категорий и тегов, а также количество статей, которые будут отображаться для каждой таксономии.
Возможно установить флажок «Выдержка из статьи», если хотите отображать фрагмент статьи под каждым архивом классификации в документации.
Затем просто нажмите кнопку «Сохранить изменения» и перейдите на вкладку «Статья».
Здесь можете установить различные флажки, чтобы активировать раздел комментариев под статьями документации, отображать биографии авторов или показывать другие связанные материалы под каждым руководством.
После того, как вы сделали свой выбор, просто нажмите кнопку «Сохранить изменения».
Шаг 3: Настройка поиска в базе знаний и настроек слагов
Теперь перейдите на вкладку «Поиск». Установите флажок «Фокус поиска», если хотите, чтобы при загрузке страницы курсор мыши пользователя автоматически перемещался в поле поиска документации.
Далее можете добавить заполнитель, отображать выдержки из статей в результатах и даже включить плагин для выделения поискового термина в выдаче.
После этого нажмите «Сохранить изменения». Перейдите на вкладку «Слаги».
Здесь можете добавить слуги для статей, категорий и тегов документации.
После того, как вы сделали выбор, нажмите кнопку «Сохранить изменения».
Шаг 4: Настройте сайдбар базы знаний и параметры стиля
Затем перейдите на вкладку «Сайдбары», чтобы выбрать макеты для них в разделах документации.
Можете определить разные положения для сайдбара главной страницы, категорий и статей. Возможно установить флажок «Фиксированный сайдбар статей?». Это позволит активировать фиксированный сайдбар для страниц.
После этого нажмите «Сохранить изменения». Далее перейдите на вкладку «Стили».
Здесь можете выбрать ширину документации, цвет ссылок, внешний вид хедеров и оттенок текста по своему усмотрению.
Затем просто нажмите кнопку «Сохранить изменения».
Шаг 5: Настройка обратной связи по статьям и параметров электронной почты
Затем перейдите на вкладку «Обратная связь по статьям». Установите флажок «Включить обратную связь», чтобы пользователи могли оценивать статьи.
Даже возможно добавить систему голосования «за»/«против» для документации ВордПресс. Для этого установите соответствующие флажки. Это позволит посетителям сообщать, помогает ли документация решать их проблемы на фронтенде.
Теперь нажмите кнопку «Сохранить изменения».
Теперь перейдите на вкладку «Отчеты по электронной почте» в левом столбце. Установите флажок «Включить отчеты по электронной почте?», если хотите, чтобы Heroic KB отправлял еженедельные отчеты по документации.
Он будет включать общее количество просмотров и среднюю оценку статей по руководству, а также отображать список самых популярных и высоко оцененных материалов за неделю.
После этого добавьте адрес электронной почты администратора в поле «Получатели отчетов». Вы даже можете вставить несколько, если хотите.
После этого нажмите кнопку «Сохранить изменения».
Теперь, когда настроили все параметры плагина Heroic KB, пришло время приступить к созданию документации для сайта.
Шаг 6: Создание документации для сайта WordPress
Вы можете создавать статьи с инструкциями, базу знаний, руководства и часто задаваемые вопросы для документации.
Чтобы начать разработку нового документа, перейдите на страницу Heroic KB > «Добавить новую статью» на дашборде WP.
Откроется редактор контента WordPress. Там можете добавить заголовок для статьи и начать писать контент. Также возможно нажать кнопку «+» в левом верхнем углу. Это позволит добавить различные блоки в материал.
После того, как напишите статью для документации, нужно развернуть вкладку «Категории» на панели блоков. Далее нажмите на ссылку «Добавить новую категорию статьи».
Затем просто создайте категорию для статьи, которую пишете.
После этого разверните раздел «Теги» на панели блоков. Добавьте столько тегов, сколько хотите, для своей статьи документации.
Вы даже можете добавить выдержку из материала, развернув вкладку «Выдержка».
Затем откройте «Обсуждение». Снимите флажок «Разрешить комментарии», если хотите отключить комментарии для статьи. Если желаете разрешить пользователям добавлять сообщения, то оставьте эту настройку без изменений.
Вы можете делать вложения к статьям в документации. Для этого прокрутите вниз до раздела «Параметры статьи» в редакторе блоков. Нажмите кнопку «Добавить или загрузить файлы».
Это запустит медиабиблиотеку. Из нее можете добавить любое вложение, которое нравится.
Затем установите флажок «Вложения в новом окне», если хотите, чтобы файлы в статье открывались в новом окне при нажатии.
Также можете отключить функцию голосования за/против конкретных статей, если желаете. Для этого прокрутите вниз до раздела «Параметры голосования».
Здесь установите флажок «Отключить голосование». Это отключит систему голосования для этой конкретной статьи.
Наконец, нажмите кнопку «Опубликовать» вверху, чтобы опубликовать статью в качестве документации.
Теперь повторите процесс еще раз, чтобы добавить несколько записей для руководства в разных категориях.
После этого можете легко просмотреть документацию. Для этого перейдите на страницу www.example.com/knowledge-base или посетите кастомизируемый раздел, который выбрали для руководства.
Шаг 7: Изменение порядка статей и категорий в документации
С помощью Heroic KB можно изменить порядок статей, отображаемых в базе знаний ВордПресс. Для этого перейдите на страницу «Heroic KB Article Ordering» с дашборда WP.
Здесь выберите категорию, для которой хотите изменить порядок статей. Затем просто перетащите материалы, чтобы поменять их очередность в соответствии с предпочтениями.
Когда закончите, не забудьте кликнуть «Сохранить порядок».
Чтобы изменить порядок категорий, отображаемых на странице документации, перейдите в «Heroic KB» > «Порядок категорий» из админ-панели WordPress.
Там можете поменять их с помощью перетаскивания. После внесения изменений нажмите «Сохранить порядок».
Теперь вы успешно создали документацию для сайта и изменили порядок категорий и статей.
Заключение
Руководство по работе с продуктами — беспроигрышный способ помочь клиентам и повысить вовлеченность в блог WP. Я надеюсь, что эта статья помогла вам узнать, как добавлять документацию в WordPress.
