Holarch

SysML v2

Требования и верификация в проектах SysML v2

Написание, проверка, утверждение и отслеживание требований и случаев верификации модели SysML v2 на страницах «Требования», «Качество», «TBD/TBR», «Ссылки для проверки», «Утверждения», «RVTM», «Случаи верификации» и «Матрица прослеживаемости».

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
    1. Требования в модели
    2. Порог и цель
    3. Связи
    4. Тестовые случаи и наборы тестов
    5. TBD и TBR
  3. Как использовать
    1. Когда и зачем
    2. Написать требование
    3. Написать требования в документе
    4. Проверить качество
    5. Утвердить требования
    6. Задать порог и цель
    7. Отметить значение как TBD или TBR
    8. Закрыть TBD или TBR
    9. Проверить изменённые связи
    10. Спланировать и провести верификацию
    11. Разобранный пример: демо-проект Hybrid Car
    12. Советы и рекомендации
    13. Типичные ошибки
    14. Связь с другими функциями
  4. Требования и качество
    1. Страница «Требования»
    2. Страница «Качество»
  5. Управление изменениями
    1. Связи для проверки
    2. Утверждения
    3. Реестр TBD/TBR
  6. Страницы верификации
    1. Варианты верификации
    2. RVTM
    3. Матрица прослеживаемости
    4. Проверки модели
  7. Сообщения
  8. Ограничения
  9. Связанные страницы

Обзор

В проекте SysML v2 те же страницы требований и верификации, что и в проекте LML. Они работают с моделью: требования — это элементы requirement модели, а тестовые случаи — её варианты verification.

Группа панели навигацииСтраницы
Потребности и требованияТребования, Качество, TBD/TBR, Ссылки для проверки, Утверждения
ВерификацияRVTM, Варианты верификации, Матрица прослеживаемости, Проверки модели

Варианты верификации — это страница, которая в проектах LML называется Центр тестирования.

Часть данных — это текст SysML, а часть — данные Holarch, хранящиеся рядом с моделью:

  • В тексте: номер (краткое имя), имя, описание (doc), вложенность, связи satisfy, verify, dependency и выведения, а также значения атрибутов с единицами.
  • Данные Holarch: статус, приоритет, метод верификации и другие атрибуты требований, метки, статус тестов, результаты, шаги и циклы тестирования. Другие инструменты SysML v2 их не читают.

Понятия

Требования в модели

Требование — это использование requirement или requirement def. Holarch читает его поля из текста:

Поле HolarchТекст SysML v2
НомерКраткое имя: <'VR-1'>
ИмяИмя: CurbMass
ОписаниеКомментарий doc: doc /* … */
Дочерние требования (decomposed by)Требования, которыми владеет требование
requirement def <'VR-1'> CurbMass {
  doc /* The car's curb mass shall not exceed the mass limit. */
  subject car : Car;
  attribute limit : MassValue;
  require constraint { car.curbMass <= limit }
}

Страницы показывают имена с заглавной буквы в каждом слове, поэтому sedanMass читается как Sedan Mass.

Порог и цель

Требование является количественным, если одно из его ограничений require сравнивает величину со значением: car.curbMass <= limit или range >= 800 [km]. Значение — это порог, минимально приемлемое значение. <= делает его верхним пределом (меньше — лучше), >= — минимумом (больше — лучше).

В SysML v2 нет ключевого слова для цели — значения, к которому стремятся сверх порога. Holarch записывает её как метаданные @Objective из библиотечного пакета HolarchRequirements (Стандартная библиотека, папка Holarch):

requirement def <'VR-1'> CurbMass {
  subject car : Car;
  attribute limit : MassValue;
  require constraint { car.curbMass <= limit }
  @Objective { value = 1600 [kg]; }
}
  • Цель в определении требования относится к каждому его использованию. Использование может задать собственную.
  • Порогом может быть значение, записанное в ограничении (12 [kg]), или атрибут, который задаёт требование или переопределение (attribute :>> limit = maxCurbMass;).
  • Другие инструменты SysML v2 читают @Objective как обычные метаданные.
  • Бюджеты и TPM использует порог как распределение для каждой части, которая удовлетворяет требованию, и перечисляет требование на вкладке TPM с его порогом и целью (Бюджеты и TPM).

Связи

Связь HolarchТекст SysML v2
satisfied bysatisfy carSpec by fleet.sedan;
verified byverify carSpec.sedanMass; в цели варианта верификации
performed byperform или allocate
traced todependency
decomposed byВладение: требование, которым владеет другое требование

Добавление или удаление любой из этих связей на любой странице меняет текст, и одно нажатие “Отменить” возвращает всё назад.

