Подтвердить что ты не робот

Заметки о выпуске, для чего?

Что такое заметки о выпуске и кто их читает? Должны ли/быть автоматизированы, просто выплевывая исправления ошибок для текущей версии, или они требуют тщательного редактирования человеком? Итак, кто-нибудь со ссылкой на лучшие практики (рассуждения позади) в отношении заметок о выпуске программного обеспечения?

4b9b3361

Ответ 1

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

Ответ 2

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

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

Ответ 3

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

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

Ключ состоит в том, что, как правило, заметки о выпуске, как полагают, относятся к типу "Эй, посмотрим, что мы сделали".

Ответ 4

Наши заметки о выпуске создаются человеком вместо созданной машины. Покрытие охватывает три основные темы.

  • Что включено в выпуски (список файлов)

  • Как установить его

  • Что изменилось с последней версии (особенно если изменения не руководство пока).

элементы 1 и 2 не сильно меняются от версии к версии, но их нужно пересмотреть. Пункт 3 выполняет большую работу.

Ответ 5

Заметки о выпуске также очень важны в производственной среде.

Они помогают ответить на вековой вопрос:

Что в настоящее время работает в производстве?

Или более утонченный вопрос: действительно ли эта ошибка была исправлена ​​в этой версии?

Ответ 6

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

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

Ответ 7

Примечания к выпуску и README могут быть действительно важны, если ваш клиент должен предпринять специальные действия в дополнение к обычным процедурам для обновления. Также полезно предупредить клиентов/пользователей о любых обновлениях db, которые могут произойти автоматически в результате установки нового патча. Как я вижу это, заметки о выпуске и README должны быть написаны для аудитории системного администратора. Поэтому расскажите о тех вещах, о которых они хотели бы узнать: резюме важных изменений, как установить, известные ошибки, все, что может сделать ваше программное обеспечение, чтобы кто-то вытащил свои волосы и т.д.

Ответ 8

Замечание о выпуске зависит от вашей организации.

Я могу поговорить о моей организации. Мы используем примечание к выпуску в формате PDF и каждый раз, когда мы публикуем кликовую или бэкэнд-версию. Мы отправляем в офис менеджера заметку о выпуске. Это документ, используемый высшим администратором бизнеса (а не только ИТ). Этот документ позволяет им узнать, что происходит. Что изменилось, новые функции, которые сейчас производятся, исправлены ошибки и другое, что они могут объяснить своим пользователям.

Это документ, который может составлять от 3 до 4 страниц, описывая работу, выполненную в этой версии, с краткими словами.

Ответ 9

Это, конечно, сильно зависит от типа приложения/сервиса/whatnot,
 но я обнаружил, что читаю заметки о выпуске своих любимых инструментов разработки и т.д.

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

Как большинство пользователей компьютеров (теперь какое выражение это...)
Я никогда не очень разбираюсь в обычной документации, так что это дает мне что-то еще что-то лишнее, кроме нажатия, зависания и факирования...

Ответ 10

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

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