AGENT SKILL

release-note

Create clear, comprehensive, and user-focused release notes that communicate new features, improvements, bug fixes, known issues, and upgrade guidance.

License 许可
MIT
最近更新
2026-11-14
Stars
★ 0
Forks
0

01 前言 Front Matter

name
release-note
author
AI Business OS
license
MIT
version
1.0.0
category
template
priority
required
description
Create clear, comprehensive, and user-focused release notes that communicate new features, improvements, bug fixes, known issues, and upgrade guidance.

03 SKILL.md 正文

Release Note

Purpose

This skill creates professional Release Notes that communicate software changes to users, stakeholders, and operational teams.

Release notes should clearly explain what changed, why it changed, and any actions users need to take.


When to Use

Execute when:

  • Publishing a new release
  • Deploying a feature update
  • Delivering bug fixes
  • Announcing security updates
  • Releasing a hotfix
  • Preparing customer communications

Objectives

Produce release notes that are:

  • Clear
  • Accurate
  • Concise
  • User-focused
  • Actionable

Inputs

Expected inputs:

  • Release Version
  • Change Log
  • User Stories
  • Bug Reports
  • Deployment Information
  • Known Issues

Release Note Structure

Generate the following sections:

  • Release Summary
  • Version
  • Release Date
  • Highlights
  • New Features
  • Improvements
  • Bug Fixes
  • Breaking Changes
  • Security Updates
  • Known Issues
  • Upgrade Instructions
  • Rollback Information
  • Support Contacts

New Features

Describe:

  • Feature Name
  • User Benefits
  • Availability
  • Configuration Requirements

Focus on business value rather than implementation details.


Improvements

Include:

  • Performance Enhancements
  • UI Improvements
  • Stability Enhancements
  • Accessibility Improvements
  • Developer Experience Improvements

Bug Fixes

Document:

  • Issue Summary
  • Impact
  • Resolution
  • Related Ticket (if available)

Keep descriptions understandable for end users.


Known Issues

Identify:

  • Current Limitations
  • Workarounds
  • Planned Fixes
  • Risk Level

Be transparent about unresolved issues.


Upgrade Guidance

Provide:

  • Prerequisites
  • Upgrade Steps
  • Compatibility Notes
  • Post-upgrade Verification
  • Rollback Instructions

Validation Checklist

Verify:

  • Version correct
  • Features complete
  • Fixes verified
  • Known issues documented
  • Upgrade instructions reviewed
  • Stakeholders approved

Failure Conditions

Stop if:

  • Release scope is unclear
  • Version information is missing
  • Changes are incomplete
  • Known issues are undocumented
  • Deployment status is unknown

Outputs

Generate:

  • Release Note
  • Feature Summary
  • Upgrade Guide
  • Deployment Summary

Rules

  • Write for end users and stakeholders.
  • Highlight customer value.
  • Keep technical jargon to a minimum.
  • Document known issues honestly.
  • Include upgrade and rollback guidance.

Success Criteria

This skill succeeds when:

  • users understand what changed
  • upgrade risks are minimized
  • stakeholders are informed
  • release communication is complete

Related Skills

  • changelog
  • test-plan
  • test-case
  • technical-writer
  • project-plan

Version History

Version Date Description
1.0.0 2026-07-10 Initial release

04 同仓库更多 Skills