Exemplos de Ações Personalizadas utilizando o Valiassistant

Aqui estão alguns scripts de exemplo que podem ser implementados em conjunto com as Ações Personalizadas. Sempre que for indicado AI, o script utiliza um prompt personalizado que é enviado juntamente com informações dos Requirements, Blocks ou Valis para a AI, que analisa os dados, tem em consideração o prompt personalizado e envia uma resposta de volta para o Requirements & Systems Portal, que depois pode ser escrita novamente no objeto no Requirements & Systems Portal. Sinta-se à vontade para adaptar estes scripts de exemplo às suas necessidades e casos de utilização.

Sugestão de Título por AI

Este script utiliza AI para criar um título curto, mas preciso, para os seus requisitos individuais.

AI_Title_Suggestion.txt

O prompt personalizado utilizado é:

custom_prompt = "Based on the Text provide a short Title for this Requirement in the context of System Engineering. Do not include any numbers or Units in the title. Only return the title and no other text."

que é enviado juntamente com o texto do Requirement para a AI.

Sugestão de Tipo de Requirement por AI

Este script utiliza AI para categorizar os seus Requirements em tipos específicos, como “Functional”, “Performance” ou “System”, com base no texto do Requirement. Todos os tipos definidos nas definições do Requirements & System Portal são tidos em consideração.

AI_Type_Suggestion.txt

O prompt personalizado utilizado é:

custom_prompt = "Respond only with the type. Take into consideration the following types: {types_string}. Based on the requirement text categorize the provided Requirement into one of the provided types ({types_string}). Return only the type in the form of 'type'."

Verificação da Qualidade dos Requirements por AI

Este script verifica a qualidade do texto do seu Requirement em relação às normas INCOSE da indústria e fornece uma resposta quantitativa e qualitativa sob a forma de uma etiqueta de qualidade e de uma sugestão de melhoria.

AI_Quality_Check.txt

O prompt personalizado utilizado inclui as regras INCOSE mais relevantes:

custom_prompt = """
        Considere as seguintes normas INCOSE para a redação de Requirements:
        R1 - Utilize uma frase estruturada e completa: sujeito, verbo, objeto. 
        R2 - Utilize a voz ativa na estrutura principal da frase da necessidade ou da declaração do requisito, com a entidade responsável claramente identificada como sujeito da frase. 
        R3 - Certifique-se de que o sujeito e o verbo da declaração da necessidade ou do requisito são adequados à entidade a que a necessidade ou o requisito se refere. 
        R5 - Utilize o artigo definido “the” em vez do artigo indefinido “a”.
        R6 - Utilize unidades adequadas ao indicar quantidades. Todos os números devem ter unidades de medida explicitamente indicadas.
        R7 - Evite a utilização de termos vagos como “some”, “any”, “allowable”, “several”, “many”, “a lot of”, “a few”, “almost always”, “very nearly”, “nearly”, “about”, “close to”, “almost” e “approximate”. 
        R8 - Evite cláusulas de escape como “so far as is possible”, “as little as possible”, “where possible”, “as much as possible”, “if it should prove necessary”, “if necessary”, “to the extent necessary”, “as appropriate”, “as required”, “to the extent practical” e “if practicable”. 
        R9- Evite cláusulas em aberto como “including but not limited to”, “etc.” e “and so on”. 
        R10 - Evite infinitivos supérfluos como “be designed to”, “be able to”, “be capable of”.  
        R12, 13, 14 - Utilize gramática, ortografia e pontuação corretas.
        R15 - Utilize uma convenção definida para expressar expressões lógicas como “[X AND Y]”, “[X OR Y]”, [X XOR Y]”, “NOT[X OR Y]”.
        R16 - Evite a utilização de “not” 
        R17 - Evite a utilização do símbolo de barra oblíqua ("/"), exceto em unidades, por exemplo km/hr
        R18 - Escreva uma única frase que contenha uma única ideia, condicionada e qualificada por subcláusulas relevantes.
        R19 - Evite combinadores que unem cláusulas, como “and”, “or”, ”then”, ”unless”, ”but”, ”as well as”, ”but also”, ”however”, ”whether”, ”meanwhile”, ”whereas”, ”on the other hand” ou ”otherwise”. 
        R20 - Evite expressões que indiquem a finalidade da necessidade ou do requisito. 
        R21 - Evite parênteses e colchetes que contenham texto subordinado.
        R22 - Enumere explicitamente os conjuntos em vez de utilizar um nome coletivo para designar o conjunto. 
        R24 - Evite a utilização de pronomes e pronomes indefinidos.
        R26 - Evite utilizar absolutos inatingíveis como 100'%' reliability, 100'%' availability, all, every, always, never, etc.
        R28 - Expresse explicitamente a natureza proposicional de uma condição para uma única ação, em vez de apresentar listas de ações para uma condição específica.
        R29 - Classifique as necessidades e os requisitos de acordo com os aspetos do problema ou do sistema que abordam. 
        R31 - Ao definir entradas de projeto, evite indicar uma solução, a menos que exista uma justificação para restringir o projeto. Foque-se no problema “what” em vez da solução “how”. 
        R32 - Utilize “each” em vez de “all”, “any" ou “both” quando se pretende quantificação universal. 
        R33 - Defina quantidades com um intervalo de valores adequado à entidade a que se aplicam e em relação ao qual a entidade será verificada ou validada.
        R34 - Forneça metas de desempenho específicas e mensuráveis adequadas à entidade à qual a necessidade ou o requisito é declarado e em relação às quais a entidade será verificada para confirmar o cumprimento.
        R35 - Defina explicitamente dependências temporais em vez de utilizar palavras-chave temporais indefinidas como “eventually”, “until”, “before”, “after”, “as”, “once”, “earliest”, “latest”, “instantaneous”, “simultaneous”, “at last”.
        R38 - Evite a utilização de abreviaturas.
        Com base nestas normas INCOSE para Requirements, devolva-me APENAS um dicionário com o quality_score_of_the_requirement_text de 0 a 100 e um comment_for_improvement correspondente, na forma de:
        {'Score': quality_score_of_the_requirement_text, 'Comment': comment_for_improvement}.
        """

Relatório de Inconsistências por AI no Módulo de Análise

Este script executa a funcionalidade “Find Inconsistencies” do ValiAssistant e gera um relatório no Módulo de Análise, que depois pode ser exportado ou partilhado.

AI_Inconsistency_Report.txt

Relatório de Análise de Impacto no Módulo de Análise

Este script realiza uma análise ao Requirement selecionado para verificar que outros Requirements, Blocks e Test Runs podem ser afetados por uma alteração no respetivo campo de texto. O script prepara um relatório no Módulo de Análise, que depois pode ser exportado ou partilhado.

Basic_Impact_Analysis.txt

Este script de Análise de Impacto não utiliza AI, mas pode ser alargado para incluir uma avaliação por AI sobre a gravidade do impacto em cada um dos objetos relacionados.