How to Create a Changelog Entry

Step-by-step guide to creating changelog entries in ChangeCrab. Learn how to write effective release notes.

All Articles

How to Create a Changelog Entry

Creating changelog entries is the core of ChangeCrab. This guide will walk you through creating your first entry and best practices for writing effective changelog content.

Prerequisites

Before creating an entry, make sure you have:

  • A changelog project created (see how to create a changelog)
  • Access to the changelog editor
  • Content ready to publish (or use draft mode)

Step-by-Step Guide

Step 1: Open the Changelog Editor

Navigate to your changelog dashboard and click on the changelog you want to add an entry to. This opens the changelog editor.

Step 2: Click "New Entry"

In the changelog editor, click the "New Entry" or "Add Entry" button. This opens the entry creation form.

Step 3: Enter Entry Summary

The entry summary is a brief title that describes the change. This appears as the heading for your entry. Examples:

  • "New Dashboard Analytics Feature"
  • "Improved Login Performance"
  • "Fixed Email Notification Bug"
  • "Breaking: API Endpoint Changes"

Step 4: Write the Content

Use the markdown editor to write the detailed description of your change. The editor supports:

  • Markdown formatting - Headers, lists, links, code blocks
  • Rich text editing - Visual editor with formatting toolbar
  • Images - Upload and embed images
  • Code blocks - Syntax-highlighted code snippets

Learn more about the markdown editor.

Step 5: Select Categories

Choose one or more categories for your entry. Common categories include:

  • New - New features or functionality
  • Improvement - Enhancements to existing features
  • Fix - Bug fixes and corrections
  • Breaking - Breaking changes that may affect users
  • Notification - Important announcements

Learn how to manage categories.

Step 6: Set Publication Status

Choose when to publish your entry:

  • Publish Now - Make the entry live immediately
  • Save as Draft - Keep it private until ready
  • Schedule - Set a future publication date

Learn more about publishing and scheduling.

Step 7: Add Optional Information

You can also add:

  • Link - External link to related content
  • Author - Who made the change
  • Tags - Additional tags for organization

Step 8: Publish or Save

Click "Publish" to make your entry live, or "Save Draft" to keep it private for now.

Using the AI Assistant

Premium users can use the AI assistant to help create entries:

  1. Click the AI button in the editor
  2. Choose an action (Build, Tune, Change Tone, Safety Check)
  3. Enter your content or notes
  4. Review and apply the AI-generated content

Learn more about the AI assistant.

Best Practices

Writing Effective Changelog Entries

  • Be Clear and Concise - Use simple language that all users can understand
  • Focus on User Value - Explain what users get, not just what changed
  • Use Examples - Show before/after or provide use cases
  • Include Visuals - Screenshots or GIFs help users understand changes
  • Link to Documentation - Provide links to detailed guides when needed

Entry Structure

A well-structured entry typically includes:

  1. Summary - Brief overview of the change
  2. What Changed - Detailed description
  3. Why It Matters - User benefits and impact
  4. How to Use - Instructions or examples (if applicable)
  5. Additional Resources - Links to docs, tutorials, etc.

Next Steps

After creating your entry: