Release documentation 2: Traceability from FS to Tests

See this use-case live on our sandbox environment here: https://radbee-sandbox.atlassian.net/wiki/spaces/GALACTIKA/pages/73466044/Galactika+functional+specification+and+traceability+to+tests

💡 Our sandbox is on Cloud, but as Jira Snapshots functionality is the same as in Data-Center, the sandbox is useful also for Data-Center users.

This is a followup use case to Release Documentation 1: The Bliss of Full Control Combined with Ease .

For a quick recap, Jira Snapshots dramatically reduces the time you need to spend on release documentation:

Jira data on Confluence page is static and time stamped.
Two, three and more traceability matrices are easy to set up.
You can compare between different versions of the data.
In Confluences' page history: each new snapshot creates a new page version.
Snapshots are included Confluence exports (Word and PDF)

Here, we’ll show how to include Xray test management in the Snapshot.

To setup the integration with Xray checkout Integration: Configuring a Link with Xray Test Management

For details of what is supported by this integration checkout Integration with Xray Test Management for Jira

Use case by Rina Nir _RadBee . RadBee’s CEO “We cannot remove the burden of regulatory compliance, but we surely can rid teams from the waste of time”

Tips

If you use Xray Test Management in Jira, then use Jira Snapshots for test and traceability reports.

JQL:

Level 1 of the traceability selects the functional specifications applicable for our release:

project = GAL AND issuetype = "Functional specifications" AND fixVersion = V1.0 order by 'Requirement type' ASC

Level 2 of the traceability selects the tests traced down from each user requirement:
1. ```
issue in linkedIssues($key,"is tested by") AND fixVersion = V1.0 order by key ASC
```

Prerequisites

This use case assumes that:

Your traceability is built on Jira issues of issue type ‘Functional specification’ (custom issue type) being tested by issues of type ‘Test’ (which is an issue type installed by the Xray Test Management App)
You are using Xray Test Management, and that Xray test issues are linked to Functional specification issue via a ‘is test by’ link. You can adapt the link name or the issue type name to what you have.

Here is how to do it

Login to Confluence and create a new page. Add to it all the “regular text” sections, like ‘Purpose’, 'Scope':
In the top editor toolbar, click the “+” icon and type “jira s” in the search bar. Then, select the “Jira snapshots” macro.
In the “Edit Jira Snapshots Macro” overlay:
1. Enter a title in the “Level title” field to represent the first level or “list” of Jira issues.
2. Enter a query in the “Search JQL” field to limit the scope of issues, like:
  1. project = GAL AND issuetype = "Functional specification" AND fixVersion = V1.0 order by 'Requirement type' ASC
3. In the “Add fields to display” field, select the desired columns.
4. When configuring the traceability report, you’ll need to select: “+ Add new level”
5. Enter a title for the 2nd level
6. Enter a query in the “Search JQL” field. This time it needs to link with Level 1, like:
  1. issue in linkedIssues($key,"is tested by") AND fixVersion = V1.0 order by key ASC
7. In the “Add fields to display” field, select the desired columns.
8. Click the “Insert” button at the bottom right to complete the macro’s configuration.
Click the “Publish” button at the top right of the page.
Finally, click the “Create controlled snapshot” button to generate a static list of issues.

Here’s the finished result.

Need to change the issue list or display different information? Simply edit the macro details and click the “Update” button, on the Confluence page, to take a new snapshot.