.png?width=75&height=75&name=4.0%20(7).png)
QVscribe supports the Easy Approach to Requirements Syntax (EARS) to help authors create clear, structured requirements. In Microsoft Office (Word and Excel), QVscribe provides tools for inserting EARS templates and analyzing how well requirements conform to EARS patterns.
🦖 Coach QRex: QVscribe 7 improved EARS pattern detection and coaching guidance. For the best experience when working with EARS templates and conformance checking, use QVscribe version 7 or later.
Inserting an EARS Template
You can insert EARS templates directly while writing requirements.
-
Open the QVscribe ribbon.
-
Select EARS Templates.
-
Choose the template that best fits your requirement.
The template will be inserted at the current cursor location.
Example:
Replace the placeholder text to complete the requirement.
EARS Template Types
QVscribe includes the standard EARS template patterns.
| Template Type | Description | Example |
|---|---|---|
| Event-driven | Triggered by an external event | WHEN <trigger> the <system name> shall <system response> |
| Option | Applies when a feature is included | WHERE <feature is included> the <system name> shall <system response> |
| State-driven | Active while a condition is true | WHILE <pre-condition> the <system name> shall <system response> |
| Ubiquitous | Always active | The <system name> shall <system response> |
| Unwanted behaviour | Defines response to an undesirable event | IF <trigger> THEN the <system name> shall <system response> |
Some requirements may combine multiple EARS patterns.
Complex EARS Templates
Complex EARS templates combine multiple EARS patterns within a single requirement.
| Pattern | Template |
|---|---|
| Optional feature, state-driven, and unwanted behaviour | WHERE <feature is included> WHILE <pre-condition> IF <trigger> THEN the <system name> shall <system response> |
| Optional feature, state-driven, and event-driven | WHERE <feature is included> WHILE <pre-condition> WHEN <trigger> the <system name> shall <system response> |
| Optional feature and state-driven | WHERE <feature is included> WHILE <pre-condition> the <system name> shall <system response> |
| Optional feature and event-driven | WHERE <feature is included> WHEN <trigger> the <system name> shall <system response> |
| Optional feature and unwanted behaviour | WHERE <feature is included> IF <trigger> THEN the <system name> shall <system response> |
| State-driven and unwanted behaviour | WHILE <pre-condition> IF <trigger> THEN the <system name> shall <system response> |
| State-driven and event-driven | WHILE <pre-condition> WHEN <trigger> the <system name> shall <system response> |
Viewing EARS Conformance
QVscribe can evaluate whether a requirement follows an EARS structure during analysis.
When expanding a requirement in the analysis window, QVscribe displays EARS conformance information.
The analysis panel shows how the requirement aligns with a detected EARS structure, including:
-
the detected EARS template type (such as Event-driven or State-driven)
-
the template structure used for comparison
-
the template elements identified in the requirement (such as trigger, system, or system response)
-
the values extracted from the requirement text
-
whether the requirement is compliant or noncompliant with the detected template
-
any issues or recommendations affecting conformance
This information helps authors understand how QVscribe interprets the requirement and identify where the structure may need adjustment.
Example: Non-Compliant Requirement
In this example, QVscribe detects an Event-driven EARS pattern but marks the requirement as Noncompliant due to multiple imperatives being present.
Example: Compliant Requirement
In this example, QVscribe detects a State-driven EARS pattern and marks the requirement as Compliant, while still providing additional recommendations to improve clarity.
Enabling or Disabling EARS Analysis
EARS conformance checking can be controlled in the QVscribe Configuration window.
-
Open the Configuration window.
-
Select the Templates tab.
-
Enable or disable EARS conformance checking.
If your team does not use EARS as part of its authoring process, this feature can be disabled.
Note: This is a local user setting and is not part of the shared configuration.