1. My Awesome App
  2. Help
  3. Creating and Writing Release Notes

Creating and Writing Release Notes

Learn how to create release notes, use labels, format content with Markdown, and write effective release notes.

Creating a New Release

To create a new release:

  1. Click the New Release button in the Releases page header
  2. A side panel will open with the release editor
  3. Fill in the required information

Basic Information

When creating a new release, you'll need to provide:

Title

A clear, descriptive title that summarizes the release. Examples:

  • "Version 2.0 - Major Update"
  • "December 2024 Release"
  • "New Dashboard Features"

Version (Optional)

A version number to help users track updates. Examples:

  • "2.0.0"
  • "1.5.3"
  • "2024.12"

Content

The main release notes content written in Markdown format. This is where you describe all the changes, features, and improvements.

Excerpt (Optional)

A short summary that appears in release lists. If left empty, it will be auto-generated from your content (first 200 characters).

Cover Image URL (Optional)

A cover image URL to make your release more visually appealing. This appears at the top of the release when published.

Using Labels

Labels help categorize your release content and make it easier for users to understand what type of changes are included. Available labels include:

  • New Feature 🎨: For new functionality and capabilities
  • Improvement 🚀: For enhancements to existing features
  • Bug Fix 🐛: For bug fixes and patches
  • Maintenance 🔧: For maintenance updates and technical improvements
  • Performance ⚡: For performance improvements and optimizations
  • Announcement 📢: For important announcements and news

You can select multiple labels to categorize different aspects of your release. For example, a release might include both "New Feature" and "Performance" labels.

Writing Release Notes with Markdown

Markdown Editor

The release editor supports full Markdown formatting with a convenient toolbar for quick formatting:

  • Bold and Italic text
  • Headings (H1, H2, H3)
  • Bullet and numbered lists
  • Links and images
  • Inline code and code blocks
  • Blockquotes

Using the Toolbar

The Markdown toolbar provides quick access to common formatting options. Simply:

  1. Place your cursor where you want to insert formatted text
  2. Click the formatting button (Bold, Italic, Heading, etc.)
  3. The formatting will be inserted at your cursor position

Preview Mode

Switch to the Preview tab to see how your release notes will appear to users. This helps ensure proper formatting before publishing.

Use preview mode to:

  • Check formatting is correct
  • See how images and links appear
  • Verify the overall layout and readability

Best Practices for Writing Release Notes

Structure

  • Start with the most exciting features
  • Group changes by type (features, fixes, improvements)
  • Use clear headings to organize content
  • Keep paragraphs short and scannable

Content

  • Use clear, user-friendly language
  • Avoid technical jargon when possible
  • Be specific about improvements (e.g., "40% faster" instead of "faster")
  • Explain the benefit to users, not just the technical change

Formatting

  • Use bullet points for lists of changes
  • Include version numbers for easier reference
  • Add screenshots or GIFs for visual changes
  • Use headings to break up long content

Example Structure

# Version 2.0 - Major Update

## What's New
- New interactive dashboard
- Dark mode support
- Enhanced search functionality

## Improvements
- 40% faster page load times
- Improved mobile experience
- Better error messages

## Bug Fixes
- Fixed authentication issues
- Resolved data sync problems
- Corrected display bugs

Tips for Great Release Notes

  • ✅ Start with the most exciting features
  • ✅ Use visuals (screenshots, GIFs, videos) to show changes
  • ✅ Be specific about improvements
  • ✅ Group related changes together
  • ✅ Keep a consistent tone and style
  • ✅ Include links to documentation or support if needed

Next Steps

Now that you know how to create and write release notes, learn about:

  • AI Content Generation - Automatically generate release notes
  • Highlighted Features - Add visual feature cards
  • Publishing and Managing Releases - Publish and manage your releases