mcpField
P
product-changelog

product-changelog

github.com/magentosh营销与增长442 次安装12 周前更新
代码仓库

关于 product-changelog

面向产品团队的 belt CLI skill,用于撰写以用户为中心的更新日志和发布说明。内容涵盖条目结构、分类、版本编号、视觉素材与发布渠道。

主要功能

  1. 01撰写用户视角的更新日志
  2. 02条目分类与结构指南
  3. 03SemVer 和日期版本编号
  4. 04视觉更新日志建议
  5. 05发布渠道格式参考

适用场景

  1. 01将工程改动转为用户说明
  2. 02为更新日志页面准备发布条目
  3. 03为功能公告选择视觉素材

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/magentosh/superpowers --skill product-changelog

安装后在 Claude Code 中输入/product-changelog确认已加载。

详细介绍

安装 belt CLI 技能: npx skills add belt-sh/cli

产品更新日志

通过 inference.sh CLI 撰写用户关注的更新日志和发布说明。

快速开始

需要 inference.sh CLI(belt)。安装说明

belt login

# Generate a feature announcement visual
belt app run falai/flux-dev-lora --input '{
  "prompt": "clean product UI screenshot mockup, modern dashboard interface showing a new analytics chart feature, light mode, minimal design, professional SaaS product",
  "width": 1248,
  "height": 832
}'

条目格式

优质条目的构成
### New: Bulk Export for Reports 📊

You can now export up to 10,000 rows at once from any report view.
Select your rows, click Export, and choose CSV or Excel format.

Previously limited to 500 rows per export.

![Bulk export button in the reports toolbar](screenshot.png)

**结构:**类别标签 -> 面向用户的标题 -> 用户现在可以做什么 -> 如何操作 -> 有哪些变化 -> 视觉素材

面向用户的语言
❌ Internal language:
"Implemented batch processing queue for the export service"
"Refactored the ReportExporter class to support pagination"
"Fixed bug in CSV serialization (PR #4521)"

✅ User-facing language:
"You can now export up to 10,000 rows at once from any report"
"Reports now load 3x faster when filtering large datasets"
"Fixed an issue where exported CSV files had missing columns"

规则:

  • 写用户现在可以做什么,而不是你构建了什么
  • 以“现在,你可以……” / “报告现在……” / “修复了……问题”开头
  • 写明收益,而不只是实现机制
  • 使用现在时

类别

标准类别
类别颜色图标适用范围
新增绿色✨ 或 🆕全新功能或能力
改进蓝色⚡ 或 🔧对现有功能的增强
修复黄色/橙色🐛 或 🔨Bug 修复
移除红色🗑️ 或 ⚠️已弃用或已移除的功能
安全紫色🔒安全补丁
分类规则
  • 新增 = 用户以前完全无法做到的事
  • 改进 = 用户以前能做到,但现在变得更好/更快/更轻松
  • 修复 = 原本无法正常工作的功能现在已恢复正常
  • 不要使用“更新”——这个说法没有意义。到底是改进了还是修复了?

版本号

语义化版本控制(SemVer)
MAJOR.MINOR.PATCH
  3   .  2  .  1
组件递增时机示例
MAJOR有不兼容变更、重大重新设计2.0.0 -> 3.0.0
MINOR新功能,且向后兼容3.1.0 -> 3.2.0
PATCHBug 修复、小幅改进3.2.0 -> 3.2.1
基于日期的版本控制
2026-02-08  or  2026.02.08  or  February 8, 2026

最适合持续部署的 SaaS 产品。

更新日志页面结构

# Changelog

## February 8, 2026

### New
- **Bulk Export for Reports** — Export up to 10,000 rows at once. [Learn more →](link)
- **Dark Mode** — Toggle dark mode from Settings > Appearance.

### Improved
- **Dashboard Loading** — Dashboards now load 3x faster on large datasets.
- **Search** — Search results now include archived items.

### Fixed
- Fixed an issue where exported CSV files had missing column headers.
- Fixed a bug where the date picker showed incorrect timezone.

