Especificar o produto

Nesta parte do tutorial, vamos percorrer um dos principais fluxos de utilizador que lhe pode permitir começar a utilizar o Requirements & Systems Portal:

• Recolher e escrever requisitos

• Decompor requisitos

• Rever e melhorar requisitos

• Aprovar e publicar especificações

Criar um Novo Projeto

1. Na página Home do Requirements & Systems Portal (acedida quando abre o Requirements & Systems Portal a partir do menu de nove pontos no canto superior direito da interface do Workspace baseada no navegador – ), clique no botão acima da lista de projetos de requisitos.

   

2. A janela Create Requirements Project será aberta, onde pode especificar os detalhes do projeto:

   • Project Name – introduza um nome de projeto adequado (e único) (por exemplo, Valifan).

   • Description – introduza uma descrição opcional para o projeto (por exemplo, Amazing Valifan project).

   • Electronics Project – deixe este campo em branco. 

   Depois de especificar os detalhes do projeto, clique no botão .

   

3. O projeto de requisitos aparecerá na lista da página Home. Clique no respetivo nome para o abrir num novo separador do navegador.

   

4. Navegue até ao Módulo do Projeto clicando no ícone na barra de Navegação de Módulos à esquerda e selecione a entrada About na lista Overview. A partir daqui, pode alterar o nome e a descrição do seu projeto em qualquer altura.

   
   As informações básicas do projeto, como nome, descrição, imagem e datas de início e fim, estão disponíveis na página About Project.

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

Definir Requisitos das Partes Interessadas

A maior parte da conceção e desenvolvimento de sistemas segue o ciclo V. O primeiro processo num ciclo V é compreender as necessidades do negócio e identificar as necessidades das partes interessadas. Estas necessidades das partes interessadas são depois convertidas em requisitos das partes interessadas, que podem ser criados diretamente, importados através de CSV/XLSX ou até criados através do ValiAssistant com tecnologia de IA. Nesta parte do tutorial, vamos focar-nos no método de importação.

1. Transfira o seguinte ficheiro CSV que contém requisitos das partes interessadas:

   Valifan_stakeholder_Requirements.csv

2. Navegue até ao Módulo de Requisitos clicando no ícone na barra de Navegação de Módulos à esquerda.

3. Clique no botão na página que se abre e selecione Import Requirements no menu apresentado.

   

4. Na janela Document Importer que se abre, clique na ligação open the legacy importer here.

   

5. O assistente Import Requirements será aberto. Na área Create a specification, defina o Name da especificação (por exemplo,Stakeholder_requirements) e depois clique no botão .

   

6. O passo seguinte é carregar o CSV para que o assistente de importação possa ler e importar o ficheiro. Arraste e largue o ficheiro CSV transferido na área Drop file do assistente Import Requirements (ou clique na área para carregar o ficheiro através de uma caixa de diálogo).

   

    Clique em  para continuar.

7. No passo seguinte, certifique-se de que as colunas de dados do ficheiro CSV estão corretamente mapeadas para as colunas no Requirements and Systems Portal. Se necessário, utilize as listas pendentes Map To no topo da tabela. 

   

   Clique em  para continuar.

8. A página seguinte do assistente irá notificá-lo sobre a importação bem-sucedida. Clique no controlo Check now no topo da janela para converter valores e unidades em parâmetros (valis), seguindo uma abordagem de engenharia de sistemas orientada por dados.

   

9. Na janela Valify Requirements que se abre, será informado de que os cinco requisitos vão ser valificados. Clique em para continuar e receber uma notificação de que foram encontrados dois valis. Clique em para continuar e depois clique em .

   

10. Como pode ver, 50 dB e 50 W foram transformados de texto simples em valis que podemos utilizar mais tarde.

    

    Feche a janela Valify Requirements para continuar. Todos os requisitos foram adicionados e todos os valores detetados foram transformados em valis. Os valis são realçados nos requisitos.

    

Adicionar Requisitos de Sistema

Num fluxo típico de engenharia de sistemas, os requisitos de sistema são criados com base nos requisitos das partes interessadas. A maioria dos projetos técnicos tem de cumprir requisitos rigorosos, como requisitos de massa, consumo de energia e custo. O Requirements & Systems Portal fornece uma visão abrangente de quão bem um design cumpre todos estes requisitos.

