Configuration

QVscribe Configurations

The way QVscribe analyses requirements and displays analysis results depends on the analysis configuration being used. To set a QVscribe configuration for analysis on the active document, select from the pull-down list.

In QVscribe for Individuals, QVscribe comes with a default analysis configuration. We recommend that you review and edit this configuration to create a configuration that adheres to your specific processes and standards.

In QVscribe for Teams, only users that have been assigned as Configuration Administrators in the QVscribe Team Server will be able to edit/create analysis configurations.

Navigating your Configuration Window

The QVscribe Configuration window contains four main tabs: Trigger Words, Unit Consistency, Exclusion Prefixes, and Templates.

There are also two other main tabs exclusive to QVscribe for Word: Tables and Key & Mouse Actions

The Trigger Words tab consists of sub-tabs, each representing a class of words/phrases corresponding to each key quality indicator used in the analysis and scoring of requirements.

Each Quality Indicator sub-tab consists of two lists of trigger words:

  • the list on the left labeled Your Words, which are the terms used during the QVscribe quality analysis to assess that quality indicator in the requirement

  • the list on the right labeled Example Words showing the set of most common trigger words to move to the Your Words list by selecting it and pressing the arrow button below the list (< )

Note that the Your Words list of trigger words comes pre-populated with the Example Words, but this should generally be modified to meet your specific requirements standards.

Making changes to your QVscribe Configuration

Adding a New Word/Phrase
To add a new word to the Your Words list click the Add button. Enter the word/phrase you want to add to the list and then click OK.

Editing Word/Phrase
To edit an existing trigger word, click on the word you want to edit in the Your Words list and click the Edit. Edit the word/phrase as needed and click OK.

Removing Word/Phrase
Click on the trigger word you want to remove from the Your Words list, and click the Remove button. Once all changes are completed, click OK on the QVscribe Configuration window to save the changes or Cancel to discard all changes.

A Note on Continuances and Directives
Continuances and Directives are quality indicators that may help in the analysis of requirements. There are different approaches to their use and QVscribe allows you to turn off their assessment so as to not adversely affect the requirements quality scores. Just check the Exclude from Analysis box.

Unit Consistency
Measurement units are key to the specification of qualities in requirements. QVscribe scans
through all marked requirements and detects any units within them based the user-configurable
list accessible in the configuration window. This list maintains the unit name, unit type, and common abbreviations.

Each unit can be enabled/disabled, edited, or removed. You can also add and edit units in this list by pressing Add or Edit and entering the new details for the unit. Selecting whether the unit is part of the International System of Units simply allows for the filtering of units present in a document based on these SI or not.

Exclusion Prefixes
In requirements documents, there are often paragraphs relating to the main requirement specification that are meant as comments, rationales, or explanations meant to provide context to the related requirement, but generally, do not follow proper requirements best practices.

To address this, the Exclusions Prefixes tab
helps by defining in QVscribe what term(s) is(are) used to define these context paragraphs so they are not included in the analysis of the actual requirement, and thus not skew the requirement’s score.

Note: the paragraph will need to begin with this prefix for QVscribe to relate it to the requirement.