Back to Details

product-changelog

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Product Changelog

产品更新日志

Write changelogs and release notes that users read and care about via inference.sh CLI.
通过inference.sh CLI撰写用户愿意阅读和关注的更新日志与发布说明。

Quick Start

快速开始

bash
curl -fsSL https://cli.inference.sh | sh && infsh login
bash
curl -fsSL https://cli.inference.sh | sh && infsh login

Generate a feature announcement visual

Generate a feature announcement visual

infsh 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 }'
undefined
infsh 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 }'
undefined

Entry Format

条目格式

The Anatomy of a Good Entry

优质条目的结构

markdown
undefined
markdown
undefined

New: Bulk Export for Reports 📊

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

**Structure:** Category label -> User-facing title -> What you can do now -> How -> What changed -> Visual
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

**结构：** 分类标签 → 面向用户的标题 → 现在可执行的操作 → 操作方式 → 变更内容 → 视觉素材

User-Facing Language

面向用户的表述方式

❌ 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"
Rules:
  • Write what the user can DO, not what you BUILT
  • Start with "You can now..." / "Reports now..." / "Fixed an issue where..."
  • Include the benefit, not just the mechanism
  • Use present tense
❌ 内部表述:
"Implemented batch processing queue for the export service"
"Refactored the ReportExporter class to support pagination"
"Fixed bug in CSV serialization (PR #4521)"

✅ 面向用户的表述:
"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"
规则：
  • 撰写用户能做什么，而非你开发了什么
  • 以「现在你可以……」「报表现在……」「修复了……问题」开头
  • 包含收益，而非仅说明技术机制
  • 使用一般现在时

Categories

分类

Standard Categories

标准分类

CategoryColorIconUse For
NewGreen✨ or 🆕Entirely new features or capabilities
ImprovedBlue⚡ or 🔧Enhancements to existing features
FixedYellow/Orange🐛 or 🔨Bug fixes
RemovedRed🗑️ or ⚠️Deprecated or removed features
SecurityPurple🔒Security patches
分类颜色图标适用场景
新增绿色✨ 或 🆕全新功能或能力
优化蓝色⚡ 或 🔧现有功能的增强
修复黄/橙色🐛 或 🔨Bug修复
移除红色🗑️ 或 ⚠️已弃用或移除的功能
安全紫色🔒安全补丁

Categorization Rules

分类规则

  • New = something users couldn't do before at all
  • Improved = something users could do, now it's better/faster/easier
  • Fixed = something that was broken, now works correctly
  • Don't use "Updated" — it's meaningless. Was it improved or fixed?
  • 新增 = 用户之前完全无法实现的功能
  • 优化 = 用户之前可以做，但现在更快/更好/更简单的功能
  • 修复 = 之前损坏的功能，现在恢复正常
  • 不要使用「更新」—— 这个词没有意义。要明确是优化还是修复？

Version Numbering

版本编号

Semantic Versioning (SemVer)

语义化版本控制（SemVer）

MAJOR.MINOR.PATCH
  3   .  2  .  1
ComponentIncrement WhenExample
MAJORBreaking changes, major redesign2.0.0 -> 3.0.0
MINORNew features, backward-compatible3.1.0 -> 3.2.0
PATCHBug fixes, small improvements3.2.0 -> 3.2.1
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

Date-Based Versioning

基于日期的版本编号

2026-02-08  or  2026.02.08  or  February 8, 2026
Best for SaaS products with continuous deployment.
2026-02-08  或  2026.02.08  或  February 8, 2026
最适合持续部署的SaaS产品。

Changelog Page Structure

更新日志页面结构

markdown
undefined
markdown
undefined

Changelog

Changelog

February 8, 2026

February 8, 2026

New

New

  • Bulk Export for Reports — Export up to 10,000 rows at once. Learn more →
  • Dark Mode — Toggle dark mode from Settings > Appearance.
  • Bulk Export for Reports — Export up to 10,000 rows at once. Learn more →
  • Dark Mode — Toggle dark mode from Settings > Appearance.

Improved

Improved

  • Dashboard Loading — Dashboards now load 3x faster on large datasets.
  • Search — Search results now include archived items.
  • Dashboard Loading — Dashboards now load 3x faster on large datasets.
  • Search — Search results now include archived items.

Fixed

Fixed

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

February 1, 2026

February 1, 2026

New

New

  • API Webhooks — Get notified when events happen in your account.
  • API Webhooks — Get notified when events happen in your account.

Fixed

Fixed

  • Fixed an issue where email notifications were delayed by up to 2 hours.
undefined
  • Fixed an issue where email notifications were delayed by up to 2 hours.
undefined

Visual Changelogs

可视化更新日志

When to Add Visuals

何时添加视觉素材

Change TypeVisual
New UI featureScreenshot of the new feature
UI redesignBefore/after comparison
New workflowStep-by-step screenshots or short video
Performance improvementChart showing improvement
Complex featureAnimated GIF or video demo
变更类型视觉素材
新UI功能新功能截图
UI重构前后对比图
新工作流分步截图或短视频
性能优化展示优化效果的图表
复杂功能动画GIF或视频演示

