Reference Guide

Requify Documentation Portal

Master requirements modeling, AI checking, test plans, defect tracking, and regulatory audit compliance.

Getting Started

Requify is an enterprise-grade requirements specification system. It is designed to combine the flexibility of modern rich-text editing with database-driven quality modeling. Unlike traditional static text editors, every paragraph in Requify can be mapped as a strict system/hardware requirement, connected to test suites, and traced down to code commits.

1. Create Project Structure

Set up your project based on standard templates (e.g. ISO 29148, SRS, HRS). Organize folders and document sections inside the hierarchical sidebar tree.

2. Map Requirements

Use the document editor to write specifications. Assign requirement IDs, risk levels, and priorities directly to text elements, automatically syncing them to the database.

AI Onboarding & Check

Requify leverages advanced AI models to simplify document onboarding and quality review workflows. Run AI-driven generation and context-aware validation directly inside the platform.

AI Onboarding Draft Generator

Kickstart new specification documents by selecting the AI-Generated Draft option during project setup. Describe your project goals, system architecture, or domain in plain text, and Requify's AI engine will seed the project with an initial structure, complete with draft section headings and descriptions.

Supported AI Validation Modes

  • SRS (Software Requirements Spec): Checks for ambiguity, correct use of directive terms (shall, must, should), and missing interface constraints.
  • HRS (Hardware Requirements Spec): Focuses on safety metrics, environmental tolerances, electrical power conditions, and physical sizing limits.
  • General Grammar & Style: Polishes text readability and formatting without changing technical constraints.

Dual-Apply Actions

After the AI proposes corrections in the check panel, you can review changes side-by-side. You have two apply options:
Apply to Section: Overwrites the selected section's editor text with the AI corrected version.
Apply in a new Section: Creates a child section directly underneath and populates it, preserving your original draft.

Requirements & Collaboration

Requirements are the building blocks of your spec. Each requirement has a rigid database schema and is fully collaborative.

Collaborative Presence & Section Locks

Requify supports multi-user editing within the same project. The top dashboard header renders an avatar group showing all Active Workers currently accessing the project. To prevent conflicts, when a collaborator opens a section, it is automatically locked. In the document structure tree, locked sections are highlighted with a dashed amber border, amber background, and the name badge of the lock holder.

Workflow States

A requirement transitions through standard lifecycle states:
Draft: Being actively edited.
Approved: Signed off by project authorities.
Implemented: Developer has coded the feature.
Verified: Linked test cases have successfully run and passed.

Change History & Auditing

Every edit to a requirement creates an immutable audit trail entry detailing:
• Who made the change.
• Which field was modified (e.g. Description, Status, Priority).
• Before and after values, timestamped for regulatory compliance.

Testing & Traceability

Traceability ensures that every requirement is fully covered by test validation. By linking Test Cases to Requirements, the system establishes a bidirectional link (Requirement ↔ Test Case ↔ Bug Ticket).

Traceability Matrix Tabs & Suspect Links View

The Traceability tab supports a two-way layout:
Matrix View: Displays a grid showing all requirements mapped against test cases to quickly identify gaps.
Suspect Links: Displays suspect link flags when requirements are modified. If there are any unacknowledged suspect links, a red badge with the link count is shown on the tab header. A tester must review the requirement changes and click "Clear Suspect" to update the trace status.

Release & Build Tracking

When executing a test case, testers record the specific Build Version (e.g. v1.2.0-rc3) and Environment (QA, Staging, Production). This allows you to track test status history across multiple releases.

Suspect Links & Clearing

If a requirement is edited, linked test cases automatically become **Suspect** (flagged as potentially outdated). Testers can review the change details in the test case pane and click **Clear Suspect** to acknowledge and remove the flag.

Traceability Metrics Glossary

  • Orphan Test Cases: Test cases with no linked requirements (unmapped testing effort).
  • Orphan Requirements: Requirements with no linked test cases (verification gap).
  • Pass Rate: Percentage of linked test cases that recorded "Passed" in their most recent execution.

Excel Import Reconciliation

Round-trip requirements engineering is protected by Requify's Excel Reconciliation Wizard, ensuring safe and selective merging.

Reconciliation Wizard Modal

When importing Excel or CSV sheets to merge with an existing project target, Requify parses the file and opens a 3-way Reconciliation Modal. This wizard computes differences and groups all updates into three distinct categories:

  • New Items to Add: Requirements in the import file that do not exist in the target project.
  • Modified Items to Update: Requirements where the title, content body, or priority has changed. The UI lists specific differences (e.g. Title changes or body edits) side-by-side.
  • Deleted Items to Remove: Requirements present in the target project but missing from the import file.

Using selective checkboxes, you can check or uncheck individual items in each category. Only selected additions, updates, and deletions will be applied upon confirmation.

The Quality Lifecycle Loop

Trace how system artifacts change state in response to developer activity and test executions. Clicking "Record Result" or resolving tickets automatically alters state.

1. Specify Requirement

Requirement is drafted (Draft/Implemented status). Linked to document sections.

2. Generate/Link Test Cases

Test cases are linked to verify the requirement. Multiple tests track verification coverage.

3. Run Test Execution

Tester executes the test case on a specific Build Version and Environment (QA, Staging).

4. Test Fails -> Bug Ticket

