关于 changelog
changelog 是用于创建、编辑和审查项目变更日志条目的技能。它为技术写作者和开发者提供产品目录选择、必要背景、格式、代码示例及文档链接方面的指引。
主要功能
- 01按指定路径创建变更日志条目
- 02检查产品目录和必要背景
- 03遵循 frontmatter 与风格规则
- 04为 API 或配置变更添加代码示例
- 05审查链接和条目质量
适用场景
- 01记录产品功能或变更
- 02编辑已有变更日志条目
- 03检查条目的结构与风格
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ cloudflare/ cloudflare-docs --skill changelog安装后在 Claude Code 中输入/changelog确认已加载。
详细介绍
创建、编辑或审核 src/content/changelog/ 下的变更日志条目时,请使用此技能。
样式参考: .agents/references/style-guide.md 包含写作风格、格式、链接、代码块和 frontmatter 的规范。以下变更日志专用补充规则是在这些规则之上添加的,不会取代它们。
前提条件
开始写作前,你需要具备以下三项内容:
- 产品名称(例如,Workers、KV、Hyperdrive、Containers、R2)
- 要记录的变更说明
- 足够的背景信息,以解释“为什么”以及适用场景
如果缺少任何一项,请请求澄清。三项齐备后再继续。
确定产品文件夹
根据产品名称,在 src/content/changelog/{product}/ 下找到正确的文件夹。检查现有文件夹以确认有效的产品名称,不要猜测。
创建变更日志文件
路径格式:
src/content/changelog/{product}/{YYYY-MM-DD}-{useful-short-name}.mdx
使用今天的日期,并使用简洁的连字符分隔 slug 描述变更。
Frontmatter
---
title: <TITLE>
description: <ONE_SENTENCE_SUMMARY>
products:
- <PRODUCT>
date: <YYYY-MM-DD>
---
写作风格
遵循 .agents/references/style-guide.md 中的规则。变更日志专用补充规则:
- 开篇句:说明功能或变更是什么,以及它解决了什么问题。
- 后续段落:进一步说明用法、适用场景以及“为什么”。
- 面向技术开发者和云计算受众。
代码示例
如果变更日志描述的是 API、SDK 或配置变更,请提供代码示例。
- 代码片段应简短、聚焦于新功能,并尽量减少样板代码。
- 在 frontmatter 后导入组件:
import { TypeScriptExample, WranglerConfig } from "~/components"; - Workers JS/TS → 使用
TypeScriptExample(不要使用裸的js/ts代码围栏) - Wrangler 配置 → 使用
WranglerConfig,输入 TOML,并将$today用于compatibility_date(不要使用裸的toml/jsonc代码围栏) - 其他语言(Python、Rust、Go 等)→ 使用带正确语言标识符的普通代码围栏
- 非 Workers 配置片段(JSON、YAML 等)→ 使用普通代码围栏(
json、yaml等)
文档链接
在变更日志末尾添加相关文档的链接:
- 使用相对路径(例如,
/workers/configuration/placement/) - 链接文本必须说明链接目标,不能使用“点击此处”或“阅读更多”。
- 检查是否有尚未提交或已暂存的
.md/.mdx文件可能是相关文档。
参考示例
查看以下现有变更日志,了解样式和格式:
src/content/changelog/workers/- 带代码示例的 Workers 变更日志src/content/changelog/kv/- KV 变更日志src/content/changelog/hyperdrive/- Hyperdrive 变更日志src/content/changelog/containers/- Container 变更日志
开始写作前,请阅读目标产品变更日志文件夹中的 2-3 条记录,以匹配样式和详略程度。如果目标文件夹中的条目少于 2 条,请从上面列出的文件夹中选择参考内容。
编辑现有条目
更新现有变更日志条目时,保留原有结构和语气。仅应用请求的更改,不要改写周围内容。
审核变更日志条目
审核时,请根据以上每个部分逐项验证:frontmatter 字段、文件路径规范、写作风格、代码示例质量和文档链接。按严重程度指出问题:
- 错误:缺少必需的 frontmatter 字段、产品文件夹错误、链接失效
- 警告:违反样式规范、API 变更缺少代码示例、描述含糊
- 细微问题:措辞方面的小改进
输出
创建或更新变更日志文件,并提供完整的文件路径和内容。