Nhập thông số kỹ thuật từ tệp tài liệu Word

Tổng quan

Công cụ này cho phép người dùng nhập các tài liệu Word có cấu trúc vào Requirements & Systems Portal. Công cụ được phát triển để đọc các tài liệu Word đã được định dạng theo các hướng dẫn cụ thể và tự động chuyển các yêu cầu trực tiếp vào Requirements & Systems Portal. Tài liệu này cung cấp các bước và hướng dẫn cần thiết để chuẩn bị tài liệu của bạn và sử dụng công cụ một cách hiệu quả.

Hướng dẫn định dạng

Để đảm bảo tài liệu của bạn được nhập thành công, tài liệu phải được định dạng theo các tiêu chuẩn sau:

• Specification Name: Sử dụng "Heading 1" để đánh dấu Tên Đặc tả.

• Sections and Sub-sections: Sử dụng "Heading 2", "Heading 3" và các tiêu đề phụ tiếp theo để biểu thị các phần và tiểu mục khác nhau của tài liệu.

• Requirement Identifier: Tạo và áp dụng một kiểu đoạn văn tùy chỉnh có tên "ReqID" cho các đoạn văn xác định Mã định danh Yêu cầu. Mã định danh này rất quan trọng để ánh xạ dữ liệu chính xác trong Requirements & Systems Portal.

• Requirement Text: Phần nội dung của yêu cầu phải nằm ngay sau đoạn "ReqID" và được định dạng theo kiểu "Normal".

• Tables and Images: Chèn bảng và hình ảnh trực tiếp vào tài liệu. Các bảng sẽ được nhập vào Requirements & Systems Portal tương ứng, và hình ảnh sẽ được đính kèm với các yêu cầu tương ứng.

Tệp và nội dung tải xuống

Tài liệu mẫu

• Airplane Standards Example.docx: Sử dụng tài liệu này làm mẫu để hiểu cách định dạng các yêu cầu của bạn cho đúng. Điều quan trọng là tài liệu của bạn phải khớp với cấu trúc được thể hiện trong ví dụ này.

Airplane Standards Example.docx

Tập lệnh nhập

• import_to_valispace.py: Tập lệnh Python này đọc tài liệu Word đã được định dạng và nhập dữ liệu vào Requirements & Systems Portal.

Word_specification_importer.py

Hướng dẫn sử dụng

1. Prepare Your Document: Định dạng tài liệu Word của bạn theo hướng dẫn trong "Airplane Standards Example.docx".

2. Run the Script: Chạy tập lệnh trong Scripting Module của Requirements & Systems Portal, sử dụng temporary access token để xác thực. Tập lệnh cũng có thể được chỉnh sửa để chạy từ môi trường máy tính để bàn của người dùng.

Tuyên bố miễn trừ trách nhiệm

Công cụ này được cung cấp "nguyên trạng", không có bất kỳ ضمان bảo nào về hiệu suất hoặc tính phù hợp cho một mục đích cụ thể. Công cụ này đóng vai trò như một ví dụ và có thể cần được chỉnh sửa để hoạt động với cấu hình Requirements & Systems Portal cụ thể của bạn.

Cấp phép

Tập lệnh này và tài liệu đi kèm được phát hành theo Giấy phép MIT. Bạn được tự do chỉnh sửa, phân phối và sử dụng chúng khi cần, theo các điều khoản của giấy phép này.

Lời cảm ơn

Nếu cần hỗ trợ, muốn gửi phản hồi hoặc chia sẻ trải nghiệm của bạn với công cụ này, vui lòng liên hệ với chúng tôi.