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: Стан у смузі рецензування, а також Пріоритет, Критичність і Власник у розділі Робочий процес; Метод верифікації і Рівень верифікації у розділі Верифікація; Обґрунтування і Джерело у розділі Вимога. Це дані Holarch; текст не змінюється. Кожна зміна відміняється одним натисканням “Відмінити”, а таблиця “Вимоги”, RVTM і VCRM показують ті самі значення.
Вимоги можна також писати в Редакторі. Вони з’являються на сторінці “Вимоги”, щойно текст розібрано.
Писати вимоги в документі
Документ може містити використання вимог одного пакета.
- У документі виберіть Написати ▾ → Пакет вимог… і виберіть пакет. Новий документ отримує пакет, названий за ним, з першою вимогою.
- Додавайте, збільшуйте й зменшуйте відступ і переміщуйте вимоги, як у документах LML.
- Вимога в розділі належить пакету.
- Вимога під іншою вимогою вкладена в неї.
- Номер — це її коротка назва. Додавання, вилучення або переміщення інших пунктів перенумеровує лише розділи й ніколи не змінює коротку назву; нова вимога отримує свій номер у документі як коротку назву. Перемістити вгору і Перемістити вниз міняють місцями короткі назви двох вимог, а Перенумерувати… змінює їх після попереднього перегляду.
- Вимоги, написані в Редакторі в цьому пакеті, з’являються в документі.
Вилучити після підтвердження видаляє вимогу пакета. Щоб вивести вимогу з документа без видалення, перемістіть її в інший пакет у Редакторі.
Перевірити якість
- Відкрийте Потреби та вимоги → Якість.
- Натисніть Перевірити якість. Опис кожної вимоги оцінюється за дев’ятьма критеріями за тими самими правилами, що й у проєктах LML.
- Спершу виправте найнижчі оцінки.
Оцінка з позначкою Застаріло належить до старішого тексту. Перевірте якість знову.
Затвердити вимоги
Стан вимоги проходить шлях Чернетка → На рецензуванні → Затверджено або Відхилено.
- Установіть стан вимоги “На рецензуванні”. Її буде наведено на сторінці Затвердження і, для рецензентів, у “Моя робота” в розділі Awaiting 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. Натисніть Порівняння, перевірте тест, потім натисніть Позначити перевіреним….
- Відкрийте Верифікація → Матриця простежуваності з вимогами як рядками й активами як стовпцями. Клітинка для
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).
- Симулятор: Перевірити на відповідність Requirement… бере свій критерій з обмеження require вимоги й записує результат у випадок верифікації (Оцінювання, одиниці та аналіз).
- Документи: блоки RTM, RVTM, VCRM, низхідного розподілу вимог і матриці розподілу перелічують вимоги моделі.
- Керування змінами: базові лінії містять модель; Порівняти перелічує зміни вимог (Функції Holarch у проєктах SysML v2).
Вимоги та якість
Сторінка “Вимоги”
Вимоги — це база даних, відфільтрована за класом Requirement. Вона має фільтри, подання, стовпці, режим дерева, редагування на місці, інструменти масових дій і експорти бази даних (Вимоги).
- + Створити додає використання вимоги з наступним номером у пакеті Requirements.
- Редагування номера, назви або опису змінює текст моделі, і кожну зміну повертає назад одне натискання “Відмінити”.
- Експорти “Таблиця” та “Визначення” містять Вид, Тип, Кратність і Значення, а в моделі з індивідами — Індивід, Частка (portion) і Екземпляри.
- Вибір вимоги показує її в інспекторі SysML v2. Її посилання відкриває її в Оглядачі.
Недоступно для елементів моделі: зміна класу, дублювання, блокування й копіювання з дочірніми, а також експорти даних проєкту (JSON) і пакета проєкту (.holarch). Експортувати проєкт… створює резервну копію всього проєкту як .holarch.
Сторінка “Якість”
Якість оцінює опис кожної вимоги за дев’ятьма критеріями проєктів LML: доречна, повна, відповідна, правильна, здійсненна, необхідна, однозначна за змістом (singular), недвозначна й верифіковна (Якість вимог). Оцінка — це дані 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, а встановлення першого значення не позначає жодного.
Сторінка Зв’язки для рецензування має Порівняння, Показати в тексті і Позначити перевіреним… для кожного зв’язку.
Затвердження
Затвердження перелічує вимоги в стані “На рецензуванні”. Інспектор показує стан із кнопками Затвердити, Відхилити… і Відкрити знову, а також хто й коли його встановив. Стан — це дані 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. у США та інших країнах.