migration-guide-writer

# Migration Guide Writer ## What this skill does This skill produces a structured, developer-friendly migration guide for any upgrade that involves breaking changes. Given the old and new versions of an API, library, or framework, it documents every breaking change with before/after code examples, produces a step-by-step migration checklist, calls out known gotchas, and estimates effort. The result is documentation your users can follow without needing to dig through release notes themselves. Use this when releasing a major version of a library, upgrading a critical dependency, or documenting a framework migration (e.g., React Router v5 → v6, Next.js 13 → 14, Postgres 15 → 16). ## How to use ### Claude Code / Cline Copy this file to `.agents/skills/migration-guide-writer/SKILL.md` in your project root. Then ask: - *"Use the Migration Guide Writer skill to document the changes from v1 to v2 of our SDK."* - *"Write a migration guide for upgrading from React Router v5 to v6 using the Migration Guide Writer skill."* Provide the changelog, breaking change list, or old vs. new API code. The more context you give, the more accurate the guide. ### Cursor Add the "Prompt / Instructions" section to your `.cursorrules` file. Open both the old and new API files (or paste the changelog) and ask Cursor to write the migration guide. ### Codex Paste the old API code and the new API code (or a changelog listing breaking changes) along with the instructions below. ## The Prompt / ...