The Breaking Change Migration Guide
Write a migration guide for a breaking change
write a migration guide for a breaking changedev tools / apitool-agnosticapimigrationdeveloper-experiencedocumentationversioningadvanced
Entry PT-0259 · full text · stolen 0 timesReceived
A breaking change is shipping: [WHAT CHANGES, WHO IT BREAKS AND HOW MANY, THE BEFORE-AND-AFTER CODE, THE VERSION TIMELINE]. Write the migration guide: the am-I-affected check in the first screen (a command, a version number, a code pattern), the before-and-after diffs for the three most common usage patterns, the edge cases that bite (the ones support will hear about), the deprecation timeline with the enforcement dates, and the codemod or script if one is possible - even a dumb one.
Inputs needed
- ■Change spec, affected users, code diffs, timeline
What good output looks like
Am-I-affected check first; pattern-level diffs; support-ticket edge cases; enforcement dates
The stream (0)
Reading the room…