Developer Platform Breaking Change Email Brief
Design a technical migration email campaign brief for breaking API and platform changes.
Use this template when planning critical deprecation notices and breaking runtime changes for engineering customers. It ensures engineering teams receive actionable migration steps, diffs, and timelines without developer churn.
Role: Staff Technical Communications Lead specializing in developer platform migrations and API lifecycle operations.
Context
- Platform architecture: {{platform_name}}
- Deprecated interface or system: {{deprecated_endpoint_or_feature}}
- Sunset deadline: {{target_migration_deadline}}
- Impacted customer cohort: {{affected_developer_tier}}
- Technical documentation asset: {{code_migration_guide_url}}
- Escalation path: {{fallback_support_channel}}
Task
Develop an advanced, multi-touch breaking change email brief that directs engineering teams through migrating away from {{deprecated_endpoint_or_feature}} on {{platform_name}} before {{target_migration_deadline}} without causing production regressions or pipeline failures.
Method
- Parse the technical blast radius and map breaking schema changes against {{affected_developer_tier}} production dependencies.
- Formulate a 3-phase notification cadence (T-90, T-30, T-7 days) defining urgency escalation and technical debt framing.
- Define code-level snippet requirements for before/after payload contracts in the email body.
- Draft explicit instructions referencing {{code_migration_guide_url}} with target SDK versions and runtime constraints.
- Establish triage copy pointing to {{fallback_support_channel}} for enterprise staging environment debugging.
- Define key performance indicators for click-through to sandbox endpoints and telemetry verification metrics.
- Specify payload error simulations so engineers can trigger staging alerts prior to production cutoff.
Constraints
- MUST include code-block diff formatting requirements (JSON schema or SDK calls) for each message tier.
- MUST NOT use generic marketing hype or vague deadlines; provide explicit UTC timestamps and HTTP error status codes.
- Copy recommendations must speak directly to Staff and Principal Software Engineers.
- Keep the entire brief structured strictly under the required output schema.
Output format
- Executive Migration Overview (Max 150 words)
- Multi-Stage Notification Matrix (Table: Stage, Trigger Window, Target Action, Risk Tier)
- Technical Email Copy Specifications (Subject lines, code diff guidelines, call-to-actions)
- Telemetry & Verification Framework (Metrics tracking API calls to deprecated endpoints)
Self-review
- Confirm that all 6 variables are seamlessly integrated into the technical specifications.
- Verify that the tone remains authoritative and technically precise for senior developers.
- Ensure both HTTP status codes and migration error handling are addressed.
Explicit role, a named task, and discrete steps the model can follow.
Background, inputs and variables the model needs before it starts.
Hard boundaries — what the model must and must not do.
A named, field-level shape for the response.
Ordered work items that force analysis before an answer.
Length and structure that travel across frontier models.
Signal density — instruction weight without padding.
Documented variables so the scaffold adapts to new inputs.
Quality bar, assumptions and behaviour when inputs are thin.
How much real usage the template has behind it.