Importación de especificaciones desde archivos de documentos de Word

Descripción general

Esta herramienta permite a los usuarios importar documentos de Word estructurados a Requirements & Systems Portal. Fue desarrollada para leer documentos de Word con formato que sigan directrices específicas y automatizar la transferencia de requisitos directamente a Requirements & Systems Portal. Esta documentación proporciona los pasos y las directrices necesarios para preparar sus documentos y utilizar la herramienta de forma eficaz.

Directrices de formato

Para garantizar la importación correcta de su documento, este debe estar formateado de acuerdo con los siguientes estándares:

• Specification Name: Utilice "Heading 1" para marcar el nombre de la especificación.

• Sections and Sub-sections: Use "Heading 2", "Heading 3" y otros subencabezados para indicar las diferentes secciones y subsecciones del documento.

• Requirement Identifier: Cree y aplique un estilo de párrafo personalizado llamado "ReqID" a los párrafos que definen el identificador del requisito. Este identificador es fundamental para asignar correctamente los datos en Requirements & Systems Portal.

• Requirement Text: El cuerpo del requisito debe ir directamente después del párrafo "ReqID" y estar formateado con el estilo "Normal".

• Tables and Images: Incluya tablas e imágenes directamente en el documento. Las tablas se importarán a Requirements & Systems Portal según corresponda, y las imágenes se adjuntarán a los requisitos respectivos.

Archivos y descargas

Documento de ejemplo

• Airplane Standards Example.docx: Utilice este documento como plantilla para comprender cómo dar formato correctamente a sus requisitos. Es fundamental que su documento coincida con la estructura mostrada en este ejemplo.

Airplane Standards Example.docx

Script de importación

• import_to_valispace.py: Este script de Python lee el documento de Word formateado e importa los datos a Requirements & Systems Portal.

Word_specification_importer.py

Instrucciones de uso

1. Prepare Your Document: Formatee su documento de Word de acuerdo con las directrices de "Airplane Standards Example.docx".

2. Run the Script: Ejecute el script en el módulo de scripting de Requirements & Systems Portal utilizando el token de acceso temporal para la autenticación. También puede modificarse para ejecutarse desde el entorno de escritorio del usuario.

Aviso legal

Esta herramienta se proporciona "tal cual", sin garantías de rendimiento ni de idoneidad para un propósito particular. Sirve como ejemplo y puede requerir modificaciones para funcionar con su configuración específica de Requirements & Systems Portal.

Licencia

Este script y la documentación adjunta se publican bajo la licencia MIT. Puede modificarlos, distribuirlos y utilizarlos según sea necesario, sujeto a los términos de esta licencia.

Agradecimientos

Para obtener ayuda, enviar comentarios o compartir su experiencia con esta herramienta, póngase en contacto con nosotros.