1. QRA Knowledge Centre
  2. For Configuration Authors

How to Further Customize Configurations

Tailor QVscribe’s analysis to match your organization’s standards.

What is a Configuration?

QVscribe provides four Starting Configurations (QV1–4), each designed for a different type of technical document. You can choose the one that best fits your use case, then fine-tune it to suit your team’s specific needs, including adding a Glossary of defined terms!

Who can edit configurations?

Only configuration Authors can tailor the rules to align with their team’s writing style or organizational standards. 

All users can select from the available configurations using a dropdown menu in the QVscribe interface.

After making changes to a configuration, an "*" will appear next to its name, indicating that you've updated your local copy. To ensure your changes are saved and shared with the team, be sure to save before switching configurations!

    Why should I customize the Configurations?

    • Your team uses industry-specific language (e.g., aerospace, medtech, automotive)
    • Certain rules are too strict or too lenient for your process
    • You want to enforce a ruleset tailored to the specific standards of each project
    • You have a list of defined terms and/or acronyms
    • Your documents contain units that are not in our default list
    • Your document contains notes, comments, or rationale statements that you don't want included in the analysis

    How do I customize the Configurations?

    Need help navigating the QVscribe Configuration window? Check out these walkthrough guides for:

    9+ Tips for Successful Customization

    1. Start with one of the Starting Configurations that most closely aligns with your needs
    2. Review Problem Types to see if anything should be toggled on or off
    3. Review Problem Type phrase lists to see if anything should be added or removed
    4. Import your glossary of defined terms
    5. Review units and abbreviations to see if there are any gaps
    6. Add exclusion prefixes (if applicable)
    7. Create a space (e.g. Slack or Teams channel) for stakeholders to help collaborate and refine
    8. Meet with an expert at QRA for additional guidance
    9. Test before rollout on a sample of your real requirements

    Bonus Tip: If you have any phrases that do not fit in the Problem Type categories but you want QVscribe to flag them for users, add them to the "Vague Phrases" category, and it will impact the score; or include them in the Glossary with a definition for correct/incorrect use. 

    Are you a Configuration Author looking for more guidance on how to manage the configurations? Book a training with our team (45 minutes recommended). Not only can we show you the how-tos, but we can also assist you with configuration selection and refinement.