Write a Migration Guide
Workflow for writing a guide to migrate between versions
CLAUDE.md
When writing a migration guide:
- State what version you’re migrating from and to.
- List all breaking changes with before/after code examples.
- Order changes by impact: things that will cause build failures first, then runtime changes, then deprecation warnings.
- Provide find-and-replace patterns or codemods where possible.
- Note any new required configuration or environment variables.
- Note any database migrations that need to run.
- Include a testing checklist: what to verify after migrating.
Copy this workflow into your CLAUDE.md or agent config file so your agent follows this process automatically.