...
3 ways to insert the macro
Alt + Shift + R |   |
Or the "Insert more content" menu. |   |
Or type "{" then "req" |   |
What’s the purpose of the macro?
When the page is saved, the macro makes the whole line into a requirement. Example:
In the editor |  .png?version=1&modificationDate=1679402599114&cacheVersion=1&api=v2) |
When viewing the page |  .png?version=1&modificationDate=1679402610505&cacheVersion=1&api=v2) |
Displaying the popup |  .png?version=2&modificationDate=1679402620912&cacheVersion=1&api=v2&width=226) |
Where can I see requirements?
Thanks to the macro, requirements have a unique hyperlink. Requirements can be seen:
In the popup |
.png?version=2&modificationDate=1679402620912&cacheVersion=1&api=v2) | |
In any popup that references to this requirement |  |
In other requirements (in which case they're called dependencies) |
 |
In the search |
 |
In JIRA |
 |
Do's and Don't
Do | Don't |
|---|---|
Write relatively short titles for your requirements, then add details in other columns. | Don't write a full document inside a requirement. It is not useful for a user to display "everything" in JIRA, especially since it is not designed for it. Confluence is much better at displaying content. |
Use a table to structure your requirements, link one requirement per row. | Better not try to define a full paragraph or section of a document as a requirement. |
Use short requirement keys with a prefix. Example: "FUNCTIONAL-001" or "FN-001". | Use spaces or expressions as requirement keys. Only letters, numbers, underscore (_), hyphen (-) and dot (.) are accepted. Don't use the view mode's "inline creation" if you're starting. That only becomes useful when you're tired of importing requirements from Word. |
...