Примечания к выпуску, для чего?
Для чего нужны заметки о выпуске и кто их читает? Должны ли они быть автоматизированы, просто выплевывая исправления ошибок в текущем выпуске, или они требуют тщательного редактирования человеком? Итак, кто-нибудь имеет ссылку на лучшие практики (обоснование) в отношении примечаний к выпуску программного обеспечения?
10 ответов
Примечания к выпуску также важны для вашей организации тестирования (если таковая имеется), чтобы они знали, что изменилось в выпуске и нуждаются в тестировании.
Исправлены ошибки и добавлены функции. Пользователи будут читать их, чтобы определить, стоит ли им заниматься установкой инкрементного обновления или подождать до следующего выпуска, потому что он не добавляет нужные им функции или исправляет ошибки в функциях, которые они использовали.
Я бы сказал, что они по крайней мере требуют, чтобы человек прочитал их и удостоверился, что каждая заметка полезна. Это зависит от того, насколько хороши комментарии к вашим исправлениям ошибок.
Это действительно зависит от того, для кого создано ваше приложение, и от целей вашей организации. Однако я склонен полагать, что примечания к выпуску должны быть кратким списком важных ключевых дополнений, улучшений или исправлений, которые включены в конкретный выпуск.
Иногда достаточно простого сброса информации о системе отслеживания ошибок, в других случаях я нахожу, что их необходимо уточнить.
Ключевым моментом является то, что обычно Примечания к выпуску считаются списком изменений типа "Привет, посмотрите, что мы сделали".
Наши заметки о выпуске созданы человеком, а не машиной. В обложке три основные темы.
Что входит в релизы (список файлов)
Как его установить
Что изменилось со времени последней версии (особенно если изменений пока нет в руководстве).
пункты 1 и 2 не сильно меняются от версии к версии, но их необходимо пересмотреть. Пункт 3 занимает большую часть работы.
Примечания к выпуску также очень важны в производственной среде.
Они помогают ответить на извечный вопрос:
Какого черта в настоящее время запускается в производство?
Или более утонченный вопрос: действительно ли эта ошибка была исправлена в этом выпуске?
Я обычно читаю заметки о выпуске. Я стремлюсь получить полный исчерпывающий список изменений функций (или настолько, насколько это возможно), чтобы расширить возможности моего использования нового продукта.
Я хочу видеть, когда решаются определенные критические ошибки или критические проблемы безопасности.
Информация о выпуске зависит от вашей организации.
Я могу говорить за свою организацию. Мы используем примечание к выпуску в формате PDF и каждый раз публикуем версию clickonce или бэкэнд. Отправляем администратору офиса Релиз-заметку. Это документ, используемый высшим администратором бизнеса (не только ИТ). Этот документ дает им возможность узнать, что происходит. Что изменилось, новые функции, которые в настоящее время находятся в производстве, исправлены ошибки и другие вещи, которые они могут захотеть объяснить своим пользователям.
Этот документ может содержать от 3 до 4 страниц, описывая работу, выполненную в этой версии, с краткими словами.
Примечания к выпуску и README могут быть очень важны, если ваш клиент должен выполнить специальные действия в дополнение к обычным процедурам для обновления. Также полезно предупредить клиентов / пользователей о любых обновлениях БД, которые могут автоматически произойти в результате установки более нового патча. На мой взгляд, Примечания к выпуску и README должны быть написаны для аудитории Системного Администратора. Так что включите в себя то, о чем они хотели бы знать: краткие сведения о важных изменениях, способах установки, известных ошибках, обо всем, что может сделать ваше программное обеспечение, которое заставило бы кого-то выпутаться, и т.д.
Примечания к выпуску предназначены для тестировщиков и пользователей, чтобы узнать, что нового / изменено. Кроме того, примечания к выпуску могут использоваться в качестве вспомогательной документации при выставлении счетов за новую "версию" программного обеспечения для клиента, который вы создаете для них. v1.31 кажется намного легче связать и изучить.
Вместо того, чтобы компилировать оба списка вручную, если вы можете использовать ваши заметки о выпуске, это здорово.
Это, конечно, сильно зависит от типа приложения / услуги / еще много чего,
но я обнаружил, что читал заметки о выпуске моих любимых инструментов разработки и т.д..
часто заставляет меня натыкаться на приятные, интересные или даже убийственные функции, которые я, вероятно, пропустил бы, если бы по крайней мере не просмотрел заметки..... ну, может быть, не убийца, но вы поняли мой дрейф;-)
Как большинство компьютерных пользователей (что это за выражение...)
Я никогда не зацикливаюсь на обычной документации, так что это дает мне
что-то еще что-то, кроме щелчка, зависания и часто задаваемых вопросов...