SkillsAdd

aj-geddes/useful-ai-prompts

api-changelog-versioning

Document API changes, breaking changes, migration guides, and version history for APIs. Use when documenting API versioning, breaking changes, or creating API migration guides.

First seen Jan 21, 2026

Installation

$ npx skills add aj-geddes/useful-ai-prompts --skill api-changelog-versioning
View on skills.sh ↗ GitHub repository ↗

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

git-workflow-and-versioning Similar name
addyosmani/agent-skills

Structures git workflow practices. Use when making any code change. Use when committing, branch…

30K installs
api-versioning Similar name
codewithmukesh/dotnet-claude-kit

API versioning strategies for ASP.NET Core. Covers Asp.Versioning library, URL segment, header,…

23 installs
vtex-io-storefront-theme-versioning Similar name
vtex/skills

Apply when installing, publishing, upgrading, or rolling back a VTEX IO storefront theme app (`…

510 installs
api-changelog-versioning Similar name
secondsky/claude-skills

Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration …

354 installs
api-versioning-strategy Similar name
secondsky/claude-skills

Implements API versioning using URL paths, headers, or query parameters with backward compatibi…

350 installs
wix-stores-versioning Similar name
wix/skills

Handle Wix Stores Catalog V1 and V3 SDK compatibility. Use when building any integration that i…

243 installs

Also in this package

Other skills from aj-geddes/useful-ai-prompts · top by installs.

npx skills add aj-geddes/useful-ai-prompts
nodejs-express-server 3.2K code-review-analysis 2.4K rest-api-design 2K architecture-diagrams 1.9K ansible-automation 1.6K ios-swift-development 1.5K android-kotlin-development 1.4K flask-api-development 1.4K wireframe-prototyping 1.4K jenkins-pipeline 1.3K

Browse all from aj-geddes/useful-ai-prompts

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 335
License LICENSE
Default branch main
Open issues 1
Status Active

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 2,306 B
  • docs SUMMARY.md 974 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 457 installs

SKILL.md

API Changelog & Versioning

Table of Contents

  • [Overview](#overview)
  • [When to Use](#when-to-use)
  • [Quick Start](#quick-start)
  • [Reference Guides](#reference-guides)
  • [Best Practices](#best-practices)

Overview

Create comprehensive API changelogs that document changes, deprecations, breaking changes, and provide migration guides for API consumers.

When to Use

  • API version changelogs
  • Breaking changes documentation
  • Migration guides between versions
  • Deprecation notices
  • API upgrade guides
  • Backward compatibility notes
  • Version comparison

Quick Start

  • Version comparison

````markdown

API Changelog

Version 3.0.0 - 2025-01-15

🚨 Breaking Changes

Authentication Method Changed

Previous (v2):

GET /api/users
Authorization: Token abc123

Reference Guides

Detailed implementations in the references/ directory:

Guide Contents
[🚨 Breaking Changes](references/breaking-changes.md) 🚨 Breaking Changes
[✨ New Features](references/new-features.md) ✨ New Features
[🔧 Improvements](references/improvements.md) 🔧 Improvements
[🔒 Security](references/security.md) 🔒 Security, 🗑️ Deprecated, 📊 Version Support Policy
[Step 1: Update Base URL](references/step-1-update-base-url.md) Step 1: Update Base URL, Step 2: Migrate Authentication, Step 3: Update Response Parsing, Step 4: Update Error Handling (+2 more)

Best Practices

✅ DO

  • Clearly mark breaking changes
  • Provide migration guides with code examples
  • Include before/after comparisons
  • Document deprecation timelines
  • Show impact on existing implementations
  • Provide SDKs for major versions
  • Use semantic versioning
  • Give advance notice (3-6 months)
  • Maintain backward compatibility when possible
  • Document version support policy

❌ DON'T

  • Make breaking changes without notice
  • Remove endpoints without deprecation period
  • Skip migration examples
  • Forget to version your API
  • Change behavior without documentation
  • Rush deprecations