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

Покажем и расскажем про систему, дадим аккаунт. Заполните форму или отправьте нам письмо.
Поддержка Документация Работа с требованиями Управление требованиями в Almware

Артефакты требований в Almware

Артефакты требований и взаимосвязь между ними

Описание требований в Almware осуществляется с использованием нескольких типов связанных между собой артефактов, описывающих отдельные компоненты требования. Это способствует консистентности требований и переиспользованию отдельных артефактов (например, сущности модели данных или экрана UI) в различных требованиях, связанных с этим артефактом.

Данный подход позволяет работать с требованиями "с разных сторон". Например, Вы можете отследить функциональные требования, которые используют определенную сущность данных, экран интерфейса, API метод и т.д.
Таким образом, если Вам необходимо сделать правку к модели данных или UI, Вы можете быстро определить какие требования это может затронуть, какие API методы для этого используются и как это все тестируется.
Структура артефактов требований в Almware

В Almware предусмотрено 2 уровня требований:

  • Верхнеуровневые требования;
  • Требования к программному обеспечению;
  • Дополнительные артефакты требований.

Верхнеуровневые требования

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

  • Бизнес-требования (бизнес-цели, ограничения, правила);
  • Пользовательские требования (варианты использования системы, пользовательские истории);
  • Другие верхнеуровневые артефакты, которые влияют на требования к ПО.

Подробнее о верхнеуровневых требованиях.

Требования к ПО

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

Низкоуровневые требования к ПО разделены на два уровня:

  • Фичи,
  • Требования к ПО.

Подробнее о требованиях к ПО.

Наборы требований

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

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

В отличие от верхнеуровневых требований, набор группирует требования к системе исходя из структуры разрабатываемого ПО, а не пользовательских или бизнес требований.
Например, набор может объединять набор требования описывающих CRUD-функции для сущности, дополняя их информацией общей для всех этих требований. Тогда, как варианта использования (как вариант верхнеуровневого требования) может включать только отдельные требования CRUD-функциональности  или разные требования из разных наборов, необходимых для реализации этого варианта использования.
В некоторых случаях перечень требований к ПО у набора и верхнеуровневого требования могут совпадать, но так происходит далеко не всегда.

Подробнее о наборах требований.

Требования к ПО

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

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

Например, предположим у нас есть набор требований "Администрирование пользователей". 
В этот набор будут входить следующие требования к ПО (отдельный артефакт для каждого требования):
- "Каталог пользователей",
- "Поиск пользователей",
- "Просмотр информации о пользователе",
- "Добавление пользователя",
- "Изменение пользователя",
- "Разблокировка пользователя",
- "Блокировка пользователя",
- "Удаление пользователя".

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

Подробнее о требованиях к ПО

Дополнительные артефакты требований

Almware позволяет настроить для проекта набор артефактов требований, которые будут использоваться в дополнение к требованиям. В минимальном варианте можно использовать только наборы требований и требования к ПО.

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

Сущность модели данных

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

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

Пользовательский интерфейс

Артефакт пользовательского интерфейса (UI) описывает отдельный экран или значимое состояние экрана пользовательского интерфейса или его части.

Этот артефакт может содержать визуальную информацию (скриншот, привязку фрейма из Figma, прототип экрана в Draw.io), ссылки на внешние системы (прототип или макет экрана в других системах) и текстовое описание (спецификацию UI) с возможностью приложить дополнительные файлы или диаграммы/макеты.

Программный интерфейс (API-методы)

Артефакты программных интерфейсов определяют способы взаимодействия между под-системами ПО и/или между ПО и внешними системами.

С помощью этих артефактов Вы можете определить API-методы, связывая их с функциональными требованиями, для реализации которых они используются.

В ближайших релизах будет добавлена интеграция с Postman для синхронизации в реальном времени и импорт OpenAPI для ручной загрузки API-методов.

Настраиваемые артефакты

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

Настраиваемые артефакты могут использоваться для формирования перечня событий, уведомлений или других элементов проекта которые могут быть привязаны к требованиям.

Также настраиваемые артефакты могут использоваться для описания деталей реализации.

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