Browse documentation

Link Specifications

Connect a requirement to the data, interface, and API specifications that describe its behavior.

Decide which specifications belong together

Start with the behavior described by the requirement. Link the specifications that a teammate needs to understand or implement it.

LinkUse it to describe
Data EntityThe information the behavior reads, creates, or changes.
User InterfaceThe screen or component where the interaction happens.
API OperationThe request and response that support the behavior.
  1. Open the requirement in the branch where you want the link to exist. Check that it is in Draft and that your role can manage specifications.
  2. On General, find Specifications and open the + menu.
  3. Choose Data Entities, User Interfaces, or API Operations. Select the matching item in the chooser and confirm the selection.
  4. Confirm that the artifact appears under its category in Specifications.

Choose New from the + menu to create a specification. Pick the artifact type and complete its creation form. After the form closes, check that the new artifact appears in the requirement's list.

Select a linked item directly from Specifications. Check its key and name in the detail view, then return to the requirement. If a link is missing, confirm the branch and revision before adding it again.

Contact Us

Fields marked * are required.

0 / 5,000

Prefer regular e-mail? info@reqode.com