Architecture Course Home / Архитектура, основанная на требованиях

Сбор требований

После того как мы определили стейкхолдеров настало время сбора с них требований.

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

Требования можно условно разложить на 4 категории:

Разберем каждый тип требования подробнее.

Функциональные требования

Функциональность – это способность системы выполнять работу, для которой она предназначена. Функциональные требования (FR) отвечают на вопрос "что". Что хочет видеть заказчик?

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

Как правило, примерно 10 процентов ваших вариантов использования(use cases) или пользовательских историй(user stories), скорее всего, будут ключевыми.


Есть две важные причины, по которым при проектировании архитектуры необходимо учитывать ключевые функциональные возможности:

  1. Вам необходимо продумать, как функциональность будет распределяться по элементам (обычно модулям), чтобы обеспечить модифицируемость или возможность повторного использования, а также планировать рабочие задания. Неверные решения, принятые относительно распределения функциональности, приводят к накоплению технического долга. (Конечно, только в ретроспективе эти решения могут оказаться плохими.) Этот долг можно погасить с помощью рефакторинга, хотя это влияет на скорость выполнения проекта.
  2. Второй важной причиной фокусироваться на ключевых функциональностях это нефункциональные требования(NFR) системы. Некоторые NFR напрямую связаны с ключевыми функциями системы. О том как из FR получить NFR я расскажу подробнее в секции про NFR. Собранные требования должны быть переформулированы в формат use cases. Такая формулировка поможет нам при формировании NFR из FR.

Источники FR

Документация

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

Пример:

User Story

User Story (пользовательская история) — короткая формулировка намерения пользователя и того, что продукт должен сделать для него.

Пример:

Use case

Use cases или варианты использования позволяют собрать и сформировать функциональные требования от лица участников. Диаграммы вариантов использования определяют границы решения и показывают связи с внешними системами и участниками.

Пример:

Методы сбора FR

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

Мозговой штурм

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

Во время мозгового штурма участники «накидывают» любые идеи, касающиеся решения данной проблемы.
С помощью этой методики можно проработать несколько различных вариантов решения заданной проблемы, а так же разрешить конфликты требований.

Преимущества:

Недостатки:

Event storming

Event storming — это увлекательный способ собрать вместе разработчиков и экспертов в бизнесе для быстрого, совместного исследования сложной предметной области. Часы вместо дней и недель.

Сессии Event storming'a позволяют бизнес и техническим экспертам совместно разобрать проблемную область.

Преимущества:

Недостатки:


Выписки: сбор FR

В личном кабинете пользователя, пользователь должен иметь возможность заказать выписку за указанный промежуток времени. Выписка формируется и отправляется на почту пользователя в формате zip архива, в случае большого файла, или в формате pdf, для небольших файлов. Пользователь может настроить формирование регулярных выписок. Регулярная выписка – это выписка, сформированная автоматически в указанный пользователем день и час с указанием фильтра. Из личного кабинета пользователь должен иметь возможность просмотра списка сформированных выписок и их скачивания.

Глоссарий

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

Use cases

  • Пользователь личного кабинета может:
    • заказать выписку себе на почту
    • заказать регулярную выписку
    • просмотреть список сформированных выписок
    • скачать любую ранее сформированную выписку
  • Система выписок должна:
    • сформировать выписку и отправить ее на почту пользователю в формате zip для больших выписок или в формате pdf для небольших выписок
    • формировать регулярные выписки на дату и время заказа по фильтру

Нефункциональные требования

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

Но достаточно ли этого для успеха?

Давайте попробуем разобраться.

Системы часто перепроектируются не потому, что они функционально несовершенны, а потому, что их трудно поддерживать, переносить, масштабировать, они слишком медленные или они были скомпрометированы. Перечисленное выше это только часть возможных требований. На самом деле их намного больше и обычно их называют нефункциональными требованиями (в противовес функциональным). Нефункциональные требования (NFR) - отвечают на вопрос "как". Как это должно работать? Как правило их принято объединять в кластеры по категориям, называемые атрибутами качества.

