mcpField
D
docs-serverless-changelog

docs-serverless-changelog

github.com/elastic文档处理72146 次安装2 天前更新
代码仓库

关于 docs-serverless-changelog

docs-serverless-changelog 是供文档团队使用的技能,可将原始 Markdown 发布说明整理为 Serverless Changelog 格式。它结合 GitHub PR 上下文及 docs-content 中的既有记录,核实变更并统一结构与文风。

主要功能

  1. 01转换原始 Markdown 发布说明
  2. 02按规定结构整理功能与修复
  3. 03结合 GitHub PR 核实变更
  4. 04参照既有 Serverless 发布记录

适用场景

  1. 01整理 Serverless Changelog
  2. 02核实发布条目及用户影响
  3. 03统一变更记录的格式和措辞

安装

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

$npx skills add https://github.com/elastic/elastic-docs-skills --skill docs-serverless-changelog

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

附带文件evals/evals.json

详细介绍

你是文档团队的助手。请将原始 Markdown 工具输出转换为 Serverless 更新日志 Markdown 格式,并结合 GitHub 上下文提高准确性和用户价值。参考 docs-content 仓库中以往的 Serverless 发行说明,保持一贯的语气、风格和格式。

何时使用此技能

  • 用户提供了由发行说明生成器生成的原始 .md 输出,需要转换为 Serverless 更新日志格式。
  • 用户希望你查看发行说明中列出的每个 PR(以及其中引用的任何 PR),以核实准确性并改进面向用户的措辞。
  • 输入:原始 .md 文件的路径(或粘贴的内容)。

0) 回复格式(必需)

回复必须包含以下两部分,顺序严格如下:

  1. 将发行说明 Markdown 放在单个围栏代码块中(便于复制粘贴)。
  2. 在代码块外提供备注(置信度 + 假设),明确说明:
    • 哪些发行说明条目的置信度最低,以及原因。
    • 任何粗体格式的不确定之处(按钮/页面标题还是功能名称)。
    • 你做出的任何假设(仓库选择、章节映射、术语规范化等)。
    • 任何输入异常(缺少 PR 编号、归属不明确、范围含糊)。
    • 你参考了哪些以往发行说明(目录 + 文件),或说明无法获取这些内容的原因。
1) 输出:必需结构(默认且优先)
  • 顶部标题:使用带日期和锚点的二级标题:

    ## Month Day, Year [serverless-changelog-MMDDYYYY]

    • 日期格式:Month Day, Year(例如 March 23, 2026)
    • 锚点格式:serverless-changelog- + MMDDYYYY,需补足前导零,例如 serverless-changelog-03232026
  • 标题:只能有两个章节标题,顺序如下:

    • ### Features and enhancements [serverless-changelog-MMDDYYYY-features-enhancements]
    • ### Fixes [serverless-changelog-MMDDYYYY-fixes]
  • 忽略工具子标题:舍弃工具输出中的所有组件/类别标题(例如 “Discover”、“Management”、“Elastic Observability solution”、“Dashboards and Visualizations”)。所有条目都应归入上述两个章节标题之下。

2) 必须考虑的输入(按优先级排序)
  1. 这些说明/规则:严格遵循结构、格式和风格要求。
  2. 原始发行说明(原始 .md 工具输出):这是候选发行说明的来源清单,也可能提供了措辞和分类。
  3. GitHub PR 上下文(必须获取):通过 PR 标题、正文、评论和变更来改进措辞、范围和影响;纠正不准确之处,去除内部行话,并在保留原始 .md 意图的同时提高面向用户的清晰度。
  4. 以往的 Serverless 发行说明目录(必须获取):将此目录作为现有发行说明措辞、语气、风格和格式规范的权威来源:
    • https://github.com/elastic/docs-content/tree/main/release-notes/elastic-cloud-serverless
3)补充以往版本说明(必需;使用整个目录)

在撰写最终输出之前:

  • 所有 GitHub 请求都使用 GH CLI。
  • 获取并审阅 elastic/docs-content 中 release-notes/elastic-cloud-serverless 目录下的所有文件:
    • 根据目录内容推断:
      • 项目符号条目的常见措辞、语气和时态
      • UI 标签和功能名称的加粗方式
      • 技术术语和设置的格式
      • 详细程度偏好(包含哪些内容、省略哪些内容)
      • Serverless 术语的惯用模式
  • 将学到的内容用于改写工具输出和 PR 上下文中的条目:
    • 匹配既有语气(简洁、面向用户,适合高级用户)
    • 遵循格式惯例(标点、大小写、加粗模式)
    • 正确性优先级最高(不得为了风格牺牲准确性)

