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
Code Performance Optimizer
Analyze code and provide optimization recommendations for better performance and efficiency
REST API Documentation Writer
Generates complete, developer-friendly REST API documentation from endpoint details including request/response examples, error codes, and authentication.
Chain-of-Thought Debugger
Step-by-step code debugging prompt that asks AI to think through the problem before providing solutions
Reasoning Model Debug Prompt (Chain-of-Thought Code Fixer)
Uses chain-of-thought reasoning to systematically diagnose and fix code bugs, explaining each step of the reasoning process before proposing a fix.