Например:

Ниже перечислю наиболее интересные для нас кластеры атрибутов качества:

  • Эволюционность (Maintainability) - представляет собой степень эффективности и результативности, с которой продукт или система могут быть модифицированы для улучшения, исправления или адаптации к изменениям в окружающей среде и требованиях. Эта характеристика состоит из следующих подхарактеристик:
    • Modularity — степень, в которой система или программа состоит из отдельных компонентов, при которой изменение одного компонента оказывает минимальное влияние на другие компоненты.
    • Analysability — степень эффективности и результативности, с которой можно оценить влияние на продукт или систему предполагаемого изменения одной или нескольких его частей, диагностировать продукт на предмет недостатков или причин сбоев или идентифицировать части, которые необходимо модифицированный.
    • Modifiability — степень, до которой продукт или система могут быть эффективно и результативно модифицированы без внесения дефектов или ухудшения качества существующего продукта.
  • Надежность (Reliability) - это степень, в которой система, продукт или компонент выполняет определенные функции в определенных условиях в течение определенного периода времени. Эта характеристика состоит из следующих подхарактеристик:
    • Faultlessness — степень, в которой система, продукт или компонент выполняет указанные функции без сбоев при нормальной работе.
    • Availability — степень, в которой система, продукт или компонент работоспособны и доступны, когда это необходимо для использования.
    • Fault tolerance — степень, в которой система, продукт или компонент работает должным образом, несмотря на наличие ошибок аппаратного или программного обеспечения.
    • Recoverability — степень, до которой в случае сбоя продукт или система могут восстановить непосредственно затронутые данные и восстановить желаемое состояние системы.
  • Масштабируемость (Scalability) - это способность системы справляться с увеличением нагрузки без снижения производительности или возможность быстрого увеличения нагрузки.
  • Производительность (Performance) показывает реакцию системы на выполнение определенных действий в течение определенного периода времени. Есть два способа измерения производительности:
    • Latency. Время, потраченное на реакцию на событие
    • Throughput. Количество событий, происходящих в определенный момент времени
  • Эластичность (Elasticity) — это способность системы автоматически регулировать уровень своих ресурсов в соответствии с рабочими нагрузками, с которыми она сталкивается в любой момент.
  • Возможность развертывания (Deployability) - это cпособность системы к быстрому развертыванию
  • Тестируемость (Testability) - это показатель, обратный трудозатратам на проведение тестирования и других видов проверки того, что внесенные изменения привели к нужным результатам.
  • Защищенность (Security) - это степень, в которой продукт или система защищает от атак со стороны злоумышленника и защищает информацию и данные, чтобы люди или другие продукты или системы имели степень доступа к данным, соответствующую их типам и уровням авторизации. Эта характеристика состоит из следующих подхарактеристик:
    • Confidentiality — степень, в которой продукт или система гарантирует доступность данных только для тех, у кого есть разрешение на доступ.
    • Integrity — степень, в которой система, продукт или компонент гарантирует, что состояние ее системы и данных защищено от несанкционированного изменения или удаления в результате злонамеренного действия или компьютерной ошибки.
    • Non-repudiation — степень, в которой можно доказать, что действия или события имели место, так что от этих событий или действий невозможно отказаться позже.
    • Accountability — степень, в которой действия объекта могут быть однозначно прослежены до объекта.
    • Authenticity — степень, в которой можно доказать, что идентичность объекта или ресурса соответствует заявленному.
    • Resistance — степень, в которой продукт или система выдерживают работу при атаке злоумышленника.
  • Простота разработки (Simplicity) - это то на сколько сложна или проста проектируемая система. Простота разработки это не сама цель а данность.
  • Общая стоимость (Overall cost ) - это стоимость разработки и эксплуатации.

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


NFR должны быть максимально конкретными.

Примеры плохих требований:

Примеры хороших требований:

Отсюда и дальше по тексту, когда речь будет касаться NFR, я буду иметь ввиду сценарии атрибутов качества.

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

Если кратко то:

03fig01.jpeg

