Getting Started

Prerequisites

To use Sprint Reports & Stakeholder Updates for Jira you need a Jira Cloud instance with project admin access. The app runs on Atlassian Forge — no external servers or configuration required.

Installation

1. Open the Atlassian Marketplace and search for Sprint Reports & Stakeholder Updates for Jira.
2. Click Get it now and select the Jira site where you want to install.
3. Navigate to any Jira Software project. Click More in the top navigation bar, then select Sprint Reports & Stakeholder Updates from the dropdown.

The app detects your project's boards and sprints automatically — no setup or mapping needed.

Generating Your First Report

1. Open Sprint Reports & Stakeholder Updates from the project navigation bar (under More).
2. The Sprint Report tab shows your project's boards. Select a board.
3. Choose a sprint (completed or active) from the dropdown.
4. Pick an audience type — Board/Leadership, Team, Product Owner, External Stakeholder, or others.
5. Click Generate Report. The AI analyzes your sprint data and produces a tailored report.

Report Types

Each audience type produces a different report structure optimized for that audience:

Audience	Focus
Board / Leadership	Traffic-light health indicators, milestone progress, key risks, decisions needed
Team	Epic coverage, delivery breakdown by assignee, scope changes, retro talking points
Product Owner	Goal completion, backlog health, acceptance criteria coverage, velocity trends
External Stakeholder	Customer-safe progress, delivered features, upcoming milestones, timeline confidence
Sprint Comparison	Side-by-side metrics for two sprints — velocity, completion, scope changes
Release Summary	Multi-sprint version rollup with epic progress and delivery milestones
Executive	High-level summary with KPIs, trends, and strategic recommendations

Release Reports

In addition to sprint reports, you can generate release reports based on Jira versions:

1. Switch to the Release tab in the Generator.
2. Select a Jira version (Fix Version).
3. Choose an audience type and click Generate.

Release reports aggregate data across all sprints that contributed to the version, showing epic progress, velocity trends, and delivery milestones.

Inline Editing

After generating a report, you can edit any section before publishing:

• Click on any section to edit its content directly.
• Add context, adjust tone, or remove sensitive details.
• Your edits are preserved when you publish or save to the archive.

Publishing to Confluence

Step 1: Configure Confluence Settings

Before publishing, configure your Confluence target from the Settings tab in the app:

1. Open Sprint Reports & Stakeholder Updates from the project navigation bar in Jira (under More).
2. Go to the Settings tab.
3. Under Confluence, select a Confluence space from the dropdown (all spaces you have access to are listed).
4. Optionally, set a parent page for each audience type (Board/Leadership, Team, Product Owner). Reports will be created as child pages under these parents. If no parent is set, reports are created at the space root.
5. Click Test to verify the connection to your Confluence space.

Step 2: Publish a Report

1. Generate a report as usual (select board, sprint, audience, click Generate).
2. Review and optionally edit the report content.
3. Click Publish to Confluence.
4. The report is created as a richly-formatted Confluence page.
5. A direct link to the published page appears on success.

Page Naming & Organization

Published pages follow this naming convention: Sprint Name — Audience Report — Month (e.g., "Sprint 12 — Board Report — March").

Pages are organized under the parent page you configured for each audience type:

• Board/Leadership and Executive reports → Board parent page
• Team reports → Team parent page
• Product Owner reports → PO parent page
• Comparison and Release reports → Board parent page

If you publish the same report again (same sprint + audience), the existing Confluence page is updated rather than duplicated.

Finding Published Reports

Reports published to Confluence show a direct link in the Archive tab, so you can navigate to the Confluence page at any time.

Using the App on Confluence

Sprint Reports & Stakeholder Updates is primarily a Jira app — reports are generated from your Jira project data (sprints, issues, boards). Confluence serves as the publishing destination where your team and stakeholders read the reports.

What You See on Confluence

Published reports appear as full Confluence pages with:

• Rich formatting — tables, headings, structured sections
• Status badges — colored indicators (green/yellow/red) for sprint health
• Interactive charts — velocity trends, completion breakdowns, epic coverage, and goal status charts rendered via the Sprint Chart macro
• Table of contents — auto-generated navigation for Board/Executive reports
• Metadata footer — generation timestamp and source information

These pages are regular Confluence pages — you can comment on them, share them, add watchers, and link them from other pages.

Sprint Chart Macro

The app includes a Sprint Chart Confluence macro that renders interactive charts. These charts are automatically embedded when you publish a report, but you can also insert them manually into any Confluence page:

1. Open a Confluence page in edit mode.
2. Type /Sprint Chart or open the macro browser and search for Sprint Chart.
3. The macro renders sprint data visualizations (velocity, completion rate, epic coverage, goal status).

Workflow Summary

Step	Where	What
1. Generate	Jira	Open the app from the project navigation bar (under More), select sprint & audience, click Generate
2. Review	Jira	Edit sections, adjust tone, remove sensitive details
3. Publish	Jira	Click “Publish to Confluence” — the page is created/updated automatically
4. Read & Share	Confluence	Stakeholders read the report, comment, and share the Confluence page

Report Archive

Every generated report is automatically saved to the archive:

• View all past reports in the Archive tab.
• Filter by audience type, sprint, or date.
• Click a report to view its full content.
• Reports published to Confluence show a direct link to the Confluence page.

Settings

Configure the app per project from the Settings tab:

• AI provider & model — select from the providers and models your admin has enabled.
• Custom fields — select which Jira fields are included in report generation (priority, labels, assignee, epic, custom fields).
• Confluence space — set the default Confluence space for publishing.

For site-wide administration (AI keys, provider restrictions, rate limits, global field defaults), see Admin & Settings.

Need Help?

For questions or feedback, contact contact@be4.software or visit the support portal.