Тестовые случаи и наборы тестов

  • Тестовый случай — это использование verification или verification def.
  • Требования, которые он верифицирует, — это члены verify его цели.
  • Пакет, владеющий вариантами верификации, — это набор тестов.
verification def CurbMassTest {
  doc /* Weigh the car on a scale with full fluids and no driver. */
  subject car : Car;
  objective massObjective {
    verify carSpec.sedanMass;
  }
}

TBD и TBR

Требование открыто (TBD или TBR), если выполняется любое из условий:

  • Его атрибут TBD/TBR равен TBD или TBR.
  • TBD, TBR или TBS встречается в его имени или doc.
  • Одно из значений его атрибутов несёт метаданные TBD или TBR.

Писать TBD вместо значения в SysML недопустимо. Вместо этого пометьте атрибут метаданными из библиотечного пакета Holarch HolarchMetadata (см. Отметить значение как TBD или TBR).

Как использовать

Когда и зачем

Используйте эти страницы после того, как написали в модели первые требования, и продолжайте использовать их во время верификации:

  • Требования и Качество во время написания: правильно ли сформулировано каждое требование?
  • Утверждения на рецензированиях: кто подписал?
  • TBD/TBR и Ссылки для проверки, пока проект меняется: что ещё открыто и что нужно посмотреть повторно?
  • Матрица прослеживаемости, Варианты верификации и RVTM, пока вы планируете и проводите верификацию: удовлетворено и верифицировано ли каждое требование?

Написать требование

  1. Откройте Потребности и требования → Требования.
  2. Нажмите + Создать. В пакет Requirements добавится использование требования со следующим номером.
  3. Введите имя и описание в инспекторе или в таблице. Текст меняется сразу, и каждая правка отменяется одним нажатием “Отменить”.
  4. Задайте данные Holarch в инспекторе, в тех же разделах, что и для требования LML: Status в полосе рецензирования и Priority, Criticality и Owner в группе Рабочий процесс; Verification Method и Verification Level в группе Верификация; Rationale и Source в группе Requirement. Это данные Holarch; текст не меняется. Каждая правка отменяется одним нажатием «Отменить», а таблица требований, RVTM и VCRM показывают те же значения.

Требования можно также писать в Редакторе. Они появляются на странице «Требования», как только текст успешно разобран.

Написать требования в документе

Документ может содержать использования требований одного пакета.

  1. В документе выберите Писать ▾ → Пакет требований… и укажите пакет. Новый документ получает пакет с тем же именем и первым требованием.
  2. Добавляйте, сдвигайте вправо и влево и перемещайте требования так же, как в документах LML.
    • Требование в разделе принадлежит пакету.
    • Требование под другим требованием вложено в него.
    • Номер — это его краткое имя. Добавление, удаление или перемещение других пунктов перенумеровывает только разделы и никогда не меняет краткое имя; новое требование получает свой номер в документе как краткое имя. Переместить вверх и Переместить вниз меняют местами краткие имена двух требований, а Перенумеровать… меняет их после предпросмотра.
  3. Требования, написанные в Редакторе в этом пакете, появляются в документе.

Убрать после подтверждения удаляет требование пакета. Чтобы вынести требование из документа, не удаляя его, переместите его в другой пакет в Редакторе.

Проверить качество

  1. Откройте Потребности и требования → Качество.
  2. Нажмите Проверить качество. Описание каждого требования оценивается по девяти критериям с теми же правилами, что и в проектах LML.
  3. Сначала исправьте самые низкие оценки.

Оценка с пометкой Устарело относится к более старому тексту. Снова проверьте качество.

Утвердить требования

Статус требования проходит путь Draft → In Review → Approved или Rejected.

  1. Установите для требования статус In Review. Оно появится в списке Утверждения, а у рецензентов — в разделе «Моя работа» в группе Ожидает рецензирования. Рецензенты получат уведомление.
  2. Как рецензент, выделите требование. Инспектор покажет его статус с кнопками Утвердить, Отклонить… и Открыть снова.
  3. Нажмите Утвердить или Отклонить… с необязательной причиной. Инспектор фиксирует, кто и когда установил статус.

Утверждать и отклонять могут пользователи с ролью рецензента. Редактирование текста утверждённого требования возвращает его в In Review.

Задать порог и цель

  1. Запишите порог как ограничение require, сравнивающее одну величину со значением, например require constraint { battery.mass <= 50 [kg] }.
  2. Выделите требование. Инспектор покажет Порог и цель с полями Величина и Порог (Не более или Не менее).
  3. Введите желаемое значение в поле Цель, например 45 kg, и нажмите Enter.

    Holarch записывает @HolarchRequirements::Objective { value = 45 [kg]; } в требование. Очистите поле, чтобы удалить его.

  4. Свяжите требование с частью, которая ему удовлетворяет, через satisfy. Редактор отмечает, когда часть достигает порога, но не цели.

