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

Требование к ПО – это основной артефакт используемый для описания низкоуровневых требований в Almware. Под “низкоуровневыми требованиями” мы имеем ввиду требования, описывающие поведение системы в рамках отдельных функций (в отличии от бизнес-требований, таких как варианты использования, которые описывают работу с системой со стороны пользователя и относятся скорее к верхнеуровневым требованиям). 

В англоязычной версии для этого артефакта мы используем название “Feature”,  которое корректно отражает суть. В русском язык, мы, к сожалению, не нашли краткой формулировки. 

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

Назначение

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

Мы рекомендуем декомпозировать требования до уровня CRUD функций. 

Например, в системе может быть модуль “Управление пользователями”, в котором заданы отдельные артефакты требований к ПО: 

• Отображение каталога пользователей
• Просмотр информации о пользователе
• Добавление пользователя
• Изменение пользователя
• Удаление пользователя

Описание внутри артефакта может включать как функциональные требования (которых обычно больше), так и нефункциональные. 

Например, у нас может быть артефакт “Отображение каталога пользователей”, в описании которого будут формулировки требований к списку, поиску, сортировке (функциональные), а также формулировки требования по максимальной задержке отображения списка пользователей (нефункциональные требования к производительности). 

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

• База знаний и онбординг. Требования должны быть равномерно декомпозированы и логично организованы.
• Трекинг. Отслеживание прогресса и актуальных задач в разрезе отдельных артефактов требований и модулей. Артефакты требований должны иметь четкие границы и критерии готовности. 
• Тестирование. Отслеживание полноты тестового покрытия и актуальных результатов тестирования в разрезе отдельных артефактов требований и модулей. 
• Работа с изменениями и анализ. Требования должны быть декомпозированы таким образом, чтобы при внесении изменений можно было легко найти изменяемые требования без необходимости погружения в большой объем документации.

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

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

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

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

Структура каталога

В Almware артефакт требований обязательно должен быть частью модуля. Один артефакт требований может быть частью только одного модуля (а модуль может иметь несколько артефактов). 

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

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

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

Атрибуты требований к ПО 

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

Текстовое описание

Основной инструмент описания требований  – это редактор текстового описания, позволяющий добавлять таблицы, изображения и другие элементы в описание. Описание может сопровождаться диаграммами или приложенными файлами. Внутри текста можно делать интерактивные ссылки на другие артефакты системы (с помощью комбинации ctrl+k или соответствующей кнопки). 

Текст автоматически сохраняется в черновик, а замена старого описания новым происходит только при нажатии кнопки “Сохранить”. 

Параметры

Для требований к ПО можно задать следующие параметры:

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

Лейблы

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

Связи и трассировка

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

Связи с артефактами требований

Связи с артефактами требований можно разделить на 3 группы: 

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

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

• Спецификации. Наличие связи зависит от статуса артефакта в проекте. Если артефакт не используется – связь не будет отображаться.

Связи со спецификациями могут быть 4-х типов (в зависимости от использования в проекте того или иного типа спецификации):

• Модель данных. Артефакты модели данных, которые используются в рамках данной функциональности. Для артефактов можно указать типы операций, который осуществляется в рамках данной функциональности (CRUD). На основе этих атрибутов связи формируется CRUD-матрица для этой сущности.  
• Пользовательские интерфейсы. Артефакты описывающие экраны/формы и другие типы UI, которые задействованы в данной фичи. 
• Программные интерфейсы. Артефакты описывающие API-методы для внутреннего и внешнего взаимодействия и другие типы программных интерфейсов, которые задействованы в данной фичи. 
• Настраиваемые артефакты. Артефакты, которые можно настроить для описания различных элементов, в зависимости от специфики проекта. Например этот каталог можно использовать для хранения и отслеживания уведомлений, событий внутри системы, конфигурационных переменных и других элементов, которые необходимо трассировать на фичи. 

Связи с задачами

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

Вручную создать или удалить связь с задачей можно как со стороны артефакта требований (во вкладке “Задачи”), так и со стороны задачи (во вкладке "Требования к ПО"). 

При интеграции внешнего трекера, задачи автоматически связываются, если в задаче упоминается ссылка на артефакт или идентификатор артефакта требования (например, FR-123). 

Связи с тест-кейсами

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

Управление тест-кейсами доступно во вкладке QA / Тест-кейсы. 

Фазы

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

Вы можете создать произвольные фазы, например “Согласование”, “Backend”, “Frontend”, “QA”, для каждой указать свой перечень возможных статусов и использовать эти фазы в процессе работы над проектом для трекинга состояния проекта. Фазы удобны тем, что в отличие от трекинга через задачи, Вы можете задать отдельные статусы для различных фаз. Это позволяет гибко настроить фазы с учетом специфики процесса принятого в Вашей команде.

Фазы настраиваются в Настройках проекта в разделе “Требования к ПО”. 

Типы артефактов требований

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

• Классификация. Вы можете указать название типа, краткое описание и иконку. Иконка и названия будут отображаться в каталоге требований к ПО с возможностью фильтрации требований по типу.
• Шаблон. Для типа можно указать исходный шаблон описания. Вы можете один раз задать структуру описания и она будет автоматически загружаться при создании артефакта требования этого типа.
• Инструкции для ИИ ассистентов. Вы можете задать дополнительные инструкции и правила, которые будут использоваться ИИ ассистентом при написании или верификации требований.  

Типы артефактов требований настраиваются в Настройках проекта в разделе “Требования к ПО”.