Контентная аналитика для документационных проектов

Техническая документация является частью продукта и требует постоянной оптимизации для соответствия потребностям пользователей.
Контентная аналитика, основанная на данных, помогает понять, как пользователи взаимодействуют с вашими материалами и какие улучшения необходимы. Яндекс Метрика позволяет анализировать и оптимизировать техническую документацию. В этой статье мы рассмотрим, как интегрировать контентную аналитику Яндекс Метрики в работу с документацией.
Отчёты по контенту в Яндекс Метрике
В Метрике c 1 июля 2019 года существуют специальные отчеты для контентных проектов и медиа изданий.
В отличие от отчетов по источникам трафика или демографическим данным, которые содержат информацию о пользователях, отчеты по контенту показывают взаимодействие пользователей с материалами сайта. Это полезный инструмент для технических писателей и тех, кто отвечает за создание и оптимизацию информационного наполнения документационных проектов.
Интерфейс

Отчеты по контенту содержат:
- Статистику по материалам, рубрикам, авторам, тематикам.
- Статистику по доскроллам и дочитыванию.
- Время на чтение статьи. Учитываются движения мыши, клики, скроллы в пределах 5 секунд. Если в течении 5 секунд нет активности, время не атрибуцируется.
- Динамика просмотра статей.
- Доля материалов с дочитыванием.
- Процент пользователей, которые перешли на другие страницы сайта.
- Доля просмотров материалов с доскроллом.
- Показатели вовлечённости и посещаемость рубрик.
- Самые популярные статьи.
- Источники переходов.
- Общая сводка по документационному проекту.
Как организовать контентную аналитику в своём документационном проекте
Создание счетчика метрики
-
Создайте счетчик метрики в соответствии с инструкцией.
-
В настройках счетчика включите опцию «Контентная аналитика» и укажите тип разметки
OpenGraph:
-
Добавьте счётчик в документационный проект, используя конфигурационный файл
.yfm.Пример:
analytics: metrika: - id: 44444444
Добавление метаинформации
В отчетах по контенту данные собираются только по размеченным материалам. Для разметки материала рекомендуется использовать словарь семантической разметки данных OpenGraph.
Разметка задаётся в метаданных файлов документации с расширением md.
Примечание
OpenGraph позволяет контролировать представление страниц в поисковых системах и социальных медиа платформах.
Данные OpenGraph должны располагаться в теге head вашего документа.
Вы можете задать название, описание, изображение и другие параметры, которые будут отображаться, при публикации вашей ссылки на сайтах в социальных сетях.
Подробнее про OpenGraph:
Пример использования в статье документации.
|
Исходный код в файле: |
|
|
Результат в документации: |
|
Описание элементов, которыми можно размечать статьи
Статьи документации можно разметить следующими элементами:
- Тип описываемого объекта *
-
Метрика поддерживает только разметку объектов типа article. Другие объекты, размеченные по стандарту Open Graph, не попадут в отчеты Метрики. Тип объекта указывается в свойстве
og:type.<meta property="og:type" content="article"> - Заголовок *
-
Заголовок отображается в отчетах Метрики. Он указывается в свойстве
og:title.<meta property="og:title" content="В Москве побит температурный рекорд 1922 года"> - Текст *
-
В качестве текста берется содержимое узла, в который вложен описываемый материал. Если разметка находится в теге
head, текстом будет все содержимое тегаbody. Символы тегов не учитываются. В тексте определяется количество символов — это нужно для расчета объема материала и метрик доскроллов и дочтения.Примечание
Полную статистику можно получить по материалу, в тексте которого больше 500 символов.
- Автор
-
Автор указывается с помощью свойства
article:author. Если авторов несколько, перечислите их в разных метатегах.<meta property="article:author" content="Иван Иванов"> <meta property="article:author" content="Петр Петров">Благодаря этим данным можно посмотреть статистику по отдельным авторам.
- Тематика
-
В качестве тематик можно указать, например, ключевые слова или хэштеги. Укажите тематики в свойстве
article:tag. Если тематик несколько, перечислите их в разных метатегах.<meta property="article:tag" content="Жара"> <meta property="article:tag" content="Москва"> - Даты публикации и изменения
-
Даты публикации и изменения указываются в свойствах
article:published_timeиarticle:modified_time. Даты записываются в формате ISO 8601.<meta property="article:modified_time" content="2018-12-11T08:56:49Z"> <meta property="article:published_time" content="2018-11-06T09:26:10+04:00"> - Рубрика
-
Рубрика — это раздел сайта, посвященный определенной теме. Чтобы указать рубрику материала, используйте свойство
article:section.<meta property="article:section" content="Погода"> - URL материала
-
URL материала должен содержаться в свойстве
og:url.<meta property="og:url" content="https://www.example-news.com/life/weather/moscow"/>Иначе значение будет взято из канонической ссылки:
<link rel="canonical" href="https://www.example-news.com/life/weather/moscow">Если разметка верна и правильно подключен счетчик, через некоторое время по материалу начнет собираться статистика в Метрике.
* Обязательный элемент
Использование отчетов по контентной аналитике
Сводные отчеты
|
Отчет |
Описание |
|
Сводка |
Отчет дает краткую статистику по контенту за выбранный день или период. Статистика включает данные о просмотрах и взаимодействии пользователей с материалами документации.
Если включить автообновление, статистика будет обновляться каждые 60 секунд. |
Интерфейс
|
|
|
Материалы |
Отчет помогает сравнить материалы между собой, отследить динамику просмотров, выделить самые интересные посты (у них будет высокий показатель дочтений) и решить в каком направлении продолжать работу с контентом. |
Интерфейс
|
|
|
Рубрики |
Отчет по рубрикам позволяют получить общую статистику и сравнить рубрики между собой. Показатели просмотров и вовлеченности аудитории позволяют определить эффективность рубрики и понять, стоит уделять им внимание или следует отказаться от них. Совет При реализации разметки, нужно помнить, что количество рубрик ограничено на данный момент двумя уровнями вложенности и это необходимо учитывать при реализации. В качестве рубрик в документационных проектах предлагается использовать разделы документации — пункты меню первого уровня. |
Интерфейс
|
|
|
Авторы |
Отчет позволяет получить общую статистику по авторам и сравнить результаты автора с остальной редакцией. |
|
Тематики |
Отчет позволяет собрать общую статистику по тематикам, которые отражают содержание статьи. В том числе:
В отличие от рубрик, количество тематик материала не ограничено. |
Интерфейс
|
|
Стандартные отчеты
|
Отчет |
Описание |
|
Источники переходов на материалы |
Отчет позволяет собрать общую статистику по тематикам, которые отражают содержание статьи. В отличие от рубрик, количество тематик материала не ограничено. |
Интерфейс
|
|
|
Рубрики |
Отчет содержит общую статистику по рубрикам и материалам вашей документации. |
Интерфейс
|
|
|
Авторы |
Отчет содержит статистику об авторах материалов. |
|
Тематики |
Отчет содержит статистику по тематикам материалов. |
Интерфейс
|
|
|
Страница материала |
В отчёте по конкретному материалу можно подробно изучить, как посетители продвигались по тексту. |
Интерфейс
|
|
Заключение
Интеграция контентной аналитики с помощью Яндекс Метрики в техническую документацию помогает глубже понимать потребности пользователей и адаптировать контент в соответствии с их ожиданиями.
Подход на основе данных позволяет не только улучшать качество документации, но и обеспечивать лучшее взаимодействие пользователей с вашим продуктом, предоставляя информацию в подходящей форме и в нужный момент.
Приведённые рекомендации помогут повысить ценность вашей документации и сделать её полезным инструментом для пользователей.
Смотрите также
- Отчёты по контенту (документация)
- Проверка передачи данных контентной аналитики
Обязательный элемент.







