Release notes: различия между версиями

Содержимое удалено Содержимое добавлено

Линейный

Версия от 15:55, 15 января 2014

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

Цель

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

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

Содержание и формат

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

Разделы замечания

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

Формат

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

Пример

Версия 1.X.X

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

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

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

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

См. также

Ссылки