SysML v2
Requisitos e verificação em projetos SysML v2
Escreva, cheque, aprove e acompanhe requisitos e casos de verificação de um modelo SysML v2 com as páginas Requisitos, Qualidade, TBD/TBR, Vínculos a revisar, Aprovações, RVTM, Casos de verificação e Matriz de rastreabilidade.
Nesta página
- Visão geral
- Conceitos
- Como usá-lo
- Quando e por quê
- Escrever um requisito
- Escrever requisitos em um documento
- Checar a qualidade
- Aprovar requisitos
- Definir um limite e um objetivo
- Marcar um valor como TBD ou TBR
- Fechar um TBD ou TBR
- Revisar vínculos alterados
- Planejar e executar a verificação
- Exemplo prático: a demonstração Hybrid Car
- Dicas e boas práticas
- Erros comuns
- Como se conecta a outros recursos
- Requisitos e Qualidade
- Controle de mudanças
- Páginas de verificação
- Mensagens
- Limites
- Páginas relacionadas
Visão geral
Um projeto SysML v2 tem as mesmas páginas de requisitos e verificação de um projeto LML. Elas trabalham sobre o modelo: os requisitos são os elementos requirement do modelo, e os casos de teste são seus casos verification.
| Grupo da barra lateral | Páginas |
|---|---|
| Necessidades e requisitos | Requisitos, Qualidade, TBD/TBR, Vínculos a revisar, Aprovações |
| Verificação | RVTM, Casos de verificação, Matriz de rastreabilidade, Checagens do modelo |
Casos de verificação é a página que os projetos LML chamam de Central de testes.
Alguns dados são texto SysML, e alguns são dados do Holarch guardados ao lado do modelo:
- No texto: o número (nome curto), o nome, a descrição (doc), o aninhamento, os relacionamentos
satisfy,verify,dependencye de derivação, e os valores de atributos com suas unidades. - Dados do Holarch: Status, Prioridade, Método de verificação e os outros atributos de requisitos, rótulos, status de teste, resultados, etapas e ciclos de teste. Outras ferramentas SysML v2 não os leem.
Conceitos
Requisitos no modelo
Um requisito é um uso requirement ou uma requirement def. O Holarch lê seus campos a partir do texto:
| Campo do Holarch | Texto SysML v2 |
|---|---|
| Número | O nome curto: <'VR-1'> |
| Nome | O nome: CurbMass |
| Descrição | O comentário doc: doc /* … */ |
| Requisitos filhos (decomposed by) | Requisitos pertencentes ao requisito |
requirement def <'VR-1'> CurbMass {
doc /* The car's curb mass shall not exceed the mass limit. */
subject car : Car;
attribute limit : MassValue;
require constraint { car.curbMass <= limit }
}
As páginas mostram os nomes com iniciais maiúsculas, então sedanMass aparece como Sedan Mass.
Limite e objetivo
Um requisito é quantitativo quando uma de suas restrições require compara uma grandeza com um valor: car.curbMass <= limit ou range >= 800 [km]. O valor é o limite, o menor valor aceitável. <= o torna um limite superior (menor é melhor), >= um mínimo (maior é melhor).
O SysML v2 não tem palavra-chave para um objetivo, o valor almejado além do limite. O Holarch o escreve como os metadados @Objective do pacote de biblioteca HolarchRequirements (Biblioteca padrão, pasta Holarch):
requirement def <'VR-1'> CurbMass {
subject car : Car;
attribute limit : MassValue;
require constraint { car.curbMass <= limit }
@Objective { value = 1600 [kg]; }
}
- Um objetivo em uma definição de requisito se aplica a cada uso dela. Um uso pode dar o seu próprio.
- O limite pode ser um valor escrito na restrição (
12 [kg]) ou um atributo que o requisito ou uma redefinição define (attribute :>> limit = maxCurbMass;). - Outras ferramentas SysML v2 leem
@Objectivecomo metadados comuns. - Orçamentos e TPMs usa o limite como a alocação de cada part que satisfaz o requisito, e lista o requisito na aba TPMs com seu limite e seu objetivo (Orçamentos e TPMs).
Relacionamentos
| Relacionamento do Holarch | Texto SysML v2 |
|---|---|
| satisfied by | satisfy carSpec by fleet.sedan; |
| verified by | verify carSpec.sedanMass; no objetivo de um caso de verificação |
| performed by | perform ou allocate |
| traced to | dependency |
| decomposed by | Propriedade: um requisito pertencente a outro requisito |
Adicionar ou remover um destes em qualquer página altera o texto, e um único Desfazer reverte tudo.
Casos de teste e suítes de testes
- Um caso de teste é um uso
verificationou umaverification def. - Os requisitos que ele verifica são os membros
verifydo seu objetivo. - Um pacote que possui casos de verificação é uma suíte de testes.
verification def CurbMassTest {
doc /* Weigh the car on a scale with full fluids and no driver. */
subject car : Car;
objective massObjective {
verify carSpec.sedanMass;
}
}
TBD e TBR
Um requisito está em aberto (TBD ou TBR) quando qualquer uma destas condições é verdadeira:
- Seu atributo TBD/TBR é TBD ou TBR.
- TBD, TBR ou TBS aparece no seu nome ou no seu doc.
- Um dos seus valores de atributo tem metadados TBD ou TBR.
Escrever TBD no lugar de um valor não é SysML válido. Em vez disso, marque o atributo com metadados do pacote de biblioteca do Holarch HolarchMetadata (consulte Marcar um valor como TBD ou TBR).
Como usá-lo
Quando e por quê
Use estas páginas depois de escrever os primeiros requisitos no modelo e continue usando-as durante a verificação:
- Requisitos e Qualidade enquanto você escreve: cada requisito está bem formado?
- Aprovações nas revisões: quem já aprovou?
- TBD/TBR e Vínculos a revisar enquanto o projeto muda: o que ainda está em aberto e o que precisa de uma segunda olhada?
- Matriz de rastreabilidade, Casos de verificação e RVTM enquanto você planeja e executa a verificação: cada requisito está satisfeito e verificado?
Escrever um requisito
- Abra Necessidades e requisitos → Requisitos.
- Clique em + Novo. Um uso de requisito é adicionado com o próximo número, no pacote Requirements.
- Digite o nome e a descrição no inspetor ou na tabela. O texto muda imediatamente, e um único Desfazer reverte cada edição.
- Defina os dados do Holarch no inspetor, nas mesmas seções de um requisito LML: Status na faixa de revisão e Prioridade, Criticidade e Responsável em Fluxo de trabalho; Método de verificação e Nível de verificação em Verificação; Justificativa e Origem em Requisito. Esses são dados do Holarch; o texto não muda. Cada edição pode ser revertida com um único Desfazer, e a tabela Requisitos, a RVTM e a VCRM mostram os mesmos valores.
Você também pode escrever requisitos no Editor. Eles aparecem na página Requisitos assim que o texto é analisado sem erros.
Escrever requisitos em um documento
Um documento pode conter os usos de requisito de um pacote.
- Em um documento, escolha Escrever ▾ → Pacote de requisitos… e escolha o pacote. Um novo documento recebe um pacote com o nome dele e com seu primeiro requisito.
- Adicione, aumente ou diminua o recuo e mova requisitos como nos documentos LML.
- Um requisito sob uma seção pertence ao pacote.
- Um requisito sob outro requisito fica aninhado nele.
- O número é seu nome curto. Adicionar, remover ou mover outros itens renumera apenas as seções e nunca altera um nome curto; um novo requisito recebe seu número no documento como nome curto. Mover para cima e Mover para baixo trocam os nomes curtos dos dois requisitos, e Renumerar… os altera após uma pré-visualização.
- Os requisitos escritos no Editor nesse pacote aparecem no documento.
Remover exclui um requisito do pacote após uma confirmação. Para tirar um requisito do documento sem excluí-lo, mova-o para outro pacote no Editor.
Checar a qualidade
- Abra Necessidades e requisitos → Qualidade.
- Clique em Checar qualidade. A descrição de cada requisito recebe uma pontuação em nove critérios, com as mesmas regras dos projetos LML.
- Corrija primeiro as pontuações mais baixas.
Uma pontuação marcada como Desatualizado pertence a um texto mais antigo. Cheque a qualidade de novo.
Aprovar requisitos
O Status de um requisito vai de Rascunho → Em revisão → Aprovado ou Rejeitado.
- Defina o Status de um requisito como Em revisão. Ele aparece em Aprovações e, para os revisores, em Meu trabalho, em Aguardando revisão. Os revisores recebem uma notificação.
- Como revisor, selecione o requisito. O inspetor mostra seu status com Aprovar, Rejeitar… e Reabrir.
- Clique em Aprovar, ou em Rejeitar… com um motivo opcional. O inspetor registra quem definiu o status e quando.
Pessoas com a função Revisor podem aprovar e rejeitar. Editar o texto de um requisito Aprovado o devolve para Em revisão.
Definir um limite e um objetivo
- Escreva o limite como uma restrição
requireque compara uma grandeza com um valor, por exemplorequire constraint { battery.mass <= 50 [kg] }. - Selecione o requisito. O inspetor mostra Limite e objetivo com a Grandeza e o Limite (No máximo ou No mínimo).
- Digite o valor almejado em Objetivo, por exemplo
45 kg, e pressione Enter.O Holarch escreve
@HolarchRequirements::Objective { value = 45 [kg]; }no requisito. Limpe o campo para removê-lo. - Vincule o requisito à part que o atende com
satisfy. O Editor aponta quando a part atende ao limite mas não ao objetivo.
Marcar um valor como TBD ou TBR
- Importe o pacote de metadados no pacote do requisito:
private import HolarchMetadata::*;. - Escreva
#TBDantes de um atributo cujo valor ainda está por definir. Omita o valor ou dê uma estimativa. - Escreva
#TBRantes de um atributo cujo valor deve ser revisado. - Para registrar quem é o responsável e o motivo, use a forma longa no corpo do atributo.
#TBR attribute limit : TimeValue = 0.5 [h];
attribute chargerPower : PowerValue {
@TBD { owner = "Powertrain lead"; rationale = "The fast-charging standard is not chosen yet."; due = "2026-12-01"; }
}
Inserir ▾ → Valor TBD e Valor TBR no Editor os escrevem para você. TBD e TBR especializam ModelingMetadata::StatusInfo, então outras ferramentas SysML v2 os leem como anotações de status. @StatusInfo { status = StatusKind::tbd; } também conta. O pacote aparece em Holarch na Biblioteca padrão.
Fechar um TBD ou TBR
- Abra Necessidades e requisitos → TBD/TBR. Cada item em aberto mostra seu responsável, prazo e idade, com um gráfico de burn-down dos itens em aberto.
- Digite o valor final no texto ou no inspetor e clique em Fechar na linha. O atributo TBD/TBR volta para Nenhum, e os metadados TBD/TBR são removidos dos valores.
As marcas no doc se fecham quando você edita o doc. Exportar XLSX exporta o registro.
Revisar vínculos alterados
Quando um requisito muda, os vínculos que dependem dele são marcados para revisão como parte dessa mudança, e um único Desfazer reverte as duas coisas.
- Abra Necessidades e requisitos → Vínculos a revisar. Cada vínculo mostra o que mudou, quando e por quem.
- Clique em Diff para ver o nome e o doc antigos e novos, ou em Mostrar no texto para abrir o requisito no Editor.
- Cheque o elemento vinculado. Atualize-o se ele não servir mais.
- Clique em Marcar como revisado…, adicione um comentário opcional e confirme.
Um elemento com um vínculo a revisar também mostra um banner com Revisar… no inspetor e um selo Revisar nas tabelas. A visão Vínculos a revisar do Banco de dados os lista.
Planejar e executar a verificação
- Abra Verificação → Casos de verificação.
- Clique em + Novo ▾ → Suíte de testes… para adicionar um pacote e depois em + Novo ▾ → Caso de teste… para adicionar um uso de verificação.
- Vincule um requisito ao caso de teste. Um
verifyé adicionado ao objetivo do caso de teste. - Adicione etapas, execute a suíte com Executar suíte e defina o status de cada caso de teste. Status, resultados esperados e obtidos, etapas e ciclos são dados do Holarch.
- Abra Verificação → RVTM para ver cada requisito com seu método de verificação, os casos de teste que o verificam e o status consolidado a partir dos sub-requisitos.
Exemplo prático: a demonstração Hybrid Car
Crie primeiro a demonstração: Gerenciar projetos → Arquivos de projeto ▾ → Novo projeto de demonstração → Hybrid Car (SysML v2). Seus requisitos estão no pacote VehicleRequirements.
- Abra Necessidades e requisitos → Requisitos. Entre eles estão VR-1 Curb Mass a VR-6 Battery Mass Limit, e o requisito
carSpeccom VR-1.1 Sedan Mass, VR-2.1 Sedan Acceleration e VR-4.1 Sedan Range abaixo dele. - Selecione VR-1.1 Sedan Mass. Ele é verificado pelo caso de verificação
CurbMassTest, por meio doverify carSpec.sedanMass;em seu objetivo. - Abra TBD/TBR. VR-5 Charge Time está em aberto: seu
limittem#TBR, e seuchargerPowertem@TBDcom o responsável Powertrain lead. - No Editor, mude
maxCurbMassde1650 [kg]para1600 [kg]. VR-1.1 Sedan Mass usamaxCurbMasscomo limite, então seus vínculos são marcados para revisão. - Abra Vínculos a revisar. O vínculo verified by de VR-1.1 Sedan Mass aparece. Clique em Diff, cheque o teste e clique em Marcar como revisado….
- Abra Verificação → Matriz de rastreabilidade com os requisitos como linhas e os Assets como colunas. A célula de
carSpecefleet.sedanmostra satisfied by, vindo desatisfy carSpec by fleet.sedan;.
Dicas e boas práticas
- Dê um nome curto a todo requisito. Ele é o número em todas as páginas e nos documentos.
- Escreva os valores como atributos, não no doc.
attribute :>> limit = maxCurbMass;pode ser avaliado, checado pela Visão paramétrica e acompanhado pelos vínculos a revisar. - Marque valores em aberto com
#TBDou#TBR, não com "TBD" no valor. O texto continua válido e o registro os encontra. - Mantenha os casos de teste em um pacote próprio. Ele se torna uma suíte de testes na página Casos de verificação.
Erros comuns
- Esperar o Status no texto. Status, Prioridade e Método de verificação são dados do Holarch. Os arquivos de troca não os levam.
- Escrever
limit = TBD. Isso não é SysML válido, e o texto fica como rascunho. Use#TBD attribute limit : TimeValue;. - Remover um requisito de um documento para movê-lo. Remover o exclui do modelo. Em vez disso, mova-o para outro pacote no Editor.
Como se conecta a outros recursos
- Visões: uma Visão de requisitos desenha os mesmos requisitos e relacionamentos satisfy, verify, derive e refine (Vistas SysML v2).
- Simulador: Verificar em relação ao requisito… obtém seu critério do require constraint de um requisito e registra o resultado em um caso de verificação (Avaliação, unidades e análise).
- Documentos: os blocos RTM, RVTM, VCRM, de desdobramento e de matriz de alocação listam os requisitos do modelo.
- Controle de mudanças: as linhas de base guardam o modelo; Comparar lista as alterações de requisitos (Recursos do Holarch em projetos SysML v2).
Requisitos e Qualidade
Página Requisitos
Requisitos é o Banco de dados filtrado pela classe Requirement. Ele tem os filtros, visões, colunas, o modo Árvore, a edição na célula, as ferramentas em lote e as exportações do Banco de dados (Requisitos).
- + Novo adiciona um uso de requisito com o próximo número no pacote Requirements.
- Editar o número, o nome ou a descrição altera o texto do modelo, e um único Desfazer reverte cada alteração.
- As exportações Tabela e Definições incluem Tipo, Tipo, Multiplicidade e Valor e, em um modelo com indivíduos, Individual, Porção e Instâncias.
- Selecionar um requisito o mostra no inspetor SysML v2. Seu vínculo o abre no Navegador.
Não disponíveis para elementos do modelo: Mudar classe, Duplicar, Bloquear e Copiar com filhos, e as exportações Dados do projeto (JSON) e Pacote do projeto (.holarch). Exportar projeto… faz backup do projeto inteiro como .holarch.
Página Qualidade
Qualidade pontua a descrição de cada requisito nos nove critérios dos projetos LML: Apropriado, Completo, Conforme, Correto, Viável, Necessário, Singular, Inequívoco e Verificável (Qualidade de requisitos). A pontuação é dado do Holarch. Uma pontuação marcada como Desatualizado pertence a um texto mais antigo.
Filtre-a como em projetos LML (Filtrar a página Qualidade): + Filtro com os grupos Qualidade, Falha em um critério e Constatação de regra, os atributos e rótulos dos requisitos, termos quality: digitados, texto de pesquisa e Visões ▾.
Controle de mudanças
Vínculos a revisar
Um vínculo requer revisão quando o item na sua outra extremidade mudou depois da última revisão do vínculo (em outras ferramentas, também chamados de vínculos suspeitos): cheque se o vínculo ainda vale e marque-o como revisado. Uma alteração em um requisito marca estes vínculos para revisão: satisfied by (satisfy), verified by (verify), decomposed by (requisitos pertencentes) e traced to (dependency).
Uma alteração é uma edição de qualquer um destes:
- O nome ou o doc do requisito.
- Um atributo-chave: Prioridade, Criticidade, Método de verificação ou Nível de verificação.
- O valor de um atributo que ele possui, como
attribute :>> limit = maxCurbMass;, ou uma de suas restrições. - Um atributo-alvo que esses valores ou restrições nomeiam, como
attribute maxCurbMass : MassValue = 1650 [kg];.
Ela conta onde quer que você a faça: no Editor, em uma visão, no inspetor ou em uma tabela. Uma alteração no Método de verificação ou no Nível de verificação marca para revisão apenas os vínculos verified by, e definir o primeiro não marca nenhum.
A página Vínculos a revisar tem Diff, Mostrar no texto e Marcar como revisado… por vínculo.
Aprovações
Aprovações lista os requisitos Em revisão. O inspetor mostra o status com Aprovar, Rejeitar… e Reabrir, e quem o definiu e quando. O status é dado do Holarch ao lado do modelo; ele não faz parte do texto SysML.
Registro de TBD/TBR
O registro lista cada requisito em aberto com seu responsável, prazo e idade, um gráfico de burn-down dos itens em aberto e Exportar XLSX. Fechar volta o atributo TBD/TBR para Nenhum e remove os metadados TBD/TBR dos valores.
O prazo é o prazo único do requisito, a mesma data de Prazo no grupo Fluxo de trabalho do inspetor e na Visão do item:
- O
duemais cedo dos metadados@TBD/@TBRnos valores do requisito, como@TBD { owner = "Powertrain lead"; due = "2027-06-30"; }. - Caso contrário, o atributo Prazo do TBD.
- Caso contrário, o próprio prazo do requisito.
O registro é somente leitura. Altere a data no texto ou defina Prazo no inspetor. Prazo escreve due = "<date>"; em cada corpo de metadados @TBD/@TBR do requisito (adicionando-o onde o corpo não tem) e define o prazo do requisito, e um único Desfazer reverte tudo. A forma de prefixo #TBD/#TBR não tem corpo, então um valor marcado apenas assim usa o prazo do requisito.
Páginas de verificação
Casos de verificação
Suítes, casos de teste, status, etapas, ciclos de teste, Executar suíte e relatórios funcionam como em projetos LML (Verificação).
- + Novo ▾ → Caso de teste… adiciona um uso de verificação; Suíte de testes… adiciona um pacote.
- Vincular um requisito adiciona um
verifyao objetivo do caso de teste. - Status, resultados esperados e obtidos, etapas e ciclos são dados do Holarch guardados ao lado do modelo.
RVTM
Cada requisito com seu método de verificação, os casos de teste que o verificam e o status consolidado a partir dos sub-requisitos (RVTM). Um ⚠ marca um requisito cujos vínculos satisfy, verify ou de decomposição requerem revisão, e um caso de verificação cujo vínculo verify requer revisão.
Matriz de rastreabilidade
Linhas, colunas e o relacionamento funcionam como em projetos LML (A Matriz de rastreabilidade).
- Assets são os usos de part (as parts do sistema), e Ações são os usos de ação.
- Para um eixo de classe, Elementos → Definições lista as definições em vez disso.
- Entre elementos do modelo, uma célula pode conter satisfied by (
satisfy), verified by (verify), performed by (allocateouperform), traced to (dependency) e decomposed by (propriedade). Outros relacionamentos aparecem como não permitidos. - Cada clique pode ser revertido com um único Desfazer e altera o texto do modelo.
Checagens do modelo
As regras que se aplicam a um modelo são executadas (Checagens do modelo), em termos de SysML v2:
- usos de requisito sem nome, sem nome curto (requisitos folha), sem descrição (própria ou da sua definição), sem
satisfyou semverify, e requisitos folha sem "shall"; - nomes curtos repetidos, palavras vagas, valores vivos que apontam para alvos ausentes, visões UAF que não podem ser mostradas;
- riscos de nível superior em aberto sem mitigação, casos de verificação reprovados sem uma Issue, TPMs que violam seu limite;
- os itens ao lado do modelo (riscos, tarefas, decisões, documentos) com o mesmo nome ou sem relacionamentos.
O checador no Editor cobre nomes, tipos e estrutura, então as regras de análise funcional do LML (Action, Asset, Conduit e Input/Output) não são executadas e Ajustes lista apenas estas regras. Correções por mesclagem não são oferecidas para elementos do modelo.
Mensagens
| Mensagem | Significado e correção |
|---|---|
| Não disponível em projetos SysML v2: altere o modelo no Editor. | A ação funciona apenas com entidades LML. Faça a alteração no Editor. |
| A alteração não foi aplicada. | A edição tornaria o texto inválido. A mensagem ao lado nomeia o problema. |
| Desatualizado — executar novamente | O texto do requisito mudou depois da última checagem de qualidade. Cheque a qualidade de novo. |
| “…” meets “…”, but … does not reach the objective …. | Informação: a part atende ao limite, mas não ao objetivo. Melhore o projeto ou altere o objetivo. |
| “…” has an objective but no threshold to compare it with. … | O requisito tem @Objective, mas nenhuma restrição require que compare uma grandeza com um valor. Adicione uma. |
| “…” has more than one threshold (…), so its objective is ambiguous. … | O requisito compara mais de uma grandeza. Divida-o em um requisito por grandeza. |
| The objective … of “…” is not below (above) its threshold …. | O objetivo precisa ir além do limite: abaixo de um limite superior, acima de um mínimo. |
| The objective … of “…” is in …, but its threshold … is in …. | A unidade do objetivo é de uma grandeza diferente da do limite. Use uma unidade da grandeza do limite. |
| @Objective applies to requirements, but “…” is …. | A anotação está fora de um requisito. Mova-a para dentro de um. |
Limites
- Status, Método de verificação, os outros atributos de requisitos, rótulos e resultados de testes são dados do Holarch. Os arquivos de troca SysML v2 não os levam.
- Mudar classe, Duplicar, Bloquear e Copiar com filhos não estão disponíveis para elementos do modelo.
- Correções por mesclagem em Checagens do modelo não são oferecidas para elementos do modelo.
Páginas relacionadas
- Primeiros passos com projetos SysML v2
- Vistas SysML v2
- O Editor de texto e o Navegador
- Avaliação, unidades e análise em projetos SysML v2
- Requisitos
- Verificação
- Rastreabilidade
SysML® e OMG® são marcas registradas da Object Management Group, Inc. nos Estados Unidos e em outros países.