Skip to end of metadata
Go to start of metadata

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

Compare with Current View Version History

« Previous Version 31 Current »

ℹ️ Related information: Search Syntax

If you want to learn how to get the perfect popup with properties, links and dependencies in less than 4 minutes, check out this tutorial:

https://youtu.be/-myl_nmpbGM

Use properties to search for requirements

All columns of a table are saved as properties and you can search by this criteria. Let's take this example in the editor:

The requirement will look like this:

  • Each column is both included in the title and in the properties,

  • In the current situation, we've defined that the first column was the description.

Requirement Yogi helps you build the query for each property if the name is short (<80 letters) and without space. For example the property "Category" becomes hyperlinked in the popup, which leads to the search screen with the preset query: @Property = 'CRITICAL'.

Build clean descriptions for your requirements: The "RY Property" macro

To achieve the configuration of the last section, we've added a small macro in the headers of the table. You can see it on the first screenshot, the name is "RY Properties". Here are the options:

  • Anywhere on a requirement, you can define a property and its value.

  • If it's in a column header, it applies to the whole column.

    • You can "rename" the column for the purpose of the properties. Searchable columns can't contain a space.

    • You can "ignore" the column, if the contents are irrelevant for the requirement.

    • You can set which column contains the correct description of the requirement by ticking "Title".

Create reports for those requirements

Create dependencies between requirements

If you want to create links to reference requirements between one and another, you will use what we call dependencies.

To create a requirement link, use the same shortcut as to create a new requirement, but this time, search for an existing requirement.

  • See the link as an arrow in front of the key

Adding a requirement link.png

In edit mode, click on a link macro to configure it:

  • Click on a property

Configure your link.png

  • When you write your requirements in tables, whether in Horizontal, or Vertical, you will simply have to add the link to your requirement line.

  • Write your requirement definition and put a /requirement yogi link macro in the same paragraph for us to index it as a dependency.

  • No labels