Holarch

Верифікація

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

Запускайте 75 перевірок на основі правил і власні набори правил для всієї моделі, звужуйте зауваження за серйозністю, класом, правилом і міткою, виправляйте їх на місці, ігноруйте навмисні та задавайте суворість кожного правила.

Як цим користуватися →

На цій сторінці
  1. Огляд
  2. Поняття
  3. Як користуватися
    1. Опрацювати зауваження
    2. Зосередитися на одній області
    3. Переглянути зауваження одного елемента разом
    4. Робочий приклад: демопроєкт CubeSat EO-1
    5. Написати власне правило
    6. Перевірити бюджет маси з одиницями
    7. Поділитися правилами з іншим проєктом
    8. Поради
  4. Сторінка
    1. Заголовок сторінки
    2. Рядок заголовка
    3. Панель інструментів
    4. Фасети
    5. Зауваження
    6. Виправлення
  5. Налаштування
  6. Набори правил
    1. Діалог Набори правил
    2. Редактор правил
    3. Правила-вирази
    4. Файли наборів правил
  7. Правила
    1. Правила лінійки продуктів
  8. Повідомлення
  9. Обмеження
  10. Пов’язане

Огляд

Верифікація → Перевірки моделі застосовує каталог правил до кожного елемента проєкту й перелічує, що знаходить кожне правило. Правила шукають прогалини, через які моделі важко довіряти або її важко рецензувати: відсутні назви й номери, відокремлені елементи, дії, яких ніхто не виконує, інтерфейси, що нічого не передають, вимоги, які не розподілено або не верифіковано, ризики без плану реагування та заходи, що не досягають свого порогу.

Перевірки виконуються знову щоразу, коли модель змінюється, тож сторінка, картка Перевірки моделі на Головній і значок на Верифікація завжди збігаються.

Поняття

  • Правило: одна перевірка з номером (наприклад, Requirement.10), заголовком, що називає те, що вона знаходить, описом того, як виглядає добра модель, і виправленням. Правила згруповано за класом, який вони перевіряють: Global (кожен елемент), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case і Measure.
  • Зауваження: один елемент, що порушує одне правило. Зауваження може називати пов’язані елементи, наприклад дублікати назви або дочірні елементи батьківського.
  • Серйозність: кожне правило повідомляє як Помилка чи Попередження або має значення Ігнорувати й не виконується. Типово — Попередження, окрім правил LML 2.0 Global.10 і Global.11 у проєкті, чия копія схеми давніша за LML 2.0 (див. Правила).
  • Проігнороване зауваження: зауваження, яке ви прийняли для одного елемента. Воно більше не враховується, а Показати проігноровані перелічує його з кнопкою Відновити.
  • Застосовна перевірка: правило, що виконалося принаймні для одного елемента свого класу. Рядок заголовка підраховує, скільки застосовних перевірок не мають зауважень.
  • Набір правил: іменована група власних правил, що зберігається в проєкті й вмикається або вимикається цілком. Його правила виконуються разом із вбудованими перевірками, а їхні зауваження використовують той самий список, Виправити та Ігнорувати. Див. Набори правил.

Як користуватися

Запускайте перевірки перед кожним рецензуванням, після великого імпорту й щоразу, коли Головна показує помилки перевірок моделі. Вони відповідають на одне питання: що в моделі потребує уваги, перш ніж її прочитає хтось інший?

Опрацювати зауваження

  1. Відкрийте Верифікація → Перевірки моделі. Рядок заголовка показує, наприклад, “Пройдено 84% застосовних перевірок”, а далі кількість помилок і попереджень та зміну від останнього запуску.
  2. Список згруповано за правилами, помилки першими. Натисніть заголовок правила, щоб відкрити його; його опис пояснює, чому правило важливе.
  3. Для кожного зауваження натисніть Виправити. Діалог виправлення показує елемент, правило й запропоноване виправлення: поле для заповнення, зв’язки для додавання, дублікати для об’єднання або кнопку, що відкриває елемент чи його діаграму.
  4. Збережіть виправлення. Зауваження зникає, і лічильники оновлюються.
  5. Коли зауваження навмисне (наприклад, дію повторно використано під двома батьківськими), натисніть Ігнорувати.

Зосередитися на одній області

  1. У фасетах ліворуч позначте Помилки в Серйозність, щоб бачити лише помилки.
  2. Позначте клас у Клас (клас елемента із зауваженням), правило в Правило або мітку в Мітка. Позначки в одному фасеті поєднуються через OR; фасети між собою — через AND. Кожне значення показує, скільки зауважень воно має.
  3. Введіть текст у Фільтрувати зауваження, щоб знайти назву елемента або заголовок правила.
  4. Натисніть Очистити фасети, щоб знову показати все.

