March 11, 2021


Selecting your requirements in QVscribe for Word

In order for QVscribe to analyze your requirements, you must first add them to the QVscribe environment. This can be done in three ways: I.            Manually highlight each requirement and add it II.            Use Find Requirements to automatically detect the requirements based on a few initial examples you give it.

In order for QVscribe to analyze your requirements, you must first add them to the QVscribe environment. This can be done in three ways:

I.            Manually highlight each requirement and add it

II.            Use Find Requirements to automatically detect the requirements based on a few initial examples you give it.

Manually adding requirements

To manually add a requirement, you can perform the following steps:

 

I.            Right-click the mouse and select ‘Mark Requirements’.

II.            Use the ‘Mark Requirements’ button on the QVscribe ribbon.

You will have the following options:

·         Single Requirement

·         Requirement Per Paragraph

·         Requirement Column

·         Requirement Row

·         Entire Table As Single Requirement

QVscribe will provide you options to mark your requirement.  Only the options available will be accessible to select.

Note that in QVscribe for Word 3.3 version and above you can no longer double-click a requirement to mark it.

These manually added requirements are immediately placed in the Checked and Available to be Analyzed list, and as the name states, they are ready to be analyzed.

Marking a Table

The latest version of QVscribe for Word allows you to mark requirements in tables with more functionality and customization.

To add a requirement within a requirement, you can perform the following steps:

I.            Right-click the mouse and select ‘Mark Requirements’.

II.            Use the ‘Mark Requirements’ button on the QVscribe ribbon.

You will have option to Mark:

·         Single Requirement

·         Requirement Per Paragraph

·         Requirement Column

·         Requirement Row

·         Entire Table As Single Requirement

QVscribe will provide you options to mark your requirement.  Only the options available will be accessible to select.

Once you have selected your requirement (or requirements), QVscribe will ask if the table has a column has a requirement I.D. column.  QVscribe will list the other columns in the table in a drop down for you to select.

QVscribe will then populate the Checked & Available to be Analyzed list according to the table details.

Using Requirements Finder

QVscribe for Word includes a requirements auto-detection feature called Requirement Finder that helps you rapidly locate and highlight all requirements in the document. The found requirements can be reviewed before marking them for analysis.

 

Note that if the document does follow Requirement writing best practices and does not have any requirement identifiers, nor do all requirements begin with a common word or phrase, Requirements Finder may be ineffective. We suggest that you manually add your requirements.

How it works: Requirements Finder looks specifically at patterns in the requirement identifiers of the sample requirements you initially selected and uses these patterns to find the remaining requirements.

For this reason, it is best if the requirements in the document have alpha-numeric requirement identifiers preceding them, such as R10.3, 2.3.34.2, 10T-34R, and Req. The example below demonstrates a typical sample of requirements with good identifiers:

[EC-LMR-RCS-030] Remote Commanding: The Remote Control Station shall accept and send …
[EC-LMR-COM-020] Delay Tolerance: The Lunar Exploration Light Rover control shall …
[EC-LMR-FNC-012] Power-up: Upon command, the Lunar Exploration Light Rover shall …

From these samples, Requirement Finder infers the common pattern ‘[EG-LMC-’ and uses it to search for other requirements in the document that begins with that same pattern.

What you do: Select 3 well-spaced requirements to set a proper pattern, then select Requirements Finder. Once the Requirement Finder process is finished, you can navigate the list of found requirements to ensure all have been properly detected.

You will notice that the auto found requirements are shown greyed out, this is because auto-found requirements are not yet marked for analysis. Requirements detected with Requirement Finder must first be reviewed before being marked.

You can individually mark specific found requirements by double-clicking on them in the Found & not Checked list. This checks them and moves them to the Checked & Available to be Analyzed list.

If you want to check all found requirements at once, you can click on the Check All button.

 


Share this Story

 

Get the Latest Updates

If you're part of an engineering team, tech company, or just like to be at the bleeding edge of innovation