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. Отметьте класс в разделе Класс (класс элемента с замечанием), правило в разделе Правило или метку в разделе Метка. Отметки в одном фасете объединяются через ИЛИ; фасеты объединяются через И. Для каждого значения показано, сколько у него замечаний.
  3. Введите текст в Фильтр замечаний, чтобы найти имя элемента или заголовок правила.
  4. Нажмите Сбросить фасеты, чтобы снова показать всё.

Просмотреть все замечания одного элемента вместе

  1. Выберите Группировать по сущностям рядом с фильтром.
  2. Каждый элемент перечисляется один раз со всеми своими замечаниями, в порядке номеров. Элемент с ошибкой показывает значок Ошибка в заголовке.

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

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

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

  1. Нажмите Наборы правил… в заголовке страницы, затем + Новый набор правил. Назовите набор, например “Program Rules”, и нажмите ОК.
  2. Под набором нажмите + Добавить правило. Открывается редактор правил с ID R1.
  3. Введите Имя, говорящее о том, что находит правило, например “Requirements with no verifying test case”.
  4. В поле Применимо к выберите Requirement.
  5. В поле Сообщать об элементе, когда выберите Связь отсутствует, затем выберите verified by в поле Связь.
  6. Задайте для Серьёзность значение Ошибка и напишите Сообщение, например “Link the test case that verifies the requirement.”
  7. Прочтите предпросмотр под полями, например “Reports 3 items now: SYS-2 Top Speed, …”. Нажмите Сохранить.
  8. Нажмите Закрыть. Замечания правила появляются в списке под R1, сначала ошибки. Нажмите Исправить, чтобы связать тестовый случай; замечание уходит из списка.

Проверить бюджет массы с единицами

  1. В демо CubeSat EO-1 откройте Наборы правил…, нажмите + Новый набор правил и назовите его “Mass Budget”.
  2. Нажмите + Добавить правило. Назовите его “Assemblies over their mass allocation” и выберите 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”. Массы в граммах и килограммах складываются; масса, введённая в метрах, выводится как “Нельзя сложить массу и длину: размерности различаются (kg vs m).”

Поделиться правилами с другим проектом

  1. В Наборы правил… нажмите Экспорт рядом с набором. Скачивается файл с именем вида program-rules.holarch-rules.json.
  2. В другом проекте откройте Наборы правил…, нажмите Импортировать…, затем Выбрать файл… (или вставьте текст файла) и нажмите Импорт.
  3. Чтобы делиться через библиотеку, храните наборы правил в проекте библиотеки и опубликуйте выпуск. В проекте, использующем библиотеку, нажмите Из библиотеки…, отметьте наборы и нажмите Копировать.
  4. Когда библиотека публикует более новый выпуск с набором, Наборы правил… показывает “Доступна более новая версия” рядом с копией. Нажмите Обновить…, просмотрите изменения, выберите Оставить мою или Взять из библиотеки для каждого правила, изменённого в обоих местах, и нажмите Обновить. Другие ваши правки копии сохраняются.

Советы

  • Установите для правил, которые ваша команда считает блокирующими, уровень Ошибка в Настройки, чтобы главная страница выводила их как проблемы.
  • Игнорируйте замечание, только если оно соответствует замыслу, и поясните причину в описании элемента или в комментарии. Показать игнорируемые позволяет рецензентам видеть, что было принято.
  • Длинный список замечаний об именах после импорта обычно быстрее всего исправить, правя имена в базе данных.
  • Запускайте проверки перед сохранением базовой линии, чтобы она не несла известных пробелов.

Страница

Элемент управленияЧто он делает
Экспорт…Открывает диалог экспорта с Замечания (CSV): все неигнорируемые замечания с правилом, серьёзностью, заголовком, id элемента, номером, именем, классом, примечанием и связанными элементами.
НастройкиЗадаёт серьёзность каждого правила и число дочерних элементов на уровень (см. «Настройки»).
↻ Запустить проверкиСнова выполняет все проверки и записывает числа как последний запуск.

Строка заголовка

  • “Пройдено N% применимых проверок”: красный, если хотя бы одно замечание — ошибка, жёлтый, если есть только предупреждения, зелёный, если исправлять нечего.
  • Число замечаний, ошибок и предупреждений.
  • Изменение с последнего запуска на этом устройстве, например “На 3 замечания меньше, чем при последнем запуске.” Последний запуск записывается, когда вы открываете страницу или уходите с неё и когда нажимаете ↻ Запустить проверки. При первом посещении показывается “Первый запуск на этом устройстве.”

В крупном проекте проверки выполняются в фоне, поэтому страница остаётся доступной: при первом посещении показывается “Выполнение проверок модели…”, при последующих — предыдущие замечания, пока не будут готовы новые, а карточка хода выполнения показывает запуск, который длится больше секунды.

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

  • Группировать по правилам (по умолчанию) или Группировать по сущностям. Выбор запоминается на этом устройстве.
  • Фильтр замечаний: находит имена элементов, номера правил и заголовки правил.
  • Развернуть все и Свернуть все раскрывают или закрывают все группы.

