Описания инструкции документируются, с помощью следующего шаблона. Компании, которые хотят создать дополнительные инструкции, поощряются использовать тот же шаблон.
| ID: Заголовок | |
| Приоритет | Обязательный, Строго рекомендуемый или Рекомендуемый |
| Осциллограф | MAAB, NA-MAAB, J-MAAB, Specific Company (для дополнительного локального использования компании) |
| MATLAB® Versions | Одно из следующего: Все RX, РАЙ, RZ RX и ранее RX и позже RX через РАЯ |
| Предпосылки | Ссылки на инструкции, которые являются предпосылками к этой инструкции (ID: Заголовок |
| Описание | Описание инструкции (текст, изображения) |
| Объяснение | Мотивация для инструкции |
| В последний раз Изменение | Номер версии последнего изменения |
| Модель Советник Проверять | Заголовок и ссылка на соответствующую проверку Model Advisor, если проверка существует |
Элементы этого шаблона являются минимальными необходимыми элементами для понимания и обмена инструкциями. Можно добавить проект или поля поставщика к этому шаблону, пока их значение не накладывается с существующими полями. Такие сложения поощряются, если они помогают интегрировать другие шаблоны инструкции и привести к более широкому принятию базового шаблона.
ID инструкции создается из двух строчных букв (представляющий источник правила) и четырехзначное число, разделенное подчеркиванием.
Если новая инструкция имеет ID, ID не изменяется.
ID используется для ссылок на инструкции.
Двухбуквенные префиксы na, мировой судья, jc и eu резервируются для будущих правил комитета MAAB.
Резервируются устаревшие префиксы, дб, jm, HD, и площадь. Комитет MAAB не будет использовать эти префиксы для новых правил.
Никакие новые правила не состоят в том, чтобы быть записаны с этими устаревшими префиксами.
Заголовок должен быть коротким, но уникальным описанием области применения инструкций (например, длина имен)
Заголовок используется для поля Prerequisites и для пользовательских инструментов средства проверки.
Текст заголовка должен появиться с гиперссылкой, которая соединяется с инструкцией.
Заголовок не должен быть избыточным кратким описанием содержимого инструкций, потому что, в то время как последний может изменяться в зависимости от времени, заголовок должен остаться стабильным.
Каждая инструкция должна быть оценена с одним из следующих приоритетов:
Обязательный
Строго рекомендуемый
Рекомендуемый
Приоритет описывает важность инструкции и определяет последствия нарушений.
| Обязательный | Строго рекомендуемый | Рекомендуемый |
|---|---|---|
| Определение | ||
Инструкции, которые все компании согласовывают на это, абсолютно необходимы. Инструкции, которым все компании приспосабливают 100%. | Инструкции, которые согласованы, чтобы быть хорошей практикой, но устаревшие модели устраняют компанию от приспосабливания до инструкции 100%. Модели должны соответствовать этим инструкциям до самой большой возможной степени; однако, 100%-е соответствие не требуется. | Инструкции, которым рекомендуют улучшить внешний вид диаграммы модели, но не очень важны для выполнения модели. Инструкции, где соответствие предпочитается, но не требуется. |
| Последствия: Если инструкция нарушена, | ||
Товары первой необходимости отсутствуют. Сила модели не работает правильно. | Качество и внешний вид ухудшаются Может быть неблагоприятное воздействие на поддерживаемости, мобильности и возможности многократного использования | Внешний вид не соответствует другим проектам. |
| Политика отказа: Если инструкция намеренно проигнорирована, | ||
Причины должны быть зарегистрированы. | ||
Осциллограф инструкции может быть установлен в одно из следующего:
| Осциллограф | Описание |
|---|---|
| MAAB (консультативный совет MathWorks® Automotive) | Группа автомобильных производителей и поставщиков, которые тесно сотрудничают с MathWorks. MAAB включает подгруппы J-MAAB и NA-MAAB. |
| JMAAB (Япония MAAB) | Подгруппа MAAB, который включает автомобильных производителей и поставщиков в Японии и работает в тесном сотрудничестве с MathWorks. Правила с осциллографом J-MAAB локальны для Японии. |
| NA-MAAB (североамериканский MAAB) | Подгруппа MAAB, который включает автомобильных производителей и поставщиков в Соединенных Штатах и Европе и работает в тесном сотрудничестве с MathWorks. Правила с осциллографом NA-MAAB локальны для Соединенных Штатов и Европы. |
Инструкции поддерживают все версии продуктов Simulink® и MATLAB. Если правило применяется к определенным версиям, версии идентифицированы в поле версий MATLAB. Информация о версии находится в одном из следующих форматов.
| Формат | Определение |
|---|---|
| Все | Все версии MATLAB |
| RX, РАЙ или RZ | Определенная версия MATLAB |
| RX и ранее | Версии MATLAB до RX версии |
| RX и позже | Версии MATLAB от RX версии до текущей версии |
| RX через РАЯ | Версии MATLAB между RX и RY |
Поле Prerequisite для ссылок на другие инструкции, которые являются предпосылками для этой инструкции (логическая конъюнкция).
Используйте ID инструкции (для непротиворечивости) и заголовок (для удобочитаемости) для ссылок.
Поле Prerequisites не должно содержать другой текст.
Это поле содержит подробное описание инструкции.
В случае необходимости добавьте изображения и таблицы.
Если формальное обозначение (математика, регулярное выражение, схемы синтаксиса и точные числа/пределы) доступно, используйте его, чтобы однозначно описать инструкцию и задать автоматизированную проверку. Однако человеческое, понятное, неофициальное описание должно всегда предоставляться для ежедневной ссылки.
Это cписки полей причины, которые применяются к данной инструкции. Можно рекомендовать инструкции по одному или нескольким следующих причин:
| Объяснение | Описание |
|---|---|
| Удобочитаемость | Понятные алгоритмы
|
| Рабочий процесс | Эффективный процесс разработки и рабочий процесс
|
| Симуляция | Эффективная симуляция и анализ
|
| Верификация и валидация | Способность проверить и подтвердить типовой кодекс и сгенерированный код с:
|
| Генерация кода | Генерация кода, который эффективен и продуктивен для встраиваемых систем
|
Последнее поле изменения содержит номер версии документа.
Продукт Simulink Check™ включает Simulink Model Advisor проверки MAAB, которые соответствуют подмножеству инструкций MAAB, которые можно выбрать и запустить с Model Advisor Simulink. В этом представлении инструкций MAAB MathWorks включает поле проверки Model Advisor в описания инструкции, которое содержит заголовок и ссылку на соответствующую проверку Model Advisor, если проверка существует. Несмотря на то, что эта информация включена, обратите внимание, что рабочая группа MAAB занимает нейтральную позицию по рекомендациям для средств проверки руководства по стилю.
Для списка доступных проверок Model Advisor на инструкции MAAB смотрите Проверки Model Advisor на Инструкции MAAB. Для получения информации об использовании Model Advisor смотрите Регистрации Модели Выполнения документации Simulink.