Verificação
Checagens do modelo
Execute 75 checagens baseadas em regras e seus próprios conjuntos de regras sobre todo o modelo, filtre as constatações por severidade, classe, regra e rótulo, corrija-as no local, ignore as que são intencionais e defina o rigor de cada regra.
Nesta página
Visão geral
Verificação → Checagens do modelo executa um catálogo de regras sobre todos os itens do projeto e lista o que cada regra encontra. As regras procuram lacunas que tornam um modelo difícil de confiar ou de revisar: nomes e números ausentes, itens isolados, ações que ninguém executa, interfaces que não transportam nada, requisitos não alocados ou não verificados, riscos sem plano de tratamento e medidas que não atingem o limite.
As checagens são executadas de novo sempre que o modelo muda, por isso a página, o cartão Checagens do modelo em Início e o selo em Verificação sempre coincidem.
Conceitos
- Regra: uma checagem com um número (por exemplo Requirement.10), um título que nomeia o que ela encontra, uma declaração de como é um bom modelo e uma correção. As regras são agrupadas pela classe que checam: Global (todos os itens), Action, Asset, Conduit, Input/Output, Requirement, Risk, Test Case e Measure.
- Constatação: um item que viola uma regra. Uma constatação pode nomear itens relacionados, por exemplo as duplicatas de um nome ou os filhos de um pai.
- Severidade: cada regra relata como Erro ou Aviso, ou é definida como Ignorar e não é executada. O padrão é Aviso, exceto para as regras do LML 2.0 Global.10 e Global.11 em um projeto cuja cópia do esquema é anterior ao LML 2.0 (veja Regras).
- Constatação ignorada: uma constatação que você aceitou para um item. Ela deixa de contar, e Mostrar ignorados a lista com Restaurar.
- Checagem aplicável: uma regra executada sobre pelo menos um item da classe dela. A linha de cabeçalho conta quantas checagens aplicáveis não têm constatação.
- Conjunto de regras: um grupo nomeado de regras suas, guardado no projeto e ativado ou desativado como um todo. As regras dele são executadas com as checagens integradas, e as constatações delas usam a mesma lista, Corrigir e Ignorar. Veja Conjuntos de regras.
Como usá-lo
Execute as checagens antes de cada revisão, após uma importação grande e sempre que Início mostrar erros nas checagens do modelo. Elas respondem a uma pergunta: o que no modelo requer atenção antes que outra pessoa o leia?
Trabalhar as constatações
- Abra Verificação → Checagens do modelo. A linha de cabeçalho mostra, por exemplo, "84% das checagens aplicáveis passam", seguido do número de erros e avisos e da mudança desde a última execução.
- A lista é agrupada por regra, com os erros primeiro. Clique no título de uma regra para abri-la; a descrição dela diz por que a regra é importante.
- Para cada constatação, clique em Corrigir. A caixa de diálogo de correção mostra o item, a regra e a correção sugerida: um campo a preencher, relacionamentos a adicionar, duplicatas a mesclar ou um botão que abre o item ou o diagrama dele.
- Salve a correção. A constatação desaparece e as contagens são atualizadas.
- Quando uma constatação for intencional (por exemplo uma ação reutilizada sob dois pais), clique em Ignorar.
Concentrar-se em uma área
- Nas facetas à esquerda, marque Erros em Severidade para ver apenas os erros.
- Marque uma classe em Classe (a classe do item com a constatação), uma regra em Regra ou um rótulo em Rótulo. As marcações em uma faceta se combinam com OU; as facetas se combinam com E. Cada valor mostra quantas constatações tem.
- Digite em Filtrar constatações para buscar o nome de um item ou o título de uma regra.
- Clique em Limpar facetas para mostrar tudo de novo.
Revisar juntas as constatações de um item
- Escolha Agrupar por entidade ao lado do filtro.
- Cada item é listado uma vez com todas as constatações dele, em ordem de número. Um item com erro mostra um selo Erro no título.
Exemplo prático: a demonstração CubeSat EO-1
- Abra o projeto de demonstração CubeSat EO-1 e vá para Verificação → Checagens do modelo.
- Marque Requirement em Classe. As regras que restam mostram quais requisitos não têm pai, alocação (Requirement.8) ou caso de teste de verificação (Requirement.10).
- Abra Requirement.10, clique em Corrigir em uma constatação e vincule o caso de teste que a verifica. A constatação sai da lista e a linha de cabeçalho sobe.
- Escolha Agrupar por entidade para ver de uma vez todas as constatações restantes de um requisito.
Escrever sua própria regra
- Clique em Conjuntos de regras… no cabeçalho da página e depois em + Novo conjunto de regras. Dê um nome ao conjunto, por exemplo “Regras do programa”, e clique em OK.
- Sob o conjunto, clique em + Adicionar regra. O editor de regras abre com o ID R1.
- Digite um Nome que diga o que a regra encontra, por exemplo “Requisitos sem caso de teste de verificação”.
- Em Aplica-se a, escolha Requirement.
- Em Relatar um item quando, escolha Falta um relacionamento e depois escolha verified by em Relacionamento.
- Defina Severidade como Erro e escreva a Mensagem, por exemplo “Vincule o caso de teste que verifica o requisito.”
- Leia a prévia abaixo dos campos, por exemplo "Reports 3 items now: SYS-2 Top Speed, …". Clique em Salvar.
- Clique em Fechar. As constatações da regra aparecem na lista sob R1, com os erros primeiro. Clique em Corrigir para vincular um caso de teste; a constatação sai da lista.
Checar um orçamento de massa com unidades
- Na demonstração CubeSat EO-1, abra Conjuntos de regras…, clique em + Novo conjunto de regras e dê a ele o nome “Orçamento de massa”.
- Clique em + Adicionar regra. Dê a ela o nome “Montagens acima da alocação de massa” e escolha Asset em Aplica-se a.
- Em Relatar um item quando, escolha Um total de valores relacionados é comparado com um valor. Defina Função como Total, Relacionamento como decomposed by, Valor de cada item relacionado como Mass, Comparação como é maior que e Comparar com como Mass Allocation.
- Defina Severidade como Erro e clique em Salvar e depois em Fechar.
- Uma montagem cujas peças pesam mais do que a alocação dela é listada, por exemplo "Total Mass of "decomposed by" 2.34 kg is more than Mass Allocation 1.35 kg". Massas em gramas e quilogramas se somam; uma massa digitada em metros é listada como "Cannot add mass and length: the dimensions differ (kg vs m)."
Compartilhar regras com outro projeto
- Em Conjuntos de regras…, clique em Exportar ao lado do conjunto. Um arquivo com um nome como
program-rules.holarch-rules.jsoné baixado. - No outro projeto, abra Conjuntos de regras…, clique em Importar…, depois em Escolher arquivo… (ou cole o texto do arquivo) e clique em Importar.
- Para compartilhar por meio de uma biblioteca, mantenha os conjuntos de regras no projeto da biblioteca e publique uma liberação. Em um projeto que usa a biblioteca, clique em Da biblioteca…, marque os conjuntos e clique em Copiar.
- Quando a biblioteca publica uma liberação mais nova com o conjunto, Conjuntos de regras… mostra "Uma versão mais recente está disponível" ao lado da cópia. Clique em Atualizar…, revise as mudanças, escolha Manter a minha ou Usar a da biblioteca para cada regra alterada nos dois lugares e clique em Atualizar. Suas outras edições na cópia são mantidas.
Dicas
- Defina as regras que sua equipe considera bloqueantes como Erro em Ajustes, para que Início as liste como problemas.
- Ignore uma constatação somente quando ela for intencional, e diga por quê na descrição do item ou em um comentário. Mostrar ignorados permite que os revisores vejam o que foi aceito.
- Uma lista longa de constatações de nomenclatura após uma importação costuma ser corrigida mais rápido editando os nomes no Banco de dados.
- Execute as checagens antes de salvar uma linha de base, para que a linha de base não carregue lacunas conhecidas.
A página
Cabeçalho da página
| Controle | O que ele faz |
|---|---|
| Exportar… | Abre a caixa de diálogo Exportar com Constatações (CSV): todas as constatações não ignoradas, com regra, severidade, título, id do item, número, nome, classe, observação e itens relacionados. |
| Ajustes | Define a severidade de cada regra e os filhos por nível (veja Ajustes). |
| ↻ Executar checagens | Executa todas as checagens de novo e registra as contagens como a última execução. |
Linha de cabeçalho
- "N% das checagens aplicáveis passam": vermelho quando alguma constatação é um erro, âmbar quando há apenas avisos, verde quando não há nada a corrigir.
- O número de constatações, erros e avisos.
- A mudança desde a última execução neste dispositivo, por exemplo "3 constatações a menos que na última execução." A última execução é registrada quando você abre ou sai da página e quando clica em ↻ Executar checagens. A primeira visita diz "Primeira execução neste dispositivo."
Em um projeto grande, as checagens são executadas em segundo plano, para que a página continue utilizável: a primeira visita mostra "Executando as checagens do modelo…", as visitas seguintes mostram as constatações anteriores até as novas ficarem prontas, e um cartão de progresso mostra uma execução que leva mais de um segundo.
Barra de ferramentas
- Agrupar por regra (padrão) ou Agrupar por entidade. A escolha é lembrada neste dispositivo.
- Filtrar constatações: busca nomes de itens, números de regras e títulos de regras.
- Expandir tudo e Recolher tudo abrem ou fecham todos os grupos.
Facetas
| Faceta | Valores |
|---|---|
| Severidade | Erros, Avisos |
| Classe | A classe de cada item com uma constatação |
| Regra | Cada regra com uma constatação, por número e título |
| Rótulo | Cada rótulo em um item com uma constatação |
| Ignorados | Mostrar ignorados adiciona à lista as constatações ignoradas, marcadas como Ignoradas, com Restaurar |
As contagens seguem as outras facetas e o filtro, por isso mostram o que marcar um valor deixaria.
Constatações
Cada constatação mostra o item (ou, no agrupamento por entidade, a regra), a observação (por exemplo "Vague words: adequate, TBD" ou "14 children"), os itens relacionados e os botões Corrigir e Ignorar, ou Restaurar para uma constatação ignorada. Um único Desfazer reverte um Ignorar ou um Restaurar.
Correções
| Correção | Usada por | O que ele faz |
|---|---|---|
| Editar um campo | Nome, número ou descrição ausentes; checagens de verbo e de substantivo | Abre o campo com o valor atual. |
| Iniciar com maiúscula | Nomes em minúsculas | Oferece o nome com a primeira letra maiúscula. |
| Adicionar relacionamentos | Pai, executor, inputs, outputs, conduits, normas ou rastreamentos ausentes | Lista os itens que o esquema permite para o relacionamento; marque-os e clique em Adicionar relacionamentos. |
| Mesclar | Nomes semelhantes, filhos únicos | Mantém um item, move para ele todos os relacionamentos dos outros, combina as descrições e exclui os outros (um único Desfazer reverte tudo). |
| Excluir relacionados | Ações com um input produzido depois de ser usado | Exclui os input/outputs que são consumidos antes de existirem. |
| Adicionar traced to | Requisitos que citam entidades não relacionadas | Adiciona traced to do requisito a cada item que o texto dele nomeia. |
| Criar Issue | Casos de teste reprovados sem problema vinculado | Cria uma Issue vinculada ao caso de teste e aos requisitos que ele verifica. |
| Abertura | Listas longas de filhos, trocas, normas, limites, relacionamentos que o esquema não permite | Abre o item ou o diagrama dele. |
| Abrir vista UAF | Vistas UAF que não podem ser mostradas | Lista as vistas da raiz com os problemas delas e abre a primeira. |
Ajustes
- Filhos por nível: Action.9 e Asset.9 relatam um pai com mais filhos do que este número. O padrão é 9, a partir da diretriz de que as pessoas lidam com cerca de 7 ± 2 itens em um nível. Os valores permitidos vão de 2 a 99; outro valor mostra "Filhos por nível deve ser um número inteiro de 2 a 99."
- Severidade por regra: Erro, Aviso ou Ignorar. Uma regra ignorada não é executada.
- Restaurar padrões volta cada regra ao padrão dela (Aviso; Requirement.11 Ignorar; Global.10 e Global.11 Ignorar em um projeto cuja cópia do esquema é anterior ao LML 2.0) e os filhos por nível para 9.
Os ajustes ficam guardados no projeto, são compartilhados com todos nele e podem ser desfeitos.
Conjuntos de regras
Conjuntos de regras… no cabeçalho da página abre a caixa de diálogo Conjuntos de regras. Suas próprias regras são executadas em Checagens do modelo com as checagens integradas: as constatações delas mostram o ID da regra (por exemplo R1) e o nome, contam na linha de cabeçalho, aparecem em Regra nas facetas e usam Corrigir, Ignorar e Exportar… como qualquer constatação. Os conjuntos de regras ficam guardados no projeto, são compartilhados com todos nele, e cada mudança é um passo de desfazer.
A caixa de diálogo Conjuntos de regras
| Controle | O que ele faz |
|---|---|
| + Novo conjunto de regras | Pede um nome e adiciona um conjunto vazio, ativado. |
| Importar… | Adiciona os conjuntos de regras de um arquivo de conjuntos de regras: Escolher arquivo… ou cole o texto dele, depois Importar. Cada regra é checada antes; um arquivo com problema é recusado e os problemas são listados. Um nome já usado recebe " (2)". |
| Da biblioteca… | Lista os conjuntos de regras nas liberações das bibliotecas que este projeto usa; marque-os e clique em Copiar. A cópia lembra a biblioteca e a liberação dela. |
| Atualizar… | Ao lado de um conjunto copiado quando a biblioteca dele publicou uma liberação mais nova que contém o conjunto ("A newer version is available"). Mostra uma prévia das regras adicionadas, alteradas e removidas na biblioteca, das edições suas que são mantidas e das regras alteradas tanto aqui quanto na biblioteca; escolha Manter a minha ou Usar a da biblioteca para cada uma delas e clique em Atualizar. Um único Desfazer reverte tudo. |
| Caixa de seleção ao lado de um conjunto | Ativa ou desativa o conjunto. Um conjunto desativado não é executado. |
| Renomear… | Renomeia o conjunto. |
| Exportar | Baixa o conjunto como um arquivo JSON de conjunto de regras. |
| Excluir | Exclui o conjunto e as regras dele após uma confirmação. Desfazer os restaura. |
| + Adicionar regra, Editar, Excluir | Adicionar uma regra ao conjunto, alterá-la ou excluí-la. |
Uma regra que não pode ser executada neste projeto, por exemplo uma que nomeia uma classe ou um relacionamento que o esquema não tem, mostra o problema em vermelho abaixo do nome e não relata nada.
O editor de regras
| Campo | O que define |
|---|---|
| Nome | O título das constatações da regra: o que a regra encontra. |
| ID | Curto e único no conjunto, por exemplo R1 ou SYS-NUM; até 40 letras, dígitos, pontos, hifens e sublinhados. |
| Aplica-se a | Qualquer item, uma classe (subclasses incluídas: um Test Case também é uma Action) ou, em um projeto SysML v2, um tipo de modelo como Part ou Requirement. |
| Somente itens que correspondem a | Opcional: um filtro na linguagem de filtros do Banco de dados que restringe os itens primeiro, por exemplo is:leaf. |
| Relatar um item quando | A condição, abaixo. |
| Severidade | Erro ou Aviso. |
| Mensagem | A correção a fazer, mostrada na caixa de diálogo Corrigir. |
A linha abaixo dos campos diz quantos itens a regra relata agora e nomeia os cinco primeiros.
| Condição | Campos | Relata um item quando |
|---|---|---|
| Um atributo está vazio | Atributo | O atributo não tem valor. |
| Um atributo corresponde a um padrão | Atributo, Padrão, Ignorar maiúsculas/minúsculas | O texto do atributo contém uma correspondência do padrão, uma expressão regular. |
| Um atributo não corresponde a um padrão | Atributo, Padrão, Ignorar maiúsculas/minúsculas | O texto do atributo não tem correspondência, por exemplo ^SYS-\d+$ para números que devem começar com SYS-. |
| Falta um relacionamento | Relacionamento, De itens de | O item não tem vínculo desse relacionamento (com itens dessa classe). |
| Um relacionamento existe | Relacionamento, De itens de | O item tem um vínculo desse tipo. |
| Os itens relacionados são pelo menos N | Relacionamento, De itens de, N | O item tem N ou mais itens relacionados, por exemplo mais de 9 filhos. |
| Os itens relacionados são no máximo N | Relacionamento, De itens de, N | O item tem N ou menos itens relacionados. |
| Um valor está fora de um intervalo | Atributo, Mínimo, Máximo, Unidade | O número do atributo está abaixo do mínimo ou acima do máximo. Deixe um limite vazio para um intervalo aberto. |
| Um valor está dentro de um intervalo | Atributo, Mínimo, Máximo, Unidade | O número do atributo está dentro do intervalo, limites incluídos. |
| Um total de valores relacionados é comparado com um valor | Função, Relacionamento, De itens de, Valor de cada item relacionado, Comparação, Comparar com | O Total, o Menor ou o Maior de um valor sobre os itens relacionados (ou o Número de itens) é maior que, pelo menos, menor que, no máximo, igual a ou diferente de um atributo do item (por exemplo Mass Allocation) ou de um valor com a unidade dele (12 kg). Itens relacionados sem o valor são ignorados. |
| Uma expressão corresponde | Expressão | O item corresponde à expressão. |
Os atributos são nomeados como no item: Nome, Número e Descrição (em um projeto SysML v2, Nome curto e Documentação) ou qualquer atributo da classe. Em um projeto SysML v2, um uso de atributo do elemento, como mass, também pode ser nomeado. Um item cuja classe não tem esse atributo é ignorado. Os valores de um item LML também incluem as características pelas quais ele é specified by (uma característica Mass com Value 2.4 e Units kg é lida como 2,4 kg) e as alocações de orçamento dele (Mass Allocation, de Orçamentos). Sem uma Unidade, um intervalo lê o número inicial do valor (1,500 kg e 1500 [kg] são lidos como 1500) e ignora os valores que não são números. Com uma Unidade como kg, os valores são convertidos primeiro (25000 g é lido como 25 kg), e um valor de outro tipo, como 3 m, é uma constatação própria: "Cannot compare length and mass: the dimensions differ (m vs kg)." Totais e expressões convertem unidades da mesma forma e relatam uma incompatibilidade da mesma forma, nunca como uma comparação silenciosa.
Regras de expressão
Uma expressão é escrita na linguagem de filtros da barra de filtros do Banco de dados, por isso um filtro que encontra lá os itens com problema funciona como regra: todo item que corresponde é relatado. Exemplos:
| Expressão | Relatórios |
|---|---|
class:Requirement is:leaf NOT relationship:"verified by" | Requisitos folha que nenhum caso de teste verifica. |
class:Requirement Requirement:"Status=Draft" | Requisitos ainda em Draft. |
class:Action is:root NOT relationship:"performed by" | Ações de nível superior que nada executa. |
class:Asset (name:%TBD% OR description:TBD) | Assets com TBD no nome ou na descrição. |
class:Asset value:"sum(decomposed by → Mass) > Mass Allocation" | Montagens cujas peças pesam mais do que a alocação delas, em qualquer mistura de unidades. |
Aritmética com unidades: value:"Mass * 1.1 <= 12 kg" ou value:"sum(decomposed by → Mass) > Mass Allocation" compara valores do item e totais sobre os itens relacionados dele (sum, min, max, count), com +, -, *, /, parênteses e unidades após os números (12 kg, 9.81 [m/s^2]). Comparações de atributos com unidade, como Asset:"Mass>2 kg", também convertem.
Termos: texto livre, name: (% corresponde a qualquer texto), number: (* corresponde a qualquer texto), description:, class:, label:, relationship:"…", status:, id:, under:"<number>", is:root, is:leaf, is:orphan, is:top, is:locked, is:diagram, comparações de atributos como Requirement:"Priority>=3" (=, ~ contém, <, <=, >, >=; = sem valor significa vazio), AND, OR, NOT e parênteses. Um termo que não nomeia nada no projeto, como uma classe desconhecida, é mostrado como problema.
Arquivos de conjuntos de regras
Um arquivo de conjunto de regras é JSON com "format": "holarch-rule-set", "version": 1, um name, uma description opcional e uma lista de rules, cada uma com id, name, severity, message, um target opcional ({"class": "Requirement"}), um filtro where opcional e um check. Exporte um conjunto para ver o formato exato. Os mesmos arquivos são executados nas checagens do modelo da API pública e do MCP. Eles também são executados em projetos SysML v2: lá a API e o MCP executam apenas os conjuntos de regras do projeto (as regras integradas são executadas no app), e uma regra sobre os relacionamentos que o Holarch lê de conexões e fluxos (connected by, transfers, generates, receives) é executada apenas no app.
Regras
| Regra | Heading | Um bom modelo |
|---|---|---|
| Global.1 | Nomes iguais ou quase iguais | Dentro de uma classe, duas entidades nunca compartilham um nome. Os nomes são comparados em qualquer idioma, ignorando maiúsculas e minúsculas, espaços, pontuação e largura dos caracteres ("ABS制御" é igual a "ABS制御"); letras acentuadas contam ("Größe" e "Grüße" são diferentes). |
| Global.2 | Nomes em minúsculas | Todo nome de entidade começa com letra maiúscula. |
| Global.4 | Números repetidos em uma classe | Dentro de uma classe, todo número é único. |
| Global.5 | Palavras vagas em nomes ou descrições | Nomes e descrições usam palavras precisas. |
| Global.6 | Entidades sem relacionamentos | Toda entidade tem um relacionamento. |
| Global.7 | Valores vivos que apontam para destinos ausentes | Valores vivos, blocos de matriz, tabelas vivas (tabelas, contagens e totais) e referências cruzadas nas descrições apontam para entidades, documentos, classes, rótulos, relacionamentos, figuras e tabelas que existem. |
| Global.8 | Vistas UAF que não podem ser mostradas | Toda vista UAF usa uma raiz, uma classe e um relacionamento que o tipo de vista dela aceita. |
| Global.9 | Relacionamentos que o esquema não permite | Todo relacionamento une classes que o esquema permite para a relação dele. |
| Global.10 | Entidades sem nome nem número | Toda entidade tem um nome ou um número. |
| Global.11 | Valores fora das opções do atributo | Todo valor de enumeração e de seleção múltipla é uma das opções do atributo, escolhida uma vez. |
| Action.1 | Nomes de Action sem verbo inicial | Todo nome de Action começa com um verbo. |
| Action.2 | Nomes de Action em minúsculas | Todo nome de Action começa com letra maiúscula. |
| Action.3 | Ações sem nome | Cada ação tem um nome. |
| Action.4 | Ações sem número | Cada ação tem um número. |
| Action.5 | Ações sem descrição | Cada ação tem uma descrição. |
| Action.6 | Ações sem pai nem filho | Toda ação tem um pai ou um filho. |
| Action.7 | Ações com um único filho | Nenhuma ação tem um único filho. |
| Action.9 | Ações com mais de 9 filhos | Nenhuma ação tem mais de 9 filhos. |
| Action.10 | Ações com vários pais | Nenhuma ação tem vários pais. |
| Action.11 | Ações que nenhum asset executa | Algum asset executa cada ação. |
| Action.12 | Ações que não produzem nada | Toda ação produz um input/output. |
| Action.13 | Ações que não consomem nada | Toda ação consome um input/output. |
| Action.14 | Ações sem inputs nem outputs | Toda ação consome ou produz um input/output. |
| Action.15 | Ações que produzem, mas não consomem nada | Toda ação que produz outputs também consome um input. |
| Action.16 | Ações que consomem, mas não produzem nada | Toda ação que consome inputs também produz um output. |
| Action.17 | Ações com um input produzido depois de ser usado | Nenhuma ação recebe um input/output que uma ação posterior gera. |
| Action.18 | Ações não rastreadas a um requisito | Toda ação é rastreada a um requisito. |
| Action.19 | Laços que nunca podem terminar | Todo laço pode terminar. Nomeia o laço e o ramo OR a 0 % que bloqueia o EXIT dele. |
| Asset.1 | Nomes de asset sem substantivo | Todo nome de asset é um substantivo ou uma locução substantiva. |
| Asset.2 | Nomes de asset em minúsculas | Todo nome de asset começa com letra maiúscula. |
| Asset.3 | Assets sem nome | Cada asset tem um nome. |
| Asset.4 | Assets sem número | Cada asset tem um número. |
| Asset.5 | Assets sem descrição | Cada asset tem uma descrição. |
| Asset.6 | Assets sem pai nem filho | Todo asset tem um pai ou um filho. |
| Asset.7 | Assets com um único filho | Nenhum asset tem um único filho. |
| Asset.9 | Assets com mais de 9 filhos | Nenhum asset tem mais de 9 filhos. |
| Asset.10 | Assets com vários pais | Nenhum asset tem vários pais. |
| Asset.11 | Assets que não executam nenhuma ação | Cada asset executa alguma ação. |
| Asset.12 | Assets não conectados por um conduit | Todo asset é conectado por um conduit. |
| Asset.13 | Assets que trocam algo sem conduit em comum | Assets que trocam um input/output são conectados por um conduit. |
| Asset.14 | Assets que interagem sem norma em comum | Assets que interagem referenciam a mesma norma. |
| Asset.15 | Assets que não trocam nada | Todo asset troca um input/output com outro asset. |
| Conduit.1 | Nomes de conduit sem substantivo inicial | Todo nome de conduit começa com um substantivo. |
| Conduit.2 | Conduits sem nome | Cada conduit tem um nome. |
| Conduit.3 | Conduits sem número | Cada conduit tem um número. |
| Conduit.4 | Conduits sem descrição | Cada conduit tem uma descrição. |
| Conduit.5 | Conduits com mais de dois assets | Nenhum conduit conecta mais de dois assets. |
| Conduit.6 | Conduits com menos de dois assets | Todo conduit conecta dois assets. |
| Conduit.7 | Conduits sem norma em comum com os assets deles | Um conduit e os assets que ele conecta referenciam a mesma norma. |
| Conduit.8 | Conduits que não transferem nada | Cada conduit transfere algum input/output. |
| Conduit.9 | Conduits não rastreados a um requisito | Todo conduit é rastreado a um requisito. |
| IO.1 | Input/outputs sem nome | Cada input/output tem um nome. |
| IO.2 | Input/outputs sem número | Cada input/output tem um número. |
| IO.3 | Input/outputs sem descrição | Cada input/output tem uma descrição. |
| IO.4 | Input/outputs com vários pais | Nenhum input/output tem mais de um pai. |
| IO.5 | Input/outputs que nenhuma ação produz | Alguma ação produz cada input/output. |
| IO.6 | Input/outputs que nenhuma ação consome | Alguma ação consome cada input/output. |
| IO.7 | Input/outputs que nenhuma ação usa | Todo input/output é produzido ou consumido por uma ação. |
| IO.8 | Input/outputs que uma ação produz e consome | Nenhuma ação consome um input/output que ela mesma produz. |
| IO.9 | Input/outputs sem norma em comum com os assets deles | Um input/output e os assets que o trocam referenciam a mesma norma. |
| IO.10 | Input/outputs não rastreados a um requisito | Todo input/output é rastreado a um requisito. |
| Requirement.1 | Requisitos que citam entidades não relacionadas | Um requisito está relacionado a cada entidade que ele nomeia. |
| Requirement.2 | Requisitos folha sem "shall" | Todo requisito folha usa a palavra "shall". |
| Requirement.3 | Requisitos sem nome | Cada requisito tem um nome. |
| Requirement.4 | Requisitos sem número | Cada requisito tem um número. |
| Requirement.5 | Requisitos sem descrição | Cada requisito tem uma descrição. |
| Requirement.6 | Requisitos sem pai nem filho | Todo requisito tem um pai ou um filho. |
| Requirement.7 | Requisitos com vários pais | Nenhum requisito tem vários pais. |
| Requirement.8 | Requisitos folha que nenhuma entidade de projeto atende | Todo requisito folha está relacionado a uma Action, um Asset, um Input/Output ou um Conduit. |
| Requirement.9 | Requisitos satisfeitos por vários Input/Outputs | Nenhum requisito é satisfeito por mais de um input/output. |
| Requirement.10 | Requisitos folha sem caso de teste que os verifique | Cada requisito folha é verificado por um Test Case. |
| Requirement.11 | Requisitos fora dos padrões EARS | Cada requisito folha com "shall" segue um dos padrões EARS. Desativada (Ignorar) até você definir a severidade dela. |
| Risk.1 | Riscos do nível mais alto sem mitigação | Cada risco aberto no nível mais alto da matriz de riscos é mitigado por algo. |
| Risk.2 | Aceitações de perigo anteriores a uma mudança de controle | Nenhuma aceitação de risco residual de um perigo é anterior a uma mudança nos controles dele ou na verificação deles. |
| TestCase.1 | Casos de teste reprovados sem problema vinculado | Cada Test Case reprovado está vinculado a uma Issue. |
| Measure.1 | Measures que violam o limite | O valor projetado (ou atual) de cada Measure atende ao limite dela. |
Observações sobre as regras:
- As regras de redação de requisitos citam o INCOSE Guide to Writing Requirements: palavras vagas (R7, termos vagos; R8, cláusulas de escape), "shall" (R1, enunciados estruturados) e letras maiúsculas (R39, guia de estilo). A checagem completa de redação é a Qualidade dos requisitos.
- Tasks, casos de teste, transições de estado, portas e recursos são ignorados pelas regras de Action e de Asset; as regras Global ainda se aplicam a eles.
- Um item decomposto conta como executado, alimentado, produtivo ou rastreado quando algum de seus descendentes é. Itens que se decompõem mutuamente em laço contam juntos.
- Global.9 relata cada item uma vez, com as outras pontas dos relacionamentos dele que o esquema não permite, e a relação e a classe na observação, por exemplo "Not allowed: decomposed by → Risk". Um relacionamento conta como permitido quando o esquema o permite em qualquer direção. Esses relacionamentos permanecem depois que um destino é removido no Editor de esquema e podem entrar com importações.
- Global.10 e Global.11 vêm do LML 2.0: uma entidade é identificada por um nome ou um número (§2.1), e um valor de enumeração ou de seleção múltipla é escolhido da lista do atributo dele (§2.5.6, §2.5.12). Global.11 coloca todos os problemas de um item na observação dele, por exemplo
Status: "Pending" is not a choiceouVerification Method: "Test" chosen twice. Ambas são executadas por padrão onde o esquema tem os itens integrados do LML 2.0: o esquema padrão, ou a cópia própria de um projeto após Esquema → Adicionar novos itens integrados…. Em um projeto cuja cópia do esquema é mais antiga, elas começam em Ignorar, para que um modelo feito com LML 1.x mostre as mesmas constatações de antes; defina-as como Aviso ou Erro em Ajustes para executá-las. O Editor de esquema pede pelo menos dois valores quando você cria ou altera uma lista. - Portas são pontos de interface, não partes: elas não contam como filhos, e um conduit em uma porta conta para o asset que a possui.
- Casos de uso (Actions com o rótulo Use Case) estão isentos da regra de verbo e das regras de input/output.
- Requirement.11 checa a frase que contém "shall" em relação aos seis padrões EARS (Escrever com modelos EARS) e nomeia a primeira coisa a corrigir, por exemplo "Event-driven: Coloque uma vírgula depois da condição \"When\", antes do nome do sistema." Justificativas e observações em outras frases não são checadas.
- Projetos SysML v2 executam 17 das regras, nos termos do SysML v2: Global.1, .2, .4 a .8, Requirement.2 a .5, .8, .10 e .11, Risk.1, TestCase.1 e Measure.1. As regras de Action, Asset, Conduit e Input/Output não se aplicam; os diagnósticos do Editor checam os nomes, os tipos e a estrutura do modelo. As regras de Requirement checam usos de requisito: por exemplo, Requirement.8 diz "Requisitos folha que nada satisfaz" (uma parte ou ação que o satisfaz) e Requirement.10 "Requisitos folha sem caso de verificação". Global.1, .2 e .6 checam os itens ao lado do modelo, como riscos, tarefas e documentos.
Regras de linha de produtos
Quando um projeto tem uma Feature ou uma Configuration, Checagens do modelo também executa o conjunto de regras integrado Linha de produtos (regras ProductLine.1 a ProductLine.11 e 13 a 17, classe Linha de produtos). Features ou configurações ausentes em Applies To (ProductLine.1), configurações que violam uma regra ou estão incompletas (ProductLine.3) e configurações Released com requisitos não verificados nelas (ProductLine.16) são erros; as outras regras são avisos. ProductLine.10 e 11 checam a completude de cada configuração a partir de Todas as configurações. ProductLine.13 e 14 checam revisões de um item (supersedes): duas em vigor para a mesma unidade, e unidades sem nenhuma. Em uma vista de configuração, cada regra checa essa configuração. Veja Linhas de produtos e configurações.
Mensagens
| Mensagem | Significado |
|---|---|
| "Nenhuma constatação. Todas as checagens aplicáveis passam." | Nada a corrigir. |
| "Nenhuma constatação. N findings ignoradas; Mostrar ignorados as lista." | Todas as constatações restantes foram ignoradas. |
| "Nenhuma constatação corresponde ao filtro. Limpe o filtro ou as facetas." | As facetas ou o filtro ocultam todas as constatações. |
| "O esquema não permite nenhum destes relacionamentos para a classe …" | A correção precisa de um relacionamento que o esquema do projeto não permite para essa classe. Adicione-o no Editor de esquema ou corrija a constatação de outra forma. |
| "The pattern is not a valid regular expression (…). Correct it." | O editor de regras ou um arquivo importado tem um padrão que não pode ser lido. |
| "O id "…" já é usado neste conjunto de regras. Escolha outro." | Duas regras de um conjunto precisam de IDs diferentes. |
| "The relationship "…" is not in this project's schema." | Uma regra nomeia um relacionamento que este projeto não tem; ela não relata nada até você alterá-la. |
| "The expression names nothing for class "…"." | Uma expressão ou um filtro nomeia uma classe, um rótulo, um relacionamento ou um item que o projeto não tem. |
| "Version N is not supported. This version of Holarch reads version 1." | O arquivo de conjunto de regras foi gravado por um Holarch mais novo. |
Limites
- A lista mostra até 200 constatações por grupo; filtre a lista para ver o restante.
- Um conjunto de regras contém até 500 regras; um arquivo contém até 50 conjuntos de regras e 2 MB. Os padrões têm até 300 caracteres e checam os primeiros 20.000 caracteres de um valor.
- A mudança desde a última execução é guardada por dispositivo e navegador, não no projeto.
- A API pública e as ferramentas MCP retornam as mesmas constatações com os ajustes do projeto; elas não armazenam resultados.