SysML v2
Требования и верификация в проектах SysML v2
Написание, проверка, утверждение и отслеживание требований и случаев верификации модели SysML v2 на страницах «Требования», «Качество», «TBD/TBR», «Ссылки для проверки», «Утверждения», «RVTM», «Случаи верификации» и «Матрица прослеживаемости».
На этой странице
- Обзор
- Понятия
- Как использовать
- Когда и зачем
- Написать требование
- Написать требования в документе
- Проверить качество
- Утвердить требования
- Задать порог и цель
- Отметить значение как TBD или TBR
- Закрыть TBD или TBR
- Проверить изменённые связи
- Спланировать и провести верификацию
- Разобранный пример: демо-проект Hybrid Car
- Советы и рекомендации
- Типичные ошибки
- Связь с другими функциями
- Требования и качество
- Управление изменениями
- Страницы верификации
- Сообщения
- Ограничения
- Связанные страницы
Обзор
В проекте 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 by | satisfy carSpec by fleet.sedan; |
| verified by | verify carSpec.sedanMass; в цели варианта верификации |
| performed by | perform или allocate |
| traced to | dependency |
| 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, пока вы планируете и проводите верификацию: удовлетворено и верифицировано ли каждое требование?
Написать требование
- Откройте Потребности и требования → Требования.
- Нажмите + Создать. В пакет Requirements добавится использование требования со следующим номером.
- Введите имя и описание в инспекторе или в таблице. Текст меняется сразу, и каждая правка отменяется одним нажатием “Отменить”.
- Задайте данные Holarch в инспекторе, в тех же разделах, что и для требования LML: Status в полосе рецензирования и Priority, Criticality и Owner в группе Рабочий процесс; Verification Method и Verification Level в группе Верификация; Rationale и Source в группе Requirement. Это данные Holarch; текст не меняется. Каждая правка отменяется одним нажатием «Отменить», а таблица требований, RVTM и VCRM показывают те же значения.
Требования можно также писать в Редакторе. Они появляются на странице «Требования», как только текст успешно разобран.
Написать требования в документе
Документ может содержать использования требований одного пакета.
- В документе выберите Писать ▾ → Пакет требований… и укажите пакет. Новый документ получает пакет с тем же именем и первым требованием.
- Добавляйте, сдвигайте вправо и влево и перемещайте требования так же, как в документах LML.
- Требование в разделе принадлежит пакету.
- Требование под другим требованием вложено в него.
- Номер — это его краткое имя. Добавление, удаление или перемещение других пунктов перенумеровывает только разделы и никогда не меняет краткое имя; новое требование получает свой номер в документе как краткое имя. Переместить вверх и Переместить вниз меняют местами краткие имена двух требований, а Перенумеровать… меняет их после предпросмотра.
- Требования, написанные в Редакторе в этом пакете, появляются в документе.
Убрать после подтверждения удаляет требование пакета. Чтобы вынести требование из документа, не удаляя его, переместите его в другой пакет в Редакторе.
Проверить качество
- Откройте Потребности и требования → Качество.
- Нажмите Проверить качество. Описание каждого требования оценивается по девяти критериям с теми же правилами, что и в проектах LML.
- Сначала исправьте самые низкие оценки.
Оценка с пометкой Устарело относится к более старому тексту. Снова проверьте качество.
Утвердить требования
Статус требования проходит путь Draft → In Review → Approved или Rejected.
- Установите для требования статус In Review. Оно появится в списке Утверждения, а у рецензентов — в разделе «Моя работа» в группе Ожидает рецензирования. Рецензенты получат уведомление.
- Как рецензент, выделите требование. Инспектор покажет его статус с кнопками Утвердить, Отклонить… и Открыть снова.
- Нажмите Утвердить или Отклонить… с необязательной причиной. Инспектор фиксирует, кто и когда установил статус.
Утверждать и отклонять могут пользователи с ролью рецензента. Редактирование текста утверждённого требования возвращает его в In Review.
Задать порог и цель
- Запишите порог как ограничение
require, сравнивающее одну величину со значением, напримерrequire constraint { battery.mass <= 50 [kg] }. - Выделите требование. Инспектор покажет Порог и цель с полями Величина и Порог (Не более или Не менее).
- Введите желаемое значение в поле Цель, например
45 kg, и нажмите Enter.Holarch записывает
@HolarchRequirements::Objective { value = 45 [kg]; }в требование. Очистите поле, чтобы удалить его. - Свяжите требование с частью, которая ему удовлетворяет, через
satisfy. Редактор отмечает, когда часть достигает порога, но не цели.
Отметить значение как TBD или TBR
- Импортируйте пакет метаданных в пакет требования:
private import HolarchMetadata::*;. - Напишите
#TBDперед атрибутом, значение которого ещё предстоит определить. Опустите значение или укажите оценку. - Напишите
#TBRперед атрибутом, значение которого нужно пересмотреть. - Чтобы указать ответственного и причину, используйте полную форму в теле атрибута.
#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
- Откройте Потребности и требования → TBD/TBR. Каждый открытый пункт показывает ответственного, срок и возраст, а также диаграмму сгорания открытых пунктов.
- Введите окончательное значение в тексте или инспекторе, затем нажмите Закрыть в строке. Атрибут TBD/TBR возвращается к None, а метаданные TBD/TBR удаляются из значений.
Пометки в doc закрываются, когда вы редактируете doc. Экспортировать XLSX экспортирует реестр.
Проверить изменённые связи
Когда требование меняется, зависящие от него связи помечаются для проверки в рамках того же изменения, и одно нажатие “Отменить” отменяет и то и другое.
- Откройте Потребности и требования → Ссылки для проверки. Для каждой связи показано, что изменилось, когда и кем.
- Нажмите Сравнение, чтобы увидеть старое и новое имя и doc, или Показать в тексте, чтобы открыть требование в Редакторе.
- Проверьте связанный элемент. Обновите его, если он больше не подходит.
- Нажмите Отметить как проверенное…, добавьте при желании комментарий и подтвердите.
Элемент со связью для проверки также показывает в инспекторе баннер с кнопкой Рецензировать…, а в таблицах — значок Review. Представление базы данных Ссылки для проверки перечисляет их.
Спланировать и провести верификацию
- Откройте Верификация → Варианты верификации.
- Нажмите + Создать ▾ → Набор тестов…, чтобы добавить пакет, затем + Создать ▾ → Тестовый случай…, чтобы добавить использование верификации.
- Свяжите требование с тестовым случаем. В цель тестового случая добавится
verify. - Добавьте шаги, выполните набор кнопкой Выполнить набор и установите статус каждого тестового случая. Статус, ожидаемые и фактические результаты, шаги и циклы — данные Holarch.
- Откройте Верификация → RVTM, чтобы увидеть каждое требование с его методом верификации, верифицирующими тестовыми случаями и статусом, сведённым из подтребований.
Разобранный пример: демо-проект Hybrid Car
Сначала создайте демо-проект: Управление проектами → Файлы проектов ▾ → Новый демо-проект → Hybrid Car (SysML v2). Его требования находятся в пакете VehicleRequirements.
- Откройте Потребности и требования → Требования. Среди них есть требования от 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. - Выделите VR-1.1 Sedan Mass. Оно верифицируется вариантом верификации
CurbMassTestчерезverify carSpec.sedanMass;в его цели. - Откройте TBD/TBR. VR-5 Charge Time открыто: его
limitнесёт#TBR, а егоchargerPowerнесёт@TBDс ответственным Powertrain lead. - В Редакторе измените
maxCurbMassс1650 [kg]на1600 [kg]. VR-1.1 Sedan Mass используетmaxCurbMassкак предел, поэтому его связи помечаются для проверки. - Откройте Ссылки для проверки. Связь verified by требования VR-1.1 Sedan Mass есть в списке. Нажмите Сравнение, проверьте тест, затем нажмите Отметить как проверенное….
- Откройте Верификация → Матрица прослеживаемости с требованиями в строках и 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 из значений.
Срок — это единственный срок требования, та же дата, что и Срок в группе Рабочий процесс инспектора и в представлении элемента:
- Самый ранний
dueиз метаданных@TBD/@TBRна значениях требования, например@TBD { owner = "Powertrain lead"; due = "2027-06-30"; }. - Иначе — атрибут TBD Due Date.
- Иначе — собственный срок требования.
Реестр доступен только для чтения. Измените дату в тексте или задайте Срок в инспекторе. Срок записывает 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 v2
- Представления SysML v2
- Текстовый редактор и браузер модели
- Вычисление, единицы измерения и анализ в проектах SysML v2
- Требования
- Верификация
- Прослеживаемость
SysML® и OMG® — зарегистрированные товарные знаки Object Management Group, Inc. в США и других странах.