Agora, vamos criar manualmente alguns requisitos de sistema.

1. Clique no botão . Na janela Create new specification que aparece, introduza Fan_Specs no campo Name e clique em .

   

2. Clique na entrada da especificação recém-criada na lista do lado esquerdo. Quando estiver nesta especificação, clique no botão  e selecione Create Requirement no menu apresentado.

   

3. A janela Create Requirement será aberta. Nesta janela:

   1. No campo Identifier, introduza um identificador único, por exemplo, R-Fan-001.

   2. No campo Text, introduza The Mass of the fan shall not exceed 300g.

   3. Clique no botão e certifique-se de que a especificação correta está selecionada (Fan_Specs) no campo Specification.

   4. Certifique-se de que a opção Parametrize values está ativada.

      Quando esta opção está ativada, os valores numéricos dentro do requisito são verificados e convertidos diretamente em valis através da funcionalidade Valify.

   5. Clique no botão .

   

4. De forma semelhante, adicione outro requisito com o identificador R-Fan-002 e o texto de requisito The Mass of the propeller shall not exceed 50g, mas desta vez desative a opção Parametrize values (mais tarde será criado manualmente um vali a partir de um valor dentro deste requisito).

   

5. Os requisitos adicionados serão listados quando a especificação Fan_Specs estiver selecionada. Note que, enquanto R-Fan-001 tem um vali, R-Fan-002 ainda não tem um vali.

   

Criar Valis de Requisito dentro de um Requisito

Agora, vamos criar manualmente um novo vali dentro do campo de texto do requisito.

1. Faça duplo clique na célula da coluna Text do requisito R-Fan-002 e elimine o texto 50g.

   

2. Escreva $ para mostrar uma janela pop-up com uma lista de valis/objetos dentro do projeto. No canto superior direito da janela pop-up, clique no botão para criar um vali.

   

3. Na janela Create new que se abre. No separador Vali da janela, introduza os seguintes dados para o novo vali:

   1. Name: Req_Mass_Propeller

   2. Formula and unit: 50g

   3. Display unit: g

      O campo Display unit é opcional. Se for deixado vazio, obterá a unidade do campo Formula and unit.

   

4. Clique no botão para criar um novo vali e inseri-lo no campo Text do requisito e depois prima Enter ou clique algures na tabela fora da célula para terminar a edição.

5. Agora, o texto 50g aparece de forma diferente do texto normal, o que indica um vali. Este vali pode agora ser utilizado em diferentes partes do projeto (por exemplo, relatórios, Módulo de Design de Sistema, verificação, etc.).

   

Decompor Requisitos com Relações de Pai e Filho

1. Clique no controlo Columns à direita da tabela e certifique-se de que as entradas das colunas Parents e Children estão assinaladas para que sejam mostradas na tabela.

   

   Clique novamente no controlo Columns para ocultar a lista.

2. Faça duplo clique na célula da coluna Parent do requisito R-Fan-002 e selecione o requisito R-Fan-001 na janela pop-up para ligar ambos os requisitos. Note que R-Fan-002 será automaticamente adicionado à coluna Children de R-Fan-001.

   ❯ ❮ Javascript ID: RSP_FanTutorial_Requirements_ParentsChildren_Add

3. Clique no separador Connections no topo da tabela de requisitos para abrir um gráfico de ligações que mostra a relação pai-filho da especificação selecionada.

   As caixas azuis em torno dos requisitos indicam a especificação em que se encontram.

   

Gerar Requisitos Utilizando o ValiAssistant

 Para acelerar o seu processo de gestão de requisitos, pode gerar requisitos/decompor requisitos utilizando a funcionalidade de IA ValiAssistant. Vamos utilizá-la para criar dois requisitos de segurança para o projeto do tutorial.

1. Clique no botão  no topo para abrir a janela ValiAssistant - Generate Requirements.

   

   A funcionalidade sugere diferentes opções de utilização da IA nos requisitos, incluindo gerar requisitos, decompor requisitos, criar um resumo, validar requisitos, detetar inconsistências, etc.

   Certifique-se de que a opção Generate Requirements está selecionada e clique no botão .

