Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

Follow this tutorial to know how to add properties to requirements, and dependencies. And how to customize their names to simplify your requirement detail: https://youtu.be/891Q3OpCiLA?si=iaWgX2gN_TQj5L0Q

To add a configuration macro, in the page edit mode, type /requi  or /config, or click on the + dropdown like you would to add any other Confluence macro.

After adding a macro to the page, you can edit it simply by clicking on the macro:

It is also possible to add a Configuration macro from the view mode, with the Transformation wizard.

Table Configuration

If your requirements are in tables, it is absolutely not mandatory. The Requirement Yogi configuration macro is useful to change the way your requirements are indexed and override column titles, or choose to put the 3rd column as the description instead of the 2nd.

When you define requirements in table, by default, the requirement key will be in the first column, with a description in the second column, and properties and depencies in the following columns.

This table:

Gets indexed as:

Here is the default configuration for requirements in tables:

With the configuration macro, you can:

  • Rename properties.

  • Change the column type.

  1. Here, I changed the column of "Author" in "Original Author".

  2. The "Dependencies" column was indexed both as a dependency and as a property, so we added a 4th column to the configuration macro and unchecked the indexing as a property, and set it to Dependency

  3. We ticked “Apply to all the following tables in the document", if this is unticked, the configuration will only apply to the following table. This configuration is not global, you need to add the macro to every Confluence page with requirements.

After inserting the macro and publishing the edited Confluence page, my requirement is now indexed with the changed properties as:

You can quickly "unindex" the requirements in a page by adding a configuration macro at the top of the document and uncheck the requirements column. It can be useful when you have duplicated requirement definitions.

Paragraph Configuration

When you define requirements in paragraph or headings, by default, the description of the requirement is the following text.

Requirement keys in paragraphs:

Here are my requirements:

With the configuration macro, you can:

  • Change the property name.

  • Treat the bold text as normal text.

  • Change the dependency name.

  • Ignore the numbering in headings.

After inserting the macro and publishing the document, here is my requirement again:

When requirements are in headings

You can ignore the numbered headings by passing a regular expression specifying the numbering format.

My headings:

will get saved as:

Here are a few common ways to number headings and their regexes:

Numbering

Example

Regex

Decimal

1.2.

^(\d+\.)+\s*

ISO-2145

1.2

^(\d+\.?)+\s*

Lower-latin

a.b.

^([a-z]+\.?)+\s*

Upper-latin

A.B.

^([A-Z]+\.?)+\s*

Upper-roman

I.II.III.

^([IVXLC]+\.?)+\s*

Document Configuration

New Feature 🚀

This is the evolution of the paragraph configuration. We call this feature Linear Documents. It is best suited when requirements are written outside of tables, when you reuse public standards or your customer’s requirements.

Instead of only having the following line in the description, each heading of your paragraph will be indexed as a requirement, with its whole body as a description, dependencies to higher and lower level titles.

Read the documentation, or watch the tutorial.

What your document looks like:

What we index:

  • No labels