skills.rest
meriley
merileyCOMMUNITY
Explore all skills by this author →
GitHub

migration-guide-writer

Generate Diátaxis How-To migration guides mapping old APIs to new APIs.

Updated Aug 23, 2026
Search Tags:#developer tools#documentation#api#migration#breaking changes#code transition
One-click install
npx skills add https://github.com/meriley/claude-code-skills --skill migration-guide-writer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: migration-guide-writer
Source: https://github.com/meriley/claude-code-skills/tree/main/skills/migration-guide-writer
Command: npx skills add https://github.com/meriley/claude-code-skills --skill migration-guide-writer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the creation of detailed, step-by-step guides for migrating from old systems or APIs to new ones, ensuring a smooth transition and minimizing errors.

Core Features & Use Cases

  • Diátaxis How-To Pattern: Generates guides structured for problem-solving and practical application.
  • API Mapping & Verification: Verifies old and new APIs against source code, preventing fabricated information.
  • Breaking Change Documentation: Clearly lists all backward-incompatible changes.
  • Troubleshooting: Includes common issues and their solutions.
  • Use Case: When a critical service API is updated with breaking changes, this Skill can generate a comprehensive guide for developers on how to update their integrations, including code examples and potential pitfalls.

Quick Start

Generate a migration guide from the old TaskService to the new TaskService.

Frequently Asked Questions about migration-guide-writer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a migration guide for API breaking changes?▼

A migration guide for API breaking changes maps old APIs to new APIs using before/after examples and documents all backward-incompatible modifications. Following the Diátaxis How-To pattern ensures developers understand the exact code transitions required for a smooth update.

What is the Diátaxis How-To pattern for writing API transition documentation?▼

The Diátaxis How-To pattern structures API transition documentation around practical problem-solving. It maps old APIs to new APIs with before/after examples and verifies all endpoints against source code to prevent fabricated information during code transition.

How do I document old to new API mapping with verified before and after examples?▼

Documenting old to new API mapping requires verifying all endpoints in both systems against source code with zero tolerance for fabricated APIs. You generate before/after code examples by mapping deprecated interfaces directly to their new system replacements.

When do I need to generate a migration guide for a major version upgrade?▼

You need to generate a migration guide when new systems replace old ones, API changes occur, major version upgrades happen, or architectural changes are documented. It maps old APIs to new APIs and lists common troubleshooting issues.

Can I use automated documentation to prevent fabricated APIs in migration guides?▼

Yes, automated documentation prevents fabricated APIs by verifying all endpoints in both old and new systems against source code. It enforces zero tolerance for unverified performance claims and fabricated interfaces when mapping code transitions.

What are the limitations of automated migration guide generation for code transitions?▼

Automated migration guide generation has zero tolerance for fabricated APIs and unverified performance claims, requiring source code verification for both systems. It cannot document breaking changes or map APIs without direct access to the old and new codebases.

Related Skills

Explore More Software Engineering Skills→
GeargrindadminGeargrindadmin

bmad-os-audit-file-refs

Audit BMAD source files for file-reference convention violations using parallel Haiku subagents.

Community
Intermediate
baphledbaphled
1

api-documentation

Generate structured endpoint guides for REST API documentation.

Community
Intermediate
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
Pixel-Process-UGPixel-Process-UG
1

tech-docs-generator

Generates technical documentation from source code, including API references and architecture overviews.

Official
Advanced