Хорошая практика написания заметок о выпуске

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

Дата выхода
Исправлена ошибка

Этого достаточно, или есть что-нибудь еще?

release

— CoolProgrammer
источник

Это выглядит как дубликат programmers.stackexchange.com/questions/66377/...

не забывайте о добавленных функциях

— трещотка урод

Ответы:

Я думаю, что следующие приведут к хорошей практике

// Дата связана

Дата выхода

// Функция связана

Добавленные функции
Избранное Удалено
Особенности изменены

// Ошибка связана

Решенные ошибки
Неразрешенные ошибки

// Связанные зависимости

Список зависимостей

// Тестирование связано

Результаты модульного теста
Результаты приемочных испытаний

// Управление версиями связано

Тег Примечание
Номер ревизии

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

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

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

— Г-н Махбубур Рахман
источник

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

— jk.

@jk. Да ты прав. Я отредактировал свой ответ как ваш хороший комментарий.

— Md Mahbubur Rahman

— Хенрик

Примечания к выпуску @Henrik могут быть полезны для людей, не являющихся конечными пользователями,

— jk.

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

— ddyer
источник

каждая строка может потерять 10% случайных, незаинтересованных (или ленивых) читателей. Это те читатели, для которых ваши заметки о выпуске не написаны. Те, кому небезразлично то, что вы сделали, прочтут их все и поблагодарят вас за каждую соответствующую строку - вам нужно только быть осторожным с включением пуха, который действительно должен входить в надлежащую документацию.

— gbjbaanb