Importação de especificações a partir de ficheiros de documentos Word

Descrição geral

Esta ferramenta permite aos utilizadores importar documentos Word estruturados para o Requirements & Systems Portal. Foi desenvolvida para ler documentos Word formatados que seguem diretrizes específicas e automatizar a transferência de requisitos diretamente para o Requirements & Systems Portal. Esta documentação fornece os passos e as orientações necessários para preparar os seus documentos e utilizar a ferramenta de forma eficaz.

Diretrizes de formatação

Para garantir a importação bem-sucedida do seu documento, este deve ser formatado de acordo com as seguintes normas:

• Specification Name: Utilize "Heading 1" para assinalar o nome da especificação.

• Sections and Sub-sections: Utilize "Heading 2", "Heading 3" e subtítulos adicionais para indicar diferentes secções e subsecções do documento.

• Requirement Identifier: Crie e aplique um estilo de parágrafo personalizado com o nome "ReqID" aos parágrafos que definem o identificador do requisito. Este identificador é essencial para mapear corretamente os dados no Requirements & Systems Portal.

• Requirement Text: O corpo do requisito deve vir imediatamente a seguir ao parágrafo "ReqID" e ser formatado com o estilo "Normal".

• Tables and Images: Inclua tabelas e imagens diretamente no documento. As tabelas serão importadas para o Requirements & Systems Portal em conformidade, e as imagens serão anexadas aos respetivos requisitos.

Ficheiros e transferências

Documento de exemplo

• Airplane Standards Example.docx: Utilize este documento como modelo para compreender como formatar corretamente os seus requisitos. É fundamental que o seu documento corresponda à estrutura demonstrada neste exemplo.

Airplane Standards Example.docx

Script de importação

• import_to_valispace.py: Este script Python lê o documento Word formatado e importa os dados para o Requirements & Systems Portal.

Word_specification_importer.py

Instruções de utilização

1. Prepare Your Document: Formate o seu documento Word de acordo com as diretrizes do "Airplane Standards Example.docx".

2. Run the Script: Execute o script no módulo de scripting do Requirements & Systems Portal, utilizando o token de acesso temporário para autenticação. Também pode ser modificado para ser executado a partir do ambiente de trabalho do utilizador.

Declaração de exoneração de responsabilidade

Esta ferramenta é fornecida "tal como está", sem quaisquer garantias de desempenho ou adequação a uma finalidade específica. Serve como exemplo e poderá necessitar de modificações para funcionar com a sua configuração específica do Requirements & Systems Portal.

Licenciamento

Este script e a documentação que o acompanha são disponibilizados ao abrigo da Licença MIT. Pode modificá-los, distribuí-los e utilizá-los conforme necessário, sujeito aos termos desta licença.

Agradecimentos

Para obter assistência, enviar comentários ou partilhar a sua experiência com esta ferramenta, contacte-nos.