Skip to main content
Skip table of contents

Write requirements in tables

Why do we recommend to use tables?

  • Each column becomes a property of your requirement.

    • A property is present in the Confluence page where your requirement is defined. A property is different than an external property, which is not present in the page.

  • You can then use those properties in the search syntax,

  • Or, add them specifically to your traceability matrices.

  • Use the Transformation wizard and optimise your work to generate requirements, and much more.

Watch our quick tutorial for more details:

Horizontal Tables

The first way to write requirements is in horizontal tables, like this:

Requirements in Horizontal tables.png
Requirement's detail.png

Each column will be indexed as the requirement’s property. By default:

  • The first column is the requirement key.

  • The second column is the description of the requirement.

  • Other columns are properties or dependencies.

    • Properties can have text, confluence macros such as the STATUS MACRO , images etc.

    • Dependencies are requirement yogi link macros present in a column. The name of the column is the name of the relationship between the two requirements.

      • In the example above: BR-01, BR-04 and BR-06 are parents of the requirement FN-01, with the relationship Refines.

  • It is possible to configure columns and override the column’s name with the Configuration macro. (It is not mandatory to use this macro).

Vertical Tables

It is also possible to use vertical tables for your requirements. It works the same way as horizontal tables, but instead of columns, it’s rows.

Vertical Tables.png
Vertical requirement detail.png

Each row will be indexed as the requirement’s properties. By default, we use the same order as the horizontal tables:

  • First row is the requirement,

  • Second row is the description,

  • Other rows will be properties or dependencies.

  • You can also use the Configuration macro to override the name and configure rows specifically. (Still not mandatory to use this macro). You just to be aware that the UI in the configuration macro will still indicate columns instead of rows:

    • Column 1 = Row 1; Column 2 = Row 2 and so on.

Having trouble seeing your properties? Contact us on the support.

JavaScript errors detected

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

If this problem persists, please contact our support.