Отметить значение как TBD или TBR

  1. Импортируйте пакет метаданных в пакет требования: private import HolarchMetadata::*;.
  2. Напишите #TBD перед атрибутом, значение которого ещё предстоит определить. Опустите значение или укажите оценку.
  3. Напишите #TBR перед атрибутом, значение которого нужно пересмотреть.
  4. Чтобы указать ответственного и причину, используйте полную форму в теле атрибута.
#TBR attribute limit : TimeValue = 0.5 [h];
attribute chargerPower : PowerValue {
  @TBD { owner = "Powertrain lead"; rationale = "The fast-charging standard is not chosen yet."; due = "2026-12-01"; }
}

Вставить ▾ → Значение TBD и Значение TBR в Редакторе записывают их за вас. TBD и TBR специализируют ModelingMetadata::StatusInfo, поэтому другие инструменты SysML v2 читают их как аннотации статуса. @StatusInfo { status = StatusKind::tbd; } тоже учитывается. Пакет указан в Стандартной библиотеке в разделе Holarch.

Закрыть TBD или TBR

  1. Откройте Потребности и требования → TBD/TBR. Каждый открытый пункт показывает ответственного, срок и возраст, а также диаграмму сгорания открытых пунктов.
  2. Введите окончательное значение в тексте или инспекторе, затем нажмите Закрыть в строке. Атрибут TBD/TBR возвращается к None, а метаданные TBD/TBR удаляются из значений.

Пометки в doc закрываются, когда вы редактируете doc. Экспортировать XLSX экспортирует реестр.

Когда требование меняется, зависящие от него связи помечаются для проверки в рамках того же изменения, и одно нажатие “Отменить” отменяет и то и другое.

  1. Откройте Потребности и требования → Ссылки для проверки. Для каждой связи показано, что изменилось, когда и кем.
  2. Нажмите Сравнение, чтобы увидеть старое и новое имя и doc, или Показать в тексте, чтобы открыть требование в Редакторе.
  3. Проверьте связанный элемент. Обновите его, если он больше не подходит.
  4. Нажмите Отметить как проверенное…, добавьте при желании комментарий и подтвердите.

Элемент со связью для проверки также показывает в инспекторе баннер с кнопкой Рецензировать…, а в таблицах — значок Review. Представление базы данных Ссылки для проверки перечисляет их.

Спланировать и провести верификацию

  1. Откройте Верификация → Варианты верификации.
  2. Нажмите + Создать ▾ → Набор тестов…, чтобы добавить пакет, затем + Создать ▾ → Тестовый случай…, чтобы добавить использование верификации.
  3. Свяжите требование с тестовым случаем. В цель тестового случая добавится verify.
  4. Добавьте шаги, выполните набор кнопкой Выполнить набор и установите статус каждого тестового случая. Статус, ожидаемые и фактические результаты, шаги и циклы — данные Holarch.
  5. Откройте Верификация → RVTM, чтобы увидеть каждое требование с его методом верификации, верифицирующими тестовыми случаями и статусом, сведённым из подтребований.

Разобранный пример: демо-проект Hybrid Car

Сначала создайте демо-проект: Управление проектами → Файлы проектов ▾ → Новый демо-проект → Hybrid Car (SysML v2). Его требования находятся в пакете VehicleRequirements.

  1. Откройте Потребности и требования → Требования. Среди них есть требования от VR-1 Curb Mass до VR-6 Battery Mass Limit и требование carSpec с вложенными VR-1.1 Sedan Mass, VR-2.1 Sedan Acceleration и VR-4.1 Sedan Range.
  2. Выделите VR-1.1 Sedan Mass. Оно верифицируется вариантом верификации CurbMassTest через verify carSpec.sedanMass; в его цели.
  3. Откройте TBD/TBR. VR-5 Charge Time открыто: его limit несёт #TBR, а его chargerPower несёт @TBD с ответственным Powertrain lead.
  4. В Редакторе измените maxCurbMass с 1650 [kg] на 1600 [kg]. VR-1.1 Sedan Mass использует maxCurbMass как предел, поэтому его связи помечаются для проверки.
  5. Откройте Ссылки для проверки. Связь verified by требования VR-1.1 Sedan Mass есть в списке. Нажмите Сравнение, проверьте тест, затем нажмите Отметить как проверенное….
  6. Откройте Верификация → Матрица прослеживаемости с требованиями в строках и Asset в столбцах. Ячейка для carSpec и fleet.sedan показывает satisfied by из satisfy carSpec by fleet.sedan;.