Failure automatically creates/reopens a Defect Ticket and demotes Requirement to Implemented.

5. Dev Resolves -> Retest Queue

Dev fixes the bug, sets Ticket status to Resolved. Ticket goes to 'Ready for Retest' queue.

6. Retest Passes -> Verified

Tester re-executes. Passing closes the linked ticket. Requirement promotes to Verified.

Defect Ticket Management

Defect tickets link failed test executions back to the development team for code corrections.

1. SLA & Aging Indicators

Active tickets track their **Age** (time since creation). If an open/reopened ticket is older than 3 days, it displays a pulsing red **Aging** warning. Tickets waiting in the resolved state show exactly how long they've been waiting for retesting.

2. Role-Based Notifications

When a developer resolves a ticket, the original tester (ticket creator) is notified automatically via a **"Ticket Ready for Retest"** alert. Watchers and assignees are also in the loop, ensuring immediate awareness.

Retest Queue & Automatic Promotion

Resolved tickets are categorized in the Test Cases list under the **"Ready for Retest"** tab, highlighted by a pulsing blue indicator next to the test. Executing the test and recording a **Passed** result closes the linked defect ticket and automatically promotes the linked requirement back to **Verified**.

Subscription & Trials

Requify offers a tiered subscription model to match teams of different sizes. To help teams evaluate the platform, new and existing organizations can activate a 14-day free trial of the Professional plan.

14-Day Free Professional Trial

Both new and existing organizations can test all Premium features without a credit card. The trial can be activated by clicking the Activate 14-Day Free Trial button in the notification banner displayed on your projects dashboard.

During the trial period, you get full access to:
AI Requirements Draft: Seed new documents from text prompts.
Suspect Links matrix view: Clear flags and track requirement edits.
Collaboration Presence: Visual avatars and real-time section locks.
Excel Reconciliation Wizard: Inspect diffs and selectively merge worksheets.

Professional Plan Pricing

Once the 14-day trial period finishes or at any time during your usage, you can upgrade to the Professional plan to keep all premium features active. We offer two pricing models:
Individual Seat: 29€ / month (or 225€ / year) per user seat.
Team Bundle (6 Seats & 15 Projects): 89€ / month (or 890€ / year) flat rate. Every additional seat costs 20€ / month.

Seat Management

Pricing is calculated per seat (organization member). You can buy additional seats (20€ / month per seat) as your team expands, and manage billing details directly from the Stripe Customer Portal inside Settings ➔ Subscription.

Git & Developer Sync (Git-Ops)

Integrate your requirements specifications directly into your development workflow. Push generated specs as version-controlled Markdown files directly into GitHub or GitLab, keeping business logic and source code fully aligned.

Connecting Your Repository

Go to your project's **Export** tab and select the **Git-Ops Sync** panel.
1. Select your provider (**GitHub** or **GitLab**).
2. Enter the repository name in `owner/repository-name` format (e.g. `acme/smart-hub`).
3. Set your target branch (e.g., `main` or `development`) and file path (e.g., `docs/requirements.md`).
4. Toggle **Enable Synchronization** and click **Save Settings**.

GitHub OAuth Authentication

By default, GitHub uses Clerk's native OAuth connection. Link your GitHub account under **User Profile Settings ➔ Connected Accounts**. Make sure you accept the repository write permissions request during authorization so the app can create commits.

GitLab & Custom Tokens

For GitLab (or to override GitHub credentials), you can provide a **Personal Access Token (PAT)** with repository write permissions. Paste the PAT in the project settings; it will be encrypted at rest using AES-256-CBC and kept secure.

Traceability Webhook Updates

You can register a webhook inside GitHub/GitLab to point to your Requify webhook URL: `https://your-domain.com/api/webhooks/git`. Whenever developers commit code with message reference tags (e.g. `feat: add sign-in logic [REQ-401]`), Requify will automatically mark requirement `REQ-401` as **Approved** and update its coverage to 100% in real-time.

Frequently Asked Questions

Q: After executing a test case, does the status turn to "passed" immediately, or is there a delay?

A: It is immediate. When you submit a result, a synchronous database transaction updates the test case and immediately re-evaluates linked requirement states. The frontend updates its UI states instantly on receiving the API response.

Q: Why does the "Execute" button still work on test cases that have already passed?

A: Regression and Auditing. Requirements must be retested whenever a new build is released or deployed to a new environment. Allowing infinite executions guarantees you can maintain an audit-compliant history showing that features remain functional across different builds and releases.

Q: Why do requirements need a "pass rate" metric?

A: For verification gating. A complex requirement (e.g. system performance under load) may have multiple verification check-points. A requirement is only fully verified when all linked test cases pass (100% pass rate). The pass rate indicator tells project owners the exact completion and quality status.

Q: Who is notified when a bug is fixed?

A: The creator, assignee, and watchers. When a ticket status changes to resolved, notifications are sent to the user who reported/created the defect (typically the QA tester), the assignee, and all watchers, directing them to retest the item.

Q: What is the behavior when a test case fails?

A: Automatic demotion. If a test case fails or is blocked, any linked requirement that was previously marked verified is demoted back to implemented. This prevents a requirement from displaying a false validated status if verification runs fail.

    Requify - Professional SRS/HRS Document Generator