Переглянути зауваження одного елемента разом

  1. Виберіть Групувати за елементами поруч із фільтром.
  2. Кожен елемент наведено один раз з усіма його зауваженнями, у порядку номерів. Елемент із помилкою показує значок Помилка у своєму заголовку.

Робочий приклад: демопроєкт CubeSat EO-1

  1. Відкрийте демопроєкт CubeSat EO-1 і перейдіть до Верифікація → Перевірки моделі.
  2. Позначте Requirement у Клас. Правила, що залишилися, показують, які вимоги не мають батьківської, розподілу (Requirement.8) або тестового випадку, що їх верифікує (Requirement.10).
  3. Відкрийте Requirement.10, натисніть Виправити для зауваження й пов’яжіть тестовий випадок, що його верифікує. Зауваження зникає зі списку, а показник у рядку заголовка зростає.
  4. Виберіть Групувати за елементами, щоб побачити всі решту зауважень однієї вимоги разом.

Написати власне правило

  1. Натисніть Набори правил… у заголовку сторінки, потім + Новий набір правил. Назвіть набір, наприклад “Правила програми”, і натисніть OK.
  2. Під набором натисніть + Додати правило. Відкривається редактор правил з ID R1.
  3. Введіть Назва, яка каже, що знаходить правило, наприклад “Вимоги без тестового випадку, що їх верифікує”.
  4. У Застосовується до виберіть Requirement.
  5. У Повідомляти про елемент, коли виберіть Зв’язок відсутній, потім виберіть verified by у Зв’язок.
  6. Задайте Серйозність значенням Помилка і напишіть Повідомлення, наприклад “Пов’яжіть тестовий випадок, що верифікує вимогу.”
  7. Прочитайте попередній перегляд під полями, наприклад “Зараз повідомляє: 3 елементи: SYS-2 Top Speed, …”. Натисніть Зберегти.
  8. Натисніть Закрити. Зауваження правила з’являються в списку під R1, помилки першими. Натисніть Виправити, щоб пов’язати тестовий випадок; зауваження зникає зі списку.

Перевірити бюджет маси з одиницями

  1. У демо CubeSat EO-1 відкрийте Набори правил…, натисніть + Новий набір правил і назвіть його “Бюджет маси”.
  2. Натисніть + Додати правило. Назвіть його “Збірки, що перевищують розподіл маси” і виберіть Asset у Застосовується до.
  3. У Повідомляти про елемент, коли виберіть Сума пов’язаних значень порівнюється зі значенням. Задайте Функція = Сума, Зв’язок = decomposed by, Значення кожного пов’язаного елемента = Mass, Порівняння = більше ніж і Порівняти з = Mass Allocation.
  4. Задайте Серйозність значенням Помилка і натисніть Зберегти, потім Закрити.
  5. Збірка, частини якої важать більше за її розподіл, потрапляє до списку, наприклад “Total Mass of “decomposed by” 2.34 kg is more than Mass Allocation 1.35 kg”. Маси в грамах і кілограмах додаються; маса, введена в метрах, потрапляє до списку як “Cannot add mass and length: the dimensions differ (kg vs m).” (не можна додати масу й довжину: розмірності різні).

Поділитися правилами з іншим проєктом

  1. У Набори правил… натисніть Експортувати поруч із набором. Завантажується файл з назвою на кшталт program-rules.holarch-rules.json.
  2. В іншому проєкті відкрийте Набори правил…, натисніть Імпортувати…, потім Вибрати файл… (або вставте текст файлу) і натисніть Імпортувати.
  3. Щоб поділитися через бібліотеку, зберігайте набори правил у проєкті бібліотеки й опублікуйте випуск. У проєкті, що використовує бібліотеку, натисніть З бібліотеки…, позначте набори й натисніть Копіювати.
  4. Коли бібліотека публікує новіший випуск із набором, Набори правил… показує “Доступна новіша версія” поруч із копією. Натисніть Оновити…, перегляньте зміни, виберіть Залишити моє або Взяти бібліотечне для кожного правила, зміненого в обох місцях, і натисніть Оновити. Інші ваші зміни в копії зберігаються.

