DocYu — бесплатный плагин документации и поддержки для WordPress

DocYu — это бесплатный плагин для WordPress, предназначенный для создания и управления документацией и поддержкой.
IT

DocYu — это относительно новый плагин для WordPress, который решает одну из самых частых задач владельцев сайтов: создание раздела документации, базы знаний или справочного центра. Плагин разрабатывается командой YuzaaCo и распространяется полностью бесплатно по лицензии GPL v2.

На момент написания обзора актуальная версия — 1.1.0, и, как любой молодой продукт, DocYu находится в активной стадии развития: функциональность постепенно расширяется, а некоторые разделы админки пока находятся в зачаточном состоянии. Демоверсия

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

Что такое DocYu и для кого он создан

DocYu — это плагин, который превращает ваш WordPress-сайт в полноценный справочный портал. Он создаёт отдельный тип записей documentation, отдельные страницы /docs/ и /support/, а также кастомный шаблон вывода с двумя колонками: слева — навигация по документам, справа — контент.

Плагин будет полезен:

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

DocYu не требует сторонних сервисов, не навязывает платные подписки и работает на обычном хостинге с WordPress 5.0+ и PHP 7.0+.

Установка и первые шаги

Установка стандартная для WordPress-плагинов: через панель администратора (Плагины → Добавить новый) или вручную через загрузку ZIP-архива. После активации плагин:

  1. Проверяет соответствие версий PHP и WordPress;
  2. Автоматически создаёт две страницы — /docs/ («Документация») и /support/ («Поддержка»);
  3. Сбрасывает правила перезаписи (flush rewrite rules);
  4. Регистрирует кастомный тип записи documentation.

Сразу после активации в админ-меню появляется отдельный пункт DocYu с иконкой, а также встроенный раздел «Поддержка» для типа записей документации. Это сделано для удобства: администратор может либо работать через фирменную панель DocYu, либо через стандартный интерфейс WordPress.

Административный интерфейс

Админка DocYu выдержана в едином современном стиле и заметно отличается от стандартного «тяжёлого» интерфейса WordPress. Разработчики явно вдохновлялись плагином SEOPress — это видно по структуре меню и по подходу к оформлению.

DocYu — бесплатный плагин документации и поддержки для WordPress

Меню DocYu

В левом меню появляется отдельный раздел DocYu с подпунктами:

  • Панель управления — дашборд со статистикой;
  • Все документы — карточный интерфейс управления документами;
  • Настройки — базовая страница настроек;
  • Справка — встроенная справка по плагину.

Панель управления (дашборд)

Дашборд — это витрина плагина. Здесь отображаются:

  • Карточки статистики — общее количество документов, опубликованные, черновики. Карточки имеют цветные иконки (фиолетовая, зелёная, оранжевая) и аккуратную типографику.
  • Быстрые действия — кнопки «Создать документ», «Все документы», «Настройки», «Просмотр».
  • Последние добавленные документы — таблица из 5 последних опубликованных статей с датой и кнопками редактирования/просмотра.
  • Информация о плагине — версия, ссылки на разделы документации и поддержки.

Отдельно стоит упомянуть статистику над списком документов: она выводится прямо над таблицей записей через хук manage_posts_extra_tablenav. Это удобно, но требует аккуратности в вёрстке — разработчики с задачей справились, статистика выглядит органично.

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

Вместо стандартного табличного списка WordPress DocYu предлагает карточный интерфейс. Каждый документ отображается в виде карточки с:

DocYu — бесплатный плагин документации и поддержки для WordPress
  • статусом (Опубликовано / Черновик / В корзине);
  • бейджем «Есть дочерние», если у документа есть вложенные страницы;
  • номером порядка сортировки;
  • заголовком;
  • метаданными (дата, родительский документ);
  • статистикой голосования — количество лайков 👍 и дизлайков 👎;
  • кнопками «Редактировать», «Просмотр», «Удалить».

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

Настройки

Раздел настроек пока минималистичен. Единственная реальная опция — «Не удалять статьи при удалении плагина». Это важный пункт: по умолчанию uninstall.php удаляет все документы, созданные страницы и опции плагина. Если вы планируете временно отключить DocYu или переустановить его, лучше заранее поставить галочку, чтобы не потерять данные.

Кроме того, на странице настроек выводятся справочная информация (версия, сервер обновлений) и быстрые ссылки.

Справка

Встроенная справка объясняет базовые принципы работы: как создавать документы, как строить иерархию, как сортировать, как устранять типичные проблемы (например, если /docs/ не открывается — нужно пересохранить постоянные ссылки). Это хороший пример заботы о пользователе, особенно для молодого плагина.

Публичная часть: как выглядит документация

Публичная часть — это то, ради чего всё затевалось. DocYu заменяет стандартный шаблон WordPress на собственный для страниц /docs/, /support/ и для всех записей типа documentation.

Структура страницы

Интерфейс построен по классической двухколоночной схеме:

  • Левая колонка — сайдбар с навигацией. Вверху заголовок «Документация», ниже — список ссылок: «Главная» и все опубликованные документы. В самом низу — две круглые иконки: «На главную сайта» и «Техподдержка».
  • Правая колонка — контент текущего документа.

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

Мобильная адаптация

