QVscribe for DOORS Next

Installation

QVscribe DOORS Next Prerequisites

QVscribe is an Add-in (extension) for Google Chrome with the following prerequisites for installation:

  • Microsoft Windows version 10, 64 bit

  • Google Chrome 85 or Greater

  • 4 GB and above RAM

Currently, QVscribe supports DOORS 6 and above versions.

QVscribe DOORS Next User Set up

All QVscribe for DOORS Next users will need the following to get up and running:

  1. Download files for QVscribeForChrome

  2. The QVscribe Teams Server hostname/IP

  3. Their username and password *Note this not needed if you are using Active Directory for licensing

Below outlines all the steps they will need to take to get up and running with QVscribe for DOORS Next,

QVscribe 3.0 Installation Process

Step 1: Run the installer (QVscribeForChrome)

Step 2: Open Google Chrome and type chrome://extensions in your address bar.

Step 3: Enable the Developer Mode present on the top right corner of the window.

Step 4: Select Load-Unpacked

Step 5: Select folder (%appdata%QRA Consulting IncQVscribechromeextension) in your Google Chrome. The QVscribe 3.0 icon will show up on the top-right corner in the extension bar.

Step 6. Disable the Developer Mode.

Step 7: Click on the QVscribe 3.0 icon and check the status of the analyzer.

If the analyzer is offline click on Start Up Anaylzer and Log into Server button.

Step 8: Enter your QVscribe for Teams Server IP or Hostname and then click Connect to your QVscribe Team Server . Note: This should be provided to you by the QVscribe Admin.

Step 9: Pick your identity provider. This information will be provided by your QTS Admin as well. If you are connecting via QTS User Directory, you should have a username and password. Alternatively, if you are set up to connect via Active Directory, you will automatically connect via your computer login credentials.

Option 1: Connecting by QTS User Directory (Username and Password)

You will then be prompted to enter your username and password

Once you have connected you by username and password, you will receive the following message.

Option 2: Connecting by Active Directory

Once you have connected you by AD, you will receive the following message.

QVscribe 3.0 Doors Connector Installation Process

Step 1: Log into DOORS Next

Step 2: Open Mini Dashboard within DOORS Next

Step 3: Click on Add Widget button.

Step 4: Within the add widget dialog box, click on Add OpenSocial Gadget.

Step 5: Add QVscribe 3.0 connector url. Note this URL will be provided in your READ ME file attached to your QVscribe DOORS Next Download files.

Step 6: Click on Add Widget.

To ensure that the QVscribe connector remains active, please pin the Mini Dashboard open using the pin button in the top right corner. If you do not pin the Dashboard you may need to click open the Dashboard again each time you log in or refresh the page.

QVscribe 3.0 service running

The extension requires the underlying QVSAnalyzer service to be running
Step 1: Open the extension in Chrome

Step 2: QVS Analyzer status should indicate online, if not, press Start QVS Analyzerand follow Steps 7-9 above

Requirement Selection and Views in QVscribe

Configuring what Artifact Types are analyzed in QVscribe for DOORS Next

Artifact Analysis Settings

Within the QVscribe Chrome Extension, the Artifact Analysis settings can be found under User Settings.

In the left column titled “Artifacts Analyzed” is the list of artifact types that QVscribe will include in the summary analysis feature.

Managing Artifact Types to be Analyzed

By default, as you browse from module to module within DOORS NG, QVscribe will automatically detect and add any new artifact types that are being used within a module and not present in the “Artifacts not Analyzed” column to the set of “Artifacts Analyzed”.

Remove Artifacts from Summary Analysis

If there is an Artifact type you do not wish to be included in the summary analysis, simply select it from the “Artifacts Analyzed” set and select “Remove”.

At least one artifact type must be enabled within the “Artifact Analyzed”  set setting for QVscribe.

Including Artifacts in Summary Analysis

If there are any artifact types that you would like to be included in the summary analysis, simply select it from the “Artifacts Not Analyzed” column set and select the “Select for Analysis” button.

Once selected, the module is refreshed in your browser and the QVscribe icon is displayed in the module, the summary view will include the analysis for the newly added artifact type.

 

Summary View in QVscribe DOORS Next

When viewing a module with QVscribe for DOORS Next installed, the QVScribe icon will be displayed to the right of the module name. Selecting this icon will open the QVscribe Summary view for all analyzed artifacts.  

The summary view is organized in 3 key sections.

Quality Score Summary 

This section will display all analyzed artifacts types within the selected module. Each artifact will be categorized according to their level of risk. Selecting any of the score bars will navigate users to the Quality Analysis section filtered for the selected quality score.

To view the second page of summary information that displays the same artifacts broke down by the specific quality issues, you can select the second dot at the bottom of the page.

This will navigate you from page 1 to page 2.

Quality Warnings

The Quality Warnings sections will display the artifacts that have issues that QVscribe recommends additional attention or review.

Selecting any of the warning categories will navigate users to the Quality Analysis section filtered for the selected quality score.

