Всем привет! На связи «Инферит Клаудмастер». Я Милена, технический писатель, и пару месяцев назад уже делилась в статье, как в две руки актуализирую портал документации, чтобы вся информация в нём была актуальная и полезная.

На этот раз хочу рассказать:

• о том, почему ченджлог и роадмап — пользовательская документация,

• о ключевых преимуществах ведения обоих видов документации,

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

Я не претендую на статус эксперта в написании ченджлога и роадмапа, а хочу: 

• поделиться нашими наработками с учетом практики в других ИТ-продуктах и 

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

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

По моему скромному мнению, и ченджлог, и роадмап — виды пользовательской документации по 2 причинам:

1. Ченджлог и роадмап содержат описание продуктовых обновлений.

Для пользователя это артефакты не только того, в какую сторону развивается продукт, но и какая функциональность реализована, и что будет для него, как для пользователя (в случае клиентов «Инферит Клаудмастер» — для его облачной инфраструктуры), максимально ценным.

В отличие от статей на портале документации ченджлог и роадмап в лаконичной форме максимально доступно объясняют, что именно было реализовано. Благодаря формату изложения информации пользователь за пару минут понимает, как обновления повлияют на его работу с продуктом, и, если ему нужны подробности, из роадмапа и ченджлога он «пойдёт» в документацию.

2. Ченджлог и роадмап — продукт работы как команды, так и самого пользователя.

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

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

Ченджлог

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

Ченджлог — результат работы в рамках delivery фазы с опорой на результаты discovery фазы. 

Ценность ченджлога для пользователей

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

1. Прозрачность и информированность

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

2. Удобство формата документа

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

3. Обеспечение стабильности

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

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

Примеры удачного оформления 

Имхо, в хорошо продуманном ченджлоге:

• уточняется, когда обновления «заехали» в продукт,

• выделены ключевые изменения каждого релиза и визуально их можно сразу увидеть,

• есть упоминание или ссылка, где об изменениях узнать подробности. 

Я отобрала несколько примеров оформления и дополнила описанием каждый кейс по шаблону для удобства их сравнения.

«Инферит Клаудмастер»

Размещение: раздел на портале документации* + телеграм-канал.

*сделала разбор обновлений на портале документации.

Оформление: разворачивающийся список с датами и номером релизов. При клике на релиз откроется список обновлений со скриншотами.

Все обновления сгруппированы в группы: «новая функциональность», «улучшения», «обновления в документации».

Структура обновления: описание обновления, скриншот с выделенным обновлением, ссылка на статью в портале документации.

Шаблон текста: «{Название раздела продукта}: добавили/улучшили/доработали {описание нового объекта или функциональности}» + важные примечания, ограничения (если есть).

«Airtable»

Размещение: раздел «Что нового?» на сайте.

Оформление: выбор пользователем формата представления: списком или галереей из карточек с обновлениями.

Доступна фильтрация обновлений по тарифному плану клиентов.

Структура обновления: заголовок обновления, скриншот с выделенным обновлением, краткое описание изменения, для какого тарифного плана доступно обновление, в каком релизе реализовано, ссылка на статью в портале документации.

Шаблон текста: свободная форма («Теперь мы используем…», «Пользователи могут {описание новой функциональности}», «{описание нового объекта или функциональности} позволяет пользователям {действия}»).

«Mindbox»

Размещение: несколько источников.

• Раздел «Что нового?» в справочном центре пользователя, 

• раздел «Обновления» на сайте,

• телеграм-канал «Обновления Mindbox»*.

*сделала разбор обновлений в телеграм-канале.

Оформление: отдельный пост под каждое обновление.

Структура обновления: заголовок обновления в форме призыва пользователя к действию («Создавайте/получайте/выгружайте…»), скриншот с выделенным обновлением или скриншот «было vs стало».

Шаблон текста: свободная форма, но чаще всего «Раньше {описание старой функциональности}. Теперь {описание новой функциональности}. Это {описание ценности для пользователя}».

«Газпромбанк»

Размещение: виджет «Что нового» на главной странице мобильного приложения.

Оформление: карточки обновлений в форме текста или видео.

