Documentation Usage Reporting Guide¶
Comparative positioning note
This document is written from the perspective of Microsoft Azure, Cloud Scale Analytics, and CSA Loom. Any description of third-party or competing products, services, pricing, or capabilities is derived from publicly available documentation and sources believed accurate at the time of writing, and is provided for general comparison only. We do not claim expertise in, or authority over, any non-Microsoft product or service; the respective vendor's official documentation is the authoritative source for their offerings, which may change over time. Nothing here is intended to disparage any vendor — where a competing product has genuine advantages, we aim to note them honestly. Verify all third-party details against the vendor's current official documentation before making decisions.
This guide provides instructions for generating, analyzing, and presenting documentation usage reports to understand adoption and guide improvement efforts.
Table of Contents¶
- Overview
- Key Metrics Definitions
- Report Types
- Generating Usage Reports
- Report Templates
- Dashboard Recommendations
- Analysis Techniques
- Best Practices
Overview¶
Regular usage reporting helps stakeholders understand:
- Documentation adoption and engagement
- User behavior and navigation patterns
- Content effectiveness and gaps
- ROI of documentation efforts
- Areas requiring improvement
Report Frequency¶
| Report Type | Frequency | Audience |
|---|---|---|
| Real-time Dashboard | Continuous | Documentation team |
| Weekly Summary | Weekly | Documentation team |
| Monthly Report | Monthly | Team leads, stakeholders |
| Quarterly Review | Quarterly | Management, leadership |
| Annual Analysis | Yearly | Executive leadership |
Key Metrics Definitions¶
User Metrics¶
Total Users¶
Definition: Unique individuals who visited the documentation site during the reporting period.
Calculation: Count of unique user identifiers (anonymized)
Benchmark: Monitor growth trends month-over-month
GA4 Path: Reports > User Attributes > Overview
New vs Returning Users¶
Definition: Ratio of first-time visitors to repeat visitors
Calculation:
- New Users: Users visiting for the first time
- Returning Users: Users who have visited before
Benchmark:
- Healthy ratio: 60% new / 40% returning
- Growing product: Higher new user percentage
- Mature product: Higher returning user percentage
GA4 Path: Reports > User Attributes > User acquisition
Active Users¶
Definition: Users who engaged with the documentation (not just landed and left)
Calculation: Users with at least one engaged session
Benchmark: > 70% of total users should be active
GA4 Path: Reports > Engagement > Overview
Session Metrics¶
Total Sessions¶
Definition: Number of distinct visits to the documentation site
Calculation: Each visit counts as one session (30-minute timeout between sessions)
Benchmark: Monitor growth trends
GA4 Path: Reports > Acquisition > Overview
Average Session Duration¶
Definition: Average time users spend on the documentation site per visit
Calculation: Total session duration / Total sessions
Benchmark:
- Excellent: > 5 minutes
- Good: 3-5 minutes
- Needs improvement: < 3 minutes
GA4 Path: Reports > Engagement > Pages and screens
Sessions per User¶
Definition: Average number of sessions per unique user
Calculation: Total sessions / Total users
Benchmark:
- Excellent: > 2.5
- Good: 1.5-2.5
- Needs improvement: < 1.5
GA4 Path: Reports > User Attributes > Overview
Engagement Metrics¶
Pages per Session¶
Definition: Average number of pages viewed in a single session
Calculation: Total page views / Total sessions
Benchmark:
- Excellent: > 4 pages
- Good: 2-4 pages
- Needs improvement: < 2 pages
GA4 Path: Reports > Engagement > Pages and screens
Bounce Rate¶
Definition: Percentage of sessions where user left after viewing only one page
Calculation: (Single-page sessions / Total sessions) × 100
Benchmark:
- Excellent: < 40%
- Good: 40-60%
- Needs improvement: > 60%
GA4 Path: Reports > Engagement > Pages and screens
Average Engagement Time¶
Definition: Average time users actively engaged with content
Calculation: Total engagement time / Total users
Benchmark:
- Excellent: > 3 minutes
- Good: 2-3 minutes
- Needs improvement: < 2 minutes
GA4 Path: Reports > Engagement > Overview
Content Metrics¶
Page Views¶
Definition: Total number of pages viewed
Calculation: Sum of all page loads (including repeat views)
Benchmark: Monitor trends and compare to unique page views
GA4 Path: Reports > Engagement > Pages and screens
Unique Page Views¶
Definition: Number of sessions where a specific page was viewed at least once
Calculation: Deduplicated page views per session
Benchmark: Higher unique views indicate diverse content consumption
GA4 Path: Reports > Engagement > Pages and screens
Exit Rate¶
Definition: Percentage of page views that were the last in a session
Calculation: (Exits from page / Total page views for that page) × 100
Benchmark:
- High exit rate on tutorial completion pages is normal
- High exit rate on overview pages needs investigation
GA4 Path: Reports > Engagement > Pages and screens
Search Queries¶
Definition: Terms users search for within the documentation
Calculation: Count of site search queries
Benchmark: Frequent searches indicate content gaps or navigation issues
GA4 Path: Reports > Engagement > Site search (requires setup)
Feedback Metrics¶
Feedback Response Rate¶
Definition: Percentage of page views that resulted in feedback submission
Calculation: (Total feedback submissions / Total page views) × 100
Benchmark:
- Excellent: > 5%
- Good: 2-5%
- Needs improvement: < 2%
Tracking: Custom event in GA4 or dedicated feedback system
Helpful Rating¶
Definition: Percentage of positive feedback responses
Calculation: (Positive feedback / Total feedback) × 100
Benchmark:
- Excellent: > 80%
- Good: 60-80%
- Needs improvement: < 60%
Tracking: Custom event in GA4
Technical Metrics¶
Browser Distribution¶
Definition: Breakdown of users by web browser
Benchmark: Ensure major browsers (Chrome, Firefox, Safari, Edge) are supported
GA4 Path: Reports > Tech > Tech details
Device Category¶
Definition: Distribution across desktop, mobile, and tablet devices
Benchmark:
- Technical documentation: 70% desktop typical
- Quick reference: Higher mobile usage acceptable
GA4 Path: Reports > Tech > Tech details
Operating System¶
Definition: Distribution of operating systems
Benchmark: Ensure content renders correctly on all major OS platforms
GA4 Path: Reports > Tech > Tech details
Report Types¶
Executive Summary (1 Page)¶
Audience: Senior leadership, executives
Frequency: Monthly or quarterly
Content:
- High-level metrics (users, sessions, growth)
- Key achievements and milestones
- Top 3 insights
- Recommended actions
- Visual charts and graphs
Format: PDF or PowerPoint slide
Detailed Analytics Report¶
Audience: Documentation team, product managers
Frequency: Monthly
Content:
- All key metrics with trends
- Page-level analysis
- User behavior patterns
- Content performance breakdown
- Feedback analysis
- Recommendations with data support
Format: PDF report with charts
Quarterly Business Review¶
Audience: Stakeholders, management
Frequency: Quarterly
Content:
- Quarter-over-quarter comparison
- Goal progress tracking
- Content ROI analysis
- User satisfaction trends
- Strategic recommendations
- Resource requirements
Format: Presentation deck
Ad-Hoc Analysis¶
Audience: Documentation team
Frequency: As needed
Content:
- Specific question or hypothesis
- Detailed data analysis
- Findings and conclusions
- Action items
Format: Memo or short report
Generating Usage Reports¶
Prerequisites¶
- Access to Google Analytics 4
- Documentation analytics configured
- Proper permissions assigned
- Report templates ready
Step-by-Step Report Generation¶
1. Define Report Parameters¶
Report Period: [Start Date] to [End Date]
Comparison Period: [Previous Period]
Audience: [Target audience]
Format: [PDF/PowerPoint/Excel]
2. Export Data from GA4¶
Option A: Standard Reports
- Navigate to Reports in GA4
- Select relevant report (e.g., Pages and screens)
- Set date range
- Click Export (PDF or CSV)
- Save exported file
Option B: Explorations (Custom Reports)
- Navigate to Explore in GA4
- Create or select exploration
- Configure dimensions and metrics
- Set date range and filters
- Export data
Option C: Data API (Automated)
# Example: Using GA4 Data API
from google.analytics.data_v1beta import BetaAnalyticsDataClient
from google.analytics.data_v1beta.types import (
DateRange,
Dimension,
Metric,
RunReportRequest,
)
def run_ga4_report(property_id, start_date, end_date):
"""Generate GA4 report programmatically"""
client = BetaAnalyticsDataClient()
request = RunReportRequest(
property=f"properties/{property_id}",
dimensions=[
Dimension(name="pagePath"),
Dimension(name="pageTitle"),
],
metrics=[
Metric(name="screenPageViews"),
Metric(name="averageSessionDuration"),
Metric(name="bounceRate"),
],
date_ranges=[DateRange(start_date=start_date, end_date=end_date)],
)
response = client.run_report(request)
return response
# Usage
report = run_ga4_report("YOUR_PROPERTY_ID", "2024-01-01", "2024-01-31")
3. Analyze Data¶
- Calculate key metrics
- Identify trends and patterns
- Compare to previous periods
- Highlight anomalies
- Generate insights
4. Create Visualizations¶
- Use charts for trends
- Tables for detailed data
- Heatmaps for user journeys
- Dashboards for overviews
5. Write Narrative¶
- Summarize findings
- Provide context
- Explain implications
- Make recommendations
6. Review and Distribute¶
- Proofread report
- Verify data accuracy
- Format for audience
- Distribute via appropriate channels
Report Templates¶
Monthly Usage Report Template¶
# Documentation Usage Report
## [Month Year]
### Executive Summary
- **Total Users:** [Number] ([+/- %] vs previous month)
- **Total Sessions:** [Number] ([+/- %] vs previous month)
- **Top Page:** [Page Name] ([Number] views)
- **Key Insight:** [1-2 sentence insight]
### User Metrics
| Metric | This Month | Last Month | Change |
|--------|------------|------------|--------|
| Total Users | [Number] | [Number] | [+/- %] |
| New Users | [Number] | [Number] | [+/- %] |
| Returning Users | [Number] | [Number] | [+/- %] |
### Engagement Metrics
| Metric | This Month | Last Month | Change |
|--------|------------|------------|--------|
| Sessions | [Number] | [Number] | [+/- %] |
| Avg Session Duration | [Time] | [Time] | [+/- %] |
| Pages per Session | [Number] | [Number] | [+/- %] |
| Bounce Rate | [Percentage] | [Percentage] | [+/- %] |
### Top Content
| Page | Views | Avg Time | Bounce Rate |
|------|-------|----------|-------------|
| 1. [Page Title] | [Number] | [Time] | [%] |
| 2. [Page Title] | [Number] | [Time] | [%] |
| 3. [Page Title] | [Number] | [Time] | [%] |
| 4. [Page Title] | [Number] | [Time] | [%] |
| 5. [Page Title] | [Number] | [Time] | [%] |
### User Feedback
- **Feedback Submissions:** [Number]
- **Helpful Rating:** [%] positive
- **Top Feedback Themes:**
- [Theme 1]
- [Theme 2]
- [Theme 3]
### Insights & Observations
1. **[Insight Title]**
- [Description]
- [Data supporting insight]
- [Implication]
2. **[Insight Title]**
- [Description]
- [Data supporting insight]
- [Implication]
### Recommendations
1. **[Recommendation 1]**
- Action: [What to do]
- Priority: [High/Medium/Low]
- Owner: [Team/Person]
2. **[Recommendation 2]**
- Action: [What to do]
- Priority: [High/Medium/Low]
- Owner: [Team/Person]
### Next Month's Focus
- [Focus area 1]
- [Focus area 2]
- [Focus area 3]
---
Report Generated: [Date]
Report Period: [Start Date] - [End Date]
Prepared By: [Name/Team]
Quarterly Review Template¶
# Quarterly Documentation Review
## Q[Number] [Year]
### Quarter Highlights
- **Achievement 1:** [Description and impact]
- **Achievement 2:** [Description and impact]
- **Achievement 3:** [Description and impact]
### Quarterly Metrics Summary
| Metric | Q[N] | Q[N-1] | YoY | Target | Status |
|--------|------|--------|-----|--------|--------|
| Total Users | [N] | [N] | [%] | [N] | [✅/⚠️/❌] |
| Sessions | [N] | [N] | [%] | [N] | [✅/⚠️/❌] |
| Avg Session Duration | [T] | [T] | [%] | [T] | [✅/⚠️/❌] |
| Pages per Session | [N] | [N] | [%] | [N] | [✅/⚠️/❌] |
| Helpful Rating | [%] | [%] | [%] | [%] | [✅/⚠️/❌] |
### Content Performance Analysis
**Top Performing Content**
- [Content 1]: [Why it performed well]
- [Content 2]: [Why it performed well]
- [Content 3]: [Why it performed well]
**Underperforming Content**
- [Content 1]: [Why it underperformed]
- [Content 2]: [Why it underperformed]
- [Content 3]: [Why it underperformed]
### User Journey Analysis
**Common Entry Points**
1. [Page]: [%] of sessions
2. [Page]: [%] of sessions
3. [Page]: [%] of sessions
**Popular Pathways**
1. [Page 1] → [Page 2] → [Page 3]
2. [Page 1] → [Page 2] → [Page 3]
3. [Page 1] → [Page 2] → [Page 3]
**Exit Points**
1. [Page]: [%] exit rate
2. [Page]: [%] exit rate
3. [Page]: [%] exit rate
### Goals Achievement
| Goal | Target | Actual | Status | Notes |
|------|--------|--------|--------|-------|
| [Goal 1] | [N] | [N] | [✅/⚠️/❌] | [Notes] |
| [Goal 2] | [N] | [N] | [✅/⚠️/❌] | [Notes] |
| [Goal 3] | [N] | [N] | [✅/⚠️/❌] | [Notes] |
### Strategic Recommendations
1. **[Strategic Area 1]**
- Current State: [Description]
- Desired State: [Description]
- Actions Required: [List]
- Timeline: [Timeframe]
- Resources Needed: [List]
2. **[Strategic Area 2]**
- Current State: [Description]
- Desired State: [Description]
- Actions Required: [List]
- Timeline: [Timeframe]
- Resources Needed: [List]
### Next Quarter Objectives
1. [Objective 1]
- Key Results: [Measurable outcomes]
- Owner: [Team/Person]
2. [Objective 2]
- Key Results: [Measurable outcomes]
- Owner: [Team/Person]
---
Report Generated: [Date]
Report Period: Q[N] [Year] ([Start Date] - [End Date])
Prepared By: [Name/Team]
Dashboard Recommendations¶
Google Analytics 4 Dashboards¶
Dashboard 1: Overview Dashboard¶
Purpose: High-level metrics at a glance
Widgets:
- Total Users (last 30 days)
- Total Sessions (last 30 days)
- User Growth Trend (line chart)
- Top 10 Pages (table)
- Engagement Rate (scorecard)
- Average Session Duration (scorecard)
- Device Category Breakdown (pie chart)
- User Acquisition by Source (table)
Dashboard 2: Content Performance Dashboard¶
Purpose: Detailed content analysis
Widgets:
- Page Views by Page (table with sparklines)
- Average Time on Page (table)
- Bounce Rate by Page (table)
- Exit Rate by Page (table)
- Page Value (if e-commerce tracking enabled)
- Content Grouping Performance
- Search Queries (if site search configured)
Dashboard 3: User Behavior Dashboard¶
Purpose: Understanding user journeys
Widgets:
- New vs Returning Users (line chart)
- Session Duration Distribution (histogram)
- Pages per Session Distribution (histogram)
- User Flow Visualization
- Landing Pages (table)
- Exit Pages (table)
- Geography Map
- Browser and OS Distribution
Dashboard 4: Feedback & Satisfaction Dashboard¶
Purpose: User satisfaction monitoring
Widgets:
- Feedback Submission Rate (trend)
- Helpful vs Not Helpful Ratio (pie chart)
- Feedback by Page (table)
- Sentiment Analysis (if configured)
- Issue Tracking Integration
- Response Time to Feedback
Third-Party Dashboard Tools¶
Option 1: Google Data Studio (Looker Studio)¶
Pros:
- Free
- Native GA4 integration
- Customizable
- Shareable
Setup:
- Go to Looker Studio
- Create new report
- Add GA4 as data source
- Build custom visualizations
- Share with stakeholders
Option 2: Tableau¶
Pros:
- Powerful visualizations
- Advanced analytics
- Enterprise features
- Interactive dashboards
Setup:
- Connect Tableau to GA4 via connector
- Import data
- Create worksheets and dashboards
- Publish to Tableau Server/Online
Option 3: Power BI¶
Pros:
- Microsoft integration
- Enterprise ready
- Advanced analytics
- Azure integration
Setup:
- Use GA4 connector for Power BI
- Import data
- Create visualizations
- Publish to Power BI Service
Option 4: Custom Dashboard¶
Tech Stack:
- Frontend: React + Chart.js or D3.js
- Backend: Python Flask/FastAPI
- Database: PostgreSQL
- Data Pipeline: GA4 API + Python scripts
Benefits:
- Full customization
- Real-time updates
- Integration with other tools
- Branded experience
Analysis Techniques¶
Trend Analysis¶
Purpose: Identify patterns over time
Methods:
- Moving averages
- Seasonal decomposition
- Year-over-year comparison
- Month-over-month comparison
Example:
import pandas as pd
import matplotlib.pyplot as plt
# Load data
df = pd.read_csv('ga4_export.csv')
df['date'] = pd.to_datetime(df['date'])
# Calculate 7-day moving average
df['users_ma7'] = df['users'].rolling(window=7).mean()
# Plot trend
plt.figure(figsize=(12, 6))
plt.plot(df['date'], df['users'], label='Daily Users', alpha=0.5)
plt.plot(df['date'], df['users_ma7'], label='7-Day Moving Average', linewidth=2)
plt.xlabel('Date')
plt.ylabel('Users')
plt.title('User Trend Analysis')
plt.legend()
plt.show()
Cohort Analysis¶
Purpose: Track user behavior by cohort
Dimensions:
- Acquisition date
- First visited page
- User source/medium
- Device type
Metrics:
- Retention rate
- Return visit frequency
- Lifetime value
Segmentation Analysis¶
Purpose: Understand different user groups
Segments:
- New vs Returning Users
- By geographic region
- By device type
- By traffic source
- By engagement level
Content Gap Analysis¶
Purpose: Identify missing or underperforming content
Method:
- Analyze search queries
- Review high-bounce pages
- Examine low time-on-page content
- Check competitor documentation
- Survey user needs
Path Analysis¶
Purpose: Understand user navigation patterns
Tools:
- GA4 Path Exploration
- Funnel analysis
- Custom user flow diagrams
Insights:
- Common learning paths
- Drop-off points
- Unexpected navigation patterns
Best Practices¶
Regular Review Cadence¶
- Daily: Monitor real-time dashboard for anomalies
- Weekly: Review key metrics and trends
- Monthly: Generate and distribute full report
- Quarterly: Conduct deep analysis and strategic planning
- Annually: Comprehensive review and goal setting
Data Quality¶
- Validate metrics regularly
- Check for tracking issues
- Audit analytics configuration
- Remove bot traffic
- Ensure data accuracy
Actionable Insights¶
- Focus on actionable metrics
- Tie insights to business goals
- Provide clear recommendations
- Assign owners to action items
- Track implementation progress
Stakeholder Communication¶
- Tailor reports to audience
- Use clear visualizations
- Avoid jargon
- Highlight key takeaways
- Provide context for numbers
Continuous Improvement¶
- Test and iterate on reports
- Gather feedback on reporting
- Refine metrics and KPIs
- Automate where possible
- Stay current with analytics trends
Additional Resources¶
Google Analytics 4¶
Data Visualization¶
Analysis Techniques¶
Getting Help¶
- Review Analytics Setup Guide
- Check Google Analytics Help Center
- Consult with data analytics team
- Join GA4 Community
Last Updated: 2025-12-09 Version: 1.0.0 Maintainer: CSA Documentation Team