2. Na página seguinte, pode descrever o seu produto, sistema, subsistema e fornecer o máximo de informação possível para que a IA possa criar os melhores requisitos para a sua descrição. Como estamos interessados em requisitos de segurança, peça dois requisitos de segurança para a nossa ventoinha, introduzindo o texto Create 2 safety requirements for designing a fan no campo sob o cabeçalho Generate Description.

   No campo de texto sob o cabeçalho Customize ValiAssistant output, pode personalizar ainda mais o pedido. Estamos à procura de requisitos escritos segundo a norma INCOSE; introduza o texto Apply the INCOSE guide to writing requirements no campo.

   

   Clique em  para continuar.

3. Na página seguinte, será apresentado o resultado da IA, e poderá rever, alterar e aceitar ou rejeitar quaisquer sugestões.

   

   Clique em  para continuar.

4. Feche a janela que o informa sobre a geração bem-sucedida dos requisitos. Os requisitos gerados serão apresentados na tabela da especificação Fan_Spec.

   

Atualizar, Gerir e Rever Requisitos

Ao longo do processo de desenvolvimento, é comum que os requisitos evoluam e sejam atualizados com base em vários fatores, como contributos das partes interessadas e restrições de conceção. No Requirements & Systems Portal, pode atualizar diretamente os requisitos fazendo duplo clique nos campos das colunas ou na secção de detalhes do requisito, sendo todas as alterações registadas no histórico para fácil referência.

1. Entre no modo de edição do texto do requisito R-Fan-003 ou R-Fan-004 fazendo duplo clique na respetiva célula na coluna Text. Altere o texto para The fan shall include a protective guard with openings no larger than inches to prevent accidental contact with moving parts. e prima Enter ou clique em qualquer ponto da tabela fora da célula para terminar a edição.

   ❯ ❮ Javascript ID: RSP_FanTutorial_Requirements_UpdateManageReview

2. Clique no identificador do requisito para abrir a vista detalhada do requisito, a partir da qual pode ajustar campos adicionais, subscrever, definir proprietários, adicionar uma justificação, criar relações pai/filho, etc.

   

3. A rastreabilidade é um conceito-chave do Requirements & Systems Portal, e todas as alterações são registadas no histórico dos requisitos e de outros objetos. Clique em History para abrir uma vista que lhe fornece informações sobre versões, quem efetuou uma alteração e quando, bem como campos e ações.

   

Criar Discussões sobre um Requisito

A colaboração e as revisões são cruciais para garantir que os requisitos são discutidos e avaliados de forma exaustiva. O Requirements & Systems Portal oferece funcionalidades poderosas como discussões, tarefas e o centro de revisões para facilitar estas etapas cruciais.

Nesta parte do tutorial, verá como pode utilizar eficazmente as discussões para participar em conversas significativas com os seus grupos ou colegas, promovendo a colaboração e garantindo o melhor resultado possível para o seu projeto.

1. Clique no botão no campo Identifier do requisito R-Fan-002 e selecione o comando Add » Discussion no menu apresentado.

   

2. A janela Discussions relating to será aberta. Nesta janela, pode ver todas as discussões, comentar discussões existentes e iniciar novas. Escreva @ no campo de texto da janela para mostrar uma lista pendente de utilizadores.

   

3. Selecione qualquer utilizador da lista (o utilizador identificado receberá uma notificação) e adicione o seguinte texto: Is it feasible to have propellers for 50g, or do we need more mass allocation?

   

4. Clique em e depois em na janela Discussions relating to. A discussão será adicionada, e o ícone será apresentado na tabela de especificações.

   

5. Clique no ícone no topo da página para abrir o painel Discussions, a partir do qual tem acesso a todas as discussões sobre a especificação ou sobre todo o módulo. As discussões podem ser iniciadas em praticamente qualquer objeto no Requirements & Systems Portal.

   

Validar Requisitos

