Word文書ファイルからの仕様書インポート
概要
このツールを使用すると、ユーザーは構造化された Word 文書を要件 & システム ポータルにインポートできます。このツールは、特定のガイドラインに従ってフォーマットされた Word ドキュメントを読み取り、要件 & Systems Portal への要件の直接転送を自動化するために開発されました。このドキュメントでは、ドキュメントを準備し、ツールを効果的に使用するために必要な手順とガイドラインを示します。
書式設定のガイドライン
ドキュメントを正常にインポートするには、次の基準に従ってフォーマットする必要があります：
-
Specification Name :見出し1」を使用して仕様名をマークする。 -
Sections and Sub-sections :見出し2"、"見出し3"、さらに小見出しを使って、文書の異なるセクションやサブセクションを示す。 -
Requirement Identifier :要件識別子を定義する段落には、"ReqID" という名前のカスタム段落スタイルを作成して適用します。こ の識別子は、 Requirements & Systems Portal でデー タ を正 し く マ ッ ピ ン グす る ために非常に重要です。 -
Requirement Text :要件本体は、"ReqID" 段落の直後に続き、"Normal" スタイルでフォーマットする。 -
Tables and Images :表や画像は文書に直接含める。表はRequirements & Systems Portalに適宜インポートされ、画像はそれぞれの要件に添付される。
ファイルおよびダウンロード
ドキュメント例
-
Airplane Standards Example.docx :このドキュメントをテンプレートとして使用し、要件を正しくフォーマットする方法を理解してください。あなたの文書がこの例で示されている構成と一致していることが重要です。
インポート スクリプト
-
import_to_valispace.py :このPythonスクリプトは、フォーマットされたWord文書を読み取り、Requirements & Systems Portalにデータをインポートします。
Word_specification_importer.py
使用方法
-
Prepare Your Document :Word文書を "Airplane Standards Example.docx "のガイドラインに従ってフォーマットしてください。 -
Run the Script :要件＆システムポータルのスクリプトモジュールでスクリプトを実行し、一時アクセストークンを認証に使用する。ユーザーのデスクトップ環境から実行するように変更することもできます。
免責事項
このツールは「現状のまま」提供されるものであり、性能または特定の目的への適合性を保証するものではありません。このツールは一例であり、Requirements & Systems Portal の特定の構成で機能するように変更する必要がある場合があります。
ライセンス
このスクリプトと付属文書は、MIT ライセンスの下でリリースされています。このライセンスの条件に従い、必要に応じて自由に変更、配布、使用することができます。
謝辞
支援、フィードバック、またはこのツールの使用経験についてのご相談は、こちらまでご連絡ください。
AI-localized