Release Notes

作者 phuryn8607e3b07781无许可证26K 个星标收录于 2026年10月8日更新于 2026年10月8日仓库3周前更新

Generate user-facing release notes from tickets, PRDs, or changelogs. Creates clear, engaging summaries organized by category (new features, improvements, fixes). Use when writing release notes, creating changelogs, announcing product updates, or summarizing what shipped.

AI 生成的概览

将工单、PRD 或变更日志转化为按类别和语气组织的面向用户的发布说明。

功能
读取 JIRA 或 Linear 工单、PRD、Git 日志或内部变更日志等原始材料,提取变更内容、影响对象及其重要性。它将变更归类为新功能、改进、缺陷修复、破坏性变更和弃用,并以通俗的用户语言撰写每条说明。产出为结构化的 Markdown 发布说明文档,可按需转换为 HTML 等其他格式。
适用场景
适用于撰写发布说明、创建变更日志、发布产品更新公告或总结已交付内容。适合需要将技术变更转化为清晰、以用户收益为导向的摘要的团队。
运行要求
无需脚本或特殊工具,基于用户提供的文件或描述工作。若提及产品网址,可能会使用网络搜索。

Release Notes Generator

Transform technical tickets, PRDs, or internal changelogs into polished, user-facing release notes.

Context

You are writing release notes for $ARGUMENTS.

If the user provides files (JIRA exports, Linear tickets, PRDs, Git logs, or internal changelogs), read them first. If they mention a product URL, use web search to understand the product and audience.

Instructions

  1. Gather raw material: Read all provided tickets, changelogs, or descriptions. Extract:

    • What changed (feature, improvement, or fix)
    • Who it affects (which user segment)
    • Why it matters (the user benefit)
  2. Categorize changes:

    • New Features: Entirely new capabilities
    • Improvements: Enhancements to existing features
    • Bug Fixes: Issues resolved
    • Breaking Changes: Anything that requires user action (migrations, API changes)
    • Deprecations: Features being sunset
  3. Write each entry following these principles:

    • Lead with the user benefit, not the technical change
    • Use plain language — avoid jargon, internal codenames, or ticket numbers
    • Keep each entry to 1-3 sentences
    • Include visuals or screenshots if the user provides them

    Example transformations:

    • Technical: "Implemented Redis caching layer for dashboard API endpoints"

    • User-facing: "Dashboards now load up to 3× faster, so you spend less time waiting and more time analyzing."

    • Technical: "Fixed race condition in concurrent checkout flow"

    • User-facing: "Fixed an issue where some orders could fail during high-traffic periods."

  4. Structure the release notes:

    # [Product Name] — [Version / Date]
    ## New Features- **[Feature name]**: [1-2 sentence description of what it does and why it matters]
    ## Improvements- **[Area]**: [What got better and how it helps]
    ## Bug Fixes- Fixed [issue description in user terms]
    ## Breaking Changes (if any)- **Action required**: [What users need to do]
  5. Adjust tone to match the product's voice — professional for B2B, friendly for consumer, developer-focused for APIs.

Save as a markdown document. If the user wants HTML or another format, convert accordingly.

来源与署名

来源:phuryn/pm-skills位于pm-execution/skills/release-notes提交8607e3b

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架