Importazione delle specifiche da file di documenti Word

Panoramica

Questo strumento consente agli utenti di importare documenti Word strutturati in Requirements & Systems Portal. È stato sviluppato per leggere documenti Word formattati che seguono linee guida specifiche e automatizzare il trasferimento dei requisiti direttamente in Requirements & Systems Portal. Questa documentazione fornisce i passaggi e le linee guida necessari per preparare i documenti e utilizzare lo strumento in modo efficace.

Linee guida di formattazione

Per garantire l'importazione corretta del documento, questo deve essere formattato secondo i seguenti standard:

• Specification Name: Utilizzare "Heading 1" per contrassegnare il nome della specifica.

• Sections and Sub-sections: Utilizzare "Heading 2", "Heading 3" e i successivi sottotitoli per indicare le diverse sezioni e sottosezioni del documento.

• Requirement Identifier: Creare e applicare uno stile di paragrafo personalizzato denominato "ReqID" ai paragrafi che definiscono l'identificatore del requisito. Questo identificatore è fondamentale per mappare correttamente i dati in Requirements & Systems Portal.

• Requirement Text: Il corpo del requisito deve seguire direttamente il paragrafo "ReqID" ed essere formattato con lo stile "Normal".

• Tables and Images: Includere tabelle e immagini direttamente nel documento. Le tabelle verranno importate in Requirements & Systems Portal di conseguenza e le immagini verranno allegate ai rispettivi requisiti.

File e download

Documento di esempio

• Airplane Standards Example.docx: Utilizzare questo documento come modello per capire come formattare correttamente i requisiti. È fondamentale che il documento corrisponda alla struttura mostrata in questo esempio.

Airplane Standards Example.docx

Script di importazione

• import_to_valispace.py: Questo script Python legge il documento Word formattato e importa i dati in Requirements & Systems Portal.

Word_specification_importer.py

Istruzioni per l'uso

1. Prepare Your Document: Formattare il documento Word secondo le linee guida di "Airplane Standards Example.docx".

2. Run the Script: Eseguire lo script nel modulo di scripting di Requirements & Systems Portal utilizzando il token di accesso temporaneo per l'autenticazione. Può anche essere modificato per essere eseguito dall'ambiente desktop dell'utente.

Esclusione di responsabilità

Questo strumento viene fornito "così com'è", senza alcuna garanzia di prestazioni o idoneità per uno scopo particolare. Serve come esempio e potrebbe richiedere modifiche per funzionare con la configurazione specifica di Requirements & Systems Portal.

Licenza

Questo script e la documentazione di accompagnamento sono rilasciati sotto la licenza MIT. È possibile modificarli, distribuirli e utilizzarli secondo necessità, nel rispetto dei termini di questa licenza.

Ringraziamenti

Per assistenza, feedback o per discutere la vostra esperienza con questo strumento, contattateci.