Importation des spécifications à partir de fichiers de documents Word

Aperçu

Cet outil permet aux utilisateurs d’importer des documents Word structurés dans Requirements & Systems Portal. Il a été développé pour lire des documents Word formatés conformément à des directives spécifiques et automatiser le transfert des exigences directement dans Requirements & Systems Portal. Cette documentation fournit les étapes et directives nécessaires pour préparer vos documents et utiliser l’outil efficacement.

Directives de mise en forme

Pour garantir l’importation réussie de votre document, celui-ci doit être mis en forme selon les normes suivantes :

• Specification Name: Utilisez « Heading 1 » pour indiquer le nom de la spécification.

• Sections and Sub-sections: Utilisez « Heading 2 », « Heading 3 » et les sous-titres suivants pour indiquer les différentes sections et sous-sections du document.

• Requirement Identifier: Créez et appliquez un style de paragraphe personnalisé nommé « ReqID » aux paragraphes qui définissent l’identifiant de l’exigence. Cet identifiant est essentiel pour mapper correctement les données dans Requirements & Systems Portal.

• Requirement Text: Le corps de l’exigence doit suivre directement le paragraphe « ReqID » et être mis en forme avec le style « Normal ».

• Tables and Images: Incluez les tableaux et les images directement dans le document. Les tableaux seront importés dans Requirements & Systems Portal en conséquence, et les images seront jointes aux exigences correspondantes.

Fichiers et téléchargements

Document d’exemple

• Airplane Standards Example.docx: Utilisez ce document comme modèle pour comprendre comment mettre correctement en forme vos exigences. Il est essentiel que votre document respecte la structure présentée dans cet exemple.

Airplane Standards Example.docx

Script d’importation

• import_to_valispace.py: Ce script Python lit le document Word formaté et importe les données dans Requirements & Systems Portal.

Word_specification_importer.py

Instructions d’utilisation

1. Prepare Your Document: Mettez en forme votre document Word conformément aux directives de « Airplane Standards Example.docx ».

2. Run the Script: Exécutez le script dans le module de script de Requirements & Systems Portal en utilisant le jeton d’accès temporaire pour l’authentification. Il peut également être modifié pour s’exécuter depuis l’environnement de bureau de l’utilisateur.

Avertissement

Cet outil est fourni « tel quel », sans aucune garantie de performance ni d’adéquation à un usage particulier. Il sert d’exemple et peut nécessiter des modifications pour fonctionner avec votre configuration spécifique de Requirements & Systems Portal.

Licence

Ce script et la documentation qui l’accompagne sont publiés sous licence MIT. Vous êtes libre de les modifier, de les distribuer et de les utiliser selon vos besoins, sous réserve des termes de cette licence.

Remerciements

Pour obtenir de l’aide, faire part de vos commentaires ou discuter de votre expérience avec cet outil, veuillez nous contacter.