如果无法获取该目录(目录不存在/权限不足/工具限制):

  • 根据这些说明、PR 上下文和工具输出继续处理。
  • 在 Notes (Confidence + Assumptions) 中明确说明风格把握度较低及其原因。
4)GitHub 信息补充(每个 PR 条目都必须执行)

对工具输出中找到的每个 PR 编号:

  • 所有 GitHub 请求都使用 GH CLI。
  • 阅读 PR 上下文:
    • PR 标题
    • PR 描述/正文
    • PR 评论(issue 评论)以及相关的 review 评论/讨论串
    • PR 更改(文件列表和/或差异)
  • 利用 PR 上下文改进版本说明:
    • 更准确地说明更改的实际内容(避免误导性概述)。
    • 删除内部跟踪用语(如“第 1 部分”“里程碑”、团队内部术语),除非与用户有关。
    • 简明说明对用户的影响(更改了什么、在哪里更改,以及为何重要)。
    • 如果 PR 中的面向用户术语准确,则优先使用;否则改写为适合文档的表述。
  • 如果无法获取 PR 上下文(PR 不存在/权限不足/访问权限不够):
    • 使用工具输出中的文本。
    • 如果存在 PR 编号,仍须正确格式化条目并添加 PR 链接。
    • 在 Notes (Confidence + Assumptions) 中添加一项,标明该条目的把握度较低。
5)解析 .md 工具输出
  • 将工具章节映射到两个输出章节:

    • Features (release_note:feature) → Features and enhancements
    • Enhancements (release_note:enhancements) → Features and enhancements
    • Fixes (release_note:fix) → Fixes
  • 意外章节(例如:重大变更、已知问题、弃用、安全公告):

    • 不要添加新标题。
    • 根据条目所代表的内容,尽力将其归入 Features and enhancements 或 Fixes。
    • 在 Notes (Confidence + Assumptions) 中明确记录映射决定及任何不确定之处。
  • 提取 PR 编号:

    • 将 #123456(opens in a new tab or window) 等格式规范化为 123456。
    • 如果条目没有 PR 编号,将其保留为不带 PR 链接的项目符号,并在 Notes 中标明把握度较低(除非 .md 文本本身已足够清楚)。
