It's not the same without you

Join the community to find out what other Atlassian users are discussing, debating and creating.

Atlassian Community Hero Image Collage

Auto generate requirement number

When writing requirements in Confluence, we are referencing to them by requirement ID.

This is should consist of some short project ID and a number, e.g RPX-E-1, RPX-E-2 ...

What would be the best option to auto-generate this numbers, so that we don't end up having 2 same numbers?

5 answers

1 accepted

2 votes
Answer accepted

You could set up Confluence and JIRA and link them together via Application Links. So you can display a list of issues from JIRA in Confluence.

Then you would create Issues for your requirements. An issue type requirement sounds like a great idea :-) You have to decide if you want to enable other issue types for the same project, too. I would suggest to do so. Then you would have all requirements, bugs and tasks within the same project where they belong to.

Unfortunately JIRA does not create different issue keys for different issue types. So RPX-1 could be a requirement and RPX-2 a bug. For me that never was a problem. When your requirements document is growing, you may delete old requirements or insert new ones, and the numbers are no more continuous. The main thing is that the keys are unique and stable (do not change over time).

The description of the requirements can be crafted into the JIRA issues or into Confluence pages. That depends on how you like to work (try out both and choose one). I would start trying with this setup:

  • create a corresponding JIRA project and a Confluence space
  • requirements have a short title (unique)
  • requirements have a component
  • in Confluence create one page for every component
  • describe all your requirements there (maybe with mockups?)
  • at the bottom of the page you could include a list of JIRA issues matching a certain filter ()
    • your project
    • type requirement
    • the component that is described at this page
  • so you have the resulting document in Confluence, all descriptions on one page and the links into JIRA underneath. If you update JIRA it will be reflected into Confluence automatically
  • If you wish you can export the whole space and get a nice PDF document for all your requirements

Maybe this page is also useful for you:

You can use "Requirement Yogi for cofluence" add-on to generate the requirements keys automated within page or common across space also.

You could use a combination of Confluence and JIRA. Then you could track your requirements directly in JIRA and get those requirement IDs for free :-)

I'm all ears...

Tell me more how would you do that?

Maybe creating a Jira project RPX, and having new issue type Requirement, can we define than that ID for that issue type be like RPX-E-1,..n, to differentiate from bugs and tasks?

Probably should be a better way?

If you don't want to maintain knowledge in two locations, you can actually do all your requirement management work in JIRA!

Just set up a "requirement" issue type as suggested by others, and use the JIRA PDF View Plugin to transform those issues to Requirement Specification documents. As for numbering, you can develop a simple Groovy script for the PDF plugin to auto-generate the numbers for you, depending on issue links or issue labels.

Here is a sample Requirement Spec generated from JIRA issues.

Suggest an answer

Log in or Sign up to answer
This widget could not be displayed.
This widget could not be displayed.
Community showcase
Published Thursday in Confluence

Confluence CVEs and common questions

Two vulnerabilities have been published for Confluence Server and Data Center recently: March 20, 2019 CVE-2019-3395 / CVE-2019-3396 April 17, 2019 CVE-2019-3398 The goal of this article is...

271 views 0 12
Read article

Atlassian User Groups

Connect with like-minded Atlassian users at free events near you!

Find a group

Connect with like-minded Atlassian users at free events near you!

Find my local user group

Unfortunately there are no AUG chapters near you at the moment.

Start an AUG

You're one step closer to meeting fellow Atlassian users at your local meet up. Learn more about AUGs

Groups near you