changelog-page-generator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Pages: Changelog

页面:Changelog

Guides changelog and release notes pages. Typically at
changelog.*
subdomain or
/changelog
. Builds trust, reduces support, increases feature adoption.
When invoking: On first use, if helpful, open with 1–2 sentences on what this skill covers and why it matters, then provide the main output. On subsequent use or when the user asks to skip, go directly to the main output.
用于指导搭建Changelog和发布说明页面,通常部署在
changelog.*
子域名或
/changelog
路径下,能够建立用户信任、减少客服咨询量、提升功能采用率。
调用规则:首次使用时如果合适,可以先用1-2句话说明该技能覆盖的范围及价值,再给出核心输出。如果是后续调用或者用户要求跳过介绍,直接给出核心输出即可。

Initial Assessment

初始评估

Check for product marketing context first: If
.claude/product-marketing-context.md
or
.cursor/product-marketing-context.md
exists, read it for product and release cadence.
Identify:
  1. Product type: SaaS, API, mobile app, etc.
  2. Audience: End users, developers, both
  3. Release cadence: Weekly, monthly, continuous
  4. Format: Timeline, version-based, category (New, Improved, Fixed)
首先检查产品营销上下文:如果存在
.claude/product-marketing-context.md
.cursor/product-marketing-context.md
文件,读取其中的产品信息与发布节奏。
识别以下信息:
  1. 产品类型:SaaS、API、移动应用等
  2. 受众:终端用户、开发者,或两者兼有
  3. 发布节奏:每周、每月、持续发布
  4. 格式:时间线式、版本号式、分类式(新增、优化、修复)

Changelog Structure

Changelog结构

SectionPurpose
EntryDate, version, title
CategoryNew, Improved, Fixed, Deprecated (optional)
DescriptionWhat changed, why it matters
LinkTo docs, blog, or in-app
MediaScreenshots, GIFs, videos (optional)
模块作用
条目日期、版本号、标题
分类新增、优化、修复、废弃(可选)
描述变更内容、价值说明
链接跳转至文档、博客或应用内页面
媒体资源截图、GIF、视频(可选)

Best Practices

最佳实践

Content

内容

  • User benefit first: "You can now X" not "We added X"
  • Concrete: Specific features, not vague "improvements"
  • Scannable: Headlines, bullets, tags
  • Searchable: If many entries, add search/filter
  • 优先讲用户收益:使用“你现在可以X”而非“我们新增了X”
  • 内容具体:明确说明功能,不要使用模糊的“优化”表述
  • 易扫读:使用标题、列表、标签排版
  • 可搜索:如果条目较多,新增搜索/筛选功能

Organization

编排

  • Reverse chronological: Newest first
  • Grouping: By version or date range
  • Tags: Feature area, product module (optional)
  • RSS/email: Notify subscribers of updates
  • 倒序排列:最新更新在前
  • 分组规则:按版本号或日期范围分组
  • 标签:功能领域、产品模块(可选)
  • RSS/邮件推送:向订阅用户推送更新通知

Placement

放置位置

  • Subdomain: changelog.yourdomain.com
  • Path: /changelog, /updates, /releases
  • Embed: Widget in app or docs sidebar
  • Link from: Footer, docs, in-app
  • 子域名:changelog.yourdomain.com
  • 路径:/changelog、/updates、/releases
  • 嵌入:应用内小组件或文档侧边栏
  • 入口位置:页脚、文档、应用内

Output Format

输出格式

  • Structure (layout, entry format)
  • Entry template (fields, tone)
  • Navigation (filters, search)
  • SEO (index, metadata)
  • Integration (embed, RSS, email)
  • 结构(布局、条目格式)
  • 条目模板(字段、语气)
  • 导航(筛选、搜索)
  • SEO(索引、元数据)
  • 集成(嵌入、RSS、邮件)

Related Skills

相关技能

  • docs-page-generator: Changelog linked from docs
  • docs-page-generator: API changelog for developers; docs includes API Reference
  • blog-page-generator: Major releases may have blog posts
  • top-banner-generator: Announce major updates on main site
  • docs-page-generator:Changelog可从文档页跳转
  • docs-page-generator:面向开发者的API Changelog;文档包含API Reference
  • blog-page-generator:重大版本更新可配套发布博客文章
  • top-banner-generator:在官网顶部横幅公告重大更新