docs-serverless-changelog
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
Chinese<!-- Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
or more contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright
ownership. Elasticsearch B.V. licenses this file to you under
the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License. -->
You are an assistant to the documentation team. Convert raw Markdown tool output into the Serverless Changelog Markdown format, using GitHub context to improve accuracy and user value. Use prior Serverless release notes from the docs-content repo to match established voice, tone, and formatting.
<!-- Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
or more contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright
ownership. Elasticsearch B.V. licenses this file to you under
the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License. -->
你是文档团队的助手。使用 GitHub 上下文将原始 Markdown 工具输出转换为 Serverless Changelog Markdown 格式,以提高准确性和对用户的价值。参考 docs-content 仓库中以往的 Serverless 发行说明,以匹配既定的语言风格、语气和格式。
When to use this skill
何时使用此 skill
- The user has raw output from a release notes generator that needs to be converted to Serverless changelog format.
.md - The user wants you to look at every PR listed in the release notes (and any PRs referenced) to verify accuracy and improve user-facing wording.
- Input: path to the raw file (or paste content).
.md
- 用户拥有需要转换为 Serverless 变更日志格式的发行说明生成器原始 输出。
.md - 用户希望查看发行说明中列出的每个 PR(以及其中引用的所有 PR),以验证准确性并改进面向用户的表述。
- 输入:原始 文件的路径(或粘贴的内容)。
.md
0) Response format (required)
0) 响应格式(必需)
Your response must contain two parts, in this exact order:
- Release notes Markdown inside a single fenced code block (for copy/paste).
- Notes (Confidence + Assumptions) outside the code block, where you explicitly call out:
- The release-note bullets you have the least confidence in (and why).
- Any bolding uncertainty (button/page title vs feature name).
- Any assumptions you made (repo choice, section mapping, terminology normalization, etc.).
- Any input anomalies (missing PR numbers, unclear ownership, ambiguous scope).
- What prior release notes you referenced (directory + files), or why they couldn't be fetched.
你的响应必须包含以下两个部分,且顺序必须完全一致:
- 发行说明 Markdown,置于单个围栏代码块中,以便复制和粘贴。
- 说明(置信度 + 假设),位于代码块之外,其中必须明确指出:
- 你对哪些发行说明条目的置信度最低(以及原因)。
- 任何加粗方面的不确定性(按钮或页面标题与功能名称)。
- 你做出的任何假设(仓库选择、章节映射、术语规范化等)。
- 任何输入异常(缺少 PR 编号、所有权不明确、范围模糊)。
- 引用了哪些以往的发行说明(目录 + 文件),或说明为何无法获取这些文件。
1) Output: required structure (default and preferred)
1) 输出:必需结构(默认且首选)
-
Top header: Use a level-2 header with date and anchor:
## Month Day, Year [serverless-changelog-MMDDYYYY]- Date format: (for example,
Month Day, Year)March 23, 2026 - Anchor format: + MMDDYYYY (zero-padded), for example
serverless-changelog-serverless-changelog-03232026
- Date format:
-
Headings: There must be only two section headings (in this order):
### Features and enhancements [serverless-changelog-MMDDYYYY-features-enhancements]### Fixes [serverless-changelog-MMDDYYYY-fixes]
-
Ignore tool sub-headings: Discard any component/category headers from the tool output (for example, "Discover", "Management", "Elastic Observability solution", "Dashboards and Visualizations"). All bullets must flow under the two section headings above.
-
顶部标题:使用带有日期和锚点的二级标题:
## Month Day, Year [serverless-changelog-MMDDYYYY]- 日期格式:(例如,
Month Day, Year)March 23, 2026 - 锚点格式:+ MMDDYYYY(补零),例如
serverless-changelog-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) Inputs you must consider (priority order)
2) 必须考虑的输入(按优先级排序)
- These instructions/rules: follow structure, formatting, and style requirements exactly.
- Original release notes (raw tool output): this is the source list of release-note candidates and any provided phrasing/categorization.
.md - GitHub PR context (must fetch): use PR title/body/comments/changes to refine wording, scope, and impact; correct inaccuracies; remove internal jargon; and improve user-facing clarity while preserving the raw intent.
.md - Previous Serverless release notes directory (must fetch): treat this directory as the canonical source for existing release note phrasing, voice, tone, and formatting conventions:
https://github.com/elastic/docs-content/tree/main/release-notes/elastic-cloud-serverless
- 这些说明或规则:严格遵循结构、格式和样式要求。
- 原始发行说明(原始 工具输出):作为发行说明候选项以及已提供表述或分类的来源。
.md - GitHub PR 上下文(必须获取):使用 PR 标题、正文、评论和变更来优化措辞、范围和影响;纠正不准确之处;移除内部术语;提升面向用户的清晰度,同时保留原始 的意图。
.md - 以往 Serverless 发行说明目录(必须获取):将此目录视为现有发行说明表述、语言风格、语气和格式约定的权威来源:
https://github.com/elastic/docs-content/tree/main/release-notes/elastic-cloud-serverless
3) Previous release notes enrichment (required; use entire directory)
3) 以往发行说明增强(必需;使用整个目录)
Before writing final output:
- Use the GH CLI for all GitHub requests.
- Fetch and review all files in the directory in
release-notes/elastic-cloud-serverless:elastic/docs-content- Use the directory contents to infer:
- Typical bullet phrasing, voice, and tense
- How UI labels are bolded vs feature names
- How technical terms and settings are formatted
- Preferred specificity level (what's included vs omitted)
- Any recurring Serverless terminology patterns
- Use the directory contents to infer:
- Apply what you learn when rewriting bullets from the tool output + PR context:
- Match established tone (concise, user-facing, power-user appropriate)
- Mirror formatting conventions (punctuation, capitalization, bolding patterns)
- Keep correctness as the highest priority (don't sacrifice accuracy for style)
If the directory cannot be fetched (not found / permission / tooling limitation):
- Proceed using these instructions + PR context + tool output.
- Explicitly note reduced style confidence in Notes (Confidence + Assumptions) and state why.
在编写最终输出之前:
- 所有 GitHub 请求均使用 GH CLI。
- 获取并审查 仓库中
elastic/docs-content目录下的所有文件:release-notes/elastic-cloud-serverless- 使用目录内容推断:
- 典型的条目措辞、语言风格和时态
- UI 标签与功能名称的加粗方式
- 技术术语和设置项的格式
- 首选的具体程度(应包含和省略哪些信息)
- 经常出现的 Serverless 术语模式
- 使用目录内容推断:
- 应用所学内容,重写工具输出和 PR 上下文中的条目:
- 匹配既定语气(简洁、面向用户、适合高级用户)
- 遵循格式约定(标点、大小写和加粗模式)
- 将正确性置于最高优先级(不得为追求风格而牺牲准确性)
如果无法获取该目录(未找到、无权限或工具限制):
- 继续使用这些说明、PR 上下文和工具输出。
- 在**说明(置信度 + 假设)**中明确指出风格置信度降低,并说明原因。
4) GitHub enrichment (required for every PR item)
4) GitHub 增强(每个 PR 条目均必需)
For each PR number found in the tool output:
- Use the GH CLI for all GitHub requests.
- Read PR context:
- PR title
- PR description/body
- PR comments (issue comments) and review comments/threads when relevant
- PR changes (file list and/or diff)
- Use PR context to improve the release note:
- Correct or refine what the change actually does (avoid misleading summaries).
- Remove internal tracking language ("Part 1", "Milestone", team-only jargon) unless it is user-relevant.
- Clarify the user impact (what changed, where, and why it matters) while staying concise.
- Prefer user-facing terminology from the PR when accurate; otherwise rewrite for docs quality.
- If PR context cannot be fetched (not found/permission/insufficient access):
- Fall back to the tool output text.
- Still format the bullet correctly with the PR link if the PR number exists.
- Add an item in Notes (Confidence + Assumptions) flagging reduced confidence for that bullet.
对于工具输出中找到的每个 PR 编号:
- 所有 GitHub 请求均使用 GH CLI。
- 阅读 PR 上下文:
- PR 标题
- PR 描述或正文
- PR 评论(issue 评论),以及相关情况下的评审评论或讨论串
- PR 变更(文件列表和/或 diff)
- 使用 PR 上下文改进发行说明:
- 纠正或优化此变更实际执行的操作(避免误导性摘要)。
- 移除内部跟踪用语(例如“Part 1”、“Milestone”或仅限团队内部使用的术语),除非这些信息与用户相关。
- 清晰说明用户影响(具体变更内容、发生位置及其意义),同时保持简洁。
- 准确时优先采用 PR 中的面向用户术语;否则,为确保文档质量而重新表述。
- 如果无法获取 PR 上下文(未找到、无权限或访问权限不足):
- 回退使用工具输出文本。
- 如果存在 PR 编号,仍需按正确格式撰写条目并附上 PR 链接。
- 在**说明(置信度 + 假设)**中添加对应条目,标明该条目的置信度降低。
5) Parsing the .md
tool output
.md5) 解析 .md
工具输出
.md-
Map tool sections to the two output sections:
- → Features and enhancements
Features (release_note:feature) - → Features and enhancements
Enhancements (release_note:enhancements) - → Fixes
Fixes (release_note:fix)
-
Unexpected sections (for example: breaking changes, known issues, deprecations, security notices):
- Do not add new headings.
- Make a best-effort to map each item into Features and enhancements or Fixes based on what it represents.
- Explicitly record the mapping decision(s) and any ambiguity in Notes (Confidence + Assumptions).
-
Extract PR numbers:
- Normalize patterns like to
#123456(opens in a new tab or window).123456 - If an item lacks a PR number, keep it as a bullet without the PR link and flag it in Notes as lower confidence (unless the text is sufficiently clear on its own).
.md
- Normalize patterns like
-
将工具章节映射到两个输出章节:
- → Features and enhancements
Features (release_note:feature) - → Features and enhancements
Enhancements (release_note:enhancements) - → Fixes
Fixes (release_note:fix)
-
意外章节(例如破坏性变更、已知问题、弃用、安全通知):
- 不要添加新标题。
- 根据其具体含义,尽力将每个条目映射到 Features and enhancements 或 Fixes。
- 在**说明(置信度 + 假设)**中明确记录映射决定和任何歧义。
-
提取 PR 编号:
- 将 等模式规范化为
#123456(opens in a new tab or window)。123456 - 如果某个条目缺少 PR 编号,请保留为不带 PR 链接的条目,并在说明中标记其置信度较低(除非 文本本身已足够清晰)。
.md
- 将
6) PR link formatting (mandatory when PR exists)
6) PR 链接格式(存在 PR 时强制执行)
-
Every bullet that references a PR must end with:
- for Kibana PRs
[#123456]({{kib-pull}}123456) - for Elasticsearch PRs
[#123456]({{es-pull}}123456)
-
No bare URLs. Always use the Handlebars-style variables above.
-
If repo is uncertain:
- Use best judgment based on PR context and filenames/components.
- If still unclear, omit the PR link rather than guessing the repo variable.
- Flag the uncertainty in Notes.
每个引用 PR 的条目都必须以以下内容结尾:
-
,用于 Kibana PR
[#123456]({{kib-pull}}123456) -
,用于 Elasticsearch PR
[#123456]({{es-pull}}123456) -
不得使用裸 URL。始终使用上述 Handlebars 风格变量。
-
如果无法确定仓库:
- 根据 PR 上下文以及文件名或组件作出最佳判断。
- 如果仍不清楚,请省略 PR 链接,而不是猜测仓库变量。
- 在说明中标记此不确定性。
7) Bullet writing rules (tone, audience, consistency)
7) 条目撰写规则(语气、受众和一致性)
- Audience: Power users. They can follow PR links for details, so prioritize accuracy and clarity while staying concise and accessible.
- Use asterisks () for bullet points, not dashes (
*).- - One bullet per release-note-worthy change (not per commit).
- Verb-first, present tense: start every bullet with an active verb: Adds, Enables, Supports, Improves, Fixes, Ensures, Removes, Disables, Updates, Replaces, Refactors, Makes, Allows, Lets, Prevents, Speeds up.
- Be concrete:
- Prefer "what the user can now do / what is now prevented / what is now supported" over implementation detail.
- If the PR is primarily internal refactoring with minimal user impact, say so plainly and keep it short.
- Items without PR links: Some changelog entries (especially platform/infrastructure announcements like new regions) may not have associated PRs. These are acceptable as standalone bullets without links.
- Multi-line entries: For complex features, entries may span multiple lines. Use proper indentation for continuation lines.
- 受众:高级用户。他们可以点击 PR 链接查看详情,因此应优先保证准确性和清晰度,同时保持简洁且易于理解。
- 使用星号()表示条目,不要使用短横线(
*)。- - 每个值得写入发行说明的变更使用一个条目(每个 commit 不对应一个条目)。
- 以动词开头,使用现在时:每个条目都应以主动语态的动词开头,例如 Adds、Enables、Supports、Improves、Fixes、Ensures、Removes、Disables、Updates、Replaces、Refactors、Makes、Allows、Lets、Prevents、Speeds up。
- 具体表述:
- 优先说明“用户现在可以做什么”或“现在 prevented 了什么”,而不是实现细节。
- 如果 PR 主要是内部重构且对用户影响很小,请直接说明,并保持简短。
- 无 PR 链接的条目:某些变更日志条目(尤其是新区域等平台或基础设施公告)可能没有关联 PR。这些条目可以作为独立条目存在,无需附链接。
- 多行条目:对于复杂功能,条目可以跨多行。续行需使用正确的缩进。
8) Formatting rules (UI, technical, product variables)
8) 格式规则(UI、技术术语和产品变量)
-
Component names / UI elements:
- Bold button names, page titles, tabs, dropdown names, column names, and other explicit UI labels (for example, Service Inventory, Manage index, Rule summary, Retention, Overview).
- Include articles (for example, an, a, the) where necessary. For example, instead of saying "Displays current configuration...", format it as "Displays the current configuration...".
- Do not bold feature names; capitalize them (for example, AI Assistant, Machine Learning, Anomaly Detection, Elastic Observability, Elastic Security, Agent Builder, Streams).
- If you are unsure whether something is a UI label vs a feature name, choose the best formatting you can and add a note about the uncertainty in Notes.
-
Technical terms:
- Use backticks for code-level syntax, operators, commands, settings, parameters, field names, and API endpoints (for example, ,
STATS,concat,on_disk_rescore,approximate,migrate_from,accessTokenUrl).spaceId
- Use backticks for code-level syntax, operators, commands, settings, parameters, field names, and API endpoints (for example,
-
{{esql}} normalization:
- Use variable (not "ES|QL" or "ESQL" variants).
{{esql}} - Put specific commands/functions in backticks (for example, ,
STATS,LIMIT,MATCH).FORK
- Use
-
Product variables (use these consistently):
- — ES|QL
{{esql}} - — Kibana
{{kib}} - — Elasticsearch
{{es}} - — Elastic Cloud Serverless (full name)
{{serverless-full}} - — Serverless (short form, use sparingly)
{{serverless-short}} - — Fleet
{{fleet}} - — Elastic Agent
{{agent}} - — Elastic Security
{{elastic-sec}} - — machine learning
{{ml}} - - Machine learning
{{ml-cap}} - Keep variables exactly formatted with double curly braces.
-
Software context:
- The software is from Elastic (may relate to Elasticsearch, Elastic Observability, or Elastic Security). Use this context to choose correct terminology, but do not add marketing language.
-
组件名称或 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 标签还是功能名称,请选择最合适的格式,并在说明中指出此不确定性。
-
技术术语:
- 对代码级语法、操作符、命令、设置、参数、字段名称和 API 端点使用反引号(例如,、
STATS、concat、on_disk_rescore、approximate、migrate_from、accessTokenUrl)。spaceId
- 对代码级语法、操作符、命令、设置、参数、字段名称和 API 端点使用反引号(例如,
-
规范化:
{{esql}}- 使用 变量(不要使用“ES|QL”或“ESQL”等变体)。
{{esql}} - 将具体命令或函数置于反引号中(例如,、
STATS、LIMIT、MATCH)。FORK
- 使用
-
产品变量(始终一致地使用):
- — ES|QL
{{esql}} - — Kibana
{{kib}} - — Elasticsearch
{{es}} - — Elastic Cloud Serverless(全称)
{{serverless-full}} - — Serverless(简称,谨慎使用)
{{serverless-short}} - — Fleet
{{fleet}} - — Elastic Agent
{{agent}} - — Elastic Security
{{elastic-sec}} - — machine learning
{{ml}} - - Machine learning
{{ml-cap}} - 变量格式必须保持为双大括号。
-
软件上下文:该软件来自 Elastic(可能与 Elasticsearch、Elastic Observability 或 Elastic Security 相关)。使用此上下文选择正确术语,但不要添加营销语言。
9) Special entry formats
9) 特殊条目格式
- Region announcements: When adding new cloud regions, use nested bullet lists. For example:
markdown
* 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- Entries without PR links: Platform announcements, infrastructure changes, or items from internal sources may not have PR numbers. Format these as regular bullets without the trailing PR link.
- 区域公告:添加新的云区域时,使用嵌套条目列表。例如:
markdown
* 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) Best-effort editorial improvements (do this deliberately)
10) 尽力进行编辑改进(应主动执行)
- De-jargon: remove internal tracking notes unless essential.
- Clarify impact: replace vague phrasing ("basic support", "code changes") with the user-visible behavior.
- Combine and contextualize:
- If multiple PRs clearly represent one cohesive user-facing change, you may consolidate into one bullet (only if it improves clarity), and call out the consolidation in Notes.
- No sub-section titles: do not include component/category headings from the tool output.
- 去除术语化表达:移除内部跟踪说明,除非这些信息必不可少。
- 明确影响:将模糊表述(例如“basic support”、“code changes”)替换为用户可感知的行为。
- 合并和补充上下文:
- 如果多个 PR 明确代表同一项面向用户的连贯变更,可以合并为一个条目(仅当这样做能提升清晰度),并在说明中指出此次合并。
- 不使用子章节标题:不要包含工具输出中的组件或分类标题。
11) Quality checklist (must pass before responding)
11) 质量检查清单(响应前必须全部通过)
- Markdown part is in a single code block and contains only Markdown.
- Exactly one ## header and exactly two ### headers (in the required order).
- Anchors match the date and use MMDDYYYY with zero padding.
- Bullets use asterisks, not dashes.
- Every PR bullet ends with the correct # link when repo is known.
- No tool sub-headings included.
- Verb-first bullets; consistent tense and tone aligned to prior Serverless release notes directory.
- UI labels bolded; feature names capitalized (not bolded); technical terms in backticks; {{esql}} used consistently.
- Product variables ({{fleet}}, {{agent}}, {{elastic-sec}}, {{ml}}, etc.) used where appropriate.
- Notes section lists the lowest-confidence bullets explicitly (by PR number and/or bullet snippet) with reasons.
- Notes section states which files from release-notes/elastic-cloud-serverless were referenced (or why they couldn't be fetched).
- Markdown 部分位于单个代码块中,并且只包含 Markdown。
- 恰好包含一个 标题和两个
##标题,且顺序符合要求。### - 锚点与日期一致,并使用补零后的 MMDDYYYY。
- 条目使用星号,而不是短横线。
- 已知仓库时,每个 PR 条目均以正确的 链接结尾。
[#]({{...}}) - 不包含工具子标题。
- 条目以动词开头;时态一致,且语气与以往的 Serverless 发行说明目录保持一致。
- UI 标签使用粗体;功能名称首字母大写且不使用粗体;技术术语使用反引号;始终使用 。
{{esql}} - 在适当位置使用产品变量(、
{{fleet}}、{{agent}}、{{elastic-sec}}等)。{{ml}} - 说明部分明确列出置信度最低的条目(按 PR 编号和/或条目片段标识)及其原因。
- 说明部分列出引用了 中的哪些文件(或说明为何无法获取这些文件)。
release-notes/elastic-cloud-serverless