Из Википедии, бесплатной энциклопедии
Перейти к навигации Перейти к поиску

Примечания к выпуску - это документы, которые распространяются вместе с программными продуктами или аппаратными продуктами, иногда, когда продукт все еще находится в стадии разработки или тестирования (например, бета- версия). [1] [2] Для продуктов, которые уже использовались клиентами, примечания к выпуску доставляются заказчику при выпуске обновления. Еще одна аббревиатурой для примечаний к выпуску является Changelog или выпуск журналов или изменения программного обеспечения или история изменений обновления или README файл . [3]

Цель [ править ]

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

Содержание [ править ]

Примечания к выпуску подробно описывают исправления, изменения или улучшения ( функциональные или нефункциональные ), внесенные в услугу или продукт, которые предоставляет компания. [5] [6] [7]

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

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

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

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

Форматировать [ редактировать ]

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

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

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

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

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

Выдающиеся примеры (в основном программное обеспечение) [ править ]

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

  • Примечания к выпуску проекта Apache Maven
  • Обновления Apple iOS 14
  • Примечания к выпуску Apple macOS
  • Примечания к выпуску Apple Xcode
  • Выпуски FreeBSD
  • Hitfilm Express от FXhome
  • Примечания к выпуску GNOME
  • Выпуски Gitlab [11]
  • Примечания к выпуску i.MX Linux® (PDF от NXP Semiconductors )
  • Примечания к выпуску Atlassian Jira Software
  • Linux (Ubuntu)
  • Ядро Linux 5.x
  • Примечания к выпуску Microsoft Visual Studio
  • Журналы изменений выпуска Minecraft
  • Обновления программного обеспечения Tesla
  • Unity3d 2020.1.0
  • Программное обеспечение Wikipedia MediaWiki
  • Windows 10 (см. Также Состояние выпуска Windows )
  • Примечания к выпуску Xilinx (например, Vivado Design Suite )

См. Также [ править ]

  • Журнал изменений
  • Управление конфигурацией
  • Лицензионное соглашение конечного пользователя
  • ПРОЧТИ МЕНЯ
  • Управление релизами
  • Релиз-кандидат
  • Жизненный цикл выпуска программного обеспечения
  • SWEBOK
  • Условия использования

Дальнейшее чтение [ править ]

  • Лаура Морено и др. ARENA: подход к автоматизированному созданию примечаний к выпуску , транзакции IEEE по разработке программного обеспечения (том: 43, выпуск: 2, 1 февраля 2017 г.) [12]
  • Кейси Ньютон. Я пил пиво и писал примечания к выпуску вместе с командой разработчиков Medium, The Verge (2016-02-10) [13]
  • Стандарты кодирования GNU - 6.8 Журналы изменений

Ссылки [ править ]

  1. ^ «Концепции журнала изменений (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 .
  2. ^ Скотт, Джеймс (2020-04-24). «Искусство писать отличные заметки о выпуске» . Средний . Проверено 5 апреля 2021 .
  3. ^ «Релизы (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 .
  4. ^ Хоббс, Брайан; Беснер, Клод (2016-05-01). «Проекты с внутренними и внешними клиентами: эмпирическое исследование различий на практике» . Международный журнал управления проектами . 34 (4): 675–687. DOI : 10.1016 / j.ijproman.2016.02.010 . ISSN 0263-7863 . 
  5. ^ «Журналы изменений (стандарты кодирования GNU)» . www.gnu.org . Проверено 5 апреля 2021 .
  6. ^ Ван, C .; Li, J .; Liang, P .; Данева, М .; Синдерен, М. (сентябрь 2019 г.). «Взгляд разработчиков на изменения в приложениях: предварительное исследование журналов изменений приложений» . Семинары 27-й Международной конференции по разработке требований (REW), IEEE 2019 : 207–212. DOI : 10,1109 / REW.2019.00042 .
  7. ^ Bourne, Kelly C. (2014-01-01), Bourne, Kelly C. (ed.), «Глава 10 - Обновления и исправления» , Руководство администратора приложений , Бостон: Морган Кауфманн, стр. 150–165, doi : 10.1016 / b978-0-12-398545-3.00010-8 , ISBN 978-0-12-398545-3, получено 2021-03-25
  8. ^ release-notes / release-notes-spec , Примечания к выпуску, 25 марта 2021 г. , получено 25 марта 2021 г.
  9. ^ «Версия ядра Linux 5.x - Документация ядра Linux» . www.kernel.org . Проверено 25 марта 2021 .
  10. ^ release-notes / release-notes-spec , Примечания к выпуску, 25 марта 2021 г. , получено 25 марта 2021 г.
  11. ^ «Выпуски · GitLab.org / GitLab» . GitLab . Проверено 13 февраля 2021 .
  12. ^ Морено, L .; Bavota, G .; Пента, доктор медицины; Oliveto, R .; Маркус, А .; Канфора, Г. (февраль 2017 г.). «ARENA: подход к автоматизированному созданию примечаний к выпуску» . IEEE Transactions по разработке программного обеспечения . 43 (2): 106–127. DOI : 10.1109 / TSE.2016.2591536 . ISSN 1939-3520 . 
  13. ^ Ньютон, Кейси (2016-02-10). «Я пил пиво и писал примечания к выпуску вместе с командой разработчиков Medium» . Грань . Проверено 5 апреля 2021 .

Внешние ссылки [ править ]

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