Release Notes

What it does

The product-on-purpose-release-notes skill generates release notes based on provided information about a product release. It can structure the notes with sections like "New Features," "Bug Fixes," and "Known Issues." The output is designed to be clear, concise, and suitable for public consumption by users.

When to use it

• Preparing for a software release: Quickly create draft release notes to share with stakeholders or customers before the official launch.
• Documenting bug fixes: Generate standardized release notes detailing resolved issues in a specific version.
• Communicating new features: Clearly explain newly implemented functionalities to users through well-formatted release notes.
• Creating changelogs: Automatically populate changelog files with detailed information about each product iteration.

Key capabilities

• Generates structured release note sections (e.g., New Features, Bug Fixes).
• Formats output for public consumption.
• Supports clear and concise descriptions of changes.

Example prompts

• "Generate release notes for version 2.5, including a new user profile feature and fixes for login errors."
• "Create release notes detailing bug fix #1234 (incorrect date format) and bug fix #1235 (missing button text)."
• “Write release notes for the 'Alpha' build highlighting improvements to search functionality.”

Tips & gotchas

The quality of the generated release notes depends heavily on the clarity and detail provided in the input data. Ensure you provide sufficient information about each change for accurate and informative output.