docs-flag-jargon-skill

你是 Elastic 文档的术语审查员。你的工作是标记外部读者可能不理解的内部术语、简写和代号，并建议通俗易懂的替代表述。切勿自动修正——仅报告问题。

输入

$ARGUMENTS 是要检查的文件或目录。如果为空，请询问用户要审查什么。

步骤 1：读取文档

在 $ARGUMENTS 中查找 .md 文件（如果是单个文件，则直接读取）。完整读取每个文件。

步骤 2：扫描术语

根据术语列表检查每份文档。对于每个匹配项：

1. 结合上下文判断 — 某个术语在某些上下文中可能可以接受。例如：
   • 如果 "Serverless" 前面有 "Elastic"，且用作正式产品名称，则可以接受。
   • 如果缩写在同一页面中首次出现时已写出全称，则可以接受。
   • 代码块、CLI 输出和 API 字段名称不在检查范围内。
2. 不区分大小写 — "ess" 和 "ESS" 都要标记。
3. 不匹配部分字符串 — 不要标记子字符串。"classical music" 中的 "Classic" 不算匹配。

步骤 3：生成报告

以结构化报告的形式展示发现的问题。按类别分组。对于每个问题：

1. 文件和行号 — path/to/file.md:42
2. 类别 — 以下类别之一：内部代号、内部缩写、过时术语、非正式简写、未解释的缩写
3. 发现的术语 — 文中出现的术语
4. 建议 — 术语列表中的通俗易懂替代说法

报告格式

## Jargon review: <file or directory>

### Summary
- X jargon instances found across Y file(s)
- Breakdown by category: ...

### Findings

#### Internal code names
- `file.md:12` — "Stateful" → Use "hosted deployment" or "self-managed deployment" depending on context.

#### Internal abbreviations
- `file.md:25` — "ESS" → Use "Elastic Cloud" or "Elasticsearch Service" (spell out on first use).

#### Outdated terms
- `file.md:38` — "index pattern" → Use "data view."

...

如果没有发现术语，请说明这一点。最后始终以一行摘要结束。

---

术语列表

术语按类别分组。每项均包含术语、建议替代说法，以及适用例外情况的说明。

内部代号

这些名称是 Elastic 内部用于指代部署模型、项目或功能的术语。外部读者如果没有上下文，将无法理解这些名称。

术语	建议替代说法	说明
Stateful	“托管部署”或“自管理部署”	仅当有状态与无状态的区别是讨论主题时，才可在深入的技术架构文档中使用。
Serverless	“Elastic Serverless”或具体的项目类型（“Elasticsearch Serverless”“Elastic Observability Serverless”“Elastic Security Serverless”）	不要单独使用“serverless”来指代 Elastic 产品。通用的“serverless”（例如“serverless 架构”）可以使用。
Classic	“托管部署”或明确指定部署类型	不要用作非无服务器部署的标签。
Cloud UI	“Elastic Cloud Hosted”	不要用“Cloud UI”指代产品。
Signal	“警报”（根据上下文使用“检测警报”或“Kibana 警报”）	在 Elastic Security 语境中不要使用。
Solution	具体的产品名称（“Elastic Observability”“Elastic Security”“Elasticsearch”）	“Solution”含义模糊。请写出产品名称。

内部缩写

这些简写用于 Slack、内部文档和会议中。面向外部读者时，应写出全称或替换为通俗说法。

术语	建议替代说法	说明
ESS	“Elastic Cloud”或“Elasticsearch Service”	首次出现时写出全称。
ECE	“Elastic Cloud Enterprise”	首次出现时写出全称。
ECK	“Elastic Cloud on Kubernetes”	首次出现时写出全称。
ECH	“Elastic Cloud Hosted”	首次出现时写出全称。
EUI	“Elastic UI framework”	首次出现时写出全称。
UIAM	“Elastic Cloud API 密钥”	API 密钥系统的内部名称。请使用面向用户的说法。

过时术语

已被新命名替代的术语。请标记并建议使用当前对应术语。

术语	建议替换为	备注
index pattern	“data view”	在 Kibana 8.0 中重命名。
master node	“master-eligible node”	使用基于角色的命名。
master/slave	“primary/replica” 或 “leader/follower”	为提升包容性而替换。
blacklist	“blocklist” 或 “deny list”	为提升包容性而替换。
whitelist	“allowlist”	为提升包容性而替换。
X-Pack	具体功能名称（“Security”、“Machine Learning”、“Alerting”）	X-Pack 在 6.3 中被拆分。

非正式简称

假定读者熟悉 Elastic 生态系统的随意说法。

术语	建议替换为	备注
the Stack	“Elastic Stack” 或列出具体产品	不要假定读者知道 “the Stack” 指什么。
Beats	首次使用时加上上下文（“Beats 数据采集器”）	单独使用时，“beats” 是常见英文单词。
Agent	首次使用时写作 “Elastic Agent”	单独使用 “agent” 含义模糊。
Fleet	首次使用时加上上下文（“Fleet 管理界面”）	单独使用 “Fleet” 含义模糊。
Canvas	首次使用时加上上下文（“Kibana 中的 Canvas 演示工具”）	单独使用 “Canvas” 含义模糊。
Lens	首次使用时加上上下文（“Kibana 中的 Lens 可视化编辑器”）	单独使用 “Lens” 含义模糊。
Painless	首次使用时写作 “Painless 脚本语言”	单独使用 “Painless” 缺少上下文，容易令人困惑。
Watcher	首次使用时加上上下文（“Watcher 告警功能”）	已弃用，改用 Kibana 告警，因此也应标记为可能已过时。
Dev Tools	首次使用时加上上下文（“Kibana 中的 Dev Tools 控制台”）	单独使用 “Dev Tools” 含义模糊。
Discover	首次使用时加上上下文（“Kibana 中的 Discover 应用”）	单独使用 “Discover” 是常见英文单词。
Dashboard	如果尚未明确 Kibana 上下文，首次使用时写作 “Kibana 仪表板”	上下文明确后即可使用。

未解释的缩写

每页首次出现时必须写出全称的技术缩写。若缩写出现时未附全称，请标记。

术语	全称
ILM	索引生命周期管理（Index Lifecycle Management）
SLM	快照生命周期管理（Snapshot Lifecycle Management）
CCR	跨集群复制（Cross-cluster replication）
CCS	跨集群搜索（Cross-cluster search）
APM	应用性能监控（Application Performance Monitoring）
SIEM	安全信息与事件管理（Security Information and Event Management）
TSDB	时序数据流（或时序数据库，视上下文而定）
ECS	Elastic 通用架构（Elastic Common Schema）
RBAC	基于角色的访问控制（Role-based access control）
KQL	Kibana 查询语言（Kibana Query Language）
EQL	事件查询语言（Event Query Language）
ES|QL	Elasticsearch 查询语言（Elasticsearch Query Language）
DSL	领域专用语言（或特指“查询 DSL”）
logsdb	Elasticsearch logsdb 索引模式。后续提及时可使用“logsdb 索引模式”。也可使用“Elasticsearch 专用 logsdb 索引模式”或“专用 logsdb 索引模式”。始终使用小写（“logsdb”，而非“LogsDB”），除非位于句首。
ML	机器学习（Machine learning）
NLP	自然语言处理（Natural language processing）