Ví dụ về các thao tác tùy chỉnh sử dụng Valiassistant
Dưới đây là một số script ví dụ có thể được triển khai cùng với các Custom Actions. Bất cứ khi nào có chỉ định AI, script sẽ sử dụng một prompt tùy chỉnh được gửi cùng với thông tin từ Requirements, Blocks hoặc Valis đến AI. AI sẽ phân tích dữ liệu, xem xét prompt tùy chỉnh và gửi câu trả lời trở lại Requirements & Systems Portal, sau đó câu trả lời này có thể được ghi ngược lại vào đối tượng trong Requirements & Systems Portal. Bạn có thể tùy chỉnh các script ví dụ này cho phù hợp với nhu cầu và trường hợp sử dụng của mình.
Gợi ý Tiêu đề bằng AI
Script này sử dụng AI để tạo ra một tiêu đề ngắn gọn nhưng chính xác cho từng requirement của bạn.
Prompt tùy chỉnh được sử dụng là:
custom_prompt = "Based on the Text provide a short Title for this Requirement in the context of System Engineering. Do not include any numbers or Units in the title. Only return the title and no other text."
được gửi cùng với văn bản Requirement đến AI.
Gợi ý Loại Requirement bằng AI
Script này sử dụng AI để phân loại Requirements của bạn thành các loại cụ thể, chẳng hạn như “Functional”, “Performance” hoặc “System”, dựa trên văn bản Requirement. Tất cả các loại được định nghĩa trong phần cài đặt của Requirements & System Portal đều được đưa vào xem xét.
Prompt tùy chỉnh được sử dụng là:
custom_prompt = "Respond only with the type. Take into consideration the following types: {types_string}. Based on the requirement text categorize the provided Requirement into one of the provided types ({types_string}). Return only the type in the form of 'type'."
Kiểm tra Chất lượng Requirements bằng AI
Script này kiểm tra chất lượng văn bản Requirement của bạn theo các tiêu chuẩn INCOSE trong ngành và cung cấp phản hồi định lượng lẫn định tính dưới dạng thẻ chất lượng và gợi ý cải thiện.
Prompt tùy chỉnh được sử dụng bao gồm các quy tắc INCOSE liên quan nhất:
custom_prompt = """
Hãy xem xét các Tiêu chuẩn INCOSE sau đây để viết Requirements:
R1 - Sử dụng câu đầy đủ, có cấu trúc: chủ ngữ, động từ, tân ngữ.
R2 - Sử dụng thể chủ động trong cấu trúc câu chính của phát biểu về nhu cầu hoặc requirement, với thực thể chịu trách nhiệm được xác định rõ là chủ ngữ của câu.
R3 - Đảm bảo chủ ngữ và động từ của phát biểu về nhu cầu hoặc requirement phù hợp với thực thể mà nhu cầu hoặc requirement đó đề cập đến.
R5 - Sử dụng mạo từ xác định “the” thay vì mạo từ không xác định “a”.
R6 - Sử dụng đơn vị phù hợp khi nêu các đại lượng. Mọi con số phải có đơn vị đo được nêu rõ ràng.
R7 - Tránh sử dụng các thuật ngữ mơ hồ như “some”, “any”, “allowable”, “several”, “many”, “a lot of”, “a few”, “almost always”, “very nearly”, “nearly”, “about”, “close to”, “almost” và “approximate”.
R8 - Tránh các mệnh đề né tránh như “so far as is possible”, “as little as possible”, “where possible”, “as much as possible”, “if it should prove necessary”, “if necessary”, “to the extent necessary”, “as appropriate”, “as required”, “to the extent practical” và “if practicable”.
R9- Tránh các mệnh đề mở như “including but not limited to”, “etc.” và “and so on”.
R10 - Tránh các cụm nguyên mẫu thừa như “be designed to”, “be able to”, “be capable of”.
R12, 13, 14 - Sử dụng đúng ngữ pháp, chính tả, dấu câu.
R15 - Sử dụng một quy ước xác định để diễn đạt các biểu thức logic như “[X AND Y]”, “[X OR Y]”, [X XOR Y]”, “NOT[X OR Y]”.
R16 - Tránh sử dụng “not”
R17 - Tránh sử dụng ký hiệu gạch chéo ("/"), ngoại trừ trong đơn vị, ví dụ km/hr
R18 - Viết một câu duy nhất chứa một ý duy nhất, được điều kiện hóa và bổ nghĩa bằng các mệnh đề phụ liên quan.
R19 - Tránh các từ nối kết hợp mệnh đề như “and”, “or”, ”then”, ”unless”, ”but”, ”as well as”, ”but also”, ”however”, ”whether”, ”meanwhile”, ”whereas”, ”on the other hand” hoặc ”otherwise”.
R20 - Tránh các cụm từ chỉ mục đích của nhu cầu hoặc requirement.
R21 - Tránh dùng dấu ngoặc đơn và ngoặc vuông chứa văn bản phụ.
R22 - Liệt kê tường minh các tập hợp thay vì dùng danh từ nhóm để gọi tên tập hợp đó.
R24 - Tránh sử dụng đại từ và đại từ bất định.
R26 - Tránh sử dụng các tính tuyệt đối không thể đạt được như độ tin cậy 100'%', tính sẵn sàng 100'%', all, every, always, never, v.v.
R28 - Diễn đạt rõ ràng bản chất mệnh đề của một điều kiện cho một hành động đơn lẻ thay vì đưa ra danh sách hành động cho một điều kiện cụ thể.
R29 - Phân loại các nhu cầu và requirements theo các khía cạnh của vấn đề hoặc hệ thống mà chúng đề cập.
R31 - Khi xác định đầu vào thiết kế, tránh nêu ra một giải pháp trừ khi có cơ sở lý giải cho việc ràng buộc thiết kế. Tập trung vào vấn đề “what” thay vì giải pháp “how”.
R32 - Sử dụng “each” thay cho “all”, “any" hoặc “both” khi muốn biểu thị lượng từ phổ quát.
R33 - Xác định các đại lượng với một khoảng giá trị phù hợp với thực thể mà chúng áp dụng, cũng như thực thể sẽ được xác minh hoặc xác nhận đối chiếu theo đó.
R34 - Cung cấp các mục tiêu hiệu năng cụ thể, có thể đo lường, phù hợp với thực thể mà nhu cầu hoặc requirement được nêu ra, và là cơ sở để xác minh rằng thực thể đáp ứng được.
R35 - Xác định rõ ràng các phụ thuộc về thời gian thay vì sử dụng các từ khóa thời gian không xác định như “eventually”, “until”, “before”, “after”, “as”, “once”, “earliest”, “latest”, “instantaneous”, “simultaneous”, “at last”.
R38 - Tránh sử dụng từ viết tắt.
Dựa trên các tiêu chuẩn INCOSE này cho Requirements, CHỈ trả về cho tôi một dictionary chứa quality_score_of_the_requirement_text từ 0 đến 100 và comment_for_improvement tương ứng theo dạng:
{'Score': quality_score_of_the_requirement_text, 'Comment': comment_for_improvement}.
"""
Báo cáo Điểm không nhất quán bằng AI trong Analysis Module
Script này chạy tính năng “Find Inconsistencies” của ValiAssistant và xuất báo cáo vào Analysis Module để sau đó có thể xuất hoặc chia sẻ.
Báo cáo Phân tích Tác động trong Analysis Module
Script này thực hiện phân tích trên Requirement được chọn để kiểm tra những Requirements, Blocks và Test Runs nào khác có thể bị ảnh hưởng bởi sự thay đổi trong trường văn bản của nó. Script chuẩn bị một báo cáo trong Analysis Module, sau đó có thể được xuất hoặc chia sẻ.
Script Impact Analysis này không sử dụng AI, nhưng có thể được mở rộng để bao gồm phần đánh giá bằng AI về mức độ nghiêm trọng của tác động đối với từng đối tượng liên quan.
AI-localized