Excerpt | ||||
---|---|---|---|---|
| ||||
Learn how to write requirements in horizontal, and vertical tables. Each column, or row, becomes a property of your requirements. |
Why do we recommend to use tables?
Because eachEach column becomes a property of your requirement
You can then use
those properties in the search syntax, or add them specifically to your traceability matrices.
Combine tables with the Transformation wizard and enhance your productivity to generate requirements, and much more.
Horizontal Tables
The first way to write requirements is in horizontal tables, like this:
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
, images etc.Status colour Blue title status macro 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
andBR-06
are parents of the requirementFN-01
, with the relationshipRefines
.
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.
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.