Релиз-ноты на практике
Как команды пишут релиз-ноты, которые действительно читают.
С чего начать: Как писать release notes, которые реально читают, Что такое changelog: определение и пример записи, Changelog vs release notes: в чём разница?
-
Release notes программного обеспечения: что включать
Release notes программного обеспечения говорят, что изменилось в версии, кого это касается и что делать. Четыре вида, состав записи и разобранный пример.
Релиз-ноты на практике4 мин чтения
-
Release notes об исправлении багов: как писать записи
Release notes об исправлении багов работают, когда запись называет симптом, охват и действие. Примеры до и после, правила для безопасности и данных.
Релиз-ноты на практике6 мин чтения
-
Примеры release notes для каждого вида изменений
Примеры release notes для новой функции, исправления, breaking change, уязвимости, депрекации, заметки в сторе и внутренней заметки, с разбором слов.
Релиз-ноты на практике7 мин чтения
-
Экстренные Release Notes: Под Давлением Реального Времени
Релизы, вызванные инцидентом, требуют заметок, написанных за минуты, а не дни, и обычный процесс написания предполагает время, которого у вас нет.
Релиз-ноты на практике4 мин чтения
-
Внутренние release notes: кому ещё нужно знать, что вышло
Саппорт и продажи узнают о запуске от растерянного клиента. Внутренние release notes решают эту проблему в форме, отличной от той, что видят клиенты.
Релиз-ноты на практике5 мин чтения
-
Release notes мобильных приложений: App Store и Google Play
App Store допускает 4000 символов, Google Play 500, и оба показывают пару строк без ссылок. Что режет лимит и как сократить текст намеренно.
Релиз-ноты на практике4 мин чтения
-
Анонс новой функции: шаблоны и как его написать
Большинство анонсов умирает в канале, который никто не читает дважды. Где анонсировать, что сказать первым, и до кого нужно достучаться в первую очередь.
Релиз-ноты на практике5 мин чтения
-
Enterprise release notes: что меняется для одного аккаунта
Enterprise release notes для клиента на приватной сборке нужно откалибровать под его инстанс. Ошибка в калибровке сливает roadmap или путает поддержку.
Релиз-ноты на практике4 мин чтения
-
Что такое changelog: определение и пример записи
Changelog, или журнал изменений, представляет собой датированную запись изменений продукта для его пользователей. Пример записи и шаблон для копирования.
Релиз-ноты на практике5 мин чтения
-
Шаблон письма об обновлении продукта, которое читают
Письмо об обновлении продукта, которое читают, ушло тому, кто его попросил. Шаблон, четыре типа писем, рабочие темы, сегментация и согласие.
Релиз-ноты на практике5 мин чтения
-
Changelog vs release notes: в чём разница?
Changelog служит непрерывным реестром для того, кто что-то ищет. Release notes дают отобранное сообщение тому, кто решает, важно ли это ему.
Релиз-ноты на практике5 мин чтения
-
Как писать release notes, которые реально читают
«Исправления багов и улучшения производительности» не годится как release note. Вопрос, на который должна отвечать каждая запись, и переписанный пример.
Релиз-ноты на практике6 мин чтения
-
Лучшие практики release notes, которые важны
Большинство списков лучших практик сводится к советам по стилю. Эти меняют поведение читателя, плюс три популярных, которые оказываются карго-культом.
Релиз-ноты на практике5 мин чтения