Macro
Requirement Yogi introduces two macros:
- 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.
Let's discover the two ways to create Requirement Yogi macros.
Macro editor
Use the macro editor:
| 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. |
Page transformation
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:
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.
| 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.
On the left side bar click on Requirements
Please check out our Search Syntax for more details.
| Info | ||
|---|---|---|
| ||
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.
Possible values:
- From/To dependencies: Displays the dependencies of each requirement based on a relationship.
- Links: Displays the title and the link to the page where the requirement was cited.
- Properties: Displays the property of a requirement.
- Description: Displays the description of each requirement.
Example:
| Info | ||
|---|---|---|
| ||
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 productCheck the following pages that explains how to use Requirement Yogi for Cloud: