从 Word 文档文件导入规范

概述

该工具可帮助用户将结构化 Word 文档导入 Requirements & Systems Portal。开发该工具的目的是为了读取符合特定指南的 Word 格式文件，并自动将需求直接传输到 Requirements & Systems Portal。本文档提供了准备文档和有效使用该工具的必要步骤和指南。

格式指南

为确保成功导入文档，文档格式必须符合以下标准：

• Specification Name:使用 "标题 1 "标记规范名称。

• Sections and Sub-sections:使用 "标题 2"、"标题 3 "和更多小标题来标示文件的不同章节和小节。

• Requirement Identifier:为定义需求标识符的段落创建并应用名为 "ReqID "的自定义段落样式。该标识符对于在 Requirements & Systems Portal 中正确映射数据至关重要。

• Requirement Text:需求正文应紧跟在 "ReqID "段落之后，并使用 "Normal "样式。

• Tables and Images:在文件中直接包含表格和图片。表格将相应地导入 "需求与系统门户"，图片将附在相应的需求中。

文件和下载

文档示例

• Airplane Standards Example.docx:使用此文档作为模板，了解如何正确格式化您的需求。您的文档必须与此示例中的结构相匹配。

飞机标准示例.docx

导入脚本

• import_to_valispace.py:此 Python 脚本可读取格式化的 Word 文档，并将数据导入 Requirements & Systems Portal。

Word_specification_importer.py

使用说明

1. Prepare Your Document:根据 "飞机标准示例.docx "指南格式化 Word 文档。

2. Run the Script:在需求与系统门户的脚本模块中运行脚本，使用临时访问令牌进行身份验证。也可将其修改为从用户的桌面环境运行。

免责声明

本工具按 "原样 "提供，不保证其性能或适用于特定用途。本工具仅作为示例，可能需要进行修改才能与您的 Requirements & Systems Portal 的特定配置相匹配。

使用许可

本脚本和随附文档采用 MIT 许可发布。在遵守本许可条款的前提下，您可以根据需要自由修改、分发和使用它们。

鸣谢

如需帮助、反馈或讨论使用本工具的经验，请联系我们。