Skip to content

Latest commit

 

History

History
 
 

README.md

Manager's Guide to GitFlow Analytics

Welcome! This guide helps engineering managers and team leads understand and use GitFlow Analytics to gain insights into team productivity and development patterns.

What GitFlow Analytics Does

GitFlow Analytics analyzes your team's Git repositories to provide actionable productivity insights without requiring JIRA, Linear, or other project management tools. It gives you visibility into what your team is building, how work is distributed, and where improvements can be made.

Key Benefits:

  • 📊 Understand team productivity and work patterns
  • 🎯 Track process adherence (ticket coverage)
  • ⚖️ Monitor work distribution and team balance
  • 🔍 Identify untracked work and process gaps
  • 📈 Analyze trends over time

Quick Navigation

Getting Started (5 Minutes)

Understanding Your Reports

What You'll Receive

When GitFlow Analytics runs, you get:

1. Executive Summary Report

A readable markdown file with:

  • Key metrics snapshot (commits, developers, ticket coverage)
  • Team composition and developer profiles
  • Project activity breakdown
  • Development patterns analysis
  • Actionable recommendations

Reading time: 5-10 minutes

2. CSV Data Exports

Spreadsheet-ready files for dashboards:

  • Weekly metrics with productivity trends
  • Developer focus and work distribution
  • Activity distribution by developer/project
  • Summary statistics and benchmarks

Use for: Executive dashboards, quarterly reviews

3. Trend Analysis

Week-by-week patterns showing:

  • Classification trends (features vs bugs vs maintenance)
  • Velocity changes
  • Process adherence shifts
  • Team health indicators

Use for: Sprint retrospectives, monthly reviews

Who Should Use This Guide?

This documentation is for:

  • Engineering Managers - Team productivity and health monitoring
  • Team Leads - Sprint planning and process improvement
  • Directors/VPs - Cross-team comparisons and organizational trends
  • Product Managers - Understanding engineering capacity and velocity

Key Metrics at a Glance

Metric What It Shows Healthy Range
Ticket Coverage % of commits linked to work items 60-80%
Work Distribution Team balance (Gini coefficient) < 0.3
Classification Mix Features vs bugs vs maintenance Varies by team
Activity Score Developer productivity percentile Context-dependent
Velocity Trend Week-over-week commit patterns Stable or growing

See Metrics Reference for detailed definitions.

Common Use Cases

Weekly Sprint Retrospectives

Review ticket coverage, untracked work, and velocity trends to improve sprint planning.

Read: Quick Start GuideReport Interpretation

Monthly Team Health Checks

Analyze work distribution, developer focus scores, and activity patterns to ensure team balance.

Read: Metrics ReferenceDashboard Guide

Quarterly Planning Reviews

Compare classification trends (feature vs bug ratios) and identify tech debt patterns.

Read: Report InterpretationDashboard Guide

Process Improvement

Track ticket coverage improvements and commit quality metrics over time.

Read: Quick Start GuideFAQ

How GitFlow Analytics Works

No Setup Required for Managers: Your technical team runs GitFlow Analytics, and you receive reports. You don't need to install anything or understand Python/Git commands.

The Process:

  1. Your team runs analysis (5-minute command)
  2. Reports are generated in ./reports/ directory
  3. You review the narrative report and CSVs
  4. Import CSVs to Excel/Sheets for dashboards (optional)

See Quick Start Guide for the delegation workflow.

Getting Help

Related Documentation

For technical details and setup:


Next Steps:

  1. Read the Quick Start Guide (5 minutes)
  2. Review the Report Interpretation Guide (10 minutes)
  3. Create your first dashboard using the Dashboard Guide

Questions? See the FAQ or ask your technical lead to reference the User Guide.