Отдельного внимания заслуживает адаптивность. На экранах до 768px сайдбар превращается в сворачиваемое меню с гамбургер-иконкой без JavaScript. Это очень грамотное решение: меньше зависимостей, выше скорость загрузки, работает даже при отключённых скриптах.

Гамбургер анимируется: при открытии меню полоски превращаются в крестик. Подменю и сайдбар плавно раскрываются.

Типографика контента

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

  • блоков-подсказок
  • FAQ-элементов
  • шагов — с номерами и подсветкой;
  • кнопок-примеров
  • таблиц, цитат, кода, изображений с подписями.

Всё это делает документацию визуально богатой и удобной для чтения.

Главная страница документации

На странице /docs/ выводится приветственный блок с быстрыми ссылками на документы. Если документов нет — просто приветствие и подсказка выбрать раздел в меню. Это скромно, но функционально.

Голосование «Была ли статья полезной?»

Это одна из самых интересных фич DocYu. Под каждой статьёй документации выводится блок с двумя кнопками: 👍 «Да» и 👎 «Нет». Голосование:

  • запоминает, что пользователь уже голосовал;
  • после голосования показывает результат: процент полезности, количество голосов и прогресс-бар.

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

Безопасность

  • Прямой доступ к файлам блокируется;
  • Nonce-проверки используются при голосовании;
  • Санитизация данных;
  • Проверка прав — в админке используются;
  • Удаление данных при деактивации — только если пользователь не поставил галочку «сохранить данные».

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

Что пока не реализовано (и это нормально)

DocYu — молодой плагин, и в нём ещё есть что улучшать. Вот что бросается в глаза:

  1. Плоское меню вместо дерева. Функции для древовидного меню написаны, но в шаблоне не используются. Вложенные документы отображаются в общем списке без визуальной иерархии.
  2. Голосование для незалогиненных. Все гости считаются одним пользователем с ID 0. В будущем, вероятно, появится голосование по cookie.
  3. Нет страницы настроек с реальными опциями. Пока есть только одна галочка — «сохранять данные при удалении». Остальное — задел на будущее.
  4. Нет REST API или Gutenberg-блоков. Плагин использует классические шаблоны и the_content, без кастомных блоков.
  5. Нет импорта/экспорта. Если вы захотите перенести документацию из другого плагина, придётся делать это вручную.
  6. Нет встроенного поиска по документации. Поиск есть только в админке. На публичной части — только браузерный поиск по странице.
  7. Нет кастомизации внешнего вида через настройки. Цвета, шрифты и структуру можно менять только через CSS.

Всё это — не недостатки, а точки роста. Для версии 1.1.0 функциональность уже вполне достойная.

Дизайн: общее впечатление

Дизайн DocYu — это, пожалуй, его сильнейшая сторона. Плагин не выглядит как «ещё один бесплатный плагин из репозитория». Он выглядит как коммерческий продукт:

  • современные скругления (16–30px);
  • аккуратная цветовая палитра (фиолетовый акцент, мягкие фоны);
  • тени и hover-эффекты;
  • единый стиль в админке и на фронтенде;
  • поддержка тёмной темы;
  • адаптивность без JavaScript.

Отдельно стоит отметить фирменные SVG-иконки: они есть в меню, в статистике, в карточках, в сайдбаре. Это мелочи, но именно они создают ощущение качества.

Сравнение с альтернативами

На рынке WordPress есть несколько известных плагинов для документации:

  • BetterDocs — мощный, но с платной подпиской для продвинутых функций;
  • Echo Knowledge Base — бесплатный, но с устаревшим дизайном;
  • Knowledge Base for Documentation — минималистичный, без голосования;
  • Documentation от WPDeveloper — простой, но ограниченный.

DocYu выгодно отличается тем, что:

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

Если вам нужна простая, красивая и бесплатная база знаний — DocYu стоит рассмотреть.

Итоги

Плюсы:

  • ✅ Полностью бесплатный, без ограничений.
  • ✅ Современный адаптивный дизайн с тёмной темой.
  • ✅ Голосование за полезность статей.
  • ✅ Иерархия документов и сортировка.
  • ✅ Готовый русский перевод.
  • ✅ Собственная система обновлений.
  • ✅ Безопасность: nonce, санитизация, проверка прав.
  • ✅ Аккуратный uninstall.php с опцией сохранения данных.
  • ✅ Админка с карточным интерфейсом и статистикой.
  • ✅ Работает без JavaScript (гамбургер-меню на CSS).

Минусы:

  • ⚠️ Плоское меню вместо дерева (функции есть, но не задействованы).
  • ⚠️ Голосование для гостей считается как один пользователь.
  • ⚠️ Мало настроек в админке.
  • ⚠️ Нет встроенного поиска по документации на фронтенде.
  • ⚠️ Нет импорта/экспорта.
  • ⚠️ Плагин молодой — возможны изменения в структуре данных.

Вердикт: DocYu — это достойный внимания бесплатный плагин для создания документации и базы знаний на WordPress. Он уже сейчас решает базовые задачи, выглядит профессионально и активно развивается. Если вам нужна простая, красивая и бесплатная система документации — попробуйте DocYu. А если чего-то не хватает — напишите автору: молодые плагины часто растут именно благодаря обратной связи.

YUZAA
Комментарии: 0