Prompt Library

Instant Prompts for Documenting Breaking Changes with ChatGPT

Documenting breaking changes is critical but time-consuming. Stop writing release notes from scratch. Use these expert ChatGPT prompts to instantly generate clear, comprehensive documentation for API updates, library version changes, and UI modifications, ensuring your users are always informed.

Add ChatBoost to ChromeSave these prompts into ChatBoost and reuse them with Alt+P.

Prompt Library (27)

27 PromptsFree

Draft Release Notes for API Change

Draft release notes for a specific API endpoint's breaking change, detailing what, why, and actions needed.

Act as a senior technical writer. Draft release notes for a breaking change in our API.

**Product:** [Your Product Name]...

Explain Technical Change to Non-Technical Users

Translate complex technical breaking changes into clear, jargon-free explanations for non-technical stakeholders.

Take the following technical description of a breaking change and rewrite it for a non-technical audience, like a project manager or marketing team member. Focus on the user impact and business implications, avoiding jargon.

**Technical Description:** 'We've deprecated the legacy XML-RPC endpoint in favor of the new REST API for improved performance and security. All integrations must be updated to use OAuth 2.0 and JSON payloads.'...

Create a Code Migration Guide

Develop a step-by-step code migration guide, including 'before' and 'after' examples, to update applications affected by a library breaking change.

Create a step-by-step migration guide for developers. The guide should show how to update their code to accommodate a breaking change in our library.

**Library:** [Library Name]...

Summarize Impact on User Workflows

Analyze a specific breaking change and detail its direct impact on common user workflows, from the user's perspective.

Analyze the following breaking change and list the potential impacts on common user workflows. Frame it from the user's perspective.

**Change:** [e.g., The 'Export as PDF' button has been moved from the main toolbar into the 'File > Export' menu.]...

Generate a Deprecation Notice

Craft a formal deprecation notice for a feature, method, or API endpoint, outlining the reason, timeline, and alternative solutions.

Write a deprecation notice for a feature in our software. The notice should be clear, empathetic, and provide a clear timeline and alternative.

**Feature to be Deprecated:** [e.g., Legacy Dashboard v1]...

Compare Old vs. New in a Table

Construct a markdown table to visually compare the old and new parameters or functionality of an API after a breaking change.

Generate a markdown comparison table for the following breaking change in our API.

**Endpoint:** `/api/v2/search`...

Write an Internal Dev Team Announcement

Draft a concise, technical internal announcement for the engineering team about an upcoming breaking change, specifying impact and required actions.

Write a brief, technical announcement for our internal engineering Slack channel about an upcoming breaking change.

**Component:** [e.g., `AuthenticationService`]...

Create an FAQ for a Breaking Change

Generate a comprehensive FAQ section addressing anticipated user questions and concerns regarding a specific breaking change.

Generate a list of 5 frequently asked questions (FAQs) and their answers regarding the following breaking change.