Сценарии атрибутов качества состоят из шести честей:

  1. Источник
  2. Стимул

  3. Артефакт
  4. Среда
  5. Ответ
  6. Мера отклика

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


Не нужно переживать если какие-то из частей сценариев атрибутов качества будут пропущены. Главное чтобы всем стейкхолдерам было понятно о чем идет речь.


В архитектуре ПО сценарии атрибутов качества принято разделять на три типа:


Важно при формировании NFR корректировать требования заказчика в сторону реальных/достижимых показателей. Объясните, что время ответа в 20 мс сложно достижимо в вашей системе. Расскажите про стандарты индустрии и о вашем личном опыте. Попробуйте договориться с заказчиком на те значения, которых вы уверены. Сможете сделать лучше - отлично. За это вас точно не отругают 🙂

Некоторые архитектора используют метод MoSCoW для формирования ожиданий заказчика:

  • Must Have
  • Should Have
  • Nice to Have
    • Could Have
    • Won't Have


Но на этапе дизайна вы все равно будете ориентироваться на показатель Must Have.

Источника NFR

Бизнес драйверы/Бизнес цели

Хорошей отправной точкой для поиска NFR могут быть бизнес драйверы и бизнес цели.


Driver: внешнее или внутреннее условие, побуждающее организацию определять свои цели.

Пример:

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

Пример:

Objective: ограниченный по времени этап для организации, используемый для демонстрации прогресса в достижении цели.

Пример:

Цель проектирования

Вам необходимо четко понимать цель проектирования, которую мы хотите достичь. Когда и почему мы занимаетесь этим архитектурным проектом? Какие бизнес-цели в данный момент больше всего беспокоят организацию?

Примеры:

Любая их перечисленных целей будет влиять на процесс принятия архитектурных решений. Архитектуры существуют для того, чтобы помочь в достижении бизнес-целей. Архитектор должен четко представлять себе эти цели, сообщать о них (и обсуждать их!) и устанавливать четкую цель проектирования до начала процесса проектирования.

SLA

Третьим, но не по значимости, хорошим местом для поиска NFR может служить соглашение об уровне обслуживания.

Пример:

Функциональные требования

FR очень хорошо конвертируются в сценарии атрибутов качества.

Пример:

Методы сбора NFR

Как и для FR одних только источников недостаточно и часто архитектору приходится применять различные методы сбора NFR.

Анкетирование

Данный способ подразумевает под собой составление опросника (анкеты, брифа), который может содержать открытые (требуют от опрашиваемого сформулировать его ответ) и закрытые (требуют от опрашиваемого выбрать ответ из предложенных вариантов) вопросы.

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

Преимущества:

  1. Высокая скорость получения результатов.
  2. Сравнительно небольшие материальные затраты.

Недостатки:

  1. Данный метод не подходит для выявления неявных требований.
  2. При составлении опросника физически невозможно учесть все необходимые вопросы.
  3. Не подходит для не технических стейкхолдеров

Интервью

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

Данный способ применяется, в основном, для получения информации по какой-либо конкретной теме и/или для уточнения требований.

Преимущества:

  1. Возможность задавать вопросы в произвольной последовательности.
  2. Возможность использовать вспомогательный материал.
  3. Анализ невербальной реакции опрашиваемого человека, позволит сделать дополнительный вывод о достоверности его ответов.

Недостатки:

  1. Интервью отнимает достаточно много времени и сил.
  2. Дополнительной сложностью является получение одинаковых ответов от интервьюируемых.

Различные воркшопы

Например: ATAM, QAW, mini QAW. Для примера разберем Quality Attribute Workshop.

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

Он позволяет собрать множество идей от различных стейкхолдеров в "кратчайшие сроки" и "практически бесплатно".

QAW состоит из 7 шагов:

Преимущества:

Недостатки:


Справедливости ради есть упрощенный семинар mini-QAW, но даже с ним не так то просто справиться.

Вот ссылка на мой неудачный опыт.

Выписки: сбор NFR

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

Бизнес драйверы/бизнес цели

Общей стратегии банка "лучший пользовательский опыт".


