📝

API Changelog Tracker

Verified

by Community

Helps you maintain an API changelog with version tracking, breaking change documentation, migration guides, and consumer notification. Covers changelog formats, automated change detection, and best practices for API change communication.

changelogapiversioningdocumentationcommunication

API Changelog Tracker

Maintain comprehensive API changelogs with version tracking, breaking changes, and migration guides for consumers.

Usage

Describe your API changes and this skill will help you document and communicate them effectively.

Examples

  • "Create a changelog entry for adding a new search endpoint"
  • "Document a breaking change in the user response format"
  • "Generate a migration guide from API v2 to v3"

Guidelines

  • Categorize changes as added, changed, deprecated, or removed
  • Clearly mark breaking changes with migration instructions
  • Include the affected endpoints and date for each change
  • Notify API consumers of breaking changes well in advance
  • Link changelog entries to relevant documentation updates