Browse documentation

Manage Requirements

Group requirements by module, choose actors and types, write acceptance criteria, and connect related requirements.

Give the requirement a clear outcome

In Specifications → Requirements, open the module for the behavior you want to describe. Create a requirement with a name that states the outcome. Select the requirement type and the subsystems involved. Add the actor when it helps identify who performs the action.

Choose the module, actor, and type

FieldWhat to decide
ModuleChoose where teammates will look for requirements about this part of the product.
ActorIdentify the person or system that performs the action or receives the outcome.
TypeChoose the type whose description template fits the requirement.
SubsystemsSelect the parts of the product that implement the behavior.

Create modules from the add menu in Specifications → Requirements. A project administrator can manage actors and requirement types under Project Settings → Requirements. Review the selected values on the requirement's Params tab.

Write acceptance criteria

Use the requirement's Description to record the purpose, observable acceptance criteria, and any business rules. Use the sections provided by the requirement type as a starting point.

SectionWhat to record
PurposeWho needs the behavior and what they should be able to accomplish.
Acceptance criteriaThe starting conditions, action, and observable result a teammate can verify.
Business rulesThe conditions, limits, and exceptions that determine how the behavior works.

Link the data, interfaces, and API operations that help explain the behavior.

Relate one requirement to another

Use Requirement Relations to show a dependency or another relationship between requirements. Choose Depends on when the current requirement relies on the related requirement.

  1. Open the requirement in the intended branch and find Requirement Relations.
  2. Select + and choose the relation that matches the intended direction. Search by key or name and select the other requirement, or open Chooser to browse available requirements.
  3. Verify the new relation in the list. Open the other requirement to check how the relationship reads in the opposite direction.

Use Specifications for links to Data Entities, User Interfaces, and API Operations.

Review status and revisions

Use the detail header to check the requirement's current lifecycle status and revision. A newly created requirement starts in Draft so you can edit its description and specification links. When the team is ready to review an agreed version, use the lifecycle controls available to your role. A Locked revision provides a read-only record of the agreement. When that definition changes, start a new revision through the detail controls.

Use the revision selector to open an earlier version. Check the selected branch and revision before sharing a requirement key or comparing its links.

Contact Us

Fields marked * are required.

0 / 5,000

Prefer regular e-mail? info@reqode.com