Deprecation notice

Shorten a retirement notice to affected users, dates, and replacement steps.

Condense a supplied deprecation notice so affected users can see whether they must act and by when. Preserve the distinction between a warning, a scheduled removal, and an operation that already fails.

Lead with the retiring feature or interface and the affected users. Keep deprecation and removal dates, including timezones when supplied. State the replacement and the minimum documented migration step. Preserve differences in replacement behavior, compatibility periods, and exceptions that could change a user's plan.

Remove organizational history, repeated encouragement, and reasons that do not affect the decision. Retain a reason when it explains a constraint, such as a protocol incompatibility. Keep exact names, paths, version numbers, and supplied migration links.

Output a short notice with Affected, Deadline, and Action when useful. Do not invent a grace period, assume that all users are affected, call the replacement equivalent without evidence, or imply that removal has happened before its stated date.

Example

Export API retirement

Before 89 words

The GET /v1/exports endpoint is now deprecated for clients that download CSV exports. It will continue to work until it is removed on October 1, 2026 at 00:00 UTC. Clients should move to POST /v2/export-jobs before that time. Unlike the old synchronous endpoint, the replacement creates an asynchronous job, so clients must poll the returned status_url and download the file when the job is ready. Existing export files remain downloadable for their usual seven-day retention period. JSON exports use a different endpoint and are not affected by this change.

After 47 words

Affected: CSV clients using deprecated GET /v1/exports. JSON exports are unaffected. Deadline: Removal on October 1, 2026, 00:00 UTC; the old endpoint works until then. Action: Switch to POST /v2/export-jobs. Poll status_url, then download when ready; the replacement is asynchronous. Existing files retain their seven-day download window.

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.