Chapter 4: Save, Share, and Track Your Analysis (Web)

📄 Capture and share your insights with Reports, Snapshots & Timelines.

This chapter covers two key ways to document and communicate your analysis results in QVscribe: Reports and Snapshots + Timelines.

• Reports are customizable, professional-quality exports that help you share results with your team.
• Snapshots + Timelines (Cloud-only) let you capture and compare different points in time to track requirement quality and progress across reviews.

Whether you're documenting findings or demonstrating improvements, these tools make it easy to keep everyone aligned.

---

Chapter 4

Reports
Snapshots and Timelines

Use Case: Snapshots and Timelines

Summary

---

Chapter 4.1: Reports

🎥 Video coming soon

A walkthrough video for this section is currently in the works. Check back shortly!

📝 Reports: Tailored Documentation for Every Stage

QVscribe Reports compile the results of your analysis into a modular HTML format (which you can also print or save as a PDF). You can fully customize what’s included, making it easy to create different versions depending on your audience or purpose.

📍 To generate a report, go to the Summary View, select which sections you want, and export.

Here’s what you can include in a report:

• ✅ Individual Requirements:
  Include all requirements or filter by score range. Each includes Quality Analysis results with issues and phrases highlighted, as well as Similarity, Consistency, and EARS compliance details.

• 📊 Score Summary:
  Shows a histogram of score distribution and risk breakdown. Great for stakeholders unfamiliar with QVscribe scoring.

• 🧩 Analysis Breakdown:
  Totals for alerts and warnings by problem type, plus overall EARS compliance rate (keep in mind 100% EARS compliance is not necessary).

• 🔍 Term and Unit Consistency:
  Shows all detected domain-specific terms and units, making it easy to spot anything unexpected.

• 🔁 Requirement Similarity:
  Lists the top similar requirement pairs, categorized by percentage match. Helps spot duplications or contradictions. To see all similar requirement pairs, open the document in QVscribe.

• 📘 Configuration Appendix:
  Lists active problem types and triggers, plus all potential units defined in your configuration. Useful for configuration onboarding and refinement.

Go to the beginning of Chapter 4

Return to Table of Contents

Chapter 4.2: Snapshots and Timelines (Cloud-only)

🎥 Video coming soon

A walkthrough video for this section is currently in the works. Check back shortly!

📸 Snapshots: Capture a Moment in Time

A Snapshot is a static capture of your current analysis, including all quality scores, alerts, and consistency data.

💡 Use Snapshots To:

• Save a baseline before editing

• Capture a version for team review

• Record your progress at key milestones

🧭 You can take a Snapshot any time from the Summary View.

📈 Timelines: Visualize Quality Trends Over Time

A Timeline is created by comparing multiple Snapshots. It gives you a powerful view of how your document is evolving.

🕵️‍♀️ Timelines Show:

• Changes in average and individual requirement scores

• Trends in issue types

• Shifts in quality indicators

This helps you communicate improvement, justify changes, and guide next steps with clarity.

🔁 Use Case: Track Improvements Through Drafts

You’re revising a system specification and want to monitor quality as you go. Here's how:

1. Run your first analysis

   • Create a Snapshot to capture a baseline of current quality.

2. Review and revise

   • Use QVscribe’s alerts, scores, and guidance to make improvements.

3. Create another Snapshot

   • Take a new Snapshot after changes to track what’s improved.

4. Open Timelines

   • Compare Snapshots to visualize trends and score improvements.

5. Repeat through each draft

   • Continue capturing Snapshots as you iterate for a clear, versioned history of your progress.

📘 Summary:

QVscribe’s Reports, Snapshots, and Timelines provide a complete toolkit to document quality, track edits, and align your team throughout the lifecycle of your requirements. Start capturing progress today and make every iteration count.

Go to the beginning of Chapter 4

Return to Table of Contents

---