Summary Navigation

The Navigation section provides easy access to the various analysis types available in the summary view.

Selecting any section from the navigation pane will display the associated analysis views available in the summary view.

This section also includes the overall score for all analyzed artifacts in the selected module.

Authoring View in QVscribe for DOORS Next

While viewing a module with QVscribe for DOORS Next installed, when “Edit mode” is active for a specific artifact, the QVscribe icon will be displayed.

Inline edit mode shown above and Artifact details edit mode shown below

Artifact Once selected QVscribe will open the text in the selected artifact into the QVscribe authoring view. The authoring view is made of 3 sections.

Artifact text

This section provides access to the text of the artifact with any alerts highlighted and colour coded. 

Within 2 seconds of any changes to the text,  QVscribe will automatically rerun the quality analysis updating the score and any associated alerts according to the active configuration. Once the text updates are complete, simply close the QVscribe authoring view to update the text in the artifact. 

QVscribe will not commit any changes to DOORS Next. It will be important to complete your changes in DOORs Next as you normally would.

Alerts

The alerts section will identify all associated alerts with the selected text. Red alerts indicate issues that are affecting the quality score of the requirement while yellow alerts provide warnings recommending additional attention.

Selecting any of the alerts will expand the alert, displaying additional information about the alert for the author’s consideration.

Filters

The filters section provides users with the ability to filter the specific alerts that are displayed in the Authoring View. 

Selecting any of the alert categories will filter the alerts, displaying only the selected category. 

Additionally, the filter section provides the quality score for the requirement and also displays the link to select from a number of EARS Templates.  See QVscribe for DOORS Next EARS Templates section for more details.

Requirement Analysis

QVscribe Quality Analysis DOORS Next

Running Quality Analysis from in QVscribe for DOORS NG can be accessed by clicking on the QVscribe icon at the top of any module.

Once selected the Quality Analysis section shows a scorecard where each row corresponds to a marked artifact in the module along with its quality score. The 5-level scoring gives you a succinct picture of which artifacts need the most attention and which ones adhere to best practices.

Quality Analysis Details and Term Highlighting in QVscribe DOORS Next

When viewing the details of any analyzed artifact in QVscribe that has one or more alerts, selecting the alert will highlight the element of the artifact that created the alert.

In the example above the quality alert for “Vague Words” has been generated, selecting the alert will then highlight specific vague word that specific alert has been generated from.

If some analysis results are inconsistent with your company standards, ensure that the QVscribe Configuration being used is appropriate for the document, or talk to your QVscribe administrator about creating a QVscribe Configuration that more directly adheres to your specific standards.

Sorting and Filtering Quality Analysis results in QVscribe DOORS Next

Opening Quality Analysis

Within DOORS Next, QVscribe enables the ability to run Quality Analysis of requirements. To access this analysis start by selecting the “Summary View” icon next to the name of the module you are in.

Within the summary view select “Quality Analysis” from the right hand Navigation Menu.

Quality Analysis

After selecting “Quality Analysis” QVscribe will present the Quality Analysis for each of the Artifacts in the module based on the order they are displayed in the module. You may navigate to any of the individual artifacts to see their detailed analysis. At the top of this view are 2 tools that will help you refine the list of artifacts to focus on the areas you want to look further.

 

Filter Requirement

Filter Requirement provides a drop down list that allows you to display artifacts based on the 1-5 score calculated by QVscribe as well as the different Quality Issues that exist within the list. Selecting any item in the options in the list will filter the artifacts displayed for the selected item.

 

Sort Order

The sort order drop down provides a number of sorting options based on their order, quality and number of warnings associated.

 

 

QVscribe Consistency Analysis in QVscribe DOORS Next

QVscribe’s Consistency feature includes 2 types of analysis, units and terms. You can navigate to these analysis types through the corresponding section in the module view. This analysis displays terms and units enumerated and in sortable and searchable lists.

Term consistency 

All found terms and phrases that appear to be domain-specific are displayed, along with a total count and number of terms similar to it.

This similarity can be tuned in real-time with the Matching Strength Min and Max settings located in the QVscribe Chrome extension. 

The Matching Strength gives the tolerance in the assessment of term similarity, such that a Matching Strength of 100% means the terms have to actually be identical for them to be considered similar, and as this Strength is decreased, then more terms will be considered similar.

The terms in the Consistency section can be explored by selecting any term to show all requirements where that term appears, as well as a list of similar terms and the %-similarity for each. Each of these similar terms can be expanded to show the requirements where it appears. This helps rapidly verify that these similar terms are valid in their own right, and reside in the correct requirements.

Unit Consistency

Unit Consistency displays all units detected, along with their type categorization and total count. Each unit in the list can be expanded to show the requirements where it was found and highlight the unit within. This helps ensure that the right unit is in the right requirement and that there is consistency in the system of units used throughout the document (i.e. metric or imperial).

Selecting any unit in the list will display all the artifacts that include that unit with the unit highlighted.

