Migration guide

Reduce upgrade instructions to the changes users must make in order.

Condense the supplied migration guide for a user moving between named versions. Preserve the sequence that makes the change safe and compatible.

Lead with the affected versions and who must act. Separate prerequisites, required edits, validation, and rollback when the source supplies them. Keep old-to-new mappings, exact identifiers, changed defaults, compatibility windows, backup requirements, and irreversible steps. Retain exceptions for users who do not need a change.

Remove release marketing, repeated background, and unchanged behavior that does not affect migration. Combine related edits without hiding their order. A suggested step remains suggested; a required step remains required. Do not invent commands, assume a backup exists, or promise that rollback restores deleted data.

Output a short scope statement and numbered steps. Add a compact mapping table if several names change. Include supplied validation and rollback limits. This is a rewrite only: do not perform the upgrade or claim that it passed.

Example

Client library breaking change

Before 95 words

This guide is for applications upgrading Client Kit from 4.x to 5.0 that use local token storage. Applications that already supply their own tokenStore are not affected. Before upgrading, export the existing token database. In 5.0, the constructor option persistTokens is removed; replace persistTokens: true with tokenStore: new FileTokenStore(path). Use the same database path as before. Start one test session and confirm that its saved token is loaded after restart. Do not delete the export until this check passes. Version 4.x cannot read a database after 5.0 has written it; rollback requires restoring the export.

After 68 words

Scope: Client Kit 4.x → 5.0 with local token storage. Existing custom tokenStore users need no change. 1. Before upgrading, export the token database. 2. Replace persistTokens: true with tokenStore: new FileTokenStore(path), using the existing path. 3. Start a test session. Restart and confirm its saved token loads. 4. Keep the export until the check passes. Rollback: 4.x cannot read a database written by 5.0. Restore the export.

Examples illustrate the method. They do not measure model output.

Files and sources

prompt.txt Complete prompt as plain text.
SKILL.md The same prompt with a skill header.
llms.txt (JSON) Prompt, metadata, example, and sources.
LICENSE MIT license text.

An original sho.rten.it skill. Source notes.