SprintAudit Documentation
Overview
SprintAudit is a Jira project page app that analyses your sprint and generates a detailed Excel report showing every field-level change, QC delivery timing, and scope drift — in one click.
It answers the questions your team asks at sprint retrospectives:
- Which requirements changed during the sprint, and what exactly changed?
- Were stories delivered to QC on time?
- Which issues were added after the sprint started?
- Did any due dates change mid-sprint?
Installation
- Go to Atlassian Marketplace and search for SprintAudit
- Click Get it now — a 30-day free trial starts automatically
- Select the Jira site to install on
- Review and accept the permissions
- Click Install
After installation, SprintAudit appears as a new tab in every Jira project.
First-time Setup
No configuration is required to get started. Open any Jira project and click the SprintAudit tab in the project navigation.
Tip: SprintAudit uses your existing Jira login — no API tokens or credentials needed.
Running an Analysis
Step 1 — Select a Sprint
Type a sprint ID directly in the Sprint field, or click Fetch Sprints to browse active, future, and recent sprints by name.
Step 2 — Configure Settings
Set the Issue Type to Track (e.g. Story, Requirement, Task) and the Tracked Fields you want to monitor for changes.
Step 3 — Run Analysis
Click Run Analysis. The progress log shows each step as it runs. Analysis time depends on sprint size — typically 5–30 seconds for most sprints.
Step 4 — Download Report
When analysis completes, click Generate & Download Excel. The report saves to your Downloads folder.
Workflow Settings
| Setting | Default | Description |
|---|---|---|
| Issue Type to Track | Story | Only issues of this type are analysed. Set to Requirement, User Story, or whatever your org uses. |
| Tracked Fields | Acceptance Criteria, Description, Story Points | Comma-separated field names. Only changes to these fields appear in the report. |
| QC Delivery Status | Ready for Testing | The workflow status that means an issue is delivered to QC. Change to match your team's status name. |
| Team/Pod Field Name | (blank) | Optional. Enter the exact name of your team or squad custom field. |
| Story Points Field Name | Story Points | Enter the exact name as it appears in Jira. Common alternatives: Story point estimate, Estimate, SP. |
| Exclude from Change Count | Impact Areas, Regression Areas | Fields that when changed alone don't count as a real requirement change. |
Field name mismatch: If a field shows blank in the report, SprintAudit will suggest the closest matching field name from your Jira instance. Update the field name in settings and re-run.
Reading the Report
Status Strip
A colour-coded count of issues in each workflow status at the time the report was generated. Click any count to jump to the issue list in the Status Details sheet.
Summary Metrics
| Metric | Meaning |
|---|---|
| Total Issues | Total tracked issues in the sprint |
| Changed Issues | Issues where at least one tracked field changed after sprint start |
| New Issues | Issues created after sprint start date |
| Change % | Changed / Total × 100 |
| Changed (Filtered) | Changed count excluding issues where only excluded fields changed |
| Due Date Changed | Issues where due date was modified during the sprint |
| New (Cloned) | Issues created by cloning — tracked separately as scope expansion |
QC Delivery — Due Date Analysis
| Bucket | Meaning |
|---|---|
| On or Before Due Date | Issue reached QC status before or on its due date |
| Post Due Date | Issue reached QC after its due date — late delivery |
| No Due Date Set | Issue had no due date — timing cannot be assessed |
| Not Delivered to QC | Issue never reached the QC status during the sprint |
QC Delivery — Sprint Timeline Analysis
| Bucket | Meaning |
|---|---|
| First 8 Working Days | Delivered in the first 80% of the sprint — healthy |
| Last 2 Days | Delivered in the final 2 days — testing pressure |
| Spillover | Moved to QC after sprint end date |
| Not Delivered to QC | Never reached QC status |
Data Table Columns
| Column | Description |
|---|---|
| Issue Key | Clickable link to the issue in Jira |
| Change Category | CHANGED / NEW / NEW(Cloned) / NO CHANGE |
| Field | Which field changed |
| Old Value | Value before the change — deleted text in red strikethrough |
| New Value | Value after the change — added text in dark red |
| Ready for Testing Date | When delivered to QC — shows (x2) if returned multiple times |
| Due Date | Highlighted orange if due date changed during sprint |
| Split From | Parent issue key if this is a cloned issue |
Troubleshooting
| Problem | Solution |
|---|---|
| No sprints found | Check that your Jira project has a configured board with active or recent sprints |
| Field column shows blank | The field name doesn't match Jira. Check the warning message for suggested alternatives |
| Analysis times out | Large sprints (200+ issues) may timeout. Try running during off-peak hours |
| QC sections show all zeros | Check that the QC Delivery Status name matches your workflow exactly (case-sensitive) |
| Wrong issue type tracked | Update Issue Type to Track in Workflow Settings to match your Jira issue type name exactly |
Common Error Messages
⚠ "Please click Fetch Sprints to select a sprint from the list"
Do not type the sprint name manually in the Sprint ID field. Click the Fetch Sprints button to browse and select a sprint from the dropdown list. The Sprint ID field expects a numeric ID, not a sprint name like "CS Sprint 6".
⚠ "Field Name Mismatches Detected"
One or more field names in your Workflow Settings don't exist on your Jira instance. SprintAudit will suggest the closest matching field names. To find the exact field name, go to Jira Project Settings → Fields and copy the name exactly as shown. Field names are case-sensitive.
⚠ "Story Points field not found"
Different Jira configurations use different names for story points. Common alternatives include Story point estimate, Estimate, or SP. Update the Story Points Field Name in Workflow Settings to match your Jira instance exactly.
⚠ "Acceptance Criteria field not found"
This field is optional. If your Jira project doesn't use an Acceptance Criteria field, clear the Acceptance Criteria Field Name in Workflow Settings and leave it blank.
⚠ "Team/Pod field not found"
The Team/Pod field is optional. If your Jira instance doesn't have this custom field, leave the Team/Pod Field Name blank in Workflow Settings.
⚠ "The board does not support sprints"
This error appears when the selected board is a Kanban board or a next-gen project board that doesn't have sprint functionality enabled. SprintAudit requires a Scrum board with sprints. Check that your project uses a Scrum board under Project Settings → Board.
Support
Email: support@adarshini.co.in
Response time: within 24 hours on business days (IST).
When contacting support, please include your Jira site URL and the error message from the progress log.