Настройка сайта документации WordPress 2025 | Полное руководство для технических писателей | Интеграция с платформами управления документацией | Лучшие практики для порталов документации на WordPress | Команды разработчиков
Product Documentation Best Practices

Как создать сайт документации на WordPress, который действительно работает

Tal F

Tal F

May 04, 2021

Узнайте, как вы можете упростить размещение и управление документацией в WordPress с помощью Docsie


Поделиться статьей:

Ключевые выводы

  • Docsie обеспечивает беспрепятственную публикацию документации WordPress с помощью простых скриптов развертывания, требующих только интеграции методом копирования и вставки
  • Встроенный машинный перевод и контроль версий документов помогают компаниям обслуживать глобальную аудиторию с многоязычным, актуальным контентом
  • Порталы самообслуживания с документацией уменьшают нагрузку на службу поддержки клиентов, одновременно удовлетворяя 73% миллениалов, предпочитающих самостоятельное решение проблем
  • Функции командного сотрудничества, включая контроль доступа на основе ролей и интегрированный чат, оптимизируют рабочие процессы документации для внутренних и внешних участников

Узнайте, как упростить размещение и управление документацией в WordPress с помощью Docsie

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

Как сказал Матшона Дливайо: «Знание – это богатство». Современные цифровые потребители имеют привилегию доступа к огромному объему знаний благодаря интернету. Предприятия, которые не могут или не умеют делиться знаниями о своих услугах, теряют явное информационное конкурентное преимущество.

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

Отвечаем на типовые вопросы с помощью портала самообслуживания

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

Внедрение портала документации для самообслуживания помогает бизнесу снизить нагрузку на службу поддержки. Это совпадает с меняющимися предпочтениями потребителей. Исследование ContactBabel 2020 года показало, что 61% американских респондентов считают самообслуживание с поддержкой ИИ «очень важным». Клиенты не просто принимают бесконтактную поддержку – они приветствуют ее. Особенно миллениалы хотят обслуживать себя сами – 73% потребителей в исследовании Aspect заявили, что должны иметь возможность решать проблемы самостоятельно.

Использование Docsie для документации WordPress

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

Рабочие пространства, книги и полки Docsie

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

Управление версиями документов в Docsie

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

Настраиваемые центры документации Docsie

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

Машинный перевод Docsie

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

Машинный перевод автоматически переводит документы на различные языки – важная функция, учитывая, что 75% респондентов с большей вероятностью совершат покупку, если поддержка предоставляется на их родном языке, согласно исследованию CSA Research 2020 года.

Docsie Vocally: визуализация обратной связи

Docsie Vocally позволяет пользователям оставлять отзывы о отдельных «книгах» на портале документации. Это помогает компаниям выявлять полезную документацию, которая приносит измеримую пользу. Также это помогает находить неэффективную документацию, которую следует пересмотреть для повышения ценности для клиентов. Обратная связь включает «эмоциональные оценки» по 5-балльной шкале или текстовые сообщения с объяснениями. Компании могут глубже анализировать пользовательский опыт с помощью записи действий на страницах для каждого пользователя, демонстрирующей привычки просмотра в соотношении с отзывами для принятия бизнес-решений.

Начало работы с Docsie на WordPress 5

Компании могут использовать функциональность Docsie для управления документацией, размещая её на платформе по выбору – в данном случае, WordPress. Публикация в WordPress из Docsie не может быть проще и требует всего один скрипт развертывания для размещения контента.

Создание скрипта развертывания Docsie для WordPress

Откройте книгу, которую хотите опубликовать в Docsie.

В панели настроек найдите раздел Свойства.

Нажмите (получить скрипт самопубликации)

Ваш код появится готовым для копирования в WordPress.

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

Здесь включены фильтры контента – Поддержка, Контент сайта, Условия и политика, Документация, Другие страницы – предлагающие детальный контроль над тем, что публикуется в WordPress.

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

Пользователи просто выбирают, что публиковать, определяя фильтры контента и стили отображения через графический интерфейс – Docsie генерирует окончательный скрипт развертывания в нижней текстовой области. Это известно как low-code или кодирование без кода.

Теперь мы можем публиковать в WordPress!

Добавление скрипта в WordPress

