Разделы документации

Статусы и редакции спецификаций

Как зафиксировать согласованную редакцию, начать новую и сравнить изменения.

Статус спецификации

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

СтатусКогда использовать
DraftСпецификация редактируется. Изменения версионируемого содержания сохраняются в текущем черновике.
LockedКоманда согласовала редакцию и фиксирует её для чтения.
DeprecatedСпецификация устарела. Её ключ и история остаются доступны для справки.

Новая редакция после согласования

  1. Проверьте содержание и связи в нужной ветке. Когда команда согласует редакцию, выберите Locked в меню статуса.
  2. Если поведение изменится, откройте ту же запись и выберите New Revision. Проверьте, что новый черновик имеет статус Draft и прежний ключ.
  3. Обновите описание и связанные спецификации. После проверки зафиксируйте новую редакцию через Locked.

Если действие недоступно, проверьте права, выбранную ветку и номер открытой редакции.

Сравнение редакций

  1. Откройте Select revision в шапке спецификации. Для полного списка выберите Show All.
  2. В меню Diff Mode выберите Previous для сравнения с предыдущей редакцией или Actual для сравнения с текущей. Режим Off открывает историческую редакцию без подсветки.
  3. Просмотрите изменения текста и связей. Когда передаёте результат коллегам, укажите ключ, ветку и номер редакции.

Связаться с нами

Поля, отмеченные *, обязательны для заполнения.

0 / 5 000

Можно также написать на info@reqode.com