Framework Migration Guide Authoring and Verification Checklist

Role: Lead Developer Relations Engineer & Migration Architect specializing in enterprise SDK upgrades and runtime modernization.

Context

• Deprecated Framework / Engine: {{legacy_framework}}
• Destination Framework / Engine: {{target_framework}}
• Known Breaking Changes: {{breaking_changes_count}}
• Runtime Environment Target: {{target_runtime_version}}
• Ecosystem Dependencies Scope: {{sdk_dependency_scope}}
• Reference Migration Repository: {{sample_repo_url}}

Task

Generate an exhaustive authoring and technical review checklist for a long-form engineering migration guide, ensuring developers can migrate production workloads from {{legacy_framework}} to {{target_framework}} on {{target_runtime_version}} without undocumented breaking failures or operational regressions.

Method

1. Evaluate the migration surface area across {{sdk_dependency_scope}} to establish prerequisites and dependency compatibility checks.
2. Draft validation items for environment parity, runtime toolchains, and minimum compiler/runtime versions for {{target_runtime_version}}.
3. Create step-by-step verification checks for the migration path, contrasting {{legacy_framework}} paradigms against {{target_framework}} idioms.
4. Build explicit testing criteria ensuring all {{breaking_changes_count}} breaking changes feature paired before/after code snippets and deprecation warnings.
5. Design checklist sections for automated test execution, contract validation, and database/state migration guarantees.
6. Formulate deep-dive debugging and troubleshooting checklist items, covering common runtime errors, memory leaks, and performance regressions.
7. Detail rollout strategy verification, covering blue/green deployment, feature flags, canary testing, and deterministic rollback steps validated against {{sample_repo_url}}.

Constraints

• Every code verification item MUST require execution testing against {{sample_repo_url}}.
• You MUST NOT omit explicit rollback verification steps for stateful or schema-altering migrations.
• Checklist items must specify required code artifact types (e.g., CI workflow, diff snippet, benchmark graph).
• The checklist must avoid generic advice and focus strictly on developer ergonomics and runtime stability.

Output format

1. Guide Scope & Environment Baseline Checklist (4 items)
2. Dependency & Compatibility Matrix Checklist (4 items)
3. Code Transformation & Breaking Changes ({{breaking_changes_count}}) Checklist (6 items)
4. Performance Benchmarking & Memory Profiling Checklist (4 items)
5. Error Diagnostics & Common Failure Recipes Checklist (4 items)
6. Production Deployment & Fallback Protocol Checklist (4 items)

Self-review

• Ensure {{legacy_framework}} and {{target_framework}} are explicitly contrasted throughout the checks.
• Verify that troubleshooting items require reproducible stack traces and remediation steps.
• Confirm the checklist provides a clear sign-off gate before documentation is published to engineering teams.