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

Работа с требованиями

Как организовать требования по модулям, записать критерии приёмки и задать зависимости.

Создание требования

Откройте нужный модуль в Specifications → Requirements. Назовите требование так, чтобы из названия был понятен результат. Укажите тип, подсистемы реализации и роль участника, если для этого поведения она важна.

ПолеКак выбрать значение
ModuleОбласть продукта, в которой команда будет искать требование.
ActorПользователь, роль или система, которые выполняют действие или получают результат.
TypeТип требования с подходящим шаблоном описания.
SubsystemsЧасти продукта, которые обеспечивают это поведение.

Создать модуль можно в меню добавления раздела Specifications → Requirements. Администратор проекта может настроить роли участников и типы требований в Project Settings → Requirements. Выбранные значения видны на вкладке Params.

Описание поведения и критерии приёмки

В Description начните с цели и используйте разделы, предусмотренные типом требования.

  • Цель. Кто использует это поведение и какую задачу решает.
  • Критерии приёмки. Исходные условия, действие и наблюдаемый результат.
  • Бизнес-правила. Ограничения, исключения и условия, которые меняют поведение.

Детали структуры данных, интерфейса и контракта API можно оформить отдельными артефактами и связать с требованием.

Связи между требованиями

Связи между требованиями добавляются в Requirement Relations. Выберите Depends on, если для выполнения текущего требования сначала должно действовать другое.

  1. Откройте требование в нужной ветке и нажмите + в блоке Requirement Relations.
  2. Выберите тип и направление связи. Найдите второе требование по ключу или названию либо откройте список через Chooser.
  3. Проверьте запись в списке и откройте второе требование, чтобы проверить обратное направление связи.

Статус и редакции

Новое требование создаётся в статусе Draft. В этом статусе можно менять описание и связи со спецификациями. Переведите согласованную редакцию в Locked, чтобы зафиксировать её для чтения. Для дальнейших изменений начните новую редакцию через меню статуса.

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

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

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

0 / 5 000

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