Creating & Editing Requirements
Requirements capture what needs to be validated in a project. Creating clear and well-structured requirements ensures better traceability, coverage, and collaboration across teams.
Creating Requirements
To create a new requirement:
- Navigate to the Requirements page in your project.
- Click Create Requirement in the header.
- Fill in the requirement details.
Requirement Fields
Title (Required)
A short and clear name describing the requirement.
Description
A brief summary explaining the purpose or context of the requirement.
Details
A rich text editor for detailed specifications. You can:
- Format content (headings, lists, emphasis)
- Add links and references
- Insert code blocks
- Upload images or files
Type
Select the appropriate requirement type based on your project configuration.
(Types are configurable and may vary by project.)
Status
Set the current status of the requirement to reflect its progress.
(Status values are project-specific and may evolve over time.)
Custom Fields
If your project uses custom fields for requirements, they appear here. Fill them in as required by your team’s workflow.
Linking Test Cases
You can link test cases to a requirement to establish traceability.
To link test cases:
- Click Add Test Cases
- Select one or more test cases from the list
- Confirm to link them
Linked test cases contribute directly to requirement coverage.
Attachments
You can attach supporting files to a requirement:
- Design documents
- Screenshots
- Reference files
Files can be uploaded by clicking the attachment area or via drag and drop.
Saving the Requirement
Click Save to create the requirement. Once saved, the requirement appears in the list and becomes available for linking and coverage tracking.
Editing Requirements
To edit a requirement:
- Open the requirement from the list.
- Click Edit.
- Update any of the following:
- Title or description
- Detailed content
- Type or status
- Custom fields
- Linked test cases
- Attachments
- Click Save to apply changes.
All updates are reflected immediately.
Deleting Requirements
To delete a requirement:
- Open the requirement.
- Click Delete.
- Confirm the deletion.
Deleting a requirement:
- Removes the requirement and its attachments
- Unlinks associated test cases
- Does not affect existing test runs or historical executions
Permissions
Requirement actions are controlled by project roles:
- Project Manager – Full access
- Project Coordinator – Full access
- Project Member – Create, edit, and link test cases
- Project Viewer – Read-only access
Permissions are managed at the project level.
Best Practices
- Keep requirement titles concise and descriptive
- Use the details section for clear, testable specifications
- Link test cases early to track coverage
- Review uncovered requirements regularly
- Update requirement status as work progresses
Next Steps
- Explore Requirement Coverage & Traceability
- Review Requirements Overview