Как написать примечания к выпуску (release notes)

Вы находитесь на финишной прямой в цикле выпуска новой версии. Пришло время выпустить ваш продукт… и вы должны написать к нему примечания.

Многие компании рассматривают release notes как второстепенные сообщения. Они спешат написать что-нибудь — что угодно — чтобы поставить галочку в графе «примечания к выпуску» конкретного цикла разработки. Примечания к выпуску в конечном итоге полны технического жаргона, который пользователи не понимают.

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

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

Что такое примечания к выпуску (release notes)?

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

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

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

• Email. Почту можно использовать для прямой передачи информации об обновлении клиентам, вместо того, чтобы ждать, пока они воспользуются вашим продуктом. Она часто используется, чтобы отметить важные обновления или объявить о важных изменениях.
• Сообщения в блоге. Они предназначены для публикации более длинного контента, чем в  электронной почте или сообщений в приложении. Это делает их идеальным форматом для релизов, которые заслуживают большего внимания или объяснений.
• Социальные сети. Это отличный способ привлечь внимание к отдельным функциям и создать шумиху вокруг новых версий и обновлений.
• App Store/Google Play. Примечания к выпуску стандартны в Apple App Store и Google Play Store. Например, пользователи, желающие купить или обновить мобильное приложение в App Store, могут просмотреть обширный список примечаний к выпуску при выборе продукта. История версий приложения TikTok выглядит так:

Как писать release notes

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

1. Объясните цель изменений

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

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

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

Объяснения должны быть короткими и простыми, но не упрощайте. Например, фраза «Исправлена ошибка ​​и сделаны обновления» будет короткой, но расплывчатой. С другой стороны, фраза «Мы улучшили возможность переключения приложений, уменьшив количество неожиданных сбоев программного обеспечения» более ясна, подчеркивает преимущества более подробно, но все же не слишком длинна и не слишком громоздка.

2. Сосредоточьтесь на пользователе

Помните, что примечания к выпуску — отличный способ общения с клиентом. Сопереживайте своим пользователям — примите их роль в поиске информации. Поймите их, узнайте их, узнайте о них. Составляя свои release notes, спросите себя, что они ищут? Смогут ли они легко это найти?

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

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

3. Объясните изменения с помощью визуальных средств

Большинство потребителей запоминают только около 20% прочитанного текста, если он не сопровождается визуальными элементами, и «хорошо подобранные изображения могут улучшить понимание, когда разработчики размещают такую графику стратегически». Если ваши примечания к выпуску нуждаются в длинном объяснении, включите короткий GIF или полезный снимок экрана, который точно показывает, что делает это изменение.

Примером могут служить примечания к выпуску карточной игры Magic: The Gathering. Одно примечание к выпуску содержало 51 страницу информации об обновлении — это много для понимания. Тем не менее, MtG проделала хорошую работу, обобщив эти примечания на первой странице с визуальными эффектами и резюме наиболее важных функций, которые были обновлены.

4. Организуйте примечания к выпуску

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

Хорошим примером является Amazon Business, у которого есть специальная страница, которая позволяет раскрывающимся меню сегментировать примечания по категориям, предложениям продуктов, месяцам и годам.

5. Не вдавайтесь в технические подробности

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

Избавьтесь от жаргона.

Используйте простые, понятные слова и фразы. Когда вы закончите писать, прочитайте вслух примечания к выпуску другу или члену семьи — кому-то, кто не знаком с техническими особенностями новой версии. Имеют ли объяснение смысл для них? Скорее всего, если ваш младший брат или сестра поняли то, о чем вы говорите, то же самое поймут и большинство ваших пользователей. «Теперь вы можете использовать GIF в нашей службе обмена сообщениями» гораздо понятнее, чем «Мы реализовали возможность использования растровых изображений в формате Graphics Interchange Format, которая включает в себя сжатие файлов, прозрачность, чередование и хранение нескольких изображений в одном файле для нашей службы обмена сообщениями».

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

6. Продолжайте продвигать свой бренд… осторожно

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

Однако будьте осторожны с подачей. Плохая подача в пояснениях звучит очень пафосно и только вредит. «Мы здесь, чтобы спасти планету, что мы успешно делаем с каждой новой версией. На здоровье! Наше новое исправление включает в себя снижение энергопотребления на 50%». Это производит впечатление высокомерия, настоящего убийцы доверия со стороны вашей аудитории.

Вместо этого более мягким (и более скромным) подходом было бы «Исправление ошибки: 00100 — Программное обеспечение теперь снижает потребление энергии конечными пользователями на 50%. Один из многих способов, которыми мы стремимся к устойчивому будущему». Вы видите, что мы сделали? Рассказали об исправлении, а затем добавили, что мы заботимся о будущем — и все это не звучит навязчиво.

Используйте правило 80/20, используемое в социальных сетях; 80% вашего контента должно быть полезным, и только 20% — саморекламой. Это правило полезно не только для примечаний к выпуску, но и для любого типа контента, который вы создаете.

7. Используйте шаблон release notes

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

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

5 примеров отличных примечаний к выпуску

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

1. Help Scout напоминает пользователям о существующих функциях

Объявляя о новой функции (маркированный список), HelpScout также обращает внимание пользователей на функции редактора сообщений, которые в настоящее время могут не использоваться.

На скриншоте показано, как используется функция Markdown на примере и ссылка на слово Markdown ведет пользователя к подробной статье об этой функции. При составлении примечаний к выпуску сама функция Markdown помогает объяснить нововведение.

2. Retool классифицирует типы изменений для удобства пользователей.

Retool классифицирует свои обновления как «Незначительные», «Улучшения» и «Новое». Если пользователь хочет сосредоточиться только на «новых» функциях в списке, их легко найти.

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

3. UiPath включает оглавление для удобной навигации

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

4. Amplitude встраивает видео

Amplitude использует комбинацию коротких видеороликов и снимков экрана при объяснении новых функций. Видео очень эффективно для привлечения аудитории. Семьдесят девять процентов людей говорят, что просмотр видео убедил их купить приложение, а «объясняющие» видео просматривают 96% потребителей.

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

5. Обновление Feefo сразу же дает вам примечания к выпуску в приложении

Некоторые пользователи не хотят копаться в длинном документе с примечаниями к выпуску на вашем веб-сайте или в электронной почте. Feefo использует Appcues, чтобы анонсировать свои последние функции, выпуски и анонсы в самом приложении. Эта коммуникация особенно эффективна, поскольку именно в приложении изменения будут иметь наибольший эффект.

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

Источник