Spezifikationsimport aus Word-Dokumentdateien

Überblick

Dieses Tool ermöglicht Benutzern den Import strukturierter Word-Dokumente in Requirements & Systems Portal. Es wurde entwickelt, um formatierte Word-Dokumente zu lesen, die bestimmten Richtlinien entsprechen, und die Übertragung von Anforderungen direkt in Requirements & Systems Portal zu automatisieren. Diese Dokumentation enthält die erforderlichen Schritte und Richtlinien, um Ihre Dokumente vorzubereiten und das Tool effektiv zu verwenden.

Formatierungsrichtlinien

Um den erfolgreichen Import Ihres Dokuments sicherzustellen, muss es gemäß den folgenden Standards formatiert sein:

• Specification Name: Verwenden Sie „Überschrift 1“, um den Spezifikationsnamen zu kennzeichnen.

• Sections and Sub-sections: Verwenden Sie „Überschrift 2“, „Überschrift 3“ und weitere Unterüberschriften, um verschiedene Abschnitte und Unterabschnitte des Dokuments anzugeben.

• Requirement Identifier: Erstellen Sie einen benutzerdefinierten Absatzstil mit dem Namen „ReqID“ und wenden Sie ihn auf Absätze an, die den Anforderungsbezeichner definieren. Dieser Bezeichner ist entscheidend für die korrekte Zuordnung der Daten in Requirements & Systems Portal.

• Requirement Text: Der Textkörper der Anforderung sollte direkt auf den Absatz „ReqID“ folgen und im Stil „Standard“ formatiert sein.

• Tables and Images: Fügen Sie Tabellen und Bilder direkt in das Dokument ein. Tabellen werden entsprechend in Requirements & Systems Portal importiert, und Bilder werden an die jeweiligen Anforderungen angehängt.

Dateien und Downloads

Beispieldokument

• Airplane Standards Example.docx: Verwenden Sie dieses Dokument als Vorlage, um zu verstehen, wie Ihre Anforderungen korrekt formatiert werden. Es ist entscheidend, dass Ihr Dokument der in diesem Beispiel gezeigten Struktur entspricht.

Airplane Standards Example.docx

Importskript

• import_to_valispace.py: Dieses Python-Skript liest das formatierte Word-Dokument und importiert die Daten in Requirements & Systems Portal.

Word_specification_importer.py

Anwendungshinweise

1. Prepare Your Document: Formatieren Sie Ihr Word-Dokument gemäß den Richtlinien in „Airplane Standards Example.docx“.

2. Run the Script: Führen Sie das Skript im Scripting Module von Requirements & Systems Portal aus und verwenden Sie dabei das temporäre Zugriffstoken zur Authentifizierung. Es kann auch so angepasst werden, dass es in der Desktop-Umgebung des Benutzers ausgeführt wird.

Haftungsausschluss

Dieses Tool wird „wie besehen“ bereitgestellt, ohne jegliche Garantien hinsichtlich Leistung oder Eignung für einen bestimmten Zweck. Es dient als Beispiel und muss möglicherweise angepasst werden, um mit Ihrer spezifischen Konfiguration von Requirements & Systems Portal zu funktionieren.

Lizenzierung

Dieses Skript und die begleitende Dokumentation werden unter der MIT-Lizenz veröffentlicht. Sie dürfen sie gemäß den Bedingungen dieser Lizenz nach Bedarf ändern, verteilen und verwenden.

Danksagungen

Wenn Sie Unterstützung oder Feedback benötigen oder Ihre Erfahrungen mit diesem Tool besprechen möchten, kontaktieren Sie uns bitte.