Nas fases iniciais do ciclo de vida do produto, é crucial validar os requisitos antes de avançar com o processo de conceção. O Requirements & Systems Portal fornece uma forma conveniente de gerir os estados dos requisitos utilizando a coluna State. Por predefinição, estão incluídos estados como Draft, In Review e Final, mas pode adicionar estados adicionais com base nas suas necessidades específicas.

Nesta parte do tutorial, irá atribuir o estado Draft aos requisitos recentemente adicionados, garantindo um fluxo de trabalho estruturado e organizado.

1. Quando estiver na especificação Fan_Spec, clique no controlo Columns à direita da tabela e certifique-se de que a entrada da coluna State está assinalada para que seja apresentada na tabela.

   

2. Assinale a caixa à esquerda do cabeçalho da coluna Identifier para selecionar todos os requisitos da especificação.

   

3. Faça duplo clique numa célula da coluna State para abrir uma lista pendente com as opções disponíveis para o estado.

   

4. Selecione Draft na lista pendente e confirme a atualização. Todos os requisitos ficarão com o estado Draft.

   

Criar uma Análise/Documentação

Como engenheiro, poderá ter de criar uma análise para tirar partido dos seus dados de engenharia e documentar as propriedades da sua conceção. O Requirements & Systems Portal permite-lhe criar documentação interna onde pode obter e referenciar os dados necessários.

Nesta parte do tutorial, irá adicionar uma análise descritiva utilizando o Módulo de Análises.

1. Navegue até ao Módulo de Análises clicando no ícone ​ na barra de navegação do módulo à esquerda.

2. Clique no botão  na página que se abre para criar uma nova análise. Na janela Create Document que se abre, introduza Project_Summary no campo Document Name e clique em .

   

3. Será aberta uma nova análise.

   Utilizando o botão no painel de navegação à esquerda, pode criar uma pasta para organizar os seus relatórios.

   Uma análise consiste em blocos, que podem ser textos, imagens, vídeos, gráficos ou tabelas. Clique dentro do bloco 1. Write heading... existente e escreva Introduction.

   

4. Clique dentro do bloco Write text... existente e adicione a seguinte frase: The ValiFan is designed in a way that it works with less power than conventional Fans.

   

5. Clique fora do bloco para guardar o conteúdo.

6. Podem ser adicionados blocos adicionais de diferentes tipos (texto, imagens, referências a requisitos e valis, orçamentos, gráficos ou diagramas). Vamos criar uma tabela de requisitos a partir das especificações das partes interessadas. Clique no controlo Click to add new block e, na janela Add Block que se abre, expanda a entrada Table e selecione Requirements.

   

7. Será adicionada uma tabela que mostra todos os requisitos do seu projeto. Vamos ver como podemos mostrar apenas os requisitos relacionados com a especificação das partes interessadas. Para isso, passe o cursor sobre o cabeçalho da coluna Text e clique no ícone que aparece.

   

8. Na janela emergente que se abre, clique no ícone para mostrar uma lista das colunas disponíveis. Desmarque todas as entradas de coluna na lista e selecione apenas as entradas Text e Specification.

   

9. Passe o cursor sobre o cabeçalho da coluna Specification, clique no ícone e, em seguida, clique no ícone na janela emergente apresentada para aceder às opções de filtro. Desative a entrada da especificação Fan_Specs e mantenha a entrada Stakeholder_requirements ativada.

   

10. Agora, são mostrados apenas os requisitos da especificação Stakeholder_requirements. Os filtros podem ser aplicados a qualquer coluna, proporcionando flexibilidade na forma como os requisitos são apresentados. 

    

11. Pode partilhar a análise criada com os seus colegas, partes interessadas ou qualquer pessoa fora do Requirements & Systems Portal. Para isso, clique no botão no canto superior direito da página e selecione Share no menu apresentado. Na janela Share analysis que se abre, selecione qualquer utilizador na lista pendente View as e clique no botão . Isto cria uma nova ligação que pode copiar e partilhar.

    

    • A análise partilhada é uma vista Web do documento que é criada no Requirements & Systems Portal e que se mantém atualizada com as alterações mais recentes.

    • A vista Web pode ser acedida por qualquer pessoa, sem que lhe seja concedido acesso ao seu Workspace.