Поради

  • Задайте правилам, які ваша команда вважає блокувальними, значення Помилка в Налаштування, щоб Головна перелічувала їх як проблеми.
  • Ігноруйте зауваження лише тоді, коли воно навмисне, і поясніть причину в описі елемента або в коментарі. Показати проігноровані дає рецензентам змогу побачити, що було прийнято.
  • Довгий список зауважень щодо назв після імпорту зазвичай найшвидше виправити, відредагувавши назви в Базі даних.
  • Запускайте перевірки перед збереженням базової лінії, щоб вона не містила відомих прогалин.

Сторінка

Елемент керуванняЩо він робить
Експортувати…Відкриває діалог Експорт із Findings (CSV): кожне непроігнороване зауваження з правилом, серйозністю, заголовком, id елемента, номером, назвою, класом, приміткою й пов’язаними елементами.
НалаштуванняЗадає серйозність кожного правила й кількість дочірніх на рівень (див. Налаштування).
↻ Запустити перевіркиЗнову виконує всі перевірки й записує лічильники як останній запуск.

Рядок заголовка

  • “Пройдено N% застосовних перевірок”: червоний, коли будь-яке зауваження є помилкою, бурштиновий, коли є лише попередження, зелений, коли нічого виправляти.
  • Кількість зауважень, помилок і попереджень.
  • Зміна від останнього запуску на цьому пристрої, наприклад “На 3 зауваження менше, ніж під час останнього запуску.” Останній запуск записується, коли ви відкриваєте або залишаєте сторінку і коли натискаєте ↻ Запустити перевірки. Під час першого відвідування показується “Перший запуск на цьому пристрої.”

У великому проєкті перевірки виконуються у фоновому режимі, тож сторінкою можна користуватися: перше відвідування показує “Виконуються перевірки моделі…”, наступні показують попередні зауваження, доки не будуть готові нові, а картка прогресу показує запуск, що триває довше за секунду.

Панель інструментів

  • Групувати за правилами (типово) або Групувати за елементами. Вибір запам’ятовується на цьому пристрої.
  • Фільтрувати зауваження: шукає в назвах елементів, номерах і заголовках правил.
  • Розгорнути все і Згорнути все відкривають або закривають усі групи.

Фасети

ФасетЗначення
СерйозністьПомилки, попередження
КласКлас кожного елемента із зауваженням
ПравилоКожне правило із зауваженням, за номером і заголовком
ПідписКожна мітка на елементі із зауваженням
ПроігнорованоПоказати проігноровані додає проігноровані зауваження до списку з позначкою Проігноровано й кнопкою Відновити

Лічильники враховують інші фасети й фільтр, тож показують, що залишиться, якщо позначити значення.

Зауваження

Кожне зауваження показує елемент (або, при групуванні за елементами, правило), примітку (наприклад, "Нечіткі слова: adequate, TBD" або "14 дочірніх"), пов’язані елементи й кнопки Виправити та Ігнорувати або Відновити для проігнорованого зауваження. Одне натискання “Відмінити” повертає назад ігнорування чи відновлення.

Виправлення

ВиправленняВикористовується вЩо він робить
Редагувати полеВідсутня назва, номер або опис; перевірки дієслова й іменникаВідкриває поле з поточним значенням.
З великої літериНазви з малої літериПропонує назву з великою першою літерою.
Додати зв’язкиВідсутні батьківський елемент, виконавець, входи, виходи, канали, стандарти, простеженняПерелічує елементи, які схема дозволяє для зв’язку; позначте їх і натисніть Додати зв’язки.
Об’єднатиСхожі назви, єдині дочірні елементиЗалишає один елемент, переносить на нього всі зв’язки інших, поєднує описи й видаляє інші (одне натискання “Відмінити” повертає все назад).
Видалити пов’язаніДії з входом, створеним після його використанняВидаляє входи/виходи, які споживаються раніше, ніж з’являються.
Додати traced toВимоги, що згадують непов’язані сутностіДодає traced to від вимоги до кожного елемента, названого в її тексті.
Створити IssueНепройдені тестові випадки без пов’язаного IssueСтворює Issue, пов’язаний із тестовим випадком і вимогами, які він верифікує.
ВідкриттяДовгі списки дочірніх елементів, обміни, стандарти, пороги, зв’язки, які схема не дозволяєВідкриває елемент або його діаграму.
Відкрити подання UAFПодання UAF, які неможливо показатиПерелічує подання кореня з їхніми проблемами й відкриває перше.

