Page tree

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

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 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.

See Page transformations




  • No labels