Примечания к выпуску

Примечания к выпуску — это документы, которые распространяются вместе с программными продуктами или аппаратными продуктами, иногда когда продукт все еще находится в состоянии разработки или тестирования (например, бета- версия). ^[1]^[2] Для продуктов, которые уже использовались клиентами, примечания к выпуску доставляются клиенту при выпуске обновления. Другое сокращение для примечаний к выпуску — «Журнал изменений» , «Журналы выпуска» , «Изменения программного обеспечения », « Обновления истории изменений» или «Файл README» . ^[3] Однако в некоторых случаях примечания к выпуску и журнал изменений публикуются отдельно. Это разделение предназначено для ясности и дифференциации основных функций от ошибок, запросов на изменения ( CR ) или улучшений с другой стороны. ^[4]^[5]

Цель

Примечания к выпуску — это документы, которые доступны конечным пользователям, клиентам и клиентам организации. Определения терминов «Конечные пользователи», «Клиенты» и «Клиенты» весьма относительны по своей природе и могут иметь различные интерпретации в зависимости от конкретного контекста. Например, группу обеспечения качества в организации, занимающейся разработкой программного обеспечения, можно интерпретировать как внутреннего заказчика. ^[6]

Содержание

В примечаниях к выпуску подробно описаны исправления, изменения или улучшения ( функциональные или нефункциональные ), внесенные в услугу или продукт, предоставляемые компанией. ^[7]^[8]^[9]

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

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

Они отличаются от Лицензионного соглашения с конечным пользователем , поскольку не содержат (не должны) содержать каких-либо юридических условий программного продукта или услуги. В центре внимания должен быть сам выпуск программного обеспечения, а не, например, юридические условия. ^[10]

Примечания к выпуску также можно интерпретировать как описание того, как установить или собрать программное обеспечение, вместо того, чтобы выделять новые функции или устраненные ошибки. ^[11] Другой термин, часто используемый в этом контексте, — «Системные требования », означающий необходимое оборудование и программное обеспечение для установки или создания программного обеспечения.

Стиль формата

Не существует стандартного формата примечаний к выпуску, которого придерживаются различные организации. Организации обычно принимают свои собственные стили форматирования в зависимости от требований и типа распространяемой информации. Содержание примечаний к выпуску также различается в зависимости от типа выпуска. Для продуктов, находящихся на стадии тестирования и недавно выпущенных, контент обычно более информативен по сравнению с примечаниями к выпуску с исправлениями ошибок и улучшениями функций, которые обычно кратки.

Примечания к выпуску могут включать следующие разделы:

Заголовок — название документа (т. е. примечания к выпуску), название продукта, номер выпуска, дата выпуска, дата примечания, версия примечания и т. д.
Обзор — краткий обзор продукта и изменений при отсутствии другой официальной документации.
Цель — краткий обзор цели примечаний к выпуску со списком того, что нового в этом выпуске, включая исправления ошибок и новые функции.
- Краткое описание проблемы — краткое описание ошибки или улучшения в выпуске.
- Шаги по воспроизведению — шаги, которые были выполнены при обнаружении ошибки.
- Разрешение — краткое описание модификации/улучшения, внесенного для исправления ошибки.
Влияние на конечного пользователя . Какие действия необходимы конечным пользователям приложения. Сюда должно быть включено, повлияют ли эти изменения на другие функции.
Влияние на поддержку — изменения, необходимые в ежедневном процессе администрирования программного обеспечения.
Примечания — примечания об установке программного или аппаратного обеспечения , обновлениях и документации по продукту (включая обновления документации).
Отказ от ответственности — стандартные сообщения, относящиеся к компании и продуктам. например; бесплатное ПО , защита от пиратства , дублирование и т. д. См. также отказ от ответственности .
Контакт — контактная информация службы поддержки.

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

Существует предложение по открытой спецификации, которое называется Спецификация схемы примечаний к выпуску. ^[12]

См. также

Дальнейшее чтение

Лаура Морено и др. ARENA: An Approach for the Automated Generation of Release Notes , IEEE Transactions on Software Engineering (Том: 43, Выпуск: 2, 1 февраля 2017 г.) ^[13]
Ньютон, Кейси (10 февраля 2016 г.). «Я пил пиво и писал примечания к выпуску вместе с командой разработчиков Medium» . Грань . Вокс Медиа . Проверено 5 апреля 2021 г.
Стандарты кодирования GNU — 6.8 Журналы изменений

Ссылки