Налаштування

  • Дочірніх на рівень: Action.9 і Asset.9 повідомляють про батьківський елемент, що має більше дочірніх, ніж це число. Типово 9, згідно з настановою, що людина охоплює приблизно 7 ± 2 елементи на одному рівні. Допустимі значення — від 2 до 99; інше значення показує “Кількість дочірніх на рівень має бути цілим числом від 2 до 99.”
  • Серйозність для кожного правила: Помилка, Попередження або Ігнорувати. Проігнороване правило не виконується.
  • Відновити типові повертає кожне правило до типового значення (Попередження; Requirement.11 — Ігнорувати; Global.10 і Global.11 — Ігнорувати в проєкті, чия копія схеми давніша за LML 2.0) і кількість дочірніх на рівень — до 9.

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

Набори правил

Набори правил… у заголовку сторінки відкриває діалог Набори правил. Власні правила виконуються в Перевірках моделі разом із вбудованими перевірками: їхні зауваження показують ID правила (наприклад, R1) і назву, враховуються в рядку заголовка, з’являються в Правило у фасетах і використовують Виправити, Ігнорувати та Експортувати…, як і будь-яке зауваження. Набори правил зберігаються в проєкті, спільні для всіх його учасників, і кожна зміна становить один крок відміни.

Діалог Набори правил

Елемент керуванняЩо він робить
+ Новий набір правилЗапитує назву й додає порожній увімкнений набір.
Імпортувати…Додає набори правил із файлу наборів правил: Вибрати файл… або вставте його текст, потім Імпортувати. Спершу перевіряється кожне правило; файл із проблемою відхиляється, а проблеми перелічуються. До вже використаної назви додається “ (2)”.
З бібліотеки…Перелічує набори правил у випусках бібліотек, які використовує цей проєкт; позначте їх і натисніть Копіювати. Копія пам’ятає свою бібліотеку й випуск.
Оновити…Поруч зі скопійованим набором, коли його бібліотека опублікувала новіший випуск із цим набором ("Доступна новіша версія"). Показує правила, додані, змінені й вилучені в бібліотеці, ваші зміни, які зберігаються, і правила, змінені і тут, і в бібліотеці; виберіть Залишити моє або Взяти бібліотечне для кожного з них, потім натисніть Оновити. Одне натискання “Відмінити” повертає все назад.
Прапорець поруч із наборомВмикає або вимикає набір. Вимкнений набір не виконується.
Перейменувати…Перейменовує набір.
ЕкспортЗавантажує набір як JSON-файл набору правил.
ВидалитиВидаляє набір і його правила після підтвердження. Відміна їх відновлює.
+ Додати правило, Редагувати, ВидалитиДодати правило до набору, змінити або видалити його.

Правило, яке не може виконуватися в цьому проєкті, наприклад таке, що називає клас або зв’язок, якого немає в схемі, показує проблему червоним під своєю назвою й ні про що не повідомляє.

Редактор правил

ПолеЩо задає
Ім’яЗаголовок зауважень правила: що правило знаходить.
IDКороткий і унікальний у наборі, наприклад R1 або SYS-NUM; до 40 літер, цифр, крапок, дефісів і підкреслень.
Застосовується доБудь-який елемент, клас (разом із підкласами: Test Case також є Action) або в проєкті SysML v2 — вид моделі, як-от Part або Requirement.
Лише елементи, що відповідаютьНеобов’язково: фільтр мовою фільтрів Бази даних, що спершу звужує елементи, наприклад is:leaf.
Повідомляти про елемент, колиУмова, нижче.
СерйозністьПомилка або Попередження.
ПовідомленняВиправлення, яке слід зробити, показане в діалозі Виправити.

Рядок під полями каже, про скільки елементів правило повідомляє зараз, і називає перші п’ять.

УмоваПоляПовідомляє про елемент, коли
Атрибут порожнійАтрибутАтрибут не має значення.
Атрибут відповідає шаблонуАтрибут, Шаблон, Ігнорувати регістрТекст атрибута містить збіг із шаблоном — регулярним виразом.
Атрибут не відповідає шаблонуАтрибут, Шаблон, Ігнорувати регістрТекст атрибута не має збігу, наприклад ^SYS-\d+$ для номерів, які мають починатися з SYS-.
Зв’язок відсутнійЗв’язок, Елементів класуЕлемент не має зв’язку цього типу (з елементами цього класу).
Зв’язок наявнийЗв’язок, Елементів класуЕлемент має такий зв’язок.
Пов’язаних елементів щонайменше NЗв’язок, Елементів класу, NЕлемент має N або більше пов’язаних елементів, наприклад понад 9 дочірніх.
Пов’язаних елементів щонайбільше NЗв’язок, Елементів класу, NЕлемент має N або менше пов’язаних елементів.
Значення поза діапазономАтрибут, Мінімум, Максимум, ОдиницяЧисло атрибута менше за мінімум або більше за максимум. Залиште одну межу порожньою для відкритого діапазону.
Значення в межах діапазонуАтрибут, Мінімум, Максимум, ОдиницяЧисло атрибута в межах діапазону, межі включно.
Сума пов’язаних значень порівнюється зі значеннямФункція, Зв’язок, Елементів класу, Значення кожного пов’язаного елемента, Порівняння, Порівняти зСума, Найменше або Найбільше значення за пов’язаними елементами (або Кількість елементів) більше, щонайменше, менше, щонайбільше, дорівнює або відрізняється від атрибута елемента (наприклад, Mass Allocation) чи значення з одиницею (12 kg). Пов’язані елементи без цього значення пропускаються.
Вираз збігаєтьсяВиразЕлемент відповідає виразу.

