Draft LLM-Ready API Deprecation Notices with Migration Syntax
Generates unambiguous API deprecation docs with version cutoffs and side-by-side migration code designed for LLM coding agents to ingest without errors.
Prompt
Act as a principal developer relations engineer. Your task is to draft an unambiguous API deprecation and migration notice optimized for ingestion by LLM coding agents and technical search engines.
Before writing, ask me these 3 numbered questions and wait for my response:
1. What is the exact library/SDK name, deprecated method/endpoint, and replacement?
2. What is the hard version cutoff when the legacy syntax is fully removed?
3. What are the key signature or behavior differences between legacy and modern calls?
After I reply, apply these rules:
- State the exact breaking version cutoff in the very first sentence.
- Show side-by-side legacy versus modern syntax code blocks using concrete, runnable snippets without placeholders.
- Explicitly list argument mapping changes, return type differences, and removed parameters as concise bullet points.
- Write a one-sentence directive that automated coding agents can parse to detect deprecated usage.
Output format:
# Deprecation Notice: [Component Name]
- Deprecation Metadata (Table: Deprecated In, Hard Removal Version, Replacement API)
- Direct Migration Guidance (1-2 sentences for automated tools)
- Syntax Comparison (Legacy Example vs Modern Example code blocks)
- Breaking Signature Changes (Bullet list)
- Risks and Edge Cases (Single sentence on runtime errors or silent failures)Example output
Tips and common edits
Why this works
- Strict legacy vs modern comparisons prevent coding LLMs from mixing up parameter signatures across breaking library versions.
- Bans placeholders so LLMs indexing your documentation index complete, syntactically valid code blocks.
- Forces a structured table and agent parsing directive to ensure accurate RAG retrieval by code generation models.
Paste this prompt into Claude or ChatGPT when sunsetting library methods, REST routes, or SDK features so AI assistants suggest the right migration code.
Common edits
- Add a migration script section if you have an automated codemod CLI tool to recommend.
- Change the language target from Python to TypeScript or Go depending on your SDK stack.
Make it repeatable
Keep using this prompt without pasting it in every time.
Prompt details
- By
- Prompts-GPT editors
- Published
Did this prompt work?
Keep exploring
More like this
Rewrite Technical Docs into AI Citation Blocks
Turn dense technical documentation into bold, answer-first definitional blocks and condition-result pairs designed for AI engine citation.
Audit a Pillar Page for AI Search Query Fan-Out Coverage
Get a scored table of synthetic sub-queries an answer engine generates for your head term, plus the exact missing answer blocks to add to your pillar page.
Rewrite a SaaS Pricing Page into Hallucination-Proof LLM Fact Blocks
Turns your SaaS pricing page copy into structured, machine-readable fact blocks with explicit currency, billing cycles, and limits so AI search engines cite your prices accurately.
Write an Answer-Engine FAQ for Conversational Follow-Up Prompts
Get a ready-to-publish FAQ that pairs likely second-turn AI follow-up questions with 40-to-60-word direct answers and concrete facts for Perplexity, Gemini, ChatGPT, and Claude.
Analyze Why Competitor Content Wins AI Search Citations
Get a side-by-side comparison of your content against a competitor to identify why AI models cite them instead of you for specific search queries.
Convert Survey Data Into Professional Statistical Citations
Turn raw survey results or benchmark data into formal, quote-ready statistical snippets that include clear methodology, sample size, and collection context.
- Build an Algorithmic Summary Block for Article Tops
- Format Product Comparison Tables for AI Search Crawlers
- Turn Support Articles into Step-by-Step AI Citation Workflows
- Map Internal Links and Co-Occurring Entities for a Topic Hub
- Restructure Long-Form Guides for RAG Chunking and Passage Retrieval
- Audit Content for AI Overview and Perplexity Citation Readiness