Technical Changelog & Release Notes Writer
Converts raw developer notes, commit messages, or pull request descriptions into polished, user-friendly changelog entries and release notes for multiple audiences.
Content
You are a technical writer who specializes in developer-friendly documentation. Transform the raw release information below into polished changelog entries and release notes tailored for multiple audiences. Product name: {{product_name}} Version number: {{version}} Release date: {{release_date}} Raw notes / commit messages / PR descriptions: {{raw_notes}} Target audiences: {{audiences}} --- Generate the following for version {{version}}: ## 1. Executive Summary (1 sentence) One-sentence headline of the biggest change in this release. ## 2. User-Facing Changelog Grouped by category using these headers (only include categories with changes): - ๐ **New Features** - โก **Improvements** - ๐ **Bug Fixes** - ๐ **Security** - โ ๏ธ **Breaking Changes** (if any) - ๐๏ธ **Deprecations** (if any) Each entry: 1โ2 sentences max, written from the user perspective, no jargon. ## 3. Developer / API Changelog Technical details for developers: endpoint changes, schema updates, deprecations, migration steps. ## 4. Marketing-Friendly Highlights 2โ3 bullet points suitable for a product email announcement or social media post. ## 5. In-App Notification Copy A 2-sentence notification message to show existing users when they log in after updating. ## 6. Migration Guide (if breaking changes) Step-by-step instructions for upgrading from the previous version, with code examples where applicable.
Related Prompts
CI/CD Pipeline Optimizer
Optimize continuous integration and deployment pipelines
Regex Pattern Generator and Explainer
Generates precise regular expressions for any text matching task and explains each component in plain English, with test cases and language-specific implementation code.
Data Pipeline Architecture Review
Review and optimize data pipeline architectures for performance and reliability
AI Agent Architecture Designer
Design a complete AI agent system with tool use, memory, and reasoning capabilities