После входа в панель управления WordPress перейдите в раздел Страницы.

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

В текстовом редакторе WordPress нажмите кнопку Добавить на блоке веб-сайта. Выберите опцию Пользовательский HTML для добавления скрипта Docsie.

Скопируйте скрипт развертывания из Docsie в буфер обмена. Затем в WordPress вставьте строку кода в поле Custom HTML. Вы также можете указать имя страницы WordPress, хотя Docsie автоматически управляет заголовками во встроенном документе.

Последний шаг – нажать Предпросмотр рядом с HTML в верхней части страницы в редакторе WordPress.

Ваша документация Docsie плавно появится на странице! Теперь нажмите Обновить в правом верхнем углу, чтобы опубликовать на своей активной веб-странице. Этот быстрый и простой процесс можно повторить со всей вашей документацией. Он поддерживает быструю публикацию для малых и больших библиотек документации; просто вставьте код и готово!

ПРИМЕЧАНИЕ – WordPress 5 покажет свой собственный заголовок и другие элементы веб-сайта при использовании этого метода, что идеально подходит для встраивания документов Docsie рядом с другими элементами сайта. Если вы хотите загрузить только документ Docsie – вставьте строку кода в HTML-футер вашей страницы в редакторе кода WordPress и оставьте остальную часть страницы пустой.

Совместная работа с членами команды в Docsie

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

Внутренние и внешние соавторы Docsie

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

Внутренние сотрудники могут быть добавлены в Команду вручную Владельцем или Администратором, через групповую политику с использованием контроля доступа на основе ролей (RBAC) Docsie или запросить доступ к группе.

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

Командный чат Docsie

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

Разрешения и управление пользователями Docsie

Docsie использует систему контроля доступа на основе ролей (RBAC) – иногда называемую управлением идентификацией и доступом (IAM) – для контроля пользовательских разрешений доступа к документации. Каждому пользователю может быть назначена роль Владельца, Администратора, Редактора и Зрителя для обеспечения детального контроля доступа, управления данными и безопасности – в рамках управления рисками соответствия (GRC).

Ключевые термины и определения

Централизованная платформа, где клиенты могут самостоятельно находить ответы на вопросы и решать проблемы без обращения к персоналу поддержки Узнать больше →
(Application Programming Interface)
Программный интерфейс приложения - набор правил и протоколов, которые позволяют различным программным приложениям взаимодействовать друг с другом Узнать больше →
Практика хранения нескольких версий документа для отслеживания изменений и обеспечения доступа к историческим версиям Узнать больше →
Автоматизированный перевод текста с одного языка на другой с использованием искусственного интеллекта и алгоритмов Узнать больше →
(Role-Based Access Control)
Контроль доступа на основе ролей - система безопасности, которая ограничивает доступ к системе на основе ролей пользователей и разрешений внутри организации Узнать больше →
Фрагмент кода, который автоматизирует процесс публикации или установки программного обеспечения и контента на целевую платформу Узнать больше →
(Graphical User Interface)
Графический пользовательский интерфейс - визуальный интерфейс, который позволяет пользователям взаимодействовать с программным обеспечением через графические элементы, такие как кнопки и меню Узнать больше →

Frequently Asked Questions

Как интеграция Docsie с WordPress упрощает публикацию документации по сравнению с традиционными методами?

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

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

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

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

Иерархическая структура Docsie обеспечивает неограниченную масштабируемость – вы можете создавать несколько «книг» (документов), организованных на «полках» (категориях продуктов) внутри рабочих пространств. Такая система позволяет легко управлять обширными библиотеками документации, сохраняя чёткую организацию. Структура также поддерживает пользовательский брендинг, который автоматически распространяется на все документы.

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

Docsie обеспечивает комплексное командное взаимодействие через разграничение доступа на основе ролей (Владелец, Администратор, Редактор, Читатель), встроенный командный чат для централизованного общения и простое подключение как внутренних сотрудников, так и внешних подрядчиков. Команды могут сотрудничать непосредственно на платформе, не переключаясь между разными инструментами вроде электронной почты или Slack.

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

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

Похожие статьи

Готовы преобразить вашу документацию?

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

Tal F

Tal F

VP of Customer Success @ Docsie