Requirements
The Requirements feature helps teams define, organize, and track business or functional needs, and link them directly to test cases for complete traceability. This ensures that every requirement is validated through testing and that no critical functionality is missed.
What is a Requirement?
A Requirement represents a documented need or condition that the software must fulfill. It defines what the system should do from a business or user perspective.
- Ensures the product meets customer expectations and specifications
- Clearly defines expected system behavior
- Can be linked to one or more test cases for validation
- Automatically updates status based on test case execution results
Creating a New Requirement
Creating a requirement allows you to formally document a business or functional need and associate it with relevant test cases.
Navigate to: Project → Requirements → Create Requirement
This opens the New Requirement form where you can capture all necessary details.
Fields in the Requirement Form
1. Name
The Name is the primary identifier for the requirement. Use a concise and descriptive title that clearly explains the functionality or need.
Examples:
- User Login Functionality
- Test Case Edit History Tracking
2. Tags
Tags help categorize and organize requirements. You can add multiple tags to a single requirement to improve discoverability.
Common tag use cases:
- Feature-based: login, reporting, dashboard
- Risk-based: critical, security
- Process-based: audit, traceability
Tags are displayed in the Requirements list view, requirement details view, and tag-based search filters.
3. Description (Rich Text Editor)
The Description field uses a rich text editor that allows detailed documentation of the requirement.
You can include:
- Business context and background
- Functional expectations
- Acceptance criteria
- Assumptions or constraints
- References or external links
Supported formatting:
- Bold and italic text
- Bullet and numbered lists
- Hyperlinks
- Images
4. External ID
The External ID allows you to link a requirement to an external system such as Jira. This is useful for teams managing requirements across multiple tools.
The External ID must be unique within the project.
Examples:
- JIRA-1024
- REQ-LOGIN-01
5. Test Cases
Use this field to link existing test cases to the requirement. A single requirement can be associated with multiple test cases.
- Ensures validation coverage
- Linked test cases appear in the requirement details view
- Test results automatically update requirement status
Click Save to create the requirement.
Viewing and Managing Requirements
The Requirements List View provides a centralized overview of all requirements within a project.
Columns Overview
- Key: Auto-generated unique identifier (e.g., Q-24)
- Name: Clickable name to open the requirement details
- Test Cases: Number of linked test cases
- Tags: Visual tag chips
- Last Modified: Date and user of last update
This view helps teams review coverage, identify gaps, and manage large sets of requirements efficiently.
Searching and Filtering Requirements
Search
Use the search bar to find requirements by name or keyword. Results update instantly as you type.
Tag-Based Filtering
Filter requirements by clicking one or more tags. Multiple tags can be combined to narrow results further, making it easier to work with large projects.
Requirement Details View
Clicking on a requirement opens the detailed view, providing complete visibility into the requirement and its associated test cases.
Details Section
- Created By: Original creator
- Last Modified By: Most recent editor
- Tags: All associated tags
Test Cases Section
This section lists all test cases linked to the requirement, including:
- Test case key
- Test case name
- Trend indicator showing test execution health over time
Actions on a Requirement
- Edit: Update the name, description, tags, External ID, or linked test cases.
- Delete: Remove the requirement from the project. If deleted accidentally, it can be recovered from the Recycle Bin.
- AI Analyze: Automatically analyze requirements and linked test cases to identify missing coverage, gaps, and areas needing additional validation.