Фасеты

ФасетЗначения
СерьёзностьОшибки, предупреждения
КлассКласс каждого элемента с замечанием
ПравилоКаждое правило с замечанием, по номеру и заголовку
НадписьКаждая метка элемента с замечанием
ИгнорируемыеПоказать игнорируемые добавляет игнорируемые замечания в список с пометкой “Ignored” и кнопкой Восстановить

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

Замечания

Каждое замечание показывает элемент (или, при группировке по сущностям, правило), примечание (например “Vague words: adequate, TBD” или “14 children”), связанные элементы и кнопки Исправить и Игнорировать либо Восстановить для игнорируемого замечания. “Игнорировать” и “Восстановить” отменяются одним нажатием “Отменить”.

Исправления

ИсправлениеГде используетсяЧто он делает
Изменить полеОтсутствующие имя, номер или описание; проверки глагола и существительногоОткрывает поле с текущим значением.
Сделать заглавнойНазвания со строчной буквыПредлагает имя с заглавной первой буквой.
Добавить связиОтсутствующие родитель, исполнитель, входы, выходы, каналы, стандарты, трассировкиПеречисляет элементы, которые схема допускает для связи; отметьте их и нажмите Добавить связи.
ОбъединитьПохожие имена, единственные дочерние элементыСохраняет один элемент, переносит на него все связи остальных, объединяет описания и удаляет остальные (одно нажатие “Отменить” возвращает всё назад).
Удалить связанныеДействия со входом, который производится после его использованияУдаляет входы/выходы, которые потребляются раньше, чем появляются.
Добавить 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). Связанные элементы без значения пропускаются.
Выражение совпадаетВыражениеЭлемент соответствует выражению.

Атрибуты называются так же, как в элементе: Имя, Номер и Описание (в проекте SysML v2 — Short Name и Документация) или любой атрибут класса. В проекте SysML v2 можно назвать и использование атрибута элемента, например mass. Элемент, у класса которого нет такого атрибута, пропускается. Значения элемента LML включают также характеристики, которыми он specified by (характеристика Mass со значением Value 2.4 и Units kg читается как 2.4 kg), и его распределения бюджета (Mass Allocation, из раздела Бюджеты). Без Единица диапазон читает начальное число значения (1,500 kg и 1500 [kg] читаются как 1500) и пропускает значения, которые не являются числами. С Единица, например kg, значения сначала преобразуются (25000 g читается как 25 kg), а значение другого рода, например 3 m, само становится замечанием: “Нельзя сравнить длину и массу: размерности различаются (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 начинается с глагола.
Action.2Названия Action со строчной буквыКаждое название 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Требования, удовлетворяемые несколькими Input/OutputНи одно требование не удовлетворяется более чем одним входом/выходом.
Requirement.10Листовые требования без верифицирующего тестового случаяКаждое конечное требование верифицируется Test Case.
Requirement.11Требования вне шаблонов EARSКаждое листовое требование с “shall” следует одному из шаблонов EARS. Выключено (Игнорировать), пока вы не зададите его серьёзность.
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, показывает те же замечания, что и раньше; чтобы их выполнять, задайте Предупреждение или Ошибка в Настройки. Редактор схемы запрашивает не меньше двух значений при создании или изменении списка.
  • Порты — это точки интерфейса, а не части: они не считаются дочерними элементами, а канал на порту учитывается для актива, которому порт принадлежит.
  • Варианты использования (Action с меткой Use Case) освобождены от правила о глаголе и от правил о входах/выходах.
  • Requirement.11 проверяет предложение, содержащее “shall”, по шести шаблонам EARS (Написание по шаблонам EARS) и называет первое, что нужно исправить, например “Event-driven: Put a comma after the \"When\" condition, before the system name.” Обоснования и примечания в других предложениях не проверяются.
  • Проекты 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 проверяют использования требований: например 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; их выводит «Показать игнорируемые».”Все оставшиеся замечания проигнорированы.
“Ни одно замечание не соответствует фильтру. Сбросьте фильтр или фасеты.”Фасеты или фильтр скрывают все замечания.
“Схема не допускает ни одну из этих связей для класса …”Для исправления нужна связь, которую схема проекта не допускает для этого класса. Добавьте её в редакторе схемы или исправьте замечание другим способом.
“Шаблон не является допустимым регулярным выражением (…). Исправьте его.”В редакторе правил или в импортированном файле есть шаблон, который невозможно прочитать.
“The id “…” is already used in this rule set. Choose another.”Двум правилам в одном наборе нужны разные ID.
“The relationship “…” is not in this project’s schema.”Правило называет связь, которой нет в этом проекте; оно ничего не сообщает, пока вы его не измените.
“The expression names nothing for class “…”.”Выражение или фильтр называет класс, метку, связь или элемент, которых нет в проекте.
“Версия N не поддерживается. Эта версия Holarch читает версию 1.”Файл набора правил записан более новой версией Holarch.

Ограничения

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