Skip to main content
Skip table of contents

Writing requirements

Requirement Yogi offers various ways to create requirements. If you prefer tutorial videos, watch the first tutorial:

Add Requirement Yogi Macros

Requirement Yogi has two main 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. You can link requirements across spaces or variants.

Inserting a Definition 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.

We give suggestions based on the already created requirements in the page.


To get the most out of Requirement Yogi, you should 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.

You can also have requirements defined in paragraphs or headings, in which case the requirement properties will be defined by the following text (See Configuring requirement properties).

Requirement Yogi Link macros that can be inserted anywhere in the page.

Inserting requirements in bulk

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.

See Page transformations

What your requirement looks like

When you have written your requirements, click on it!

  • You’ll see each of its properties, dependencies, external properties and Jira Links.

  • Thanks to our treeview, you’ll be able to navigate easily across your requirements and pages

Requirement Detail Example.png

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.