Roles

Roles can be used to get short information of needs inside single sentences:

My specification :need:`my_spec` is used to fulfill requirements :need_incoming:`my_spec`

need

The role :need: will add title, id and a link to the need.

It is mostly used to reference an existing need, without the need to keep title and link location manually in sync.

Example

Requirement: Sliced Bread ROLES_REQ_1
links incoming: ROLES_REQ_2
links outgoing: None
The requirement :need:`roles_req_1` is the most important one.

Result: The requirement Sliced Bread (ROLES_REQ_1) is the most important one.

need_outgoing

New in version 0.1.25.

:need_outgoing: adds a list of all outgoing links of the given need. The list contains the need IDs only, no title or any other information is printed.

Example

Requirement: Butter on Bread ROLES_REQ_2
links incoming: None
links outgoing: ROLES_REQ_1
To get butter on our bread, we need to fulfill :need_outgoing:`roles_req_2`

Result: To get butter on our bread, we need to fulfill ROLES_REQ_1

need_incoming

New in version 0.1.25.

:need_incoming: prints a list IDs of needs, which have set outgoing links to the given need.

Example

The realisation of **Sliced Bread** is really important because the needs :need_incoming:`roles_req_1` are based on
it.

Result: The realisation of Sliced Bread is really important because the needs ROLES_REQ_2 are based on it.