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