If you want to create links to reference requirements between one and another. When creating your requirements, you will want to reference that requirement to another existing requirement. We’ll see use what we call dependencies. This page will teach you how to create dependencies depending on your structure in this documentationwith multiple use cases.
You can also take a look at the tutorial for more information:
...
How to create a dependency?
Using tables
When you write your requirements in tables, whether in Horizontal, or Vertical, you will simply have to add the
/requirement yogi link
macro to your requirement line.The name of the relationship is the one you put in the column header.
In the first example below: FN-01
references BR-01
and DIS-REQ-001
with the relationship Refines
.
...
When you write requirements is using paragraphs, we will index the paragraph where as the content of the requirement is defined in. And the dependencies work the same way as above:
Write your requirement definition and put a
/requirement yogi link
macro in the same paragraph for us to index it as a dependency.By default, the name of the relationship will be
Dependency
but you can customize it with the RY Configuration macro and > Paragraph Configuration (see docs).In the example below,
TECHNICAL REQUIREMENT 001
referencesLIDAR 001
, with the relationshipDependency
.
...
💡Linear documents create requirement keys for each heading, we index the heading text as the description, and everything that is written in that section will be the property @Content
of the requirement. If you are not familiar with linear docs, we recommend to read the documentation and test the feature: Linear documents: Manage requirements outside of tables .
...
When you are writing your specifications, and using a page-per-feature structure, you may define the highest requirement first in the page, and then define all it’s sub requirements in the same page. You may want all those sub-requirement to be references of reference this higher level requirement, automatically. Using the RY Configuration
macro, and the Parent requirement Configuration
, you can achieve that. See the documentation for the full explanation: https://confluence.intranet.requirementyogi.com/wiki/spaces/RYC/pages/2554036227/Parent+Requirement+Configuration?atlOrigin=eyJpIjoiOTYyYTIwYTI2ODdmNDJkYTkxYWM5MTg0NmVjYzM3ZWEiLCJwIjoiYyJ9.
...
The syntax is a bit more different for Linear Documents, find so please explore the docs for more information on our search syntax in this documentation page: https://confluence.intranet.requirementyogi.com/wiki/spaces/RYC/pages/1804765458/Search+syntax?atlOrigin=eyJpIjoiNWZkZTUxNjk4MmM0NDhiYTk1ZTI0MDkzZjcwZDhmZjAiLCJwIjoiYyJ9
...
Quick way to remember how to use the TO and FROM in the search syntax is to use the sentence "I want to find requirements that point / reference to another requirement", so use
TO
in the search.Parent
andTo
execute the same search: requirements which refer to reference another.Child
andFrom
execute the same search: requirements which are referred from referenced by another.
How do I find requirement dependencies to deleted requirements?
...