Insights

The Insights feature in the requirements module provides a comprehensive visual summary of the current requirements status within the specification/section within your project. This interactive tool offers a high-level overview of various aspects, such as the state, verification status, and discussion activity on the requirements related to requirements across different folders, specifications, and sections. The feature provides the ability to quickly grasp the project's progress and identify areas that may require attention.

Accessing Insights

To access the Insights feature, navigate to the requirements module in your project and then click the  button at the top right.

Insights Interface

Upon opening the Insights feature, you will encounter several graphical representations. These graphs are generated from the requirements within the specification/section or folders. Currently, the Insights shows the following information.

  • State

  • Requirements V&V Status Chart

  • Number of Requirements within the Specification/section/folder

  • Requirements Activity (display the requirements that are modified recently)

  • Quality Assessment graph

State Graph

This pie chart displays the proportion of requirements in different states:

  • Not Defined: Requirements that have not yet been specified.

  • Draft: Requirements that are currently in the draft phase.

  • In Review: Requirements that are under review.

  • Final: Requirements that have been finalized.

If custom states are defined in the settings (on the Project Settings – States page of the Settings), they will also be included in the graph.

Requirements V&V Status Chart

Another pie chart shows the number of requirements that are verified or not verified or partial verified within the specification.

  • Not Verified: Requirements that have not been verified.

  • Partial Verified: Requirements that have been partially verified.

  • Verified: Requirements that have been fully verified.

Quality Assessment

The Quality Assessment feature is an AI-powered tool designed to help you to maintain high-quality requirements. By evaluating the text against several quality parameters, this feature provides a Quality Assessment Score and a Quality Assessment Comment for each requirement, which is displayed in their respective columns within the Requirements module. This allows you to identify requirements that might need further refinement quickly.

Accessing Quality Assessment

To utilize the Quality Assessment feature, select the requirements, click the  button and select the Assistant » Quality Assessment command. The Quality Assessment window will open. You will be informed of how many Requirements will be analyzed. Using the text field in the Prompt Extension region, you can provide additional instructions.

Click  to proceed. Once the process is finished, the next window will inform you that the quality assessment was successful.

The Quality Assessment Score and Quality Assessment Comment columns in the specification's table will provide additional information about the quality of your requirement text.

The Quality Assessment graph on the Insights view will show the updated results. In case you would like to do the new assessment, you can also do the refresh by click the  button at the top right of the graph.

Quality Assessment Graph

This circular graph displays the quality levels of your requirements:

  • High: Indicates requirements of superior quality.

  • Medium: Represents requirements that are adequately defined but might need improvement.

  • Low: Signifies requirements that are likely to require significant refinement.

  • Not Defined: Pertains to requirements that have not been evaluated or are missing sufficient information.

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Contents
Feature Availability

The features available to you depend on which Altium solution you have – Altium Develop, Altium Agile Teams, Altium Agile Enterprise, or Altium Designer (on active term).

If you don’t see a documented feature in your actual software, contact Altium Sales to find out more.

Contents