Структура обновления: заголовок обновления, описание новой функциональности, кнопка на обновленный раздел приложения.

Шаблон текста: «Теперь в приложении доступно {описание новой функциональности}. Для этого перейдите/настройте…».

Роадмап

Преамбула части про роадмап — в данной статье речь пойдёт о публичном продуктовом роадмапе (т.е. том, который публикуют для пользователей).

Роадмап, или дорожная карта — это «артефакт, который содержит набор целей и инициатив по продукту на определенный период. Другими словами, это план действий, который указывает направление развития продукта и описывает, над чем будет работать команда, чтобы достичь продуктового видения» (цит. из статьи Как продакт-менеджеру собрать роадмап: 4 этапа).

Т.е. роадмап это про то, какие шаги команда продукта предпринимает для достижения стратегии его развития. 

Роадмап показывает фичи на всех этапах: от идей до реализации, включая запланированные и те, что в разработке. В роадмапе 3/4 фичей — это результаты discovery фазы, и 1/4 — реализованные в delivery.

Ченджлог же отражает только реализованные фичи, то есть последний этап роадмапа.

Ценность роадмапа для пользователей

Отвечая на вопрос, зачем компании вести продуктовый роадмап, вижу как минимум 3 аргумента «за»:

1. Прозрачность и доверие пользователя

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

2. Причастность к развитию продукта

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

Так, делясь обратной связью по продукту, пользователь делает свою работу в нём более удобной.

3. Мотивация оставаться с продуктом

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

Примеры удачного оформления

«Инферит Клаудмастер»

Размещение: 

• отдельный домен под роадмап в сервисе Ducalis (см. подборку других сервисов ниже), 

• встроенный виджет в продукте,

• ссылки на роадмап в подвале портала документации и сайта, 

• примечание о ведении роадмапа в ченджлоге.

Оформление: доска Канбан с карточками задач и скриншотами.

Структура задачи: заголовок задачи, описание задачи по формату ответа на 2 вопроса (как будет работать? чем будет полезно?), скриншот с планируемым обновлением.

Шаблон текста: «Добавим/встроим/разработаем {описание новой функциональности}. Пользователи смогут {описание пользы функциональности}».

«Timeweb Cloud»

Размещение: подраздел «Роадмап и чейнджлог» на сайте документации*.

*Подход Timeweb Cloud к объединению роадмапа и ченджлога подтверждает мой тезис о том, что в роадмапе описана часть функциональности из ченджлога.

Оформление: список обновлений по месяцам и категории “Реализовано” или “Запланировано”.

Структура задачи: заголовок с месяцем реализации, подзаголовок с сервисом, в котором запланированы новые фичи, список задач по каждому сервису. 

Шаблон текста: 

• в роадмапе: {Название сервиса или раздела в продукте}. Установка/расширение {описание новой или существующей функциональности},

• в ченджлоге: добавили/исправили/реализовали {описание новой или существующей функциональности}.

«Пачка»

Размещение: раздел «Roadmap» на сайте + ссылка на ченджлог с подробным описанием обновлений.

Оформление: список обновлений по кварталам.

Структура задачи: краткое описание задачи, теги с указанием типа приложения (web/desktop) и типа ОС.

Шаблон текста: свободная форма (например, «бесплатные гостевые аккаунты» или «отложенная отправка сообщений»).

Итоги и инсайты

Соберём ключевые тезисы статьи:

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

• Ченджлог отображает результаты работы по окончанию delivery фазы, роадмап отображает результаты работы обеих фаз: discovery (в большей мере) и delivery фазы. 

• Фактически ченджлог — это часть роадмапа (то, что команда запланировала в рамках стратегии и реализовала).

• Ценность ченджлога — в поддержании информированности пользователей, формате представления изменений и верификации, насколько разрабатываемый продукт стабильный.

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

• Публичный продуктовый роадмап даёт пользователям множество преимуществ, начиная от доверия и прозрачности до возможности влияния на развитие продукта.

• Формат ведения ченджлога и продуктового роадмапа в компаниях разнообразный. Некоторые компании совмещают ченджлог и роадмап в один раздел документации.