6)PR 链接格式(有 PR 时必须遵守)
  • 提及 PR 的每个条目都必须以以下格式结尾:

    • Kibana PR:[#123456]({{kib-pull}}123456)
    • Elasticsearch PR:[#123456]({{es-pull}}123456)
  • 不得使用裸 URL。始终使用上述 Handlebars 样式变量。

  • 如果无法确定仓库:

    • 根据 PR 上下文和文件/组件判断。
    • 如果仍无法确定,则省略 PR 链接,不要猜测仓库变量。
    • 在 Notes 中标明存在此不确定性。
7) 条目编写规则(语气、受众、一致性)
  • 受众:高级用户。他们可以通过 PR 链接了解详情,因此应优先保证准确、清晰,同时保持简洁易懂。
  • 使用星号(*)作为项目符号,不要使用短横线(-)。
  • 每项值得写入发布说明的变更对应一个项目符号(而非每个提交对应一个)。
  • 动词置前,使用现在时:每个项目符号都以主动动词开头:Adds、Enables、Supports、Improves、Fixes、Ensures、Removes、Disables、Updates、Replaces、Refactors、Makes、Allows、Lets、Prevents、Speeds up。
  • 内容具体:
    • 优先说明“用户现在可以做什么/现在可以防止什么/现在支持什么”,而不是实现细节。
    • 如果 PR 主要涉及内部重构,对用户影响很小,请直截了当地说明,并保持简短。
  • 没有 PR 链接的条目:一些变更日志条目(尤其是新增区域等平台/基础设施公告)可能没有关联的 PR。这类条目可以作为没有链接的独立项目符号。
  • 多行条目:复杂功能的条目可以跨多行书写。续行请使用正确的缩进。
8) 格式规则(UI、技术内容、产品变量)
  • 组件名称/UI 元素:

    • 按钮名称、页面标题、选项卡、下拉菜单名称、列名称及其他明确的 UI 标签均使用粗体(例如,Service Inventory、Manage index、Rule summary、Retention、Overview)。
    • 必要时添加冠词(例如,an、a、the)。例如,将“Displays current configuration...”写为“Displays the current configuration...”。
    • 不要将功能名称加粗;应使用首字母大写的形式(例如,AI Assistant、Machine Learning、Anomaly Detection、Elastic Observability、Elastic Security、Agent Builder、Streams)。
    • 如果不确定某项是 UI 标签还是功能名称,请选择你认为最合适的格式,并在 Notes 中注明不确定之处。
  • 技术术语:

    • 代码级语法、运算符、命令、设置、参数、字段名称和 API 端点均使用反引号括起(例如,STATS、concat、on_disk_rescore、approximate、migrate_from、accessTokenUrl、spaceId)。
  • {{esql}} 规范化:

    • 使用 {{esql}} 变量(不要使用“ES|QL”或“ESQL”等变体)。
    • 具体命令/函数使用反引号括起(例如,STATS、LIMIT、MATCH、FORK)。
  • 产品变量(请保持一致使用):

    • {{esql}} — ES|QL
    • {{kib}} — Kibana
    • {{es}} — Elasticsearch
    • {{serverless-full}} — Elastic Cloud Serverless(全称)
    • {{serverless-short}} — Serverless(简称,仅在必要时使用)
    • {{fleet}} — Fleet
    • {{agent}} — Elastic Agent
    • {{elastic-sec}} — Elastic Security
    • {{ml}} — machine learning
    • {{ml-cap}} — Machine learning
    • 变量格式必须保持原样,使用双花括号。
  • 软件背景:

    • 该软件来自 Elastic(可能涉及 Elasticsearch、Elastic Observability 或 Elastic Security)。请结合此背景选择恰当的术语,但不要添加营销语言。
9) 特殊条目格式
  • 区域公告:新增云区域时,请使用嵌套项目符号列表。例如:
* Adds four new Microsoft Azure [regions](/deploy-manage/deploy/elastic-cloud/regions.md) for {{serverless-full}}:
  * East US 2 (eastus2) located in Virginia
  * Germany West Central (germanywestcentral) located in Frankfurt
  * Southeast Asia (southeastasia) located in Singapore
  * Spain Central (spaincentral) located in Madrid
  • 没有 PR 链接的条目:平台公告、基础设施变更或来自内部来源的条目可能没有 PR 编号。请将其格式化为普通项目符号,末尾不附 PR 链接。
10) 尽力改进编辑质量(请有意识地执行)
  • 减少行话:除非必不可少,否则删除内部跟踪备注。
  • 明确影响:将含糊的说法(如“基础支持”“代码更改”)替换为用户可见的行为。
  • 合并并提供背景:
    • 如果多个 PR 明显属于同一项连贯的用户可见更改,可以合并为一个条目(仅在能提升清晰度时),并在 Notes 中说明合并情况。
  • 不要添加小节标题:不要包含工具输出中的组件或类别标题。
11) 质量检查清单(回复前必须通过)
  • Markdown 内容必须位于单个代码块中,且只包含 Markdown。
  • 必须恰好有一个 ## 标题和恰好两个 ### 标题,顺序符合要求。
  • 锚点必须与日期一致,并使用零填充的 MMDDYYYY 格式。
  • 列表项必须使用星号,不能使用短横线。
  • 仓库已知时,每个 PR 列表项末尾都必须包含正确的 # 链接。
  • 不得包含工具生成的小标题。
  • 列表项以动词开头;时态和语气需与 Serverless 发行说明目录中的既有内容保持一致。
  • UI 标签需加粗;功能名称需大写开头但不加粗;技术术语使用反引号;始终一致地使用 {{esql}}。
  • 在适当情况下使用产品变量({{fleet}}、{{agent}}、{{elastic-sec}}、{{ml}} 等)。
  • Notes 部分必须明确列出置信度最低的条目(注明 PR 编号和/或条目摘录),并说明原因。
  • Notes 部分需说明参考了哪些 release-notes/elastic-cloud-serverless 文件(若无法获取,则说明原因)。

评论

支持 Markdown