Overview

Changelog Voice guides you to write release notes that prioritize user benefit while clearly describing what changed, why it matters, and how to use it. It enforces entry structure, category tagging, and visuals for UI updates, helping readers understand impact quickly. This makes updates less marketingy and more actionable.

How This Skill Works

Apply the Entry Structure to every item: What changed (concrete, no marketing language), Why it matters (user impact), and How to use it (instructions or links). Categorize each entry as New, Improved, Fixed, or Removed, and add a visual for UI changes when available. Surface breaking changes prominently and include migration steps and timing.

When to Use It

• When drafting public release notes for users
• When you need to explain the impact of changes beyond features
• When categorizing updates under New, Improved, Fixed, or Removed
• When presenting UI changes, including a visual
• When there are breaking changes and migration steps are needed

Quick Start

1. Step 1: Outline each update with What changed, Why it matters, and How to use it
2. Step 2: Decide the category (New, Improved, Fixed, Removed) and attach a visual if UI changed
3. Step 3: Write concisely, lead with user benefit, add migration notes for breaking changes, and publish with a date

Best Practices

• Lead with the user benefit before technical details
• Categorize each entry as New, Improved, Fixed, or Removed
• Describe what changed, why it matters, and how to use it
• Include a visual (screenshot, GIF, video) for UI updates
• Highlight breaking changes prominently with migration steps and timing

Example Use Cases

• What changed: Added in-app search with filters. Why it matters: You can find items faster. How to use it: Open the search bar and apply filters.
• What changed: Faster checkout flow. Why it matters: Reduces cart abandonment. How to use it: Add items to cart and proceed with the streamlined checkout.
• What changed: Fixed crash when exporting reports under heavy load. Why it matters: Your data exports will not fail unexpectedly. How to use it: Try exporting again; if issue persists contact support.
• What changed: Removed the legacy analytics endpoint. Why it matters: Simplifies data access and improves performance. How to use it: Migrate to the v2 endpoint using the new API docs.
• What changed: UI labels updated for clarity (eg, Sign in instead of Log in). Why it matters: Reduces user confusion. How to use it: Look for the new labels across screens and refresh.

Frequently Asked Questions