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.

Editing/Authoring in Summary View

Users will have the ability to edit/author requirements within the Summary view. This can be done when you open a requirement within the Quality Analysis.

Once you open up a requirement, you will see an icon in the top right beside the requirement. You can click this icon to edit/author the requirement.

This icon will bring you to your authoring/editing window. You can edit directly into DOORS or you can click on the QVscribe button at the bottom.

This brings you to the authoring view, where you can make changes. The QVscribe analysis will update to your changes showing you whether your score is improving.

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.