Атрибути називаються так, як на елементі: Name, Number і Опис (у проєкті SysML v2 — Short Name і Документація) або будь-який атрибут класу. У проєкті SysML v2 можна назвати й використання атрибута елемента, як-от mass. Елемент, клас якого не має такого атрибута, пропускається. Значення елемента LML також містять характеристики, якими він specified by (характеристика Mass зі значенням 2.4 і одиницями kg читається як 2.4 kg), і його розподіли бюджету (Mass Allocation, з Бюджетів). Без Одиниця діапазон читає перше число значення (1,500 kg і 1500 [kg] читаються як 1500) і пропускає значення, що не є числами. З Одиниця, як-от kg, значення спершу перетворюються (25000 g читається як 25 kg), а значення іншого виду, як-от 3 m, є окремим зауваженням: “Cannot compare length and mass: the dimensions differ (m vs kg).” (не можна порівняти довжину й масу: розмірності різні). Суми й вирази перетворюють одиниці так само й так само повідомляють про невідповідність, ніколи не порівнюючи мовчки.

Правила-вирази

Вираз пишеться мовою фільтрів панелі фільтра Бази даних, тож фільтр, який там знаходить проблемні елементи, працює як правило: про кожен відповідний елемент повідомляється. Приклади:

ВиразЗвіти
class:Requirement is:leaf NOT relationship:"verified by"Кінцеві вимоги, які не верифікує жоден тестовий випадок.
class:Requirement Requirement:"Status=Draft"Вимоги, що досі в стані Draft.
class:Action is:root NOT relationship:"performed by"Дії найвищого рівня, які ніщо не виконує.
class:Asset (name:%TBD% OR description:TBD)Активи з TBD у назві або описі.
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation"Збірки, частини яких важать більше за їхній розподіл, за будь-якого поєднання одиниць.

Арифметика з одиницями: value:"Mass * 1.1 <= 12 kg" або value:"sum(decomposed by → Mass) > Mass Allocation" порівнює значення елемента й суми за його пов’язаними елементами (sum, min, max, count), з +, -, *, /, дужками й одиницями після чисел (12 kg, 9.81 [m/s^2]). Порівняння атрибутів з одиницею, як-от Asset:"Mass>2 kg", теж перетворюються.

Терміни: довільний текст, name: (% відповідає будь-якому тексту), number: (* відповідає будь-якому тексту), description:, class:, label:, relationship:"…", status:, id:, under:"<number>", is:root, is:leaf, is:orphan, is:top, is:locked, is:diagram, порівняння атрибутів, як-от Requirement:"Priority>=3" (=, ~ містить, <, <=, >, >=; = без значення означає порожнє), AND, OR, NOT і дужки. Термін, що нічого не називає в проєкті, як-от невідомий клас, показується як проблема.

Файли наборів правил

Файл набору правил — це JSON з "format": "holarch-rule-set", "version": 1, name, необов’язковим description і списком rules, кожне з id, name, severity, message, необов’язковим target ({"class": "Requirement"}), необов’язковим фільтром where і check. Експортуйте набір, щоб побачити точну структуру. Ті самі файли виконуються в перевірках моделі публічного API і MCP. Вони виконуються й у проєктах SysML v2: там API і MCP виконують лише набори правил проєкту (вбудовані правила виконуються в застосунку), а правило щодо зв’язків, які Holarch зчитує зі з’єднань і потоків (connected by, transfers, generates, receives), виконується лише в застосунку.

Правила

