Импорт спецификаций из файлов документов 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: Включайте таблицы и изображения непосредственно в документ. Таблицы будут импортированы в Requirements & Systems Portal соответствующим образом, а изображения будут прикреплены к соответствующим требованиям.

Файлы и файлы для скачивания

Пример документа

• Airplane Standards Example.docx: Используйте этот документ в качестве шаблона, чтобы понять, как правильно оформить свои требования. Очень важно, чтобы ваш документ соответствовал структуре, продемонстрированной в этом примере.

Пример стандартов для самолетов.docx

Сценарий импорта

• import_to_valispace.py: Этот сценарий на языке Python считывает отформатированный документ Word и импортирует данные в портал Requirements & Systems Portal.

Word_specification_importer.py

Инструкции по использованию

1. Prepare Your Document: Отформатируйте документ Word в соответствии с руководством "Airplane Standards Example.docx".

2. Run the Script: Запустите сценарий в модуле сценариев портала Requirements & Systems Portal, используя временный маркер доступа для аутентификации. Его также можно модифицировать для запуска из среды рабочего стола пользователя.

Отказ от ответственности

Данный инструмент предоставляется "как есть", без каких-либо гарантий работоспособности или пригодности для конкретной цели. Он служит в качестве примера и может потребовать модификации для работы с вашей конкретной конфигурацией портала Requirements & Systems Portal.

Лицензирование

Этот скрипт и сопутствующая документация выпущены на условиях лицензии MIT. Вы можете свободно изменять, распространять и использовать их по мере необходимости в соответствии с условиями этой лицензии.

Благодарности

Для получения помощи, обратной связи или для обсуждения вашего опыта работы с этим инструментом, пожалуйста, свяжитесь с нами.