Requirement Analysis

Quality Analysis in QVscribe for Jama

Running Quality Analysis in QVscribe for Jama can be accessed by clicking on the QVscribe icon at the top of any Requirement Folder or Project.

Once selected, the QVscribe summary dashboard will open. The 5-level scoring gives you a succinct picture of which requirements/items need the most attention and which ones adhere to best practices.

Quality Analysis Details and Quality Indicator Highlighting in QVscribe for Jama

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 the vague words that specific alert has been generated from.

All alerts will be displayed in the order they are found in the text. Alerts can be filtered by using the right-most menu. 

This allows the user to focus on one specific type of alert, hiding all the others (e.g. select “Multiple Imperatives” to only display alerts pertaining to “Multiple Imperatives”). All the alerts can be displayed by choosing “All Alerts” from the right-most menu.

Note: 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 for Jama

Opening Quality Analysis

Within Jama, QVscribe enables the ability to run a Quality Analysis for requirements/items. To access this analysis start by selecting the “Summary View” icon at the top of the page for the set of requirements/items.

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 requirements/items based on the order they are displayed in the requirement/item. You may navigate to any of the individual requirements/items to see their detailed analysis. See Quality Analysis Details section for details. At the top of this view are two tools that will help you refine the list of requirements/items to focus on the areas you want to look further.

Filter Requirement

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

Sort Order

The sort order drop-down provides a number of sorting options based on the requirements/items order, quality score, or the number of warnings associated.

 

 

 

Consistency Analysis in QVscribe for Jama

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 summary view. These analyses display the terms and units found within your requirements/items 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.

You can search for a specific term by entering text beside the magnifying glass icon.

Terms can be organized by selecting the drop down beside the “Alphabetical Order” text in the top right. The options are:

  • Alphabetical Order: Default option, displays terms alphabetically

  • Most Occurrences: Displays terms in order of the number of times they appear from highest number of occurrences to least number of occurrences

  • Most Similar: Displays terms in order of the number of similar requirements/items, from highest number of similar requirements/items to least number of similar requirements/items

  • Highest % Match: Displays terms based on the highest % match to other identified terms

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

This similarity can be tuned in real-time with the Matching Strength Min and Max settings located in the User Settings section of the QVscribe Browser 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 be identical for them to be considered similar, and as this Strength is decreased, then more terms will be considered similar.

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/items where it was found and highlight the unit within. This helps ensure that the right unit is in the right requirement/item and that there is consistency in the system of units used throughout the document (i.e. metric or imperial)

You can search for a specific unit by entering text beside the magnifying glass icon.

Units can be organized by selecting the drop down beside the “All” text in the top right. The options are:

  • All: Default option, displays all the identified units

  • International System of Units (SI): Displays identified SI units

  • Inconsistent with International System of Units (SI): Displays identified units that are not SI units(imperial)

Selecting any unit in the list will display all the requirements/items that include that unit with the unit highlighted.

Unit consistency can be updated any time in the Configurations section of the QVscribe Browser extension.

Units can be customized to suit your team’s needs and can be added, edited, and removed to determine what units are included in the analysis.

Similarity Analysis in QVscribe for Jama

The Similarity section shows the results of the requirements/items similarity analysis. The number of similar requirements/items found is shown beside each requirement/item in the list. 

The requirements/items can be sorted by Order of Appearance (default), Number of Similar, or Highest % Match, by selecting the drop-down beside the “Order of Appearance” text in the top right.

Expanding a requirement/item lists its similar requirements/items on the right, along with a percentage of how similar they are. Clicking a similar requirement/item in the list will display the clicked on requirement/item below the original with the differences highlighted in light purple.

A Matching Strength minimum and maximum setting is available in the User Settings section of the QVscribe Browser Extension.  This lets you adjust how close requirements/items 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/items that may contradict each other. You can also set the Matching Strength to 100% to review if there are any identical requirements/items.

 

Create a report in QVscribe for Jama

In the Summary View, click the ‘Create Report’ button in the bottom right-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.  This will create a PDF of your QVscribe report.

The QVscribe analysis report includes:

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

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

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

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

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

  • A detailed list of all terms and units present.

  • A list of highly similar requirements/items displayed dependent on the current Matching Strength Threshold selected in the QVscribe settings.

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