ПравилоHeadingДобра модель
Global.1Однакові або майже однакові назвиУ межах класу жодні дві сутності не мають однакової назви. Назви порівнюються будь-якою мовою без урахування регістру, пробілів, пунктуації й ширини символів (“ABS制御” дорівнює “ABS制御”); літери з діакритикою враховуються (“Größe” і “Grüße” різні).
Global.2Назви з малої літериНазва кожної сутності починається з великої літери.
Global.4Повторені номери в класіУ межах класу кожен номер унікальний.
Global.5Нечіткі слова в назвах або описахНазви й описи використовують точні слова.
Global.6Сутності без зв’язківКожна сутність має зв’язок.
Global.7Живі значення, що вказують на відсутні ціліЖиві значення, блоки матриць, живі таблиці (таблиці, кількості й суми) і перехресні посилання в описах вказують на наявні сутності, документи, класи, мітки, зв’язки, рисунки й таблиці.
Global.8Подання UAF, які неможливо показатиКожне подання UAF використовує корінь, клас і зв’язок, які приймає його тип подання.
Global.9Зв’язки, які схема не дозволяєКожен зв’язок поєднує класи, які схема дозволяє для його відношення.
Global.10Сутності без назви й без номераКожна сутність має назву або номер.
Global.11Значення поза варіантами свого атрибутаКожне значення переліку чи множинного вибору — один з варіантів його атрибута, вибраний один раз.
Action.1Назви дій без дієслова на початкуКожна назва Action починається з дієслова.
Action.2Назви дій з малої літериКожна назва Action починається з великої літери.
Action.3Дії без назвиКожна дія має назву.
Action.4Дії без номераКожна дія має номер.
Action.5Дії без описуКожна дія має опис.
Action.6Дії без батьківського й дочірнього елементаКожна дія має батьківський або дочірній елемент.
Action.7Дії з одним дочірнім елементомЖодна дія не має лише одного дочірнього елемента.
Action.9Дії з понад 9 дочірніми елементамиЖодна дія не має понад 9 дочірніх елементів.
Action.10Дії з кількома батьківськими елементамиЖодна дія не має кількох батьківських елементів.
Action.11Дії, які не виконує жоден активКожну дію виконує певний актив.
Action.12Дії, які нічого не створюютьКожна дія створює вхід/вихід.
Action.13Дії, які нічого не споживаютьКожна дія споживає вхід/вихід.
Action.14Дії без входів і виходівКожна дія споживає або створює вхід/вихід.
Action.15Дії, які створюють, але нічого не споживаютьКожна дія, яка створює виходи, також споживає вхід.
Action.16Дії, які споживають, але нічого не створюютьКожна дія, яка споживає входи, також створює вихід.
Action.17Дії з входом, створеним після його використанняЖодна дія не отримує вхід/вихід, який створює пізніша дія.
Action.18Дії, не простежені до вимогиКожна дія простежується до вимоги.
Action.19Цикли, які ніколи не завершуютьсяКожен цикл може завершитися. Називає цикл і гілку OR з 0 %, що блокує його EXIT.
Asset.1Назви активів без іменникаКожна назва активу — іменник або іменникова фраза.
Asset.2Назви активів з малої літериКожна назва активу починається з великої літери.
Asset.3Активи без назвиКожен актив має назву.
Asset.4Активи без номераКожен актив має номер.
Asset.5Активи без описуКожен актив має опис.
Asset.6Активи без батьківського й дочірнього елементаКожен актив має батьківський або дочірній елемент.
Asset.7Активи з одним дочірнім елементомЖоден актив не має лише одного дочірнього елемента.
Asset.9Активи з понад 9 дочірніми елементамиЖоден актив не має понад 9 дочірніх елементів.
Asset.10Активи з кількома батьківськими елементамиЖоден актив не має кількох батьківських елементів.
Asset.11Активи, які не виконують жодної діїКожен актив виконує певну дію.
Asset.12Активи, не з’єднані каналомКожен актив з’єднаний каналом.
Asset.13Активи, що обмінюються, без спільного каналуАктиви, що обмінюються входом/виходом, з’єднані каналом.
Asset.14Взаємодійні активи без спільного стандартуВзаємодійні активи посилаються на той самий стандарт.
Asset.15Активи, які нічим не обмінюютьсяКожен актив обмінюється входом/виходом з іншим активом.
Conduit.1Назви каналів без іменника на початкуКожна назва каналу починається з іменника.
Conduit.2Канали без назвиКожен канал має назву.
Conduit.3Канали без номераКожен канал має номер.
Conduit.4Канали без описуКожен канал має опис.
Conduit.5Канали з понад двома активамиЖоден канал не з’єднує понад два активи.
Conduit.6Канали з менш ніж двома активамиКожен канал з’єднує два активи.
Conduit.7Канали без спільного стандарту зі своїми активамиКанал і активи, які він з’єднує, посилаються на той самий стандарт.
Conduit.8Канали, які нічого не передаютьКожен канал передає певний вхід/вихід.
Conduit.9Канали, не простежені до вимогиКожен канал простежується до вимоги.
IO.1Входи/виходи без назвиКожен вхід/вихід має назву.
IO.2Входи/виходи без номераКожен вхід/вихід має номер.
IO.3Входи/виходи без описуКожен вхід/вихід має опис.
IO.4Входи/виходи з кількома батьківськими елементамиЖоден вхід/вихід не має більше одного батьківського елемента.
IO.5Входи/виходи, які не створює жодна діяКожен вхід/вихід створює певна дія.
IO.6Входи/виходи, які не споживає жодна діяКожен вхід/вихід споживає певна дія.
IO.7Входи/виходи, які не використовує жодна діяКожен вхід/вихід створюється або споживається дією.
IO.8Входи/виходи, які дія і створює, і споживаєЖодна дія не споживає вхід/вихід, який сама створює.
IO.9Входи/виходи без спільного стандарту зі своїми активамиВхід/вихід і активи, що ним обмінюються, посилаються на той самий стандарт.
IO.10Входи/виходи, не простежені до вимогиКожен вхід/вихід простежується до вимоги.
Requirement.1Вимоги, що згадують непов’язані сутностіВимога пов’язана з кожною сутністю, яку вона називає.
Requirement.2Кінцеві вимоги без “shall”Кожна кінцева вимога використовує слово “shall”.
Requirement.3Вимоги без назвиКожна вимога має назву.
Requirement.4Вимоги без номераКожна вимога має номер.
Requirement.5Вимоги без описуКожна вимога має опис.
Requirement.6Вимоги без батьківської чи дочірньоїКожна вимога має батьківський або дочірній елемент.
Requirement.7Вимоги з кількома батьківськимиЖодна вимога не має кількох батьківських елементів.
Requirement.8Кінцеві вимоги, яких не виконує жодна проєктна сутністьКожна кінцева вимога пов’язана з Action, Asset, Input/Output або Conduit.
Requirement.9Вимоги, satisfied by кількох Input/OutputЖодну вимогу не задовольняє більше одного входу/виходу.
Requirement.10Кінцеві вимоги без тестового випадку, що верифікуєКожна кінцева вимога верифікується Test Case.
Requirement.11Вимоги поза шаблонами EARSКожна кінцева вимога з “shall” відповідає одному із шаблонів EARS. Вимкнено (Ignore), доки ви не задасте серйозність.
Risk.1Ризики найвищого рівня без пом’якшенняКожен відкритий ризик на найвищому рівні матриці ризиків чимось пом’якшено.
Risk.2Прийняття небезпек, старіші за зміну засобу контролюПрийняття залишкового ризику жодної небезпеки не передує зміні її засобів контролю або їхньої верифікації.
TestCase.1Непройдені тестові випадки без пов’язаного IssueКожен непройдений Test Case пов’язаний з Issue.
Measure.1Measure, що порушують свій порігПрогнозоване (або поточне) значення кожного Measure відповідає його порогу.