Советы и рекомендации

  • Давайте каждому требованию краткое имя. Это номер на всех страницах и в документах.
  • Записывайте значения как атрибуты, а не в doc. attribute :>> limit = maxCurbMass; можно вычислить, проверить в параметрическом представлении и отслеживать через ссылки для проверки.
  • Отмечайте открытые значения через #TBD или #TBR, а не словом «TBD» в значении. Текст остаётся корректным, и реестр их находит.
  • Держите тестовые случаи в отдельном пакете. Он становится набором тестов на странице «Варианты верификации».

Типичные ошибки

  • Ожидание статуса в тексте. Статус, приоритет и метод верификации — данные Holarch. Файлы обмена их не переносят.
  • Запись limit = TBD. Это недопустимо в SysML, и текст остаётся черновиком. Используйте #TBD attribute limit : TimeValue;.
  • Удаление требования из документа, чтобы переместить его. Убрать удаляет его из модели. Вместо этого переместите его в другой пакет в Редакторе.

Связь с другими функциями

  • Представления: представление требований рисует те же требования и связи satisfy, verify, derive и refine (Представления SysML v2).
  • Симулятор: Проверить по требованию… берёт критерий из ограничения require требования и записывает результат в вариант верификации (Вычисление, единицы и анализ).
  • Документы: блоки RTM, RVTM, VCRM, нисходящего распределения и матрицы распределения перечисляют требования модели.
  • Управление изменениями: базовые линии хранят модель; Сравнить перечисляет изменения требований (Функции Holarch в проектах SysML v2).

Требования и качество

Страница «Требования»

Требования — это база данных, отфильтрованная по классу Requirement. В ней есть фильтры, представления, столбцы, режим дерева, правка в ячейках, массовые инструменты и экспорт базы данных (Требования).

  • + Создать добавляет использование требования со следующим номером в пакет Requirements.
  • Изменение номера, имени или описания меняет текст модели, и каждое изменение отменяется одним нажатием “Отменить”.
  • Экспорт таблицы и определений включает Вид, Тип, Кратность и Значение, а в модели с индивидами — Individual, Доля (portion) и Экземпляры.
  • При выделении требования оно показывается в инспекторе SysML v2. Его ссылка открывает его в Браузере.

Недоступно для элементов модели: смена класса, дублирование, блокировка и копирование с дочерними элементами, а также экспорт данных проекта (JSON) и пакета проекта (.holarch). Экспортировать проект… создаёт резервную копию всего проекта в формате .holarch.

Страница «Качество»

Качество оценивает описание каждого требования по девяти критериям проектов LML: Appropriate, Complete, Conforming, Correct, Feasible, Necessary, Singular, Unambiguous и Verifiable (Качество требований). Оценка — данные Holarch. Оценка с пометкой Устарело относится к более старому тексту.

Фильтруйте её так же, как в проектах LML (Фильтрация страницы «Качество»): + Фильтр с группами «Качество», «Не проходит критерий» и «Замечание правила», атрибуты и метки требований, вводимые условия quality:, текст поиска и Представления ▾.

Управление изменениями

Связь требует проверки, если элемент на другом её конце изменился после последней проверки связи (в других инструментах это называют подозрительными связями): убедитесь, что связь по-прежнему верна, затем отметьте её как проверенную. Изменение требования помечает для проверки такие связи: satisfied by (satisfy), verified by (verify), decomposed by (собственные требования) и traced to (dependency).

Изменение — это правка любого из следующего:

  • Имя или doc требования.
  • Ключевой атрибут: приоритет, критичность, метод верификации или уровень верификации.
  • Значение собственного атрибута, например attribute :>> limit = maxCurbMass;, или одно из его ограничений.
  • Целевой атрибут, на который ссылаются эти значения или ограничения, например attribute maxCurbMass : MassValue = 1650 [kg];.

Учитывается, где бы вы её ни сделали: в Редакторе, представлении, инспекторе или таблице. Изменение метода верификации или уровня верификации помечает для проверки только связи verified by, а задание первого значения не помечает ничего.

На странице Ссылки для проверки для каждой связи есть Сравнение, Показать в тексте и Отметить как проверенное….

Утверждения

Утверждения перечисляет требования в статусе In Review. Инспектор показывает статус с кнопками Утвердить, Отклонить… и Открыть снова, а также кто и когда его установил. Статус — данные Holarch рядом с моделью; он не входит в текст SysML.

Реестр TBD/TBR