QVscribe Similarity Analysis in QVscribe DOORS Next

The Similarity section shows the results of the artifacts similarity analysis. The number of similar artifacts found is shown beside each artifact in the list. Expanding an artifact displays its similar requirements along with a percentage of how similar they are to each other.

When you click on a single requirement, the similar requirements are then listed below.  Clicking an additional requirement in that list will then display the requirements slide by side with the differences highlighted in light purple.

A Matching Strength min and max setting is available in the configuration section of the Chrome Extension.  This lets you adjust how close requirements need to be in structure and terminology to be considered similar. 

It is useful to try different Matching Strength settings within 75% to 95%. This will display requirements that may contradict each other. You can also set the Matching Strength to 100% to review if there are any identical requirements

How to create a report in QVscribe DOORS Next

In the Summary View, click the grey button in the bottom left-hand corner.

 

A window will appear for you to configure the report and choose the file name. Once your settings are set, press Create Report.

 

The QVscribe analysis report includes:

  • Document title, analysis date, the configuration used, and a total number of analyzed requirements.

  • Score Summary detailing the number of requirements with each score.

  • Analysis Breakdown showing how many requirements include each of the QVscribe quality indicators.   

  • Summary of EARS Conformance for all requirements (Easy Approach to Requirements Syntax)

  • The list of individual requirements with their corresponding scores, quality indicator/unit highlighting, analysis details, EARS conformance, number of similar requirements, and a terms list

  • A detailed list of all terms and units present

  • A list of highly similar requirements displayed dependent on the Matching Strength Threshold chosen

  • A detailed Appendix of the Configuration settings used during the analysis

 

Configuration and User Settings

Navigating the QVscribe DOORS Next Configuration Window

The QVscribe for DOORS Next configuration can be accessed using the Chrome Extension located to the right of the address bar in Google Chrome.

The QVscribe for DOORS Next Configuration has 3 key sections. Configurations, User Settings, and Help Center. The default screen highlights the active configuration, the user currently signed into QVscribe, the version number of the extension, the status of the QVscribe analyzer as well as quick access to the QVscribe Help Center.

The ability to select any saved configuration is available to all users, but to change settings within the configuration requires the “Configuration Author” role.  You may select a saved configuration in the drop-down menu on the top right corner of the QVscribe window.

The configuration section of the QVscribe extension is used to modify settings for:

  • Trigger words

  • Term Consistency match strength

  • Unit Consistency

  • Similarity match strength

  • Exclusion Prefixes

  • EARS Templates availability

Once Configurations has been selected there is a secondary menu that will allow users to navigate to the settings for each of the above sections.

The Trigger Words option can be further expanded to display a tertiary menu to edit each of the configurable quality indicators.

The User Settings section provides a more detailed overview of the user account information including seat pool, version number of QVscribe, status of the QVscribe Team Server, address of the QVscribe Team server, and currently selected Identity provider. Additionally, this is where users can sign out of QVscribe.

The Artifact Analysis settings provide a list of the artifact types that are currently being analyzed by QVscribe in DOORS NG. 

The Help Center provides users a link to the QVscribe Knowledge Base as well as access to support contact details and the ability to provide QVscribe logs that can be used to diagnose issues should they arise. 

Help Centre in QVscribe DOORS Next

The QVscribe Help Centre details can be found by clicking the QVscribe extension.  

To go to OnlineHelp Centre, you can find the link directly on the main page of the QVscribe Extension Menu.

If you select the Help Center option on the left, you can find more information.

 Another link to the Help Centre can be found here.

If you experience errors or unexpected behaviour in QVscribe or if you would like to contact us for assistance, select the Contact Support option on the left.

Follow the steps outlined on this page to contact QVscribe support.

 

Easy Approach to Requirements Syntax (EARS)

QVscribe DOORS Next EARS Templates

EARS or the Easy Approach to Requirement Syntax is a standard for writing requirements that will improve the quality of your written requirements. Read more here.

EARS Templates in QVscribe

When users are viewing a requirement in QVscribe’s authoring view, there is an option to insert an EARS template.

 

Select Template Type

Select from one or more of the EARS templates made available within QVscribe.

Insert a Template

Expand any option to view the full template and display the link to insert it into the authoring view. Click the grey icon to insert the template into your requirement.

 

Edit the template

Once the template has been added to the requirement section, you are able to modify it freely.  After modification QVscribe will check for conformance with any EARS template and score it according to the active configuration.

EARS Template Conformance in QVscribe DOORS Next

EARS or the Easy Approach to Requirement Syntax is a standard for writing requirements that will improve the quality of your written requirements. Read more here.

EARS Compliance

When viewing an Artifact’s Quality Analysis, QVscribe will automatically detect if a requirement is compliant with the EARS standard. The identification of an artifact’s compliance with the EARS standard will be displayed in the Alert Column displayed below.

Selecting the Alert will provide an expanded view of the alert with additional information about compliance  of the standard.

 

Additionally, the specific type of EARS requirement will be displayed in the left hand menu.