Примітки до правил:

  • Правила написання вимог посилаються на INCOSE Guide to Writing Requirements: нечіткі слова (R7, нечіткі терміни; R8, ухильні формулювання), “shall” (R1, структуровані твердження) і великі літери (R39, посібник зі стилю). Повну перевірку написання див. у Якість вимог.
  • Правила Action і Asset пропускають завдання, тестові випадки, переходи станів, порти й ресурси; правила Global до них однаково застосовуються.
  • Декомпонований елемент вважається виконуваним, забезпеченим входами, продуктивним або простеженим, коли таким є будь-який з його нащадків. Елементи, що декомпонують одне одного в циклі, враховуються разом.
  • Global.9 повідомляє про кожен елемент один раз, з іншими кінцями його зв’язків, які схема не дозволяє, а також відношенням і класом у примітці, наприклад “Not allowed: decomposed by → Risk”. Зв’язок вважається дозволеним, коли схема дозволяє його в будь-якому напрямку. Такі зв’язки залишаються після вилучення цілі в Редакторі схеми і можуть з’явитися під час імпорту.
  • Global.10 і Global.11 походять з LML 2.0: сутність ідентифікується назвою або номером (§2.1), а значення переліку чи множинного вибору вибирається зі списку його атрибута (§2.5.6, §2.5.12). Global.11 записує всі проблеми одного елемента в його примітку, наприклад Status: "Pending" is not a choice або Verification Method: "Test" chosen twice. Обидва правила типово виконуються там, де схема має вбудовані елементи LML 2.0: у типовій схемі або у власній копії схеми проєкту після Схема → Додати нові вбудовані…. У проєкті зі старішою копією схеми вони починають зі значення Ігнорувати, тож модель, створена з LML 1.x, показує ті самі зауваження, що й раніше; задайте їм Попередження або Помилка в Налаштування, щоб їх виконувати. Редактор схеми вимагає щонайменше два значення, коли ви створюєте або змінюєте список.
  • Порти — це точки інтерфейсу, а не частини: вони не вважаються дочірніми елементами, а канал на порту зараховується активу, якому порт належить.
  • Варіанти використання (Actions з міткою Use Case) звільнено від правила про дієслово й правил щодо входів/виходів.
  • Requirement.11 перевіряє речення з “shall” на відповідність шести шаблонам EARS (Писати за шаблонами EARS) і називає перше, що слід виправити, наприклад “Event-driven: Put a comma after the “When” condition, before the system name.” (поставте кому після умови “When”, перед назвою системи). Обґрунтування й примітки в інших реченнях не перевіряються.
  • Проєкти SysML v2 виконують 17 правил у термінах SysML v2: Global.1, .2, .4–.8, Requirement.2–.5, .8, .10 і .11, Risk.1, TestCase.1 і Measure.1. Правила Action, Asset, Conduit і Input/Output не застосовуються; діагностика Редактора перевіряє назви, типи й структуру моделі. Правила щодо вимог перевіряють використання вимог: наприклад, Requirement.8 має заголовок “Кінцеві вимоги, які ніщо не задовольняє” (частина або дія, що її задовольняє), а Requirement.10 — “Кінцеві вимоги без випадку верифікації”. Global.1, .2 і .6 перевіряють елементи поруч із моделлю, як-от ризики, завдання й документи.

