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:
...
Use Confluence macro editor..: INSERT IMAGE
...
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.
| Info | ||
|---|---|---|
| ||
You need to use a specific format for your pages:
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.
Start by creating tables in a Confluence page:
Then in view mode click on Requirement Yogi:
In your table, write requirement keys in the first column:
Then save the page and open the Requirement Yogi menu:
Configure your columns:
...
All your requirement keys and dependencies will be transformed into Requirement Yogi macros:
| Info |
|---|
In order to create dependencies using the page transformation tool, both requirements should be defined:
|
...