Using EARS Templates in QVscribe for Web

QVscribe supports the Easy Approach to Requirements Syntax (EARS) to help authors create clear, structured requirements. In QVscribe for Web, you can work with EARS when analyzing requirements in:

• Jama Connect

• IBM DOORS Next Generation

• Siemens Polarion

QVscribe provides tools for both reviewing EARS conformance and inserting EARS templates to help structure requirements.

Accessing EARS Analysis in Summary View

You can review EARS conformance for multiple requirements from the QVscribe Summary View.

In each supported platform, selecting the QVscribe icon opens the Summary View for the current set of analyzed requirements.

From the Summary View you can:

• review requirement quality scores

• filter or navigate analyzed requirements

• view EARS conformance results for each requirement

However, the Summary View does not allow editing requirements or inserting templates.

This is because the Summary View cannot verify editing or locking permissions within the source platform.

To insert or modify EARS templates, you must open the requirement in QVscribe Authoring View.

Opening Authoring View

To insert an EARS template or edit a requirement, open the requirement in QVscribe Authoring View within your platform.

Jama Connect

Requirements can be edited when they are in Draft status or when editing an item within an active Review.

Open the item for editing and select the QVscribe icon to launch Authoring View.

IBM DOORS Next Generation

When editing an artifact within a module or collection, the QVscribe icon appears while the artifact is in Edit mode.

Selecting the icon opens the requirement in QVscribe Authoring View.

Siemens Polarion

When viewing editable Work Items, the QVscribe icon appears near the item status or within the document viewer.

Selecting the icon opens the requirement in Authoring View.

For more information on platform-specific differences in accessing Summary View and Authoring View, see:

Chapter 2: Platform-Specific Differences (Web)

Inserting an EARS Template

EARS templates can be inserted directly while editing a requirement in QVscribe Authoring View.

To insert a template:

1. Open the requirement in Authoring View.

2. Select Insert EARS Template from the side panel
   

3. Choose the template type that best matches your requirement.
   

When you select a template, QVscribe displays the template structure and description.

Click the insert icon to add the template to the requirement text.

After inserting the template, you can modify the placeholder text to complete the requirement. QVscribe will automatically analyze the requirement and check it for EARS conformance according to the active configuration.

EARS Template Types

QVscribe includes the standard EARS template patterns.

Some requirements may combine multiple EARS patterns.

Complex EARS Templates

Complex EARS templates combine multiple EARS patterns within a single requirement.

Viewing EARS Conformance

QVscribe automatically checks requirements for EARS compliance during quality analysis when the EARS compliance check is enabled in your configuration settings.

When reviewing a requirement in the analysis panel, QVscribe displays information about how the requirement aligns with a detected EARS structure.

Selecting the EARS alert expands the analysis and provides detailed feedback.

The compliance analysis highlights:

• 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)

• 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.