Реестр перечисляет каждое открытое требование с ответственным, сроком и возрастом, диаграмму сгорания открытых пунктов и Экспортировать XLSX. Закрыть возвращает атрибут TBD/TBR к None и удаляет метаданные TBD/TBR из значений.

Срок — это единственный срок требования, та же дата, что и Срок в группе Рабочий процесс инспектора и в представлении элемента:

  1. Самый ранний due из метаданных @TBD/@TBR на значениях требования, например @TBD { owner = "Powertrain lead"; due = "2027-06-30"; }.
  2. Иначе — атрибут TBD Due Date.
  3. Иначе — собственный срок требования.

Реестр доступен только для чтения. Измените дату в тексте или задайте Срок в инспекторе. Срок записывает due = "<date>"; в каждое тело метаданных @TBD/@TBR требования (добавляя его, если в теле его нет) и задаёт срок требования; одно нажатие “Отменить” возвращает всё назад. У префиксной формы #TBD/#TBR нет тела, поэтому значение, отмеченное только так, использует срок требования.

Страницы верификации

Варианты верификации

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

  • + Создать ▾ → Тестовый случай… добавляет использование верификации; Набор тестов… добавляет пакет.
  • Связывание требования добавляет verify в цель тестового случая.
  • Статус, ожидаемые и фактические результаты, шаги и циклы — данные Holarch, хранящиеся рядом с моделью.

RVTM

Каждое требование с его методом верификации, верифицирующими тестовыми случаями и статусом, сведённым из подтребований (RVTM). ⚠ отмечает требование, связи satisfy, verify или декомпозиции которого требуют проверки, и вариант верификации, связь verify которого требует проверки.

Матрица прослеживаемости

Строки, столбцы и связь работают так же, как в проектах LML (Матрица прослеживаемости).

  • Активы — это использования частей (части системы), а Действия — использования действий.
  • Для оси класса Элементы → Определения перечисляет вместо этого определения.
  • Между элементами модели ячейка может содержать satisfied by (satisfy), verified by (verify), performed by (allocate или perform), traced to (dependency) и decomposed by (владение). Другие связи показываются как недопустимые.
  • Каждый щелчок отменяется одним нажатием “Отменить” и меняет текст модели.

Проверки модели

Правила, применимые к модели, выполняются (Проверки модели), в терминах SysML v2:

  • использования требований без имени, краткого имени (листовые требования), описания (собственного или своего определения), satisfy или verify, а также листовые требования без «shall»;
  • повторяющиеся краткие имена, расплывчатые слова, живые значения, указывающие на отсутствующие цели, представления UAF, которые нельзя показать;
  • открытые риски верхнего уровня без мер снижения, неуспешные варианты верификации без Issue, TPM, нарушающие свой порог;
  • элементы рядом с моделью (риски, задачи, решения, документы) с одинаковым именем или без связей.

Средство проверки в Редакторе охватывает имена, типы и структуру, поэтому правила функционального анализа LML (Action, Asset, Conduit и Input/Output) не выполняются, и в настройках перечислены только эти правила. Исправления слиянием для элементов модели не предлагаются.

Сообщения

СообщениеЗначение и исправление
Недоступно в проектах SysML v2: измените модель в Редакторе.Действие работает только с сущностями LML. Внесите изменение в Редакторе.
Изменение не применено.Правка сделала бы текст недопустимым. Сообщение рядом называет проблему.
Устарело — перезапуститеТекст требования изменился после последней проверки качества. Снова проверьте качество.
“…” meets “…”, but … does not reach the objective ….Информация: часть достигает порога, но не цели. Улучшите проект или измените цель.
“…” has an objective but no threshold to compare it with. …У требования есть @Objective, но нет ограничения require, сравнивающего величину со значением. Добавьте его.
“…” has more than one threshold (…), so its objective is ambiguous. …Требование сравнивает больше одной величины. Разделите его на отдельные требования для каждой величины.
The objective … of “…” is not below (above) its threshold ….Цель должна выходить за порог: быть ниже верхнего предела или выше минимума.
The objective … of “…” is in …, but its threshold … is in ….Единица цели относится к другой величине, чем единица порога. Используйте единицу величины порога.
@Objective applies to requirements, but “…” is ….Аннотация находится вне требования. Переместите её в требование.

Ограничения

  • Статус, метод верификации, другие атрибуты требований, метки и результаты тестов — данные Holarch. Файлы обмена SysML v2 их не переносят.
  • Смена класса, дублирование, блокировка и копирование с дочерними элементами недоступны для элементов модели.
  • Исправления слиянием в проверках модели для элементов модели не предлагаются.

SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.