Requirement Analysis

Analyzing your requirements

Once you have selected all the requirement you would like to analyze and ensured that QVscribe is using the appropriate analysis Configuration for your document, press the Analyze # Requirements.

Once you press Analyze # Requirements a pop-up window will appear showing the analysis in progress. The duration of the analysis will depend on the number and size of requirements confirmed. This should not take longer than a couple of minutes.

QVscribe performs three distinct types of analysis on the selected requirements, each focusing on a key area:

1. Requirements Quality: Each requirement is assessed and scored based on the analysis configuration that encodes established requirements engineering standards, the INCOSE Guide for Writing Requirements and best practices. The quality analysis uses the following set of Key Quality Indicators in its algorithms.

Imperatives

Non-specific Temporal Words

Negative Imperatives

Continuances and Combinators

Vagues

Directives

Optional Escape Clauses

Justification(warning)

Optional Open-ended Clauses

Universal Quantifiers and Absolutes (warning)

Superfluous Infinitives

Passive Voice (warning)

Cross Referencing Pronouns

Incomplete sentence (warning)

Immeasurable Quantification

2. Term and Unit Consistency:

Terms: QVscribe detects and highlights all noun-phrases found in the requirements and displays them along with the requirements containing them, and along with any similar terms. This helps verify that domain-specific terminology is consistent throughout the document and that the correct terms are used in each requirement.

Units: QVscribe detects and highlights all units in the selected requirements based on the list of units in the QVscribe Configuration. The detected units are displayed by type, along with the requirements containing them. This helps assess that all units are correct and consistent throughout the requirements.

3. Requirements Similarity: QVscribe analyzes the syntax of each requirement and shows any requirements found that is similar to it. The level of similarity can be tuned higher or lower to help assess if duplicates or contradicting requirements are present.

QVscribe Quality Analysis

The Quality Analysis tab shows a scorecard where each row corresponds to a marked requirement in the document along with its quality score. The 5-level scoring gives you a succinct picture of which requirements need the most attention and which ones adhere to best practices.

Quality Analysis Details and Term Highlighting

Every requirement in the scorecard that has a score of less than 5 bars can be expanded to reveal details on what quality indicators issues led to the given score. The requirement within the main document will be selected and the issues will be highlighted. This helps you you understand where exactly the requirement is not meeting best practices.

The example above has the problematic terminology highlighted. There is the use of a negative imperative ‘shall not’, as well as superfluous infinities ‘limit’ and ‘capability’

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 Filterings Quality Analysis Results

The value of the scorecard is especially evident when the results are sorted and filtered. This allows you to cut through the noise in the document and focus on the areas that need the most attention first.

To sort by Requirements or by Scores, click on the header of the desired column. Sorting by score can quickly let you see where the most problems are and the source of these problems.

You are also able to filter the results based on the individual quality indicator being affected in the requirements. To filter the results, press on the Issues pulldown list above the Score column and choose from any of the found issues.

QVscribe Consistency Analysis

The Consistency tab shows the results of the terminology and unit consistency analysis. This analysis displays terms and units enumerated and in sortable and searchable lists. Each term or unit in the list can be expanded to show the corresponding requirements where the term or unit was found.

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 slider. 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 tab can also be explored by double-clicking on them 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 in turn also 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.

The Unit Consistency results display all units detected, along with their type categorization and total count. Each unit on 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 also consistency in the system of units used throughout the document (i.e. metrics or imperial).

QVscribe Similarity Analysis

The Similarity tab shows the results of the requirement similarity analysis. The number of similar requirements found is shown along with each requirement in the list and expanding a requirement in the list displays its similar requirements along with a percentage of how similar they are to each other.

Similar to the term similarity function in the Consistency tab, a Matching Strength slider lets you adjust how close requirements need to be in structure and terminology to be considered similar. It is useful to try different 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

When compared, the two similar requirements will be displayed at the bottom of the screen where the similarities and differences are highlighted. All similarities are highlighted in red and all differences are highlighted in green.

Generating a report

The final step in using QVscribe is to generate an analysis report. To do this, press on Generate Report. A window will appear for you to set the location and file name of the analysis report, as well as configure how the report should present the analyst results. Once your settings are set, press Create.

The QVscribe analysis report includes:

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

  • Score Summary detailing the number of requirements with each score

  • Analysis Breakdown for each quality indicator and how many requirements had issued with it

  • The list of Individual Requirements with their corresponding scores, terminology highlighting, and
    analysis details

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

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