Правила лінійки продуктів

Щойно проєкт має Feature або Configuration, Перевірки моделі також виконують вбудований набір правил Лінійка продуктів (правила ProductLine.1–ProductLine.11 і 13–17, клас Лінійка продуктів). Відсутні характеристики чи конфігурації в Applies To (ProductLine.1), конфігурації, що порушують правило або неповні (ProductLine.3), і конфігурації зі статусом Released, у яких вимоги не верифіковано (ProductLine.16), є помилками; інші правила — попередженнями. ProductLine.10 і 11 перевіряють повноту кожної конфігурації з Усіх конфігурацій. ProductLine.13 і 14 перевіряють ревізії елемента (supersedes): дві чинні для тієї самої одиниці та одиниці без жодної. У поданні конфігурації кожне правило перевіряє цю конфігурацію. Див. Лінійки продуктів і конфігурації.

Повідомлення

ПовідомленняЗначення
“Зауважень немає. Усі застосовні перевірки пройдено.”Нічого виправляти.
“Зауважень немає. Проігноровано зауважень: N; Показати проігноровані перелічує їх.”Усі решта зауважень проігноровано.
“Жодне зауваження не відповідає фільтру. Очистьте фільтр або фасети.”Фасети або фільтр приховують усі зауваження.
“Схема не дозволяє жодного з цих зв’язків для класу …”Виправлення потребує зв’язку, якого схема проєкту не дозволяє для цього класу. Додайте його в Редакторі схеми або виправте зауваження іншим способом.
“Шаблон не є коректним регулярним виразом (…). Виправте його.”Редактор правил або імпортований файл містить шаблон, який неможливо прочитати.
“Id “…” уже використовується в цьому наборі правил. Виберіть інший.”Два правила в одному наборі потребують різних ID.
“Зв’язку “…” немає в схемі цього проєкту.”Правило називає зв’язок, якого цей проєкт не має; воно ні про що не повідомляє, доки ви його не зміните.
“Вираз нічого не називає для класу “…”.”Вираз або фільтр називає клас, мітку, зв’язок чи елемент, яких проєкт не має.
“Версія N не підтримується. Ця версія Holarch читає версію 1.”Файл набору правил записано новішою версією Holarch.

Обмеження

  • Список показує до 200 зауважень на групу; відфільтруйте список, щоб побачити решту.
  • Набір правил містить до 500 правил; файл містить до 50 наборів правил і до 2 МБ. Шаблони мають до 300 символів і перевіряють перші 20 000 символів значення.
  • Зміна від останнього запуску зберігається для кожного пристрою й браузера, а не в проєкті.
  • Публічний API та інструменти MCP повертають ті самі зауваження з налаштуваннями проєкту; вони не зберігають результати.