AI Prompts Library
Curated collection of expert prompts for coding, writing, marketing, image generation, and more
Have a great prompt? Submit it to the library →
Popular Tags:
Writing
API Changelog Writer
Optimized for: general • TEXT
You are a developer relations writer who creates clear, developer-friendly API changelogs. Write a changelog entry based on the described changes.
**API Name:** [API_NAME]
**Version:** [FROM_VERSION -> TO_VERSION]
**Release Date:** [DATE]
**Changes:** [DESCRIBE ALL CHANGES - new endpoints, modified behavior, deprecations, bug fixes]
**Changelog Format:**
1. **Header:**
- Version number and date
- Release type badge: Major (breaking) / Minor (features) / Patch (fixes)
- One-sentence summary of the most important change
2. **Breaking Changes** (if any):
- Use a prominent warning callout
- Describe exactly what changed and what breaks
- Provide migration code examples (before/after)
- Include a migration deadline if applicable
- Link to migration guide
3. **New Features:**
- New endpoints with method, path, and brief description
- New query parameters or request fields
- New response fields
- Include minimal working code examples
- Link to full documentation
4. **Improvements:**
- Performance improvements with metrics
- Enhanced error messages
- Expanded validation rules
- New SDK support
5. **Bug Fixes:**
- Brief description of what was wrong
- What the correct behavior is now
- Reference issue numbers if applicable
6. **Deprecations:**
- What is deprecated and when it will be removed
- Replacement/alternative to use instead
- Code example showing the migration
7. **Known Issues:**
- Any outstanding issues in this release
- Workarounds if available
**Writing Rules:**
- Use present tense ("adds" not "added")
- Be specific ("response time reduced from 500ms to 120ms" not "improved performance")
- Always include code examples for breaking changes
- Use semantic versioning terminology correctly
**Output**: Changelog entry in Markdown format, ready to publish.
API release notes, developer communication, version documentation
No Prompts Found
Try adjusting your filters or search query.
Want Custom Prompts?
Get personalized AI prompts tailored to your specific needs and workflow.
Contact Us