Tutorial da Ventoinha 1 - Especificar o Produto - Parte 1

Esta página do documento foi substituída e já não é mantida. Para consultar o tutorial mais atual, veja a seguinte página: Especificar o Produto.

Neste tutorial, iremos percorrer um dos principais fluxos de utilizador que o podem ajudar a começar a utilizar o Requirements & Systems Portal:

  • Recolher e escrever requisitos

  • Decompor requisitos

  • Rever e melhorar requisitos

  • Aprovar e publicar especificações

Os dois primeiros aspetos, ou seja, "Gather and write requirements" e "Breakdown requirements", são abordados na Parte 1, e os restantes na Parte 2 do tutorial Especificar o Produto. Este primeiro tutorial demorará aproximadamente 15-20 minutos a concluir.  Todos os valores e requisitos são arbitrários.

(1) Criar um Novo Projeto

Se estiver a aceder ao Requirements & Systems Portal pela primeira vez, pode avançar para a Figura Quickstart Feature.

 

  • No canto superior esquerdo (ver Figura Creating a New Project), clique no menu pendente do projeto (1).

  • Na lista de projetos, selecione + Create new project (2)

image-20240320-163009.png

Criar um Novo Projeto - Pode criar um novo projeto clicando em “+ Criar novo projeto“

 

  • Depois de selecionar esta opção, será encaminhado para a nossa funcionalidade “Quickstart” (ver Figura Quickstart Feature). Clique na opção Simple Create para um “Projeto vazio”

Funcionalidade Quickstart - A partir daqui, pode criar um novo projeto de várias formas. Para este tutorial, selecione “Criação simples“.

 

  • Depois de clicar em Simple Create , ser-lhe-á pedido que "Introduza um nome de projeto único (ainda não existente)" (por exemplo, ValiFan_yourname) (1) e prima Create Project (2). Isto também é mostrado na Figura Setting up a Project Name.  Nas Permissões do Projeto, pode optar por utilizar as mesmas permissões do workspace, o que significa que os utilizadores que têm acesso ao workspace também terão acesso ao projeto. Também pode configurar permissões personalizadas para selecionar as permissões dos utilizadores manualmente. Para este tutorial, selecione “Usar permissões do workspace (Leitura & Escrita)” nas Permissões do Projeto.

O nome do projeto não reconhece caracteres especiais, exceto “_” e “-”.  Também não são aceites espaços.

Configurar um Nome de Projeto - Aqui, pode escolher o nome do projeto e as permissões. Para este tutorial, deixe as permissões como estão por agora.

 

  • Depois de o projeto ser criado, verá automaticamente o “Dashboard” predefinido.

  • Navegue até About (1) no painel de navegação à esquerda e, se quiser, adicione informações sobre o seu projeto. Aqui, também pode alterar o nome do seu projeto (2) a qualquer momento (ver Figura About Project Page).

  • Pode sempre recolher ou expandir o painel principal de navegação clicando na seta (3) junto ao mesmo.

image-20240320-163942.pngPágina Sobre o Projeto - Aqui são apresentadas informações cruciais do projeto, como o nome, a descrição, a imagem e as datas de início e fim.

(2) Definir Requisitos das Partes Interessadas - Importar Requisitos


Most system design and development follows the V cycle. The first process in a V cycle is understanding the business needs and eliciting the stakeholders' needs. These stakeholder needs are then converted to Stakeholder Requirements. The stakeholder's requirements can be directly created, imported through CSV/XLSX, or even created through the AI-powered “ValiAssistant.”  For this section, we will concentrate on the import method.

Recebemos um ficheiro das nossas partes interessadas e vamos importar estes requisitos.


Para o fazer, transfira o seguinte ficheiro CSV:

Valifan_stakeholder_Requirements.csv

  • Vá para o Módulo de Requisitos (ver Figura Requirements Module) clicando em Requirements no painel de navegação à esquerda (1)

  • Ao entrar no Módulo de Requisitos, clique em Import Requirements (2)

 

Módulo de Requisitos - Este é o Módulo de Requisitos do Requirements & Systems Portal. Aqui, iremos carregar os Requisitos das Partes Interessadas.

 

Depois de selecionar a opção, pode escolher uma especificação ou criar uma diretamente no assistente de importação. Vamos criar a especificação no assistente de importação (ver Figura Import Wizard 1).

  • Selecione Create a Specification, escreva Stakeholder_requirements, e clique em Continue.

 

image-20240320-165544.png

Assistente de Importação 1 - No primeiro passo, criamos a especificação onde os requisitos serão armazenados.

 

O passo seguinte é carregar o CSV para que o assistente de importação possa ler e importar o ficheiro. Depois de concluída a importação, pode utilizar uma funcionalidade chamada “Valify“, que transforma parâmetros baseados em texto em referências que armazenam o valor e a unidade, também chamadas Valis. Isto é mostrado na imagem abaixo.

 

Durante a importação de requisitos, demonstrámos uma funcionalidade chamada "Valify." Depois de mapear os atributos e importar os requisitos, verá um ecrã de mensagem onde pode selecionar “Check Now” para utilizar a funcionalidade “Valify”.

A opção “Valify” permite-lhe converter automaticamente os valores numéricos em valis do requisito. Os valis são parâmetros técnicos de blocos, requisitos ou análises que podem ser utilizados em cálculos e documentação. Um vali tem um valor numérico e contém informações adicionais, como tipo, unidade, fórmula, descrição e requisitos mínimos/máximos.

