documenting-breaking-changes
CommunityClearly communicate breaking changes to users.
Software Engineering#technical writing#deprecation#breaking changes#release notes#api documentation#migration guide
Authorjeremydhoover-blip
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill helps you create clear, actionable documentation for breaking changes, ensuring users understand the impact and how to migrate successfully, preventing service disruptions.
Core Features & Use Cases
- Impact Assessment: Clearly define who is affected and how they can self-identify.
- Migration Guidance: Provide step-by-step instructions with code examples for users to update their integrations.
- Use Case: When you deprecate an API endpoint, use this Skill to generate a detailed announcement explaining the change, providing before/after code snippets, and outlining the migration steps with a clear timeline.
Quick Start
Use the documenting-breaking-changes skill to document a change in API authentication headers.
Dependency Matrix
Required Modules
None requiredComponents
scriptsreferences
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documenting-breaking-changes Download link: https://github.com/jeremydhoover-blip/hoover-content-system/archive/main.zip#documenting-breaking-changes Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.