At its core, Requirement Yogi is very simple...
3 ways to insert the macro
| Alt + Shift + R |  | |
|---|---|---|
| Or the "Insert more content" menu. |  | |
| Or type "{" then "req" |  |
What the macro does
When the page is saved, the macro makes the whole line into a requrement. Example:
| In the editor |  |
|---|---|
| When viewing the page |  |
| Displaying the popup |  |
Where requirements can be seen
Thanks to the macro, requirements have a unique hyperlink. Requirements can be seen:
| In the popup | |
|---|---|
| In any popup that references to this requirement |  |
| In other requirements (in which case they're called dependencies) |  |
| In the search |  |
| In JIRA |  |
That's all you need to know, literally!
Everything else is tools around the Requirement macro. Get going with your job!
- You'll need some search at one point,
- You can use some blueprints so all your documents look the same with requirements in the middle,
- You'll ask for versioning at one point, we've built it,
- You'll make cross-dependencies and ask for coverage, we have that also,
- You'll ask for a testing solution, either you use our extension (RY Testing and Compliance) or you integrate with others like SynapseRT.
But keep it simple, start with writing requirements!