Documentation21 categories
Write a migration guide for a breaking change
Shipping a major version and users have to change their code.
Write a migration guide for the breaking change below. Structure: 1. **Who is affected**, stated so a reader can tell in ten seconds whether to keep reading. Include how to check, ideally a grep or a command. 2. **What changed and why**, two sentences. The why matters because it tells readers what else to expect. 3. **Before and after**, as code, for each affected pattern. Cover the common case first and the awkward cases after. 4. **Step-by-step migration**, in an order that leaves the codebase working after each step. 5. **Automated help**: a codemod, a regex, or a compiler flag if one exists. If none exists, say so plainly. 6. **What to do if you cannot migrate yet**: how long the old path keeps working, and what the deprecation warning looks like. Do not minimise the effort. If a case requires a rewrite rather than a rename, say that. The change:
Making it yours
- Paste your own material where the prompt asks for it. Everything above that line is instruction, not content.
- Delete any rule that does not apply to you. A shorter prompt that fits beats a thorough one that does not.
- If the answer comes back vague, add a line saying what you do not want. Constraints work better than encouragement.
Releases and decisions. Changelogs, migration guides and decision records that explain what changed and why.
Related prompts
Write changelog entries from these commitsCutting a release and the commit log is not a changelog.Write an architecture decision recordA decision was made in a meeting and will be questioned in a year.Changelog line for this changeOne commit that needs one honest user-facing line.Structure a README that gets someone runningA project with working code and a README that says only its name.Generate API reference from this codeA module whose public surface needs documenting properly, not just typed.Write the doc comment this function deservesA function whose name and types don't tell the whole story.
Keep this one
Phrasery saves prompts with a right-click and puts them back the same way. Add this to your own library in one click.
Add to your browser — free