^ «Концепции журнала изменений (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 г.
^ Скотт, Джеймс (24 апреля 2020 г.). «Искусство написания замечательных заметок о выпуске» . Середина . Проверено 5 апреля 2021 г.
^ «Релизы (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 г.
^ «История версий — Английский — База знаний» . kb.i-doit.com . Проверено 10 октября 2021 г.
^ «56508 — SoC Zynq-7000, 14.6 FSBL — есть ли журнал изменений?» . Xilinx поддерживает поиск по ключевым словам .
^ Хоббс, Брайан; Беснер, Клод (01 мая 2016 г.). «Проекты с внутренними и внешними клиентами: эмпирическое исследование различий на практике» . Международный журнал управления проектами . 34 (4): 675–687. дои : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863 .
^ «Журналы изменений (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 г.
^ Ван, К.; Ли, Дж.; Лян, П.; Данева, М.; Синдерен, М. (сентябрь 2019 г.). «Взгляд разработчиков на изменения в приложениях: предварительное исследование журналов изменений приложений» . IEEE, 2019 г. Семинары 27-й Международной конференции по разработке требований (REW ) стр. 207–212. дои : 10.1109/REW.2019.00042 . ISBN 978-1-7281-5165-6 . S2CID 209460408 .
^ Борн, Келли К. (01 января 2014 г.), Борн, Келли К. (редактор), «Глава 10 — Обновления и исправления» , Справочник администратора приложений , Бостон: Морган Кауфманн, стр. 150–165, doi : 10.1016 /b978-0-12-398545-3.00010-8 , ISBN 978-0-12-398545-3 , получено 25 марта 2021 г.
^ примечания к выпуску/примечания к выпуску-spec , Примечания к выпуску, 25 марта 2021 г. , получено 25 марта 2021 г.
^ «Ядро Linux версии 5.x — Документация по ядру Linux» . www.kernel.org . Проверено 25 марта 2021 г.
^ примечания к выпуску/примечания к выпуску-spec , Примечания к выпуску, 25 марта 2021 г. , получено 25 марта 2021 г.
^ Морено, Л.; Бавота, Г.; Пента, доктор медицины; Оливето, Р.; Маркус, А.; Канфора, Г. (февраль 2017 г.). «ARENA: подход к автоматическому созданию примечаний к выпуску» . Транзакции IEEE по разработке программного обеспечения . 43 (2): 106–127. дои : 10.1109/TSE.2016.2591536 . ISSN 1939-3520 .

Внешние ссылки

Как писать примечания к выпуску
Как следует писать примечания к выпуску? (переполнение стека)
Примечания к выпуску приложения «Странное искусство письма»
Release Notes Hub (также https://www.release-notes.com ) с открытым исходным кодом на GitHub
Спецификация схемы примечаний к выпуску

[1] «Концепции журнала изменений (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 г.

[2] Скотт, Джеймс (24 апреля 2020 г.). «Искусство написания замечательных заметок о выпуске» . Середина . Проверено 5 апреля 2021 г.

[3] «Релизы (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 г.

[4] «История версий — Английский — База знаний» . kb.i-doit.com . Проверено 10 октября 2021 г.

[5] «56508 — SoC Zynq-7000, 14.6 FSBL — есть ли журнал изменений?» . Xilinx поддерживает поиск по ключевым словам .

[6] Хоббс, Брайан; Беснер, Клод (01 мая 2016 г.). «Проекты с внутренними и внешними клиентами: эмпирическое исследование различий на практике» . Международный журнал управления проектами . 34 (4): 675–687. дои : 10.1016/j.ijproman.2016.02.010 . ISSN 0263-7863 .

[7] «Журналы изменений (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 г.

[8] Ван, К.; Ли, Дж.; Лян, П.; Данева, М.; Синдерен, М. (сентябрь 2019 г.). «Взгляд разработчиков на изменения в приложениях: предварительное исследование журналов изменений приложений» . IEEE, 2019 г. Семинары 27-й Международной конференции по разработке требований (REW ) стр. 207–212. дои : 10.1109/REW.2019.00042 . ISBN 978-1-7281-5165-6 . S2CID 209460408 .

[9] Борн, Келли К. (01 января 2014 г.), Борн, Келли К. (редактор), «Глава 10 — Обновления и исправления» , Справочник администратора приложений , Бостон: Морган Кауфманн, стр. 150–165, doi : 10.1016 /b978-0-12-398545-3.00010-8 , ISBN 978-0-12-398545-3 , получено 25 марта 2021 г.

[10] примечания к выпуску/примечания к выпуску-spec , Примечания к выпуску, 25 марта 2021 г. , получено 25 марта 2021 г.

[11] «Ядро Linux версии 5.x — Документация по ядру Linux» . www.kernel.org . Проверено 25 марта 2021 г.

[12] примечания к выпуску/примечания к выпуску-spec , Примечания к выпуску, 25 марта 2021 г. , получено 25 марта 2021 г.

[13] Морено, Л.; Бавота, Г.; Пента, доктор медицины; Оливето, Р.; Маркус, А.; Канфора, Г. (февраль 2017 г.). «ARENA: подход к автоматическому созданию примечаний к выпуску» . Транзакции IEEE по разработке программного обеспечения . 43 (2): 106–127. дои : 10.1109/TSE.2016.2591536 . ISSN 1939-3520 .

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]