Generating Visuals

生成视觉素材

bash
undefined
bash
undefined

Feature screenshot (if you have the app running, use agent browser)

Feature screenshot (if you have the app running, use agent browser)

infsh app run infsh/agent-browser --input '{ "url": "https://your-app.com/new-feature", "action": "screenshot" }'
infsh app run infsh/agent-browser --input '{ "url": "https://your-app.com/new-feature", "action": "screenshot" }'

Before/after comparison

Before/after comparison

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

Annotated screenshot with callout

Annotated screenshot with callout

infsh 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" }'
infsh 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

Feature announcement banner

infsh 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 }'
undefined
infsh 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 }'
undefined

Breaking Changes

重大变更

Breaking changes need special treatment:
markdown
undefined
重大变更需要特殊处理：
markdown
undefined

⚠️ Breaking: API v2 Endpoints Deprecated

⚠️ 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 →)
  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 support@company.com.
undefined
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 →)
  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 support@company.com.
undefined

Distribution Channels

分发渠道

ChannelFormatWhen
Changelog pageFull detail, all entriesEvery release
In-app notification1-2 line summaryNew features, breaking changes
EmailCurated highlights, visualsMajor releases (monthly/quarterly)
Blog postDeep dive with contextBig launches
Social mediaSingle feature highlightNotable features
Slack/DiscordBrief announcementIf you have a community
渠道格式适用时机
更新日志页面完整详情，所有条目每次发布
应用内通知1-2行摘要新功能、重大变更
邮件精选亮点+视觉素材重大版本发布（每月/每季度）
博客文章深度解读+背景信息大型功能上线
社交媒体单一功能亮点重要功能
Slack/Discord简短公告若有社区用户

Social Media Snippet Format

社交媒体文案格式

🆕 New in [Product]: [Feature Name]

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

[Screenshot or demo video]

Try it now → [link]
🆕 [产品名称] 新功能：[功能名称]

[1-2句话说明现在可实现的操作]

[截图或演示视频]

立即体验 → [链接]

Writing Tips

撰写技巧

Do

建议

  • Group related changes together
  • Lead with the biggest/most requested change
  • Link to documentation for complex features
  • Include who requested it ("By popular request:")
  • Show migration paths for breaking changes
  • Date every entry
  • 将相关变更分组
  • 以最大/用户最期待的变更开头
  • 为复杂功能链接到文档
  • 注明需求来源（「应广大用户要求：」）
  • 为重大变更提供迁移路径
  • 为每个条目标注日期

Don't

禁忌

  • Don't say "various bug fixes" — list specific fixes or skip them
  • Don't include internal references (PR numbers, ticket IDs, branch names)
  • Don't use "Updated [feature]" without saying how
  • Don't list changes nobody cares about (dependency bumps, internal refactors)
  • Don't commit-dump — one changelog entry may represent many commits
  • 不要说「多项Bug修复」—— 列出具体修复内容或省略
  • 不要包含内部引用（PR编号、工单ID、分支名称）
  • 不要说「更新[功能]」却不说明具体变化
  • 不要列出无人关心的变更（依赖升级、内部重构）
  • 不要直接提交日志—— 一条更新日志条目可能对应多个提交

Changelog Frequency

更新日志发布频率

Product TypeFrequencyNotes
SaaS (continuous deploy)Weekly batchGroup a week of changes
SaaS (major features)Per feature launchWith blog post
Versioned softwarePer version releaseTied to semver
APIPer version + deprecation noticesInclude migration guides
Mobile appPer app store releaseMatch store listing "What's New"
产品类型频率说明
SaaS（持续部署）每周批量发布汇总一周的变更
SaaS（重大功能）每次功能上线搭配博客文章
版本化软件每次版本发布关联语义化版本
API每次版本发布+弃用通知包含迁移指南
移动应用每次应用商店发布匹配商店列表中的「新功能」

Common Mistakes

常见错误

MistakeProblemFix
Developer languageUsers don't understandWrite what users can do
"Bug fixes and improvements"Zero informationList specific fixes
No datesCan't tell what's newDate every entry
No visualsUsers skip textScreenshot major features
Breaking changes buriedUsers discover too lateProminent warning + timeline
Commit log as changelogNoisy, unhelpfulCurate and rewrite
错误问题修复方案
开发者表述用户无法理解撰写用户能做什么
「Bug修复与优化」无有效信息列出具体修复内容
无日期无法判断新旧为每个条目标注日期
无视觉素材用户跳过文字为重大功能添加截图
重大变更被隐藏用户发现过晚显著警告+时间线
提交日志直接当更新日志杂乱无章、毫无帮助整理并重写

Related Skills

相关技能

bash
npx skills add inference-sh/skills@ai-image-generation
npx skills add inference-sh/skills@prompt-engineering
Browse all apps: 
infsh app list
bash
npx skills add inference-sh/skills@ai-image-generation
npx skills add inference-sh/skills@prompt-engineering
浏览所有应用：
infsh app list