---

## February 1, 2026

### New
- **API Webhooks** — Get notified when events happen in your account.

### Fixed
- Fixed an issue where email notifications were delayed by up to 2 hours.

可视化更新日志

何时添加视觉素材
变更类型视觉素材
新 UI 功能新功能的截图
UI 重新设计前后对比图
新工作流分步截图或短视频
性能改进展示改进效果的图表
复杂功能动图或视频演示
生成视觉素材
# Feature screenshot (if you have the app running, use agent browser)
belt app run infsh/agent-browser --input '{
  "url": "https://your-app.com/new-feature",
  "action": "screenshot"
}'

# Before/after comparison
belt app run infsh/stitch-images --input '{
  "images": ["before-screenshot.png", "after-screenshot.png"],
  "direction": "horizontal"
}'

# Annotated screenshot with callout
belt app run bytedance/seededit-3-0-i2i --input '{
  "prompt": "add a red circle highlight around the export button in the top right area",
  "image": "screenshot.png"
}'

# Feature announcement banner
belt app run falai/flux-dev-lora --input '{
  "prompt": "clean modern product announcement banner, gradient blue to purple background, abstract geometric shapes, professional SaaS aesthetic, wide format",
  "width": 1248,
  "height": 832
}'

不兼容变更

不兼容变更需要特别处理:

### ⚠️ Breaking: API v2 Endpoints Deprecated

**What changed:** API v1 endpoints will stop working on March 15, 2026.

**What you need to do:**
1. Update your API calls to use v2 endpoints ([migration guide →](link))
2. Update authentication to use Bearer tokens instead of API keys
3. Test your integration before March 15

**Timeline:**
- Now: v2 endpoints available, v1 still works
- March 1: v1 returns deprecation warnings
- March 15: v1 stops working

If you need help migrating, contact [email protected].

发布渠道

渠道格式适用时机
更新日志页面完整详情,包含所有条目每次发布
应用内通知1-2 行摘要新功能、不兼容变更
邮件精选重点、视觉素材主要版本发布(每月/每季度)
博客文章包含背景的深入介绍重大发布
社交媒体单项功能亮点值得关注的功能
Slack/Discord简短公告有社区时
社交媒体摘要格式
🆕 New in [Product]: [Feature Name]

[1-2 sentence description of what you can now do]

[Screenshot or demo video]

Try it now → [link]

写作技巧

应该做
  • 将相关变更归在一起
  • 优先介绍最重要/最受期待的变更
  • 对复杂功能添加文档链接
  • 说明是谁提出了需求(“应广大用户要求:”)
  • 为不兼容变更展示迁移路径
  • 为每条记录标注日期
不应该做
  • 不要写“各种 Bug 修复”——列出具体修复内容,否则就略过
  • 不要包含内部引用(PR 编号、工单 ID、分支名称)
  • 不要只写“更新了 [功能]”,却不说明具体变化
  • 不要列出无人关心的变更(依赖项升级、内部重构)
  • 不要逐条罗列提交——一条更新日志可能对应多次提交

更新日志频率

产品类型频率备注
SaaS(持续部署)每周汇总汇总一周内的更改
SaaS(主要功能)每项功能发布时配合博客文章
版本化软件每次版本发布时与语义化版本对应
API每个版本发布时 + 弃用通知包含迁移指南
移动应用每次应用商店发布时与商店页面的“最新动态”一致

常见错误

错误问题修正方法
使用开发者语言用户看不懂写清用户能做什么
“错误修复和改进”没有提供任何信息列出具体修复内容
没有日期无法判断有哪些新内容为每条记录标注日期
没有图片用户会跳过文字为主要功能添加截图
将重大变更埋在内容中用户发现得太晚添加醒目警告和时间表
将提交记录当作更新日志内容杂乱且无用筛选并改写

相关技能

npx skills add inference-sh/skills@ai-image-generation
npx skills add inference-sh/skills@prompt-engineering

浏览所有应用:belt app list

评论

支持 Markdown