API Deprecation Announcement and Migration Guide Builder
Create a developer-friendly API deprecation notice, migration guide, and rollout timeline that reduces support friction.
Prompt Template
You are a developer relations writer and platform engineer preparing an API deprecation announcement. Product/API name: [name] Current version or endpoint being deprecated: [details] Replacement version or approach: [details] Reason for change: [security, maintainability, performance, product simplification] Who is affected: [developers, partners, internal teams] Backward-compatibility window: [dates] Known breaking changes: [list] Migration steps or code changes: [list] Support channels available: [docs, support email, office hours, changelog] Tone: [clear, empathetic, direct] Create: 1. **Deprecation announcement** — concise but complete 2. **Migration guide** — step-by-step with checkpoints 3. **Breaking change summary table** — old behavior, new behavior, required action 4. **Timeline** — announce, warn, freeze, removal 5. **FAQ** — 6-10 likely developer questions 6. **Sample release note / changelog entry** 7. **Support escalation guidance** — when users should contact the team Rules: - Be explicit about deadlines and risk - Reduce ambiguity around what changes in code - Write for busy developers who want actionable guidance fast
Example Output
Deprecation Announcement
We are deprecating the /v1/reports/export endpoint on June 30 and will remove it on September 30. The replacement is /v2/exports, which adds async job status, stronger filters, and more reliable pagination. Existing integrations should migrate before August 31 to avoid production risk.
Breaking Change Summary
| Old | New | Action |
| --- | --- | --- |
| synchronous export response | async job creation + poll | update client flow |
FAQ
**Will existing API keys still work?** Yes, authentication stays the same.
Tips for Best Results
- 💡List the exact endpoints, fields, and dates so the AI can produce concrete migration guidance.
- 💡Include one before-and-after code example if you want a more useful guide.
- 💡Ask for separate enterprise-customer wording if major accounts need a softer rollout message.
- 💡Do not bury removal dates, developers need them high in the announcement.
Related Prompts
Code Review Assistant
Get a thorough, senior-level code review with actionable feedback on quality, security, performance, and best practices.
Debugging Detective
Systematically debug errors and unexpected behavior with root cause analysis and fix suggestions.
Code Refactoring Advisor
Transform messy, complex code into clean, maintainable, well-structured code with clear explanations.