Верификация
Проверки модели
Запуск 75 проверок на основе правил и ваших собственных наборов правил по всей модели, сужение замечаний по серьёзности, классу, правилу и метке, исправление на месте, игнорирование намеренных случаев и настройка строгости каждого правила.
На этой странице
Обзор
Верификация → Проверки модели выполняет каталог правил по каждому элементу проекта и перечисляет, что находит каждое правило. Правила ищут пробелы, из-за которых модели трудно доверять или её трудно рецензировать: отсутствующие имена и номера, изолированные элементы, действия, которые никто не выполняет, интерфейсы, которые ничего не передают, требования, которые не распределены или не верифицированы, риски без плана обработки и меры, не достигающие порогового значения.
Проверки выполняются заново при каждом изменении модели, поэтому страница, карточка Проверки модели на главной странице и значок на Верификация всегда совпадают.
Понятия
- Правило: одна проверка с номером (например Requirement.10), заголовком, называющим то, что она находит, описанием того, как выглядит хорошая модель, и исправлением. Правила сгруппированы по классу, который они проверяют: Global (каждый элемент), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case и Measure.
- Замечание: один элемент, нарушающий одно правило. Замечание может называть связанные элементы, например дубликаты имени или дочерние элементы родителя.
- Серьёзность: каждое правило сообщает как Ошибка или Предупреждение либо имеет значение Игнорировать и не выполняется. По умолчанию — Предупреждение, кроме правил LML 2.0 Global.10 и Global.11 в проекте, чья копия схемы старше LML 2.0 (см. Правила).
- Игнорируемое замечание: замечание, которое вы приняли для одного элемента. Оно больше не учитывается, а Показать игнорируемые выводит его с кнопкой Восстановить.
- Применимая проверка: правило, выполненное хотя бы для одного элемента своего класса. Строка заголовка подсчитывает, сколько применимых проверок не имеют замечаний.
- Набор правил: именованная группа собственных правил, которая хранится в проекте и включается или выключается целиком. Его правила выполняются вместе со встроенными проверками, а их замечания используют тот же список, «Исправить» и «Игнорировать». См. Наборы правил.
Как использовать
Запускайте проверки перед каждой рецензией, после крупного импорта и всякий раз, когда главная страница показывает ошибки проверок модели. Они отвечают на один вопрос: что в модели требует внимания, прежде чем её прочтёт кто-то другой?
Проработать замечания
- Откройте Верификация → Проверки модели. Строка заголовка показывает, например, “Пройдено 84% применимых проверок”, затем число ошибок и предупреждений и изменение с последнего запуска.
- Список сгруппирован по правилам, сначала ошибки. Щёлкните заголовок правила, чтобы раскрыть его; его описание объясняет, почему правило важно.
- Для каждого замечания нажмите Исправить. Диалог исправления показывает элемент, правило и предлагаемое исправление: поле для заполнения, связи для добавления, дубликаты для объединения или кнопку, открывающую элемент или его диаграмму.
- Сохраните исправление. Замечание исчезает, и числа обновляются.
- Если замечание соответствует замыслу (например действие повторно использовано под двумя родителями), нажмите Игнорировать.
Сосредоточиться на одной области
- В фасетах слева установите флажок Ошибки в разделе Серьёзность, чтобы видеть только ошибки.
- Отметьте класс в разделе Класс (класс элемента с замечанием), правило в разделе Правило или метку в разделе Метка. Отметки в одном фасете объединяются через ИЛИ; фасеты объединяются через И. Для каждого значения показано, сколько у него замечаний.
- Введите текст в Фильтр замечаний, чтобы найти имя элемента или заголовок правила.
- Нажмите Сбросить фасеты, чтобы снова показать всё.
Просмотреть все замечания одного элемента вместе
- Выберите Группировать по сущностям рядом с фильтром.
- Каждый элемент перечисляется один раз со всеми своими замечаниями, в порядке номеров. Элемент с ошибкой показывает значок Ошибка в заголовке.
Рабочий пример: демо CubeSat EO-1
- Откройте демо-проект CubeSat EO-1 и перейдите в Верификация → Проверки модели.
- Отметьте Requirement в разделе Класс. Оставшиеся правила показывают, у каких требований нет родителя, распределения (Requirement.8) или верифицирующего тестового случая (Requirement.10).
- Раскройте Requirement.10, нажмите Исправить для замечания и свяжите тестовый случай, который его верифицирует. Замечание уходит из списка, а показатель в строке заголовка растёт.
- Выберите Группировать по сущностям, чтобы сразу увидеть все оставшиеся замечания одного требования.
Написать собственное правило
- Нажмите Наборы правил… в заголовке страницы, затем + Новый набор правил. Назовите набор, например “Program Rules”, и нажмите ОК.
- Под набором нажмите + Добавить правило. Открывается редактор правил с ID R1.
- Введите Имя, говорящее о том, что находит правило, например “Requirements with no verifying test case”.
- В поле Применимо к выберите Requirement.
- В поле Сообщать об элементе, когда выберите Связь отсутствует, затем выберите verified by в поле Связь.
- Задайте для Серьёзность значение Ошибка и напишите Сообщение, например “Link the test case that verifies the requirement.”
- Прочтите предпросмотр под полями, например “Reports 3 items now: SYS-2 Top Speed, …”. Нажмите Сохранить.
- Нажмите Закрыть. Замечания правила появляются в списке под R1, сначала ошибки. Нажмите Исправить, чтобы связать тестовый случай; замечание уходит из списка.
Проверить бюджет массы с единицами
- В демо CubeSat EO-1 откройте Наборы правил…, нажмите + Новый набор правил и назовите его “Mass Budget”.
- Нажмите + Добавить правило. Назовите его “Assemblies over their mass allocation” и выберите Asset в поле Применимо к.
- В поле Сообщать об элементе, когда выберите Сумма связанных значений сравнивается со значением. Задайте Функция = Итого, Связь = decomposed by, Значение каждого связанного элемента = Mass, Сравнение = больше чем и Сравнить с = Mass Allocation.
- Задайте для Серьёзность значение Ошибка и нажмите Сохранить, затем Закрыть.
- Сборка, чьи части весят больше её распределения, попадает в список, например “Total Mass of “decomposed by” 2.34 kg is more than Mass Allocation 1.35 kg”. Массы в граммах и килограммах складываются; масса, введённая в метрах, выводится как “Нельзя сложить массу и длину: размерности различаются (kg vs m).”
Поделиться правилами с другим проектом
- В Наборы правил… нажмите Экспорт рядом с набором. Скачивается файл с именем вида
program-rules.holarch-rules.json. - В другом проекте откройте Наборы правил…, нажмите Импортировать…, затем Выбрать файл… (или вставьте текст файла) и нажмите Импорт.
- Чтобы делиться через библиотеку, храните наборы правил в проекте библиотеки и опубликуйте выпуск. В проекте, использующем библиотеку, нажмите Из библиотеки…, отметьте наборы и нажмите Копировать.
- Когда библиотека публикует более новый выпуск с набором, Наборы правил… показывает “Доступна более новая версия” рядом с копией. Нажмите Обновить…, просмотрите изменения, выберите Оставить мою или Взять из библиотеки для каждого правила, изменённого в обоих местах, и нажмите Обновить. Другие ваши правки копии сохраняются.
Советы
- Установите для правил, которые ваша команда считает блокирующими, уровень Ошибка в Настройки, чтобы главная страница выводила их как проблемы.
- Игнорируйте замечание, только если оно соответствует замыслу, и поясните причину в описании элемента или в комментарии. Показать игнорируемые позволяет рецензентам видеть, что было принято.
- Длинный список замечаний об именах после импорта обычно быстрее всего исправить, правя имена в базе данных.
- Запускайте проверки перед сохранением базовой линии, чтобы она не несла известных пробелов.
Страница
Заголовок страницы
| Элемент управления | Что он делает |
|---|---|
| Экспорт… | Открывает диалог экспорта с Замечания (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.1 | Measure, нарушающие свой порог | Прогнозируемое (или текущее) значение каждого 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 возвращают те же замечания с настройками проекта; они не хранят результаты.