Creating & Editing Requirements - Step Guide

Creating Requirements

To create a new requirement:

  1. Click the Create Requirement button in the header (or press Ctrl+N)
  2. Fill in the requirement details:

Title: A concise name for the requirement (required)

Description: A brief summary of what the requirement entails

Details: Rich text editor for detailed requirement specifications. You can:

  • Format text (bold, italic, headings, lists)
  • Add links
  • Insert code blocks
  • Upload images and files
  • Use parameters (e.g., {{BASE_URL}})

Type: Select the requirement type from the dropdown:

  • Feature
  • Bug Fix
  • Performance
  • Enhancement

Status: Select the initial status:

  • Draft
  • In Progress
  • In Review
  • Approved
  • Rejected

Custom Fields: If your project has custom fields configured for requirements, they will appear here. Fill them in as needed.

Test Cases: Link existing test cases to this requirement:

  1. Click Add Test Cases
  2. Select test cases from the test case selector
  3. Click Add to link them

Attachments: Upload files related to the requirement:

  1. Click the attachment area or drag and drop files

  2. Files are uploaded automatically

  3. Add captions to images for better context

  4. Click Save to create the requirement

Keyboard Shortcuts

  • Ctrl+N: Create a new requirement
  • Ctrl+F: Toggle advanced filters
  • Ctrl+A: Select all requirements
  • Ctrl+Shift+C: Toggle column manager
  • Ctrl+Shift+A: Toggle analytics panel
  • Escape: Clear selection, close panels

Editing Requirements

To edit a requirement:

  1. Open the requirement details (click on the requirement row)
  2. Click the Edit button
  3. Modify the fields as needed:
    • Title
    • Description
    • Details (rich text editor)
    • Type
    • Status
    • Custom fields
    • Linked test cases
  4. Click Save to update the requirement

Quick Edit

You can quickly edit the type or status directly from the table:

  1. Click on the type or status badge in the table
  2. Select a new value from the dropdown
  3. The change is saved automatically

Deleting Requirements

To delete a requirement:

  1. Open the requirement details
  2. Click the Delete button
  3. Confirm the deletion in the confirmation modal

Note: Deleting a requirement removes:

  • The requirement details
  • Attachments
  • Links to test cases

Note: Existing releases and past test executions are not affected.

Permissions

Requirements are subject to project-level permissions:

  • View Requirements: View requirements list and details
  • Create Requirements: Create new requirements
  • Edit Requirements: Modify existing requirements
  • Delete Requirements: Remove requirements

Permissions are managed at the project level through roles. Contact your project administrator if you need additional permissions.

Was this page helpful?