.png?height=120&name=4.0%20(7).png)
🚀Start here to learn how to navigate QVscribe in MS Excel and Word.
This first part of the series introduces the set-up and core interface so you can confidently interact with your requirements.
Chapter 1
Navigating the Toolbar and Pane in MS Excel and Word
Introduction to the Configuration Window
Chapter 1.1: Where You’ll Use QVscribe
QVscribe for Web integrates directly into MS Office, specifically in MS Excel and Word. Please follow the installation instructions below to get everything set up:
Once installed, QVscribe will appear as a new tab in the ribbon of both Word and Excel.
Click the QVscribe button to open the pane — you’ll be prompted to log in using your preferred authentication method.
QVscribe works in a server-client structure. The QVscribe for MS Office add-on communicates between the server (Cloud or QTS) and the client (Excel or Word) to confirm licensing and authentication, as well as communicate the configurations to the end user.
Visit the following for more information on the prerequisites for installation:
Go to the beginning of Chapter 1
Chapter 1.2: Navigating the Toolbar and Pane in MS Excel and Word
🎥 Video coming soon
A walkthrough video for this section is currently in the works. Check back shortly!
Once the QVscribe for Word or Excel add-on is installed, you’ll see a new QVscribe tab in the MS Office ribbon! 🧩📄
From left to right, here’s what each button in the toolbar does:
🧭 Main Panel
-
QVscribe – Opens or closes the QVscribe analysis pane on the side of your screen.
⚙️ Configuration
-
User: Displays your user ID
-
License Pool: Shows your assigned license
-
Configuration Selector: Pick from available configurations and (if permitted) save or edit them
-
Refresh/Delete Configuration: Available to users with permission
🏷️ Requirement Marking
-
Mark Requirements: Choose how to tag requirements in your document
-
Remove Marks: Clear any existing QVscribe metadata
🎨 Utilities
-
Toggle Colour Background: Turn on/off the coloured highlighting of marked requirements
🦖 Coach QRex: The highlighting makes it easy to spot which requirements have been marked, but it can sometimes affect readability. For higher contrast, try toggling the coloured highlighting off!
🧾 EARS Templates
-
Place Requirement Template: Insert from 12 EARS-based requirement structures to guide consistent writing. This includes the 5 core templates (Ubiquitous, State-Driven, Event-Driven, Optional Feature, and Unwanted Behaviour), plus 7 complex templates that combine elements of the core patterns
🆘 Support
- User Information: Displays your server address, username, and tenant details.
-
QVscribe Help: Opens access to the Help Center, logs, and telemetry tools
- Log Out: Frees up your floating license so another user can access QVscribe (Highly recommended for floating licenses)
🖥️ QVscribe Pane in MS Word and Excel
The QVscribe pane appears on the right side of your screen by default. From here, you can:
-
Navigate through requirements
-
View analysis results
-
Generate reports
🦖 Coach QRex: You can drag and undock the QVscribe pane to any side of the MS Office window—or float it on a second screen for more space while writing!
MS Excel
MS Word
Your marked requirements will appear in this pane, making it easy to review them before running your analysis. In Chapter 2, we’ll guide you through how to mark requirements, and in Chapter 3, we’ll dive into what this pane shows after the analysis is complete—and how to interpret and act on the feedback!
Go to the beginning of Chapter 1
Chapter 1.3: Introduction to the Configuration Window
🎥 Video coming soon
A walkthrough video for this section is currently in the works. Check back shortly!
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:
-
Unit Consistency: Ensures consistent use of measurements by using a default list of units, with the option for Configuration Authors to add custom units.
-
Exclusion Prefixes: Exclude specific sections (e.g., commentary or rationale) from analysis by using prefixes (disabled by default).
- EARS Templates: Checks if your requirements follow one of the five EARS (Easy Approach to Requirements Syntax) templates.*
🦖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.
📘 Summary:
-
Where to Use & Install:
QVscribe integrates into Microsoft Word and Excel for real-time requirement analysis. You learned how to install and launch the add-in. -
Toolbar & Pane Overview:
You explored the main QVscribe toolbar and pane, where you can analyze, mark, and manage your requirements. -
Configuration Window Intro:
Covered how to select rule sets, adjust configurations, and manage access settings.
Now you’re ready to dive into the platform-specific differences between Word and Excel to get the most out of each one!
Go to the beginning of Chapter 1