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

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

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

Отчёты по контенту в Яндекс Метрике

В Метрике c 1 июля 2019 года существуют специальные отчеты для контентных проектов и медиа изданий.

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

Отчеты по контенту содержат:

• Статистику по материалам, рубрикам, авторам, тематикам.
• Статистику по доскроллам и дочитыванию.
• Время на чтение статьи. Учитываются движения мыши, клики, скроллы в пределах 5 секунд. Если в течении 5 секунд нет активности, время не атрибуцируется.
• Динамика просмотра статей.
• Доля материалов с дочитыванием.
• Процент пользователей, которые перешли на другие страницы сайта.
• Доля просмотров материалов с доскроллом.
• Показатели вовлечённости и посещаемость рубрик.
• Самые популярные статьи.
• Источники переходов.
• Общая сводка по документационному проекту.

Как организовать контентную аналитику в своём документационном проекте

Создание счетчика метрики

1. Создайте счетчик метрики в соответствии с инструкцией.

2. В настройках счетчика включите опцию «Контентная аналитика» и укажите тип разметки OpenGraph:

   

3. Добавьте счётчик в документационный проект, используя конфигурационный файл .yfm.

   Пример:

   allowHTML: true
   apply-presets: true
   varsPreset: external
   langs: ['ru', 'en']
   
   docs-viewer:
     metrika: 44444444
     project-name: your-project-name
   

Добавление метаинформации

В отчетах по контенту данные собираются только по размеченным материалам. Для разметки материала рекомендуется использовать словарь семантической разметки данных OpenGraph.
Разметка задаётся в файлах документации с расширением md, в блоке front-matter.

Пример использования в статье документации:

---
metadata:
    - property: 'og:type'
      content: 'article'
    - property: 'og:title'
      content: 'В Москве побит температурный рекорд 1922 года'
    - property: 'og:url'
      content: 'https://www.example-news.com/life/weather/moscow#cao'
    - property: 'article:section'
      content: 'Погода'
    - property: 'article:modified_time'
      content: '2018-12-11T08:56:49Z'
    - property: 'article:published_time'
      content: '2018-11-06T09:26:10+04:00'
    - property: 'article:author'
      content: 'Иван Иванов'
    - property: 'article:author'
      content: 'Петр Петров'
    - property: 'article:tag'
      content: 'Жара'
    - property: 'article:tag'
      content: 'Москва'
---

<meta property="og:type" content="article"/>
<meta property="og:title" content="В Москве побит температурный рекорд 1922 года"/>
<meta property="og:url" content="https://www.example-news.com/life/weather/moscow#cao"/>
<meta property="article:section" content="Погода">
<meta property="article:modified_time" content="2018-12-11T08:56:49Z">
<meta property="article:published_time" content="2018-11-06T09:26:10+04:00">   
<meta property="article:author" content="Иван Иванов">
<meta property="article:author" content="Петр Петров">
<meta property="article:tag" content="Жара">
<meta property="article:tag" content="Москва">

<meta property="og:type" content="article">

<meta property="og:title" content="В Москве побит температурный рекорд 1922 года">

<meta property="article:author" content="Иван Иванов">
<meta property="article:author" content="Петр Петров">

<meta property="article:tag" content="Жара">
<meta property="article:tag" content="Москва">

<meta property="article:modified_time" content="2018-12-11T08:56:49Z">
<meta property="article:published_time" content="2018-11-06T09:26:10+04:00">

<meta property="article:section" content="Погода">

<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">

Использование отчетов по контентной аналитике

Сводные отчеты

Стандартные отчеты

Заключение

Интеграция контентной аналитики с помощью Яндекс Метрики в техническую документацию помогает глубже понимать потребности пользователей и адаптировать контент в соответствии с их ожиданиями.

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

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

Смотрите также

• Отчёты по контенту (документация)
• Проверка передачи данных контентной аналитики