Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Requirement Yogi offers two ways to create requirements.

Macros

...

Requirement Yogi introduces two macros:

Image Added

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

Macro editor:

Use Confluence macro editor..: INSERT IMAGE

Page transformation:

Inserting a macro directly

Type '/requirementyogi' in the Confluence editor:

Image Added

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
titleImportant

You need to 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.

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:

Image Removed

Then in view mode click on Requirement Yogi:

Image RemovedIn your table, write requirement keys in the first column:

Image Added

Then save the page and open the Requirement Yogi menu:

Image Added


Configure your columns:

...

All your requirement keys and dependencies will be transformed into Requirement Yogi macros:

Image RemovedImage Added

Info

In order to create dependencies using the page transformation tool, both requirements should be defined:

...