# New Release Notes Template

1 min read

**📌 1\. Release Overview**

A short intro paragraph:

- Version number / name
- Release date
- One-sentence summary of the update (business & product impact)

**👥 2\. Role-Based Highlights (Optional/Expandable Section)**

Quick scan for stakeholders by role

Great for emails or dashboards

| **Role** | **Impact** | **Notes** |
| --- | --- | --- |
| Admin | Moderate | [This is a sample text: New role permission settings available under ‘Team Management’.] |
| User | High | [This is a sample text: Faster report loading and new dashboard widgets.] |
| tech | Low | [This is a sample text: Minor SDK updates, one deprecated API endpoint (see Upgrade Notes).] |

* * *

**🚀 3\. What’s New (Business/End-User Focus)**

Designed for User and Admin

Focus on features, improvements, and UX changes

**Important**: Mark who benefits e.g. User, Admin

Example:

**🔍 Advanced Search Filters** User, Admin

**Why it matters:** Enables quicker access to relevant data with new filters (e.g., date range, status, custom tags). This improves productivity and reduces time spent navigating large datasets.

**✨ New Features**

- Clear list of newly launched features
- Why it matters (the value it adds)

**🔧 Improvements**

- UI/UX improvements
- Performance enhancements
- Workflow optimizations

**🐞 Bug Fixes (To be discussed if needed - only client reported bugs to be noted)**

- Only major bugs impacting users/admins
- Describe them in a simple, non-technical way

* * *

**🛠️ 4\. Upgrade Notes (Technical Focus)**

Designed for tech **teams**, e.g. sysadmins, DevOps, engineers managing integrations

Focus on system behavior, integration, API, SDKs

**Important**: Mark the relevant environment e.g. MT, ST, Self-Hosted

**⚠️ Breaking Changes**

- List any backward-incompatible changes
- Include guidance or mitigation steps

**🔁 Deprecated Features**

- APIs or features marked as deprecated
- Timeline for removal (if applicable)

**🔄 API & Integration Changes**

- Endpoints added/removed/modified
- Auth changes or token handling updates

**🧪 Known Issues**

- Document known problems post-release
- Workarounds or support links if available