Agent skill · writing content · secondsky
api-changelog-versioning
Creates comprehensive API changelogs documenting breaking changes, deprecations, and migration strategies for API consumers. Use when managing API versions, communicating breaking changes, or creating upgrade guides.
Why this skill is useful
Provides a structured template and best practices for documenting API changes that the AI wouldn't reliably generate on its own.
What it needs
About 1k tokens when loaded. Last updated 2026-08-06. 204 stars on the source repository.
What this skill does
API Changelog & Versioning Document API changes with clear migration paths and deprecation timelines. Changelog Structure Deprecation Schedule Version Status Support Until --------- -------- --------------- v3.x Current Full support v2.x Maintenance 2025-06-01 v1.x EOL Unsupported Version Support Policy Current: Full support, new features Maintenance: Bug fixes and security only EOL: No support, remove from docs Migration Guide Template json { "username": "john" } json { "data": { "type": "user", "attributes": { "name": "john" } } } Best Practices Provide 3-6 months deprecation notice Include before/after code examples Mark breaking changes prominently Maintain backward compatibility when feasible Version via URL path (/api/v1/) for clarity
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills secondsky/api-changelog-versioning