.png?height=120&name=4.0%20(7).png)
🚀Start here to learn how to navigate QVscribe in your web-based tools.
This first part of the series introduces the core interface and views so you can confidently interact with your requirements.Chapter 1
Navigating the QVscribe Web Extension
Introduction to the Different Views
Chapter 1.1: Where You’ll Use QVscribe
QVscribe for Web integrates directly into your existing requirements platforms via a browser extension. Please follow the installation instructions below to get everything set up:
Edge
Chrome
Once installed (via Chrome or Edge) and logged in using your preferred authentication method, QVscribe activates alongside your requirement fields and lets you analyze content in context, without leaving your platform.
QVscribe works in a server-client structure. The browser extension communicates between the server (Cloud or QTS) and the client (Jama, DOORS Next Generation, or Polarion) to confirm licensing and authentication, as well as communicate the configurations to the end user.
Visit the following for more information on the high-level architecture and data flow:
Go to the beginning of Chapter 1
Chapter 1.2: Navigating the QVscribe Web Extension
🎥 Video coming soon
A walkthrough video for this section is currently in the works. Check back shortly!
When you open QVscribe in your browser, you’ll be greeted with a panel containing several key components to help you navigate and utilize the tool. 🌐
Active Configuration (Upper Right Corner)
Here, you can choose your active configuration and view a list of other configurations available to you.
👉 Learn more about our Four Starting Configurations.
Left Side Panel: Key Sections
Configurations serve as your team’s shared playbook for writing high-quality requirements. They define the rules and checks QVscribe uses during analysis. While all users can view the rule sets, only Configuration Authors can modify and save them.
QVscribe analyzes requirements against 15 key quality indicators, called Problem Types, to assess clarity, testability, and best practices. These are flagged based on curated phrase lists, which you can access by clicking the right-facing chevron in the panel.
You'll also find a built-in Glossary of defined terms that helps ensure consistent language across your project.
Additional configuration features include:
-
Term Consistency: Set upper and lower thresholds to control how closely QVscribe matches nouns and noun phrases across requirements.*
-
Unit Consistency: Ensures consistent use of measurements by using a default list of units, with the option for Configuration Authors to add custom units.
-
Similarity Analysis: Detects duplicate or overly similar requirement pairs based on upper and lower match strength thresholds.*
-
EARS Templates: Checks if your requirements follow one of the five EARS (Easy Approach to Requirements Syntax) templates.*
-
Exclusion Prefixes: Exclude specific sections (e.g., commentary or rationale) from analysis by using prefixes (disabled by default).
🦖Coach QRex: The sections marked with "*" are user-specific and only apply locally. They do not affect the shared team configuration on the server. All users, not just Configuration Authors, can modify them.
User Settings displays key details about your QVscribe account. You can view your current version, check the server connection status, and log out of the extension.
🦖 Coach QRex: For DOORS Next Generation users, you can customize which artifact types QVscribe should analyze, such as "Feature" or "Requirement," based on your environment.
Help Center allows you to access the Knowledge Centre directly from the extension. You can also use it to share feedback, report bugs, or contact our support team with any questions. We’re always here to help — reaching out is easy! 💬
Go to the beginning of Chapter 1
Chapter 1.3: Introduction to the Different Views
🎥 Video coming soon
A walkthrough video for this section is currently in the works. Check back shortly!
QVscribe offers two main ways to interact with requirements within web-based platforms: Summary View and Authoring View. Each view is designed to support a different part of your workflow — whether you're reviewing existing requirements or making improvements.
Summary View
This read-only view lets you quickly assess the quality of your requirements. It displays the analysis results, including Quality Analysis, Consistency Analysis, and Similarity Analysis. This is ideal for getting a high-level overview before diving deeper into specific analyses. You can also create snapshots (Cloud only) and generate reports here. 📊
Important: Summary View is read-only, so any requirements opened here will be locked for editing.
🔒 Why? QVscribe cannot verify permission levels or lock status in this view.
You can still review all alerts and feedback, but to make changes, click the icon next to Not editable. This opens the requirement in a new window. Then, click the QVscribe ScoreScan icon to allow QVscribe to check the permissions for that specific requirement and open it in Authoring View, where editing is enabled.
Authoring View
This editable view allows you to refine and rewrite your requirements based on QVscribe’s feedback. You can see your changes update in real-time as you re-run the analysis, helping you improve clarity, consistency, and conformance to quality standards. ✍️
📘 Summary:
-
Summary View: Ideal for high-level reviews, reports, and snapshots.
-
Authoring View: Best for editing and improving requirements based on detailed analysis.
Choose the right view depending on whether you're reviewing or refining your requirements!
Go to the beginning of Chapter 1