Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Macro

...

Requirement Yogi introduces two macros:

Image Added
  • Requirement Yogi macro: Use this macro to define a requirement.
  • Requirement Yogi Link: Use this macro as a link to the original requirement and/or to create dependencies between requirements. 

There are Let's discover the two ways as of now to create Requirement Yogi macros.

Macro editor

...

Use Confluence the macro editor..: INSERT IMAGE

Image Added


Requirement Yogi macros should reside in tables otherwise they will be dismissed, unlike 
Info
titleIMPORTANT

You need to use a specific format for your pages:

  • Your page should contain tables,
  • One column, preferably the first, should contain the requirement keys,
  • The other columns are the description and the properties.

Macros outside those tables are dismissed, unlike Requirement Yogi Link macros that can be inserted anywhere in the page.


Page transformation

...

You can use Requirement Yogi to transform a page and automatically create Requirement Yogi macros.

...

Info

In order to create dependencies using the page transformation tool, both requirements should be defined:


Search:

Requirement Yogi offers an easy way to search for requirements by key, text or properties.

...

Info
titleIMPORTANT

As of now, you can only search for requirements that are in the same space, we will include cross space search in the next release.

In both Search and Traceability matrix screens, you can click on a requirement to display a popup with its description, properties, dependencies and links.


Traceability matrix:

Traceability matrix is a great tool to visualise requirements reports.

Start by a search query to display a set of requirements.


Add columns:

You can easily add columns to display more details about your requirements.

...

Info
titleIMPORTANT

We recommend refining your search query to only display the requirements you are interested in.

By default the limit is 200 rows displayed at once, you can change the limit but it's not recommended for performance concerns.


Delete all your data:

Admins can chose to manually delete all Requirement Yogi data. We don't recommend doing that as we will automatically delete it for you two months after you uninstall our product.

...