QVscribe Toolbar

Exporting Requirements in QVscribe for Word

After marking requirements in QVscribe for Word, you can export them in CSV format by clicking on Export Requirements on the QVscribe toolbar as shown below.

The CSV file can be generated in either a single column format (denoted as Excel) or in a multi-column format that conforms with the standard IBM Rational DOORs.

Note that you only need to have the requirements marked for the exporting functionality to be
enabled and need not to have analyzed them first. This may be a useful feature for rapidly taking
requirements from Word documents into requirements management tools.

We do suggest running the QVscribe analysis before the exporting function to ensure any issues are
caught before moving into the later stages of development.

QVscribe Help Centre

The QVscribe Help window provides access to the same brief intro video shown prior to activation. This is useful when a new user is accessing a system with QVscribe already installed. In case a video player is not detected, a URL will be provided to see this video online.

A URL to the QVscribe Help Centre is also provided in this window. The Help Centre contains the same information as the user guide but in a categorized format.

If you experience errors or unexpected behaviour in QVscribe, you can also generate Log Files that may be useful to QRA engineers to help troubleshoot and find the root cause. You can save the log files and then attach them in an email to support@qracorp.com along with a description of the issue you have encountered.

In order to improve the functionality of QVscribe, non-user specific application usage data is collected. This data is being collected to help improve product features, performance and your overall experience. The data collected can only be provided to us by user action and is not automatically collected. Your specific user data is not being captured; you can look at the data being collected by clicking on View QVscribe Telemetry. You can send this data to us to help with QVscribe features and improvements, by clicking on Send QVscribe Telemetry.

QVscribe Toolbar and Pane in QVscribe for Word

Once the QVscribe for Word add-on has been successfully installed and activated, you will see the
QVscribe toolbar as a new tab in the Word ribbon. The buttons function as follows:

  • QVscribe – opens/closes the QVscribe pane

  • QVscribe for Individuals/Teams – shows licensing information

  • The pull-down list – shows the available QVscribe analysis configurations for the user along with save/edit buttons. In QVscribe for Teams, these buttons may or may not be available to all users, depending on the team permissions setting

  • Remove All Marks – clears any existing QVscribe metadata from the document

  • Toggle Colour Background – Turns on/off the marked requirement highlighting on the document

  • Export Requirements – Prompts to export the marked requirements to CSV formats

  • QVscribe Help – opens a window to access the help centre, log files and telemetry data

The QVscribe pane appears on the right-hand side of your Word screen. From the QVscribe pane, you select and navigate requirements, view analysis results, and generate reports.

Note that the QVscribe pane can be undocked and moved to any of the other sides of the Word window by simply dragging it from the top section of the pane to a new side. The undocked QVscribe pane can also be left as a floating window on your screen or moved to a second screen to maximize the document view.