**Breaking Change:** [e.g., We are moving our application's data storage from North America to Europe to comply with GDPR.]...

Rewrite Error Message Documentation

Revise error message documentation to reflect new or changed error codes introduced by a breaking API change, including explanations and resolutions.

A recent update introduced a breaking change to our API's error handling. Rewrite the documentation for the following error codes.

**Old Error:** `403 Forbidden` (generic)...

Document a Breaking UI Component Change

Document a breaking change in a shared UI component, providing 'before' and 'after' code examples and rationale for frontend developers.

Write documentation for a breaking change in a reusable UI component.

**Component:** [e.g., `<Button>`]...

Explain a Database Schema Change

Detail a breaking change in a database schema, providing the SQL migration script and outlining impact on services for backend teams.

Document a breaking change in our database schema.

**Database:** [e.g., PostgreSQL]...

Generate a 'Before and After' Code Example

Produce a side-by-side 'before' and 'after' code example to clearly illustrate the impact and required adjustments for a specific breaking change.

Create a 'Before' and 'After' code example in markdown to illustrate a breaking change in our SDK.

**SDK:** [e.g., Python Payments SDK]...

Create a User Migration Checklist

Develop a simple, actionable migration checklist for users to follow, ensuring a smooth transition after a product's breaking change.

Create a migration checklist for users to follow after our recent breaking change.

**Product:** [e.g., Project Management Tool]...

Draft an Email Announcement to Customers

Compose a professional and clear email announcement to customers about an upcoming breaking change, outlining critical details and required actions.

Draft an email to our customers announcing an important upcoming breaking change.

**Change:** [e.g., Our platform will require Two-Factor Authentication (2FA) for all users starting next month.]...

Translate Technical Rationale to Business Benefits

Translate the technical rationale behind a breaking change into clear, tangible business or user benefits for broader communication.

Convert the following technical reason for a breaking change into a user-centric or business benefit.

**Technical Reason:** 'We refactored the state management from Vuex to Pinia to reduce bundle size and improve tree-shaking.'...

Document Changes to Configuration Files

Document a breaking change in a configuration file's structure or syntax, providing 'before' and 'after' examples and the rationale.

Document a breaking change in our application's configuration file format.

**File:** `config.yaml`...

Generate a Security-Related Breaking Change Notice

Draft a precise, public-facing notice for a security-related breaking change, balancing transparency with non-disclosure of exploitable details.

Draft a public announcement about a breaking change that was implemented to patch a security vulnerability. Be transparent without revealing exploitable details.

**Vulnerability:** [e.g., A potential XSS vector in the user profile page's 'bio' field.]...

Create a Quick Start Guide for the New Version

Produce a concise quick start guide for a new version, highlighting major breaking changes and new features to aid rapid user adoption.

Create a 'Quick Start Guide' for version [e.g., 3.0] of our software, focusing on the major breaking changes.

**Key Changes:**...

Format Release Notes for GitHub Markdown

Structure a given list of changes into GitHub-flavored Markdown release notes, categorized by type (features, fixes, breaking changes).

Format the following list of changes into a structured release notes document using GitHub-flavored Markdown.

**Version:** v4.0.0 - "Orion"...

Summarize Multiple Breaking Changes into a Digest

Consolidate multiple breaking changes from a major release into a clear, actionable 'Upgrade Guide' digest for developers.

We are releasing a major new version with several breaking changes. Summarize them into a single 'Upgrade Guide' digest.

**Changes:**...

Identify Potential Edge Cases for a Change

Identify 3-5 potential edge cases or unintended consequences of a specific breaking change to inform comprehensive documentation and testing.

Act as a QA engineer. Analyze the following breaking change and list 3-5 potential edge cases or user scenarios we might have overlooked. This will help us write more comprehensive documentation.

**Change:** We are adding a 10-second cache to the `/api/realtime-stats` endpoint to reduce database load....

Document Changes in Authentication Logic

Develop critical documentation for breaking changes in authentication or authorization logic, including security benefits and user migration steps.

Write a clear, high-priority documentation entry for a breaking change in our authentication system.

**Change:** API keys now have scopes. Previously, any key could access any endpoint. Now, keys must be created with specific permissions (e.g., `read:users`, `write:posts`)....

Generate a Script to Find Deprecated Code

Produce a simple shell script (e.g., grep command) to help developers quickly locate instances of specific deprecated code in their codebase.

Our latest release deprecates the function `utils.old_method()`. Write a simple shell command or script that developers can run in their codebase to find all instances of this deprecated function.

**Deprecated Function:** `utils.old_method()`...

Write a Blog Post Announcing a Major Version

Draft a compelling blog post announcing a major version release, narrating the 'why' behind breaking changes and highlighting future product vision.

Write a blog post announcing the release of [Product Name] v2.0. The post should tell a story about our product's evolution and explain the high-level reasoning behind the breaking changes.

**Theme:** [e.g., 'From a Simple Tool to a Powerful Platform']...

Generate a Tweet-Sized Announcement

Condense a critical breaking change announcement into a concise, tweet-sized message (under 280 characters) with relevant hashtags and calls to action.

Draft a tweet (under 280 characters) to announce a breaking change in our open-source library.

**Library:** [e.g., `react-data-grid`]...

Document Changes in Library Dependencies

Create a release note entry detailing a breaking change in critical library dependencies, explaining its impact and necessary actions for users.

Write a release note entry about a breaking change in our project's dependencies.

**Project:** [e.g., Our main web application]...

Create a Glossary for New Terms

Construct a clear glossary section to define new concepts or technical terms introduced in a major release or alongside a breaking change.

A new release introduces several new concepts. Create a glossary section for our documentation to define these terms.

**Terms to Define:**...

Turn these prompts into a reusable workspace

Save your favourite prompts once, reuse them with Alt+P, keep a live Table of Contents of long chats, and export conversations when you're done.

Add ChatBoost to Chrome — It's free