Beispiele für benutzerdefinierte Aktionen mit dem Valiassistant
Hier sind einige Beispielskripte, die zusammen mit den Custom Actions implementiert werden können. Immer wenn AI angegeben ist, verwendet das Skript einen benutzerdefinierten Prompt, der zusammen mit Informationen aus den Requirements, Blocks oder Valis an die AI gesendet wird. Diese analysiert die Daten, berücksichtigt den benutzerdefinierten Prompt und sendet eine Antwort an Requirements & Systems Portal zurück, die dann in das Objekt in Requirements & Systems Portal zurückgeschrieben werden kann. Passen Sie diese Beispielskripte gern an Ihre Anforderungen und Anwendungsfälle an.
AI-Titelvorschlag
Dieses Skript verwendet AI, um einen kurzen, aber präzisen Titel für Ihre einzelnen Anforderungen zu erstellen.
Der verwendete benutzerdefinierte Prompt lautet:
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."
der zusammen mit dem Requirement-Text an die AI gesendet wird.
AI-Vorschlag für den Anforderungstyp
Dieses Skript verwendet AI, um Ihre Requirements anhand des Requirement-Texts in bestimmte Typen wie „Functional“, „Performance“ oder „System“ zu kategorisieren. Dabei werden alle in den Einstellungen von Requirements & System Portal definierten Typen berücksichtigt.
Der verwendete benutzerdefinierte Prompt lautet:
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'."
AI-Qualitätsprüfung für Requirements
Dieses Skript prüft die Qualität Ihres Requirement-Texts anhand der branchenüblichen INCOSE-Standards und liefert eine quantitative und qualitative Antwort in Form eines Qualitäts-Tags und eines Verbesserungsvorschlags.
Der verwendete benutzerdefinierte Prompt enthält die wichtigsten INCOSE-Regeln:
custom_prompt = """
Berücksichtigen Sie die folgenden INCOSE-Standards zum Schreiben von Requirements:
R1 - Verwenden Sie einen strukturierten, vollständigen Satz: Subjekt, Verb, Objekt.
R2 - Verwenden Sie im Hauptsatz der Bedarfs- oder Anforderungsaussage das Aktiv, wobei die verantwortliche Einheit klar als Subjekt des Satzes erkennbar sein muss.
R3 - Stellen Sie sicher, dass Subjekt und Verb der Bedarfs- oder Anforderungsaussage für die Einheit geeignet sind, auf die sich der Bedarf oder die Anforderung bezieht.
R5 - Verwenden Sie den bestimmten Artikel „the“ statt des unbestimmten Artikels „a“.
R6 - Verwenden Sie geeignete Einheiten bei der Angabe von Mengen. Alle Zahlen sollten ausdrücklich mit Maßeinheiten angegeben werden.
R7 - Vermeiden Sie vage Begriffe wie „some“, „any“, „allowable“, „several“, „many“, „a lot of“, „a few“, „almost always“, „very nearly“, „nearly“, „about“, „close to“, „almost“ und „approximate“.
R8 - Vermeiden Sie Ausweichklauseln wie „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“ und „if practicable“.
R9- Vermeiden Sie offene Klauseln wie „including but not limited to“, „etc.“ und „and so on“.
R10 - Vermeiden Sie überflüssige Infinitive wie „be designed to“, „be able to“, „be capable of“.
R12, 13, 14 - Verwenden Sie korrekte Grammatik, Rechtschreibung und Zeichensetzung.
R15 - Verwenden Sie eine definierte Konvention, um logische Ausdrücke wie „[X AND Y]“, „[X OR Y]“, [X XOR Y]“ und „NOT[X OR Y]“ auszudrücken.
R16 - Vermeiden Sie die Verwendung von „not“
R17 - Vermeiden Sie die Verwendung des Schrägstrichsymbols ("/") außer bei Einheiten, z. B. km/hr
R18 - Schreiben Sie einen einzelnen Satz, der einen einzelnen Gedanken enthält, der durch relevante Nebensätze bedingt und qualifiziert wird.
R19 - Vermeiden Sie Verknüpfungen, die Satzteile verbinden, wie „and“, „or“, ”then“, ”unless“, ”but“, ”as well as“, ”but also“, ”however“, ”whether“, ”meanwhile“, ”whereas“, ”on the other hand“ oder ”otherwise“.
R20 - Vermeiden Sie Formulierungen, die den Zweck des Bedarfs oder der Anforderung angeben.
R21 - Vermeiden Sie Klammern und eckige Klammern mit untergeordnetem Text.
R22 - Zählen Sie Mengen explizit auf, anstatt ein Gruppenhauptwort zur Benennung der Menge zu verwenden.
R24 - Vermeiden Sie die Verwendung von Pronomen und unbestimmten Pronomen.
R26 - Vermeiden Sie unerreichbare Absolute wie 100'%' reliability, 100'%' availability, all, every, always, never usw.
R28 - Drücken Sie die aussagenlogische Natur einer Bedingung für eine einzelne Aktion explizit aus, anstatt Listen von Aktionen für eine bestimmte Bedingung anzugeben.
R29 - Klassifizieren Sie die Bedarfe und Anforderungen nach den Aspekten des Problems oder Systems, die sie behandeln.
R31 - Vermeiden Sie bei der Definition von Design-Inputs die Angabe einer Lösung, sofern es keine Begründung für die Einschränkung des Designs gibt. Konzentrieren Sie sich auf das Problem, also das „Was“, statt auf die Lösung, also das „Wie“.
R32 - Verwenden Sie „each“ statt „all“, „any“ oder „both“, wenn eine universelle Quantifizierung beabsichtigt ist.
R33 - Definieren Sie Mengen mit einem Wertebereich, der für die Einheit geeignet ist, auf die sie angewendet werden und gegen die die Einheit verifiziert oder validiert wird.
R34 - Geben Sie spezifische messbare Leistungsziele an, die für die Einheit geeignet sind, für die der Bedarf oder die Anforderung formuliert ist und gegen die verifiziert wird, dass die Einheit diese erfüllt.
R35 - Definieren Sie zeitliche Abhängigkeiten explizit, anstatt unbestimmte zeitliche Schlüsselwörter wie „eventually“, „until“, „before“, „after“, „as“, „once“, „earliest“, „latest“, „instantaneous“, „simultaneous“ und „at last“ zu verwenden.
R38 - Vermeiden Sie die Verwendung von Abkürzungen.
Geben Sie mir auf Grundlage dieser INCOSE-Standards für Requirements NUR ein Dictionary mit dem quality_score_of_the_requirement_text von 0 bis 100 und einem entsprechenden comment_for_improvement in folgender Form zurück:
{'Score': quality_score_of_the_requirement_text, 'Comment': comment_for_improvement}.
"""
AI-Bericht zu Inkonsistenzen im Analysis Module
Dieses Skript führt die ValiAssistant-Funktion „Find Inconsistencies“ aus und gibt einen Bericht im Analysis Module aus, der anschließend exportiert oder geteilt werden kann.
Impact-Analysis-Bericht im Analysis Module
Dieses Skript führt eine Analyse der ausgewählten Anforderung durch, um zu prüfen, welche anderen Requirements, Blocks und Test Runs von einer Änderung in ihrem Textfeld betroffen sein könnten. Das Skript erstellt einen Bericht im Analysis Module, der anschließend exportiert oder geteilt werden kann.
Dieses Impact-Analysis-Skript verwendet keine AI, kann jedoch erweitert werden, um eine AI-Bewertung zur Schwere der Auswirkungen auf jedes der zugehörigen Objekte einzubeziehen.
AI-localized