Import specyfikacji z plików dokumentów Word

Przegląd

Narzędzie to umożliwia użytkownikom importowanie ustrukturyzowanych dokumentów Word do portalu Requirements & Systems Portal. Zostało ono opracowane w celu odczytywania sformatowanych dokumentów Word, które są zgodne z określonymi wytycznymi i automatyzują transfer wymagań bezpośrednio do portalu Requirements & Systems Portal. Niniejsza dokumentacja zawiera niezbędne kroki i wytyczne dotyczące przygotowania dokumentów i efektywnego korzystania z narzędzia.

Wytyczne dotyczące formatowania

Aby zapewnić pomyślny import dokumentu, musi on być sformatowany zgodnie z poniższymi standardami:

• Specification Name: Użyj "Nagłówka 1", aby zaznaczyć nazwę specyfikacji.

• Sections and Sub-sections: Użyj "Nagłówka 2", "Nagłówka 3" i dalszych podtytułów, aby wskazać różne sekcje i podsekcje dokumentu.

• Requirement Identifier: Utwórz i zastosuj niestandardowy styl akapitu o nazwie "ReqID" do akapitów definiujących identyfikator wymagań. Identyfikator ten ma kluczowe znaczenie dla prawidłowego mapowania danych w portalu wymagań i systemów.

• Requirement Text: Treść wymagania powinna następować bezpośrednio po akapicie "ReqID" i być sformatowana w stylu "Normalnym".

• Tables and Images: Tabele i obrazy należy umieszczać bezpośrednio w dokumencie. Tabele zostaną odpowiednio zaimportowane do portalu wymagań i systemów, a obrazy zostaną dołączone do odpowiednich wymagań.

Pliki i pliki do pobrania

Przykładowy dokument

• Airplane Standards Example.docx: Użyj tego dokumentu jako szablonu, aby zrozumieć, jak poprawnie sformatować swoje wymagania. Bardzo ważne jest, aby dokument był zgodny ze strukturą przedstawioną w tym przykładzie.

Przykład standardów lotniczych.docx

Skrypt importu

• import_to_valispace.py: Ten skrypt Python odczytuje sformatowany dokument Word i importuje dane do portalu wymagań i systemów.

Word_specification_importer.py

Instrukcje użycia

1. Prepare Your Document: Sformatuj dokument Word zgodnie z wytycznymi "Airplane Standards Example.docx".

2. Run the Script: Uruchom skrypt w module skryptowym portalu wymagań i systemów, wykorzystując tymczasowy token dostępu do uwierzytelniania. Można go również zmodyfikować tak, aby był uruchamiany ze środowiska pulpitu użytkownika.

Zastrzeżenie

To narzędzie jest dostarczane w stanie, w jakim się znajduje, bez gwarancji wydajności lub przydatności do określonego celu. Służy ono jako przykład i może wymagać modyfikacji w celu działania z określoną konfiguracją portalu wymagań i systemów.

Licencjonowanie

Ten skrypt i towarzysząca mu dokumentacja są udostępniane na licencji MIT. Użytkownik może je dowolnie modyfikować, rozpowszechniać i wykorzystywać zgodnie z warunkami niniejszej licencji.

Podziękowania

Aby uzyskać pomoc, opinie lub omówić swoje doświadczenia z tym narzędziem, skontaktuj się z nami.