skills.rest
cslsoftwares
cslsoftwaresCOMMUNITY
Explore all skills by this author →
GitHub

version-deprecation-policy

Automate public API deprecation with markers, changelogs, and removal scheduling.

Updated Jan 6, 2026
Search Tags:#changelog#versioning#api#migration#deprecation#governance
One-click install
npx skills add https://github.com/cslsoftwares/ParamentersORM --skill version-deprecation-policy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: version-deprecation-policy
Source: https://github.com/cslsoftwares/ParamentersORM/tree/main/.cursor/skills/version-deprecation-policy_V1.0.0
Command: npx skills add https://github.com/cslsoftwares/ParamentersORM --skill version-deprecation-policy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The policy guides teams to deprecate public APIs in a controlled, transparent manner, preventing surprise removals and ensuring a clear migration path.

Core Features & Use Cases

  • Mark deprecated APIs with explicit messaging and a removal timeline in interfaces and implementations (I* and T*).
  • Document alternatives and update changelogs to communicate migrations and schedules to consumers.
  • Plan removal in MAJOR releases by creating backlog items and aligning with governance practices to avoid breaking changes.

Quick Start

Mark the API as deprecated and record its replacement and removal date in the changelog and backlog.

Frequently Asked Questions about version-deprecation-policy

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

FAQPage Schema
How do I deprecate a public API and document its replacement?▼

To deprecate a public API, you mark the interface and implementation with a deprecated marker, output a deprecation message detailing the replacement and removal date, and update the changelog to document the migration path.

What is the best way to schedule API removal in the next MAJOR release?▼

Scheduling API removal in a MAJOR release involves creating a backlog item indicating the specific removal version, aligning with governance practices to ensure the deprecation timeline is transparently communicated to consumers.

Can I use this deprecation governance workflow with Delphi and FPC platforms?▼

Yes, this deprecation governance workflow is applicable to API design and maintenance across Delphi, FPC, and other platforms, allowing you to consistently mark APIs as deprecated and manage their lifecycle.

Do I need version-breaking-change-guard and version-semver-product to automate the deprecation lifecycle?▼

Yes, automating the full deprecation lifecycle requires integration with the prerequisite skills version-breaking-change-guard and version-semver-product to properly align API removal schedules with versioning governance.

How does API deprecation governance prevent breaking changes for consumers?▼

API deprecation governance prevents surprise breaking changes by enforcing a controlled, transparent manner of marking APIs as deprecated, ensuring a clear migration path with documented alternatives and scheduled removal dates.

Related Skills

Explore More Software Engineering Skills→
thefixer3xthefixer3x

version-manager

Enforce semantic versioning, deprecation lifecycles, and migration safety checks.

Community
Advanced
murphytruemanmurphytrueman
155

deprecation-process

Automate usage auditing and generate deprecation plans for design system assets.

Community
Advanced
cslsoftwarescslsoftwares

developer-delphi-docs-to-structured-code

Convert canonical project documentation into structured Delphi/FPC code with traceability.

Community
Intermediate
harishgovardhandamodarharishgovardhandamodar

deprecation-and-migration

Identify legacy systems and plan phased deprecation with timelines and owners.

Community
Intermediate