No futuro, à medida que o projeto avança, poderá comparar os valis do requisito com os valis do design no Módulo de Design de Sistema.

(3) Adicionar Requisitos de Sistema

In a typical system engineering flow, the system's requirements are created with the help of the stakeholder requirements.  Most technical developments are designed against strict requirements, e.g.  mass, power consumption, and budget. Requirements & Systems Portal maintains a complete overview of whether your design fulfills all of these requirements.

Agora, vamos criar manualmente alguns requisitos de sistema (ver Figura Creating the Fan Specification)

  • Clique em + Specification (1) e introduza Fan_Specs (2) e clique em Create (3)

Criar a Especificação da Ventoinha - Criar manualmente uma especificação no Requirements & Systems Portal é fácil.
  • Na Figura, Create a new requirement manually, clique em Fan_Specs (1). Dentro desta especificação, clique em Create Requirements(2). Em alternativa, também pode clicar no botão azul “Adicionar requisito” no canto superior direito Add Requirement (3).

Criar manualmente um novo requisito.

 

  • No menu pop-up, verifique se selecionou a especificação correta. Depois, adicione um identificador único (1), por exemplo, R-Fan-001 e escreva The Mass of the fan shall not exceed 300g em “Texto do requisito” (2).

 

image-20240731-112927.pngCriar manualmente um novo requisito - Aqui, pode adicionar o Identificador, Título, Texto e até a Fundamentação do seu Requisito.

Ter a marca de verificação em Check for possible Valis verifica os valores numéricos no requisito e converte-os diretamente em valis através da funcionalidade Valify.

  • Utilizando o mesmo método, mas sem assinalar Check for possible Valis, crie outro requisito chamado R-Fan-002 com o texto do requisito: The Mass of the propeller shall not exceed 50g.

image-20240731-113013.pngNos dois requisitos da Especificação da Ventoinha, o R-Fan-001 tem um vali e o R-Fan-002 ainda não tem um vali.

Para o segundo requisito, durante a criação, não utilizámos a funcionalidade “Valify”. Caso não queira utilizar o Valify automaticamente, tem a opção de criar valis manualmente dentro de um requisito. Vamos ver como o podemos fazer.

Criar Valis de Requisito dentro de um Requisito

  • Faça duplo clique na coluna de texto do Requisito R-Fan-002 e elimine 50g.

  • Escreva $ e abrir-se-á uma janela pop-up com a lista de valis/objetos dentro do projeto.

  • No canto superior direito da caixa de diálogo, selecione o ícone + para criar um Vali.

  • Introduza os seguintes detalhes. Name: req_mass_propeller, Formula and unit: 50g and Display unit: g

Veja como isto é feito na demonstração interativa abaixo:

Criar Manualmente um Vali de Requisito - Experimente!

Decompor Requisitos com Relações de Pai e Filho

Observe a Figura Enable Columns para ver como ativar mais colunas na sua tabela de requisitos.

  • Clique em column (1) no lado direito da tabela

  • Verifique se as caixas Parents e Children estão assinaladas (2)

Ativar Colunas - Verifique se as colunas de pais e filhos estão assinaladas

.

  • Ativar Colunas - verifique se as colunas de pais e filhos estão assinaladas

  • Na tabela de requisitos, encontre o segundo requisito que criou (R-Fan-002). Na coluna Parents , faça duplo clique na célula (1)

  • No menu pendente, escreva R-Fan-001 para ligar ambos os requisitos. Note que os filhos são automaticamente adicionados ao requisito R-Fan-001

  • Depois de fazer isto, os seus requisitos deverão ficar assim:

image-20240324-114433.pngCriar relação pai-filho - Ao fazer duplo clique em Pais ou Filhos, pode atribuir herança entre requisitos.
  • Ao clicar no separador Connections Graph (2 na Figura Creating parent_child relationship) localizado na parte superior central da tabela de requisitos, pode ver e verificar esta relação (ver Figura Connection Graph)

image-20240731-114240.pngGrafo de Ligações - O Grafo de Ligações mostra a relação pai-filho da especificação selecionada. As caixas azuis à volta dos requisitos indicam a especificação em que se encontram.

Experimente isto: Pode gerar requisitos/decompor requisitos através do ValiAssistant. Por exemplo, clique em ValiAssitant, escolha a opção Generate Requirements e escreva um prompt como Create 2 safety requirements for designing a fan.

Lembre-se de que o ValiAssistant é alimentado por um LLM (Large Language Model) e os resultados dos requisitos gerados podem variar.

Os passos são mostrados na demonstração interativa abaixo:

Gerar Requisitos de Segurança através do ValiAssistant com um Prompt.

AI-LocalizedLocalizado por IA
Caso encontre um problema, selecione o texto/imagem e primaCtrl + Enterpara nos enviar o seu feedback.
Disponibilidade de Funcionalidades

As funcionalidades disponíveis dependem da solução Altium que possui – Altium Develop, uma edição do Altium Agile (Agile Teams ou Agile Enterprise), ou Altium Designer (com subscrição ativa).

Se não encontrar uma funcionalidade mencionada no seu software, contacte a equipa de Vendas da Altium para saber mais.

Conteúdo