Стратегия после 24 февраля 2022.


Отлично, мы выявили NFR, основываясь на бизнес драйверах и целях.


На практике мне ни разу не удавалось побывать на формировании бизнес целей. В лучшем случае спускается конкретная бизнес цель. В худшем objective. Чаще всего бизнес аналитики по целям формируют objectoves, но в этом есть и минус. Инженеры могут подсказать бизнес аналитикам те решения о которых они, аналитики, даже не думали.

Примеры:

  • сокращение Time to market.
    • Что может предложить бизнес аналитик?
      • Оптимизация рабочих процессов.
    • Что может предложить архитектор?
      • Продуктовая трансформация и командная развязность.
  • Оптимизация Cost and Benefit.
    • Что может предложить бизнес аналитик?
      • Покупка более дешевого вендорского решения.
    • Что может предложить архитектор?
      • Автоматизация рабочего процесса (сокращение рабочих мест).
      • Может предложить компромиссные решение: стоимость – надежность.


Следующим шагом давайте приземлим наши NFR на Utility Tree.


Уже получается не маленькое дерево, а ведь мы только начали!

SLA

Следующем шагом попробуем поискать наши NFR в наших SLA.

Мы видим, что в документе SRE 2.0 наш сервис попадает под критерии Business Critical (BC), а для BC систем выставлены следующие требования:

  • Время простоя меньше 60 мин
  • Uptime (7, 30, 90 дней) — 99.8%
  • Допустимая потеря данных - 4 часа

Добавим их на наше Utility Tree

Функциональные требования

Следующим шагом поищем из каких же FR мы можем получить хорошие NFR.

У нас есть ряд FR которые хорошо ложатся на сценарии атрибутов качества.

  • Пользователь заказывает выписку по компании с указанием дат начала и конца выписки. Выписка формируется и отправляется на почту
  • Пользователь создает регулярную выписку
  • Система формирует регулярные выписки
  • Пользователь просматривает список заказанных выписок
  • Пользователь скачивает выписку с web интерфейса

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

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

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

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


Добавляем новые требования в наше Utility Tree.


Ограничения

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


📌 Важно:


Выписки: сбор ограничений

Изучив наше окружение мы выяснили:

  • ограничения по используемому стеку:
    • Postgresql
    • Redis
    • Kafka
    • Cassandra
    • ElasticSearch
  • ограничения по используемым ресурсам:
    • утилизация сервиса должны быть выше 30%
  • ограничения по развертыванию
    • сервисы должны быть k8s compliance

Записали и пошли дальше. Эта информация, как и вся предыдущая, будет нужна на этапе дизайна.


Кроме того, у нас появился еще ряд вопросов к заказчику. Пока мы собирали требования, наш заказчик изрядно подрос, и мы смело закидываем ему опросник.

  • Какой срок хранения у отчетов?
  • За какую глубину в прошлое можно построить отчет?
  • Устраивает ли вас конечная согласованность данных в выписки?
  • Допустима ли потеря данных в выписке?

Ответы заказчика добавили в список ограничений.

  • Система должна хранить сформированный отчет в течение 3 месяцев.
  • Пользователь может запросить отчет с того момента как он стал клиентом компании.
  • Данные в отчетах должны быть максимально актуальными, но задержку в 1 час можно считать нормой.
  • Система должна гарантировать целостность данных в выписки. Потеря данных не допускается.

Опасения/риски

Чаше всего риски выявляются на этапе дизайна. Риск удовлетворения какого-то требования может быть связан с ограничением стека технологий, уровня зрелости команды, неизвестностью будущего и тд.

Примеры:


Выписки: выявление рисков

На стадии сбора требований мы выяснили объем необходимого хранилища, это порядка 3 тб данных. Пообщавшись с поддержкой postgresql, выяснили, что ребята готовы гарантировать SLA для инстансов размером не больше 1 тб., а это значит, что придётся что-то придумывать и договариваться.

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

Читать дальше Приоритизация требований/выделение архитектурных кандидатов

Оригинал на wiki