Правильные заметки к релизу

Это заметка из серии «60 секунд». В ней я публикую избранные короткие эссе, обычно со ссылкой на рекомендуемый материал. Больше таких заметок — в  телеграме

На днях Ника Троицкая подняла тему пользы и шуточек в release notes. А сегодня я прочитал статью Роба Гила «As a Designer I want Better Release Notes», в которой он подробно и с примерами описал идеальные заметки к релизу для апсторов.

Вкратце:

  1. Первым абзацем — краткая суть изменений в релизе («добавили вход по отпечатку пальца»). Можно короткий список, если главных изменений несколько.

  2. Не стесняйтесь написать, что весь релиз про исправление злого бага, если от него пострадали многие.

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

  4. Явно разделите на секции: новые фичи, улучшения, багфиксы. Для подзаголовков используйте ПРОПИСНЫЕ. Для перечисления применяйте списки с булитами.

  5. Добавьте немного настроения одной фразой (если хочется). Только не надо натужно шутить.

As a Designer I want Better Release Notes