Skip to main content

Jama Connect Help

Analyze a requirements statement (Document View)

When Jama Connect Advisor is enabled and configured by an organization admin, you can use it to analyze the quality of the text of a requirement text against industry-standard rules.

Jama Connect Advisor generates a report with the results.

Jama Connect Advisor behavior aligns with the fundamental INCOSE approach that requirements are authored using a single sentence structure. Jama Connect Advisor only analyzes the first sentence of a requirements statement.

To analyze a requirements statement in Document View:

  1. From the Jama Connect header, select Projects > Project.

    The Projects button and Project tab are highlighted for a selected project.

  2. In the Explorer Tree, select the component or folder with the requirement you want to analyze.

  3. In Document View, select the item you want to analyze to open quick edit mode, with the option to expand to full edit mode.

    In Document View, text is displayed for editing and below it, the option Highlight text to analyze is selected.

  4. Highlight the text (up to 400 characters), then select Analyze.

    A User Story is displayed with two paragraphs highlighted and the Analyze selection button is highlighted.

    The initial assessment includes a quality rating and a quick analysis summary.

    The quality rating and quick analysis summary includes a score, number of errors found, and two buttons: View details and Dismiss.

  5. Select View details, read the analysis report, then select X to close the panel.

    The analysis report displays a score for INCOSE Rules analysis and the number of errors found for EARS analysis.

  6. Implement the recommended changes:

    1. Select Dismiss.

      The Dismiss button is highlighted in the example User Story's initial assessment.

    2. Edit the text, following the recommendations from Jama Connect Advisor.

    3. Rerun Jama Connect Advisor on the same text, then read the results.

  7. Select Save & done.

    The screen is refreshed, and your changes are refreshed.

  8. After analyzing your requirements, refresh Document View , then select Display scores.

    Advisor_Display_Scores.png

    The analysis score is displayed next to the Jama Connect Advisor-enabled field label.

    advisor_score_example.png

    • Select the Jama Connect Advisor score to expand the view of the Initial Score and Latest Score, if available.

      score_example_2.png

      The scores are saved when you:

      • Analyze a single-statement when the Item is first analyzed and Save & Done is selected.

      • Analyze with batch analysis when each score is loaded in the slide-over panel.

      • Analyze with batch analysis when the report is exported from the slide-over panel.

In this section: