Release notes

Материал из Википедии — свободной энциклопедии
Перейти к: навигация, поиск

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

Цель[править | править вики-текст]

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

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

Содержание и формат[править | править вики-текст]

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

Разделы замечания[править | править вики-текст]

  • Заголовок — "Замечания к релизу", название продукта, название версии, дата выпуска и т.д.
  • Обзорная часть — Резюме изменений в версии
  • Цель — Краткое описание цели выпуска версии со списком изменений, исправлений ошибок, добавленной функциональности
  • Описание ошибок — список ошибок (для каждой ошибки: в чем ошибка, где и как воспроизводится), описание исправлений этих ошибок
  • Перечень требуемых обновлений — для обновления аппаратной и программной части, документации
  • Юридическая информация — лицензии, гарантии, отказ от ответственности и т.д.
  • Контактная информация

Формат[править | править вики-текст]

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

  • «+» добавленная функциональность;
  • «*» изменения, не влияющие на конечного пользователя;
  • «-» исправления ошибок.
Пример[править | править вики-текст]

Версия 1.X.X

- Отключена возможность полета без явной установки pref.godmode в true (ошибка была только в многопользовательском режиме)

+ Улучшен движок

* Изменена работа поршней

- Удален Хиробрин

См. также[править | править вики-текст]

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