api-changelog-versioning

>

INSTALLATION
npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill api-changelog-versioning
Run in your project or agent environment. Adjust flags if your CLI version differs.

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
# 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
BrowserAct

Let your agent run on any real-world website

Bypass CAPTCHA & anti-bot for free. Start local, scale to cloud.

Explore BrowserAct Skills β†’

Stop writing automation&scrapers

Install the CLI. Run your first Skill in 30 seconds. Scale when you're ready.

Start free
free Β· no credit card