Marking Requirements

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.

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.

 

Removing all Marked Requirements in QVscribe for Word

When using QVscribe, marks are added to the document’s metadata that outline the selected requirements. These marks are an extremely useful tool in gathering all requirements into one easily accessible and navigable list. The marks are also used for the analysis and are a helpful aid when working within the analysis results.

In some instances, you may need to create a clean copy of a document that has been previously analyzed in QVscribe, and that does not include these marks (QVscribe marks may be visible to others that open the document in Excel, even if they do not have QVscribe). In this case, you may remove all marks by pressing Remove Marks on the QVscribe toolbar.

A confirmation window will ask you to confirm that you are about to remove all visible marks from the document. Press OK to confirm, or Cancel to leave the QVscribe marks in the document.

Tip: You can save a copy of your marked requirements documents before removing marks to further speed up any later revisions if needed.

Removing Single Requirements from Analysis

You can remove requirements directly from the QVscribe Quality Analysis screen.

Each requirement row in the Quality Analysis screen has an ‘X’ that will immediately remove the requirement from the QVscribe environment (it will not affect the actual requirement on the document beyond removing the QVscribe mark from it). This is a useful feature if rogue sentences make it into the QVscribe environment.

Note that removing a single requirement will immediately invalidate the Consistency and Similarity analyses as these may depend on that requirement. You will need to rerun the analysis after removing a requirement in order to see the Consistency and Similarity results.

Key/Mouse Actions and Hotkeys for Marking Requirements

Below are Key/Mouse Actions and Hotkeys that can be used in QVscribe for Word.

In Document Actions

Action Type

Result

Double-Click on a single paragraph

Add

Adds selected paragraph as a Requirement.

Double-Click + shift (with a selected requirement)

Modify

Will expand or shrink the Requirement range from the Selected Requirements control range to the paragraph the double-click occurred at.

Double-Click + shift (without a selected requirement)

None

No marking will occur, will just be a word selection highlight.

Double-Click on a Found Requirement

Convert

This will convert the Requirement to a Marked Requirement.

Double Click+ Ctrl on a Marked or Found Requirement

Remove

This will remove the Requirement from the document.

Document + QVscribe Pane Combo Actions

Action Type

Result

Highlight paragraph(s) and click Add button

Add

Adds the paragraph in the highlighted section as a requirement.

Highlight paragraph(s) and click Add button where requirement present in the selected range

None

Nothing will happen and a dialog will appear telling you this.

Select a Marked or Found Requirement and click Remove Button

Remove

This will remove the Requirement from the document.

QVscribe Pane Actions

Action Type

Result

Double-Click on a Found Requirement Node

Convert

This will Convert it to a Marked Requirement

Double-Click +Ctrl on a Marked or Found Requirement Node

Remove

This will remove the Requirement from the document

Double-Click +Ctrl on a selected Group of Marked or Found Requirement Nodes

Remove

This will remove these Requirements from the document

Click on a checked Check Box

Convert

This will convert the Marked Requirement to a Found Requirement

Click on an un-checked Check Box

Convert

This will convert the Found Requirement to a Marked Requirement

Select/highlight Multiple Nodes and click on an unchecked Check Box

Convert

This will convert them all from Found Requirement to a Marked Requirement

Select/highlight Multiple Nodes and click on a checked Check Box

Convert

This will convert them all from Marked Requirement to a Found Requirement

Hit Delete key while selecting a node

Remove

This will remove the Requirement from the document

Up-Down Arrows

Navigation

Will scroll up and down the list in the appropriate direction

Select a Marked or Found Requirement Node and click the Remove button

Remove

This will remove the Requirement from the document

Select/highlight a group of Marked or Found Requirement Nodes and click the Remove button

Remove

This will remove these Requirements from the document