See this in action in our Sanbox https://radbee-sandbox.atlassian.net

Release Documentation 1: The Bliss of Full Control Combined with Ease

Owned by Rina Nir _RadBee
Last updated: Aug 06, 2021 by Bonnie Roskes (Unlicensed)
4 min read

See this use-case live on our sandbox environment here: https://radbee-sandbox.atlassian.net/wiki/spaces/GALACTIKA/pages/73466010/Galactika+user+requirements+and+traceability

If you work in a regulated industry, you need to issue up-to-date release documents before a release goes live.

You manage the specifications and tests in Jira, and it’s frustrating to run into these limitations:

  1. Because of the dynamic nature of Jira macros in Confluence, you can’t use them for the release documents; you can’t assume that the Jira data won’t change.

  2. It's difficult to create proper traceability documents.

Overcoming these limitation means using hacks, workarounds, or various apps and scripts.

With Jira Snapshots, creating release documents directly in Confluence is secure and quick:

  1. The Jira data on Confluence page is static and time stamped. No matter what happens in Jira, the Confluence page will not change until you want it to change.

  2. Two traceability matrices, or three, or more, are easy to set up.

  3. Extra bonus: You can compare different versions of the data. Stakeholders absolutely love this feature because of the visibility of what changed since the previous release.

  4. Confluence page history: Each new snapshot creates a new page version. When you view previous versions of a page, the page includes the correct historic snapshot.

  5. Snapshots are included in Confluence exports (Word and PDF).

So with Jira Snapshots, release documents can be ready as soon as the product release is ready - no delays or wasted time.

Use case by Radbee CEO @Rina Nir _RadBee

“We cannot remove the burden of regulatory compliance, but we can certainly save teams from wasting time.”

 

 

Prerequisites

This use case assumes that your traceability is built like this:

  • Jira issues of issue type “User requirement” (custom issue type)

  • are linked with “Traces down to” links (custom link type)

  • to issues downwards the traceability chain (like “Functional Specifications”).

How to Do It:

  1. Log in to Confluence and create a new page. In this page, add all the “regular text” sections, such as “Purpose,” “Scope,” etc.

     

  2. In the top editor toolbar, click the “+” icon and type “jira s” in the search bar.  Then select the “Jira snapshots” macro.

     

  3. 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, such as:

      1. project = GAL AND issuetype = "User requirement" 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, such as:

      issue in linkedissues($key,"Traces down to") 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.

       

  4. Click the “Publish” button at the top right of the page.

     

  5. Finally, click the “Create controlled snapshot” button to generate a static list of issues.

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.