Requirement Yogi offers two ways to create requirements.
Macros
Requirement Yogi introduces two macros:
- Requirement Yogi macro: Use this macro to define a requirement. This macro must be in a table.
- Requirement Yogi Link: Use this macro as a link to the original requirement and/or to create dependencies between requirements.
Inserting a macro directly
Type '/requirementyogi' in the Confluence editor:
The key must be unique in the space and identifies your current requirement. This will be useful when you need to reference this requirement across your documentation.
Important
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, the properties and the dependencies.
Macros outside those tables are dismissed, unlike Requirement Yogi Link macros that can be inserted anywhere in the page.
Inserting requirements automatically
You can use Requirement Yogi to transform a page and automatically create Requirement Yogi macros.
This is especially helpful when you want to copy paste an existing document into Confluence and easily create requirements.
In your table, write requirement keys in the first column:
Then save the page and open the Requirement Yogi menu:
Configure your columns:
- Requirement Key: The column values will be transformed into Requirement Yogi macros.
- Description: The column will be used as a description for requirements.
- Property: The column will be used as property for requirements.
- Dependency: The column values will be transformed into Requirement Yogi Link macros, the column's label will be used as a relationship for dependencies.
- Property and dependency: The column values will be transformed into Requirement Yogi Link macros, as well as considered as requirement's properties.
All your requirement keys and dependencies will be transformed into Requirement Yogi macros:
In order to create dependencies using the page transformation tool, both requirements should be defined:
