菜单
文档面包屑箭头 Writers' Toolkit面包屑箭头 构建和评审面包屑箭头 文本检查 (Lint prose)面包屑箭头 规则
开源 此页面内容适用于开源版本。
最近评审时间：2025 年 3 月 18 日

Vale 规则

Vale 将我们的风格指南编入了一系列可用于检查文本的规则。以下是我们定义的所有规则列表。

错误 (Errors)

以下规则被视为错误，必须修正。

Grafana.GoogleAMPM

Extends: existence

使用 ‘AM’ 或 ‘PM’（前面加一个空格）。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \d{1,2}[AP]M\b
  • \d{1,2} ?[ap]m\b
  • \d{1,2} ?[aApP]\.[mM]\.

更多信息 ->

Grafana.GoogleDateFormat

Extends: existence

使用 ‘July 31, 2016’ 格式，而非 <CURRENT TEXT>。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}
  • \d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)?|Aug(?:ust)?|Sep(?:tember)?|Oct(?:ober)?|Nov(?:ember)?|Dec(?:ember)?) \d{4}

更多信息 ->

Grafana.GoogleEmDash

Extends: existence

破折号前后不要加空格。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \s[—–]\s

更多信息 ->

Grafana.GoogleEnDash

Extends: existence

使用长破折号（’—’），而非 ‘–’。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • –

更多信息 ->

Grafana.GoogleGender

Extends: existence

不要使用 <CURRENT TEXT> 作为中性代词。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • he/she
  • s/he
  • \(s\)he

更多信息 ->

Grafana.GoogleGenderBias

Extends: substitution

考虑使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
(?:alumnae|alumni)graduates
(?:alumna|alumnus)graduate
air(?:m[ae]n|wom[ae]n)pilot(s)
anchor(?:m[ae]n|wom[ae]n)anchor(s)
authoressauthor
camera(?:m[ae]n|wom[ae]n)camera operator(s)
door(?:m[ae]|wom[ae]n)concierge(s)
draft(?:m[ae]n|wom[ae]n)drafter(s)
fire(?:m[ae]n|wom[ae]n)firefighter(s)
fisher(?:m[ae]n|wom[ae]n)fisher(s)
fresh(?:m[ae]n|wom[ae]n)first-year student(s)
garbage(?:m[ae]n|wom[ae]n)waste collector(s)
lady lawyerlawyer
ladylikecourteous
mail(?:m[ae]n|wom[ae]n)mail carriers
man and wifehusband and wife
man enoughstrong enough
mankindhuman kind|humanity
manmademanufactured
manpowerpersonnel
middle(?:m[ae]n|wom[ae]n)intermediary
news(?:m[ae]n|wom[ae]n)journalist(s)
ombuds(?:man|woman)ombuds
oneupmanshipupstaging
poetesspoet
police(?:m[ae]n|wom[ae]n)police officer(s)
repair(?:m[ae]n|wom[ae]n)technician(s)
sales(?:m[ae]n|wom[ae]n)salesperson or sales people
service(?:m[ae]n|wom[ae]n)soldier(s)
steward(?:ess)?flight attendant
tribes(?:m[ae]n|wom[ae]n)tribe member(s)
waitresswaiter
woman doctordoctor
woman scientist[s]?scientist(s)
work(?:m[ae]n|wom[ae]n)worker(s)

更多信息 ->

Grafana.GoogleLyHyphens

Extends: existence

<CURRENT TEXT> 不需要连字符。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \b[^\s-]+ly-\w+\b

更多信息 ->

Grafana.GoogleOptionalPlurals

Extends: existence

不要在括号中使用复数，例如 <CURRENT TEXT>。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \b\w+\(s\)

更多信息 ->

Grafana.GooglePeriods

Extends: existence

不要在首字母缩略词或缩写词中使用句点，例如 <CURRENT TEXT>。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \b(?:[A-Z]\.){3,}

更多信息 ->

Grafana.GoogleSlang

Extends: existence

不要使用互联网俚语缩写，例如 <CURRENT TEXT>。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • tl;dr
  • ymmv
  • rtfm
  • imo
  • fwiw

更多信息 ->

Grafana.GoogleSpacing

Extends: existence

<CURRENT TEXT> 应该有一个空格。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • [a-z][.?!] {2,}[A-Z]
  • [a-z][.?!][A-Z]

更多信息 ->

Grafana.Latin

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
e\.?g[,.]?for example
i\.?e[,.]?that is

更多信息 ->

Grafana.Ordinal

Extends: existence

对于序数词，1到9请使用单词拼写。从10开始，使用数字。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • 1st
  • 2nd
  • 3rd
  • 4th
  • 5th
  • 6th
  • 7th
  • 8th
  • 9th

更多信息 ->

Grafana.Paragraphs

Extends: script

br 元素只能用于实际内容中的换行，例如诗歌或地址。

更多信息 ->

Grafana.Please

Extends: existence

保持礼貌是好事，但在说明中使用“please”则显得过于客气。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • please

更多信息 ->

Grafana.ReferTo

Extends: substitution

在 Markdown 中链接时，使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
Check out \[Refer to [
See \[Refer to [
check out \[refer to [
see \[refer to [

更多信息 ->

Grafana.RepeatedWords

Extends: repetition

<CURRENT TEXT> 重复出现

Grafana.Spelling

Extends: spelling

您的意思确实是 <CURRENT TEXT> 吗？

Grafana 词典可能尚未收录此词。

要添加新词，请参考 添加词汇到 Grafana Labs 词典。或者，您可以提出一个 Issue，维护者会为您添加。

对于 UI 元素，使用 粗体 格式。拼写检查器不检查粗体格式的词汇。

对于路径；配置；用户输入；代码；类、方法和变量名；状态码；以及控制台输出，使用 代码 格式。拼写检查器不检查代码格式的词汇。

警告 (Warnings)

以下规则是警告，可能需要修正或需要考虑。

Grafana.Admin

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>，除非它是 UI 标签名称，例如 Grafana 的“Admin”角色。

当前文本替代文本
adminadministrator

更多信息 ->

Grafana.Admonitions

Extends: script

优先使用 admonition shortcode，而非 blockquotes。

admonition shortcode 会将内容渲染为具有全网站一致样式的 blockquote。

更多信息 ->

Grafana.Agentless

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

Grafana Agent 已被 Grafana Alloy 替代，因此不应再使用基于 agent 的术语。

如果您讨论的是为什么以及如何直接从应用发送信号到 Grafana Cloud，优先使用 no-collector 而非 agentless。

这与 OTel 文档一致。

当前文本替代文本
agentlessno-collector

更多信息 ->

Grafana.AllowsTo

Extends: substitution

您的意思是 <REPLACEMENT TEXT> 吗？

'Allows to' 是一个常见的用词错误。

当前文本替代文本
allows toallows you to|makes it possible to

Grafana.AltText

Extends: script

所有图片必须带有 alt text。

更多信息 ->

Grafana.AmazonCloudWatch

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
AWS CloudWatchAmazon CloudWatch
CloudwatchCloudWatch
aws CloudWatchAmazon CloudWatch
cloudWatchCloudWatch
cloudwatchCloudWatch

更多信息 ->

Grafana.AmazonProductNames

Extends: conditional

首次提及时使用完整的 Amazon 产品名称。

更多信息 ->

Grafana.AndOr

Extends: existence

避免使用 'and/or'，除非空间有限，例如表格中。

通常，“and”隐含着“or”的含义，因此您无需同时使用这两个词。

如果您的内容需要同时指定两者，请写成：“您可以导出原始事件、已处理事件或两者。”

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • and/or

更多信息 ->

Grafana.ApacheProjectNames

Extends: conditional

首次提及时使用完整的 Apache 项目名称。

更多信息 ->

Grafana.CHANGELOG

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>，除非您指的是拼写如此的特定文件。

当前文本替代文本
[Cc]hangelogCHANGELOG
[Cc]hangelog\.mdCHANGELOG.md
[Cc]hangelogsCHANGELOGs

更多信息 ->

Grafana.CommandLinePrompts

Extends: script

不要在命令前添加 $ 或 # 作为提示符。请方便用户复制和粘贴命令。

此外，不要在命令中使用 # 添加注释。解释应放在代码块外部。

更多信息 ->

Grafana.DatadogProxy

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
Datadog ProxyDatadog proxy
[tT]he [Dd]atadog proxyDatadog proxy

Grafana.DialogBox

Extends: substitution

使用 <REPLACEMENT TEXT> 而非 <CURRENT TEXT>。

当前文本替代文本
dialog box appearsdialog box opens
dialog(?! box)dialog box
modaldialog box

更多信息 ->

Grafana.DocumentationTeam

Extends: substitution

使用 <REPLACEMENT TEXT> 而非 <CURRENT TEXT>。

当前文本替代文本
[Dd]ocs? (?:[Ss]quad|[Tt]eam)the Grafana Labs documentation team
[Dd]ocumentation (?:[Ss]quad|Team)the Grafana Labs documentation team

Grafana.EndToEnd

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
[eE]2[eE]end-to-end

更多信息 ->

Grafana.Exclamation

Extends: existence

避免在文本中使用感叹号，除非是极少数真正令人兴奋的时刻。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \w+!(?:\s|$)

更多信息 ->

Grafana.Gerunds

Extends: script

对于基于任务的标题，以 不带 to 的不定式 开头，也称为原形或 基本形式 动词。在英语中，祈使语气也使用动词的基本形式，因此看起来与不带 to 的不定式相同。

基于任务的标题经常用于快速入门、操作指南和教程中。

对于概念性或非基于任务的标题，使用不以 -ing 动词开头的 名词短语。

名词短语标题经常用于概念文档中。

更多信息 ->

Grafana.GoogleEllipses

Extends: existence

通常情况下，不要使用省略号。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \.\.\.

更多信息 ->

Grafana.GoogleFirstPerson

Extends: existence

避免使用第一人称代词，例如 <CURRENT TEXT>。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • (?:^|\s)I\s
  • (?:^|\s)I,\s
  • \bI'm\b
  • \bme\b
  • \bmy\b
  • \bmine\b

更多信息 ->

Grafana.GoogleHeadingPunctuation

Extends: existence

标题末尾不要加句号。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • [a-z0-9][.]\s*$

更多信息 ->

Grafana.GoogleProductNames

Extends: conditional

首次提及时使用完整的 Google 产品名称。

更多信息 ->

Grafana.GoogleRanges

Extends: existence

描述数字范围时，不要添加“from”或“between”等词汇。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • (?:from|between)\s\d+\s?-\s?\d+

更多信息 ->

Grafana.GoogleSpelling

Extends: existence

通常情况下，使用美式拼写而非 <CURRENT TEXT>。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • (?:\w+)nised?
  • colour
  • labour
  • centre

更多信息 ->

Grafana.GoogleWill

Extends: existence

避免使用 <CURRENT TEXT>。

对于描述与特定时间无关的一般性行为的陈述，请使用现在时。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • will

更多信息 ->

Grafana.GrafanaCom

Extends: existence

不要使用 grafana.com，请改用以下方式之一

  • 如果您讨论的是 Grafana Cloud，请使用 Grafana Cloud。
  • 如果您讨论的是公司，请使用 Grafana Labs。
  • 如果您链接到网站上的页面，请使用页面标题或包含 scheme 的完整 URL。例如，https://grafana.org.cn/。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • grafana\.com

Grafana.Headings

Extends: capitalization

对 <CURRENT TEXT> 使用句子风格的大小写。

Vale 将多词例外（例如 Grafana Enterprise Metrics）视为一个单独且大小写正确的词汇。

如果您的标题包含代表产品名称的首字母大写词汇，您需要将这些词汇添加到 Grafana 词典或 https://github.com/grafana/writers-toolkit/blob/main/vale/Headings.jsonnet 中的静态例外列表中，以便它们被视为大小写正确。

更多信息 ->

Grafana.Kubernetes

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
[Kk]ubectlkubectl
[Kk]ubeletkubelet
[Kk]ubernetes deploymentKubernetes Deployment
cron jobCronJob
d[ae][ae]mon[Ss]etDaemonSet
podPod
replica[Ss]etReplicaSet
stateful[Ss]etStatefulSet

更多信息 ->

Grafana.MetaMonitoring

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
meta ?monitoringmeta-monitoring

更多信息 ->

Grafana.OK

Extends: existence

不要在文本中使用 okay 的任何变体。例外情况是您引用或引述时

  • 用户界面
  • HTTP 状态码或其他代码

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • O.K.
  • OK
  • ok
  • Ok
  • Okay
  • okay
  • A-OK
  • hokay
  • k
  • keh
  • kk
  • M'kay
  • oka
  • okeh
  • Okie dokie
  • Okily Dokily

更多信息 ->

Grafana.ProductPossessives

Extends: existence

不要从功能名称、产品名称或商标构成所有格，无论其所有者是谁。相反，将其用作修饰语，或重写以使用类似 'of' 的词来表示关系。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • ADOT's
  • AI Observability's
  • Agent's
  • Alloy's
  • ARN's
  • Asserts'
  • AWS's
  • AWS Distro for OpenTelemetry Collector's
  • AWS X-Ray's
  • Beyla's
  • BoringCrypto's
  • CentOS's
  • CloudWatch's
  • Codespaces'
  • Data Firehose's
  • Databricks'
  • Datadog's
  • Dynatrace's
  • EKS's
  • Elastic Kubernetes Service's
  • Entra's
  • Figma's
  • Firehose's
  • FreeBSD's
  • GEM's
  • GKE's
  • Git's
  • GitHub's
  • GitLab's
  • GNU's
  • Grafana's
  • Gravatar's
  • Graylog's
  • Gunicorn's
  • hashmod's
  • IBM's
  • InfluxDB's
  • Jaeger's
  • Jira's
  • journald's
  • Jsonnet's
  • Kibana's
  • Killercoda's
  • Kinesis'
  • Kotlin's
  • KQL's
  • Kubernetes'
  • Kubernetes Engine's
  • Kusto's
  • Kustomize's
  • LangChain's
  • launchd's
  • Logs Drilldown's
  • Loki's
  • Lucene's
  • Markdown's
  • Memcached's
  • Metrics Drilldown's
  • Mesos'
  • Mimir's
  • Moodle's
  • MySQL's
  • Netlink's
  • Okta's
  • OnCall's
  • OpenAI's
  • OpenShift's
  • OpenTelemetry's
  • Opsgenie's
  • OTel's
  • PagerDuty's
  • Parca's
  • Phlare's
  • Pinecone's
  • Podman's
  • Postgres'
  • PostgreSQL's
  • pprof's
  • Profiles Drilldown's
  • Prometheus'
  • Promtail's
  • Pyroscope's
  • RCA workbench's
  • RDS's
  • Relational Database Service's
  • React's
  • Redis'
  • RHEL's
  • Rollup's
  • RudderStack's
  • Sensu's
  • Sensu Go's
  • Splunk's
  • SSM's
  • SUSE's
  • Tempo's
  • Thanos'
  • Threema's
  • Traces Drilldown's
  • Velero's
  • Vite's
  • VMware's
  • Webex's
  • WildFly's
  • windows_exporter's
  • Zipkin's

更多信息 ->

Grafana.PrometheusExporters

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
[Nn]ode exporterNode Exporter

更多信息 ->

Grafana.Quickstart

Extends: substitution

无论名词是隐含的还是明确的，都请使用复合形容词 <REPLACEMENT TEXT>（不带连字符）替代 <CURRENT TEXT>。例如，您可以使用 quickstart guide 或仅使用 quickstart。

当前文本替代文本
quick startquickstart

更多信息 ->

Grafana.README

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>，除非您指的是拼写如此的特定文件。

当前文本替代文本
[Rr]eadmeREADME
[Rr]eadme\.mdREADME.md
[Rr]eadmesREADMEs

更多信息 ->

Grafana.React

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
[Rr]eact[. ]?[Jj][Ss]React

更多信息 ->

Grafana.SQL

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

在首字母缩略词 SQL 之前使用的冠词（a 或 an）取决于该词的发音方式。

指代产品 Microsoft SQL Server 时，SQL 应发音为“sequel”。在这种情况下，使用冠词“a”，例如“a SQL Server analysis”。

在任何其他语境下（例如 SQL databases, errors, or servers）指代该术语时，SQL 应发音为“ess-cue-el”。在这种情况下，使用冠词“an”，例如“an SQL error”。

当前文本替代文本
[Aa] SQL serveran SQL server|a SQL Server
[Aa] SQL(?! [Ss]erver)an SQL
[Aa]n SQL Servera SQL Server

更多信息 ->

Grafana.SelfManaged

Extends: substitution

讨论 Grafana 部署方法时，使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
on-prem(?:ise)?self-managed
self-hostedself-managed

更多信息 ->

Grafana.Shortcodes

Extends: script

优先使用 {{< 和 >}}，而非 {{% 和 %}}

它具有最一致的语义。

百分号语法用于此 shortcode 不需要特殊行为的情况。

更多信息 ->

Grafana.SmartQuotes

Extends: script

避免在源文件中使用智能引号，尤其是在代码块中。

将所有智能双引号（例如 “ 或 ”）替换为 "。将所有智能单引号（例如 ‘、’ 或 ʼ）替换为 '。

在某些上下文中，Unicode 字符不受支持并会破坏配置。

网站会在段落中将成对的引号渲染为智能引号。

Grafana.Wish

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
wishneed|want

更多信息 ->

Grafana.WordList

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
(?:(?<!Data )Firehose|Kinesis Data Firehose|Kinesis Firehose)Data Firehose
(?:SHA-1|HAS-SHA1)SHA-1
(?:WiFi|wifi)Wi-Fi
(?:[Oo]penshift|openShift)OpenShift
(?:[eE]-mail)email
(?:[oO]pentelemetry|openTelemetry)OpenTelemetry
(?:alert[Mm]anager|[Aa]lert [Mm]anager|AlertManager)Alertmanager
(?:cell ?phone|smart ?phone)phone|mobile phone
(?:content|media)-?typemedia type
(?:file ?path|path ?name)path
(?:file ?path|path ?name)spaths
(?:github|gitHub|Github)GitHub
(?:gitlab|gitLab|Gitlab)GitLab
(?:hamburger menu|kebab menu)menu icon
(?:java[Ss]cript|Javascript)JavaScript
(?:kill|terminate|abort)stop|exit|cancel|end
(?<!kube-)prometheusPrometheus
(?<!lambda-)promtailPromtail
GMEGEM
Grafana AI observabilityGrafana AI Observability
HTTPsHTTPS
Influx[Dd]bInfluxDB
Influxd[Bb]InfluxDB
OnceAfter
PagerdutyPagerDuty
RCA WorkbenchRCA workbench
RudderstackRudderStack
VMWareVMware
VmwareVMware
[Ww]orld [Ww]ide [Ww]ebweb
[cC]entosCentOS
\b(?:[aA]daptive metrics|adaptive Metrics)\bAdaptive Metrics
ad[- ]?hocfree-form|user-written
back[ -]endbackend
blacklistblocklist
blacklistedblocklisted
blacklistingblocklisting
blacklistsblocklists
cadvisorcAdvisor
check[- ]boxcheckbox
content typemedia type
media typedata-?source
data sourcedata-?sources
data sourcesdata[- ]?set
datasetdata[- ]?sets
datasetsdatacenter
data centerdatacenters
data centersde-duplicate
deduplicatede-duplicated
deduplicatedde-duplicates
deduplicatesde-duplication
deduplicationfewer data
less datafigma
Figmafile name
filenamefile names
filenamesfirewalls
firewall rulesfront[ -]end
frontendfront[ -]ends
frontendsgit
GitGrafana
grafanaunavailable
gunicornGunicorn
in order toto
influx[Dd][Bb]InfluxDB
jsonnetJsonnet
kotlinKotlin
langchainLangChain
left[- ]hand[- ]sideleft-side
log(?:ql|QL)LogQL
lokiLoki
luceneLucene
markdownMarkdown
memcachedMemcached
meta[- ]datametadata
mix[- ]inmixin
mysqlMySQL
network IP addressinternal IP address
open-sourceopen source
otelOTel
otlpOTLP
pager[dD]utyPagerDuty
phlarePhlare
postgresPostgres
postgresqlPostgreSQL
prom(?:ql|QL)PromQL
redisRedis
regex[ep]?sregular expression
regexp?regular expression
reporepository
reposrepositories
right[- ]hand[- ]sideright-side
rudderstackRudderStack
sensuSensu
sign intosign in to
sqliteSQLite
style sheetstylesheet
style sheetsstylesheet
synchsync
synchedsynced
synchingsyncing
tempoTempo
the Grafana AgentGrafana Agent
the RCA [Ww]orkbenchRCA workbench
threemaThreema
timeseriestime series|time-series
trace(?:ql|QL)TraceQL
un(?:check|select)clear
urlURL
urlsURLs
vmwareVMware
vs\.versus
webexWebex
whitelistallowlist
whitelistedallowlisted
whitelistingallowlisting
whitelistsallowlists

更多信息 ->

建议 (Suggestions)

以下规则是风格方面的建议。

Grafana.Acronyms

Extends: conditional

如果受众不熟悉，请拼出 <CURRENT TEXT> 的全称。

更多信息 ->

Grafana.Archives

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
[Uu]n(?:archive|compress|tar|zip)extract
[Zz][Ii][Pp](?: file)?archive|compressed file
unzipextract

更多信息 ->

Grafana.DropDown

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

将 drop-down 作为修饰语使用，而非独立名词。例如：drop-down menu。

当前文本替代文本
drop ?downdrop-down

更多信息 ->

Grafana.GoogleContractions

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
are notaren't
cannotcan't
could notcouldn't
did notdidn't
do notdon't
does notdoesn't
has nothasn't
have nothaven't
how ishow's
is notisn't
it isit's
should notshouldn't
that isthat's
they arethey're
was notwasn't
we arewe're
we havewe've
were notweren't
what iswhat's
when iswhen's
where iswhere's
will notwon't

更多信息 ->

Grafana.GoogleOxfordComma

Extends: existence

在 <CURRENT TEXT> 中使用牛津逗号。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • (?:[^,]+,){1,}\s\w+\s(?:and|or)

更多信息 ->

Grafana.GooglePassive

Extends: existence

通常情况下，使用主动语态而非被动语态（<CURRENT TEXT>）。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • [\w]+ed
  • awoken
  • beat
  • become
  • been
  • begun
  • bent
  • beset
  • bet
  • bid
  • bidden
  • bitten
  • bled
  • blown
  • born
  • bought
  • bound
  • bred
  • broadcast
  • broken
  • brought
  • built
  • burnt
  • burst
  • cast
  • caught
  • chosen
  • clung
  • come
  • cost
  • crept
  • cut
  • dealt
  • dived
  • done
  • drawn
  • dreamt
  • driven
  • drunk
  • dug
  • eaten
  • fallen
  • fed
  • felt
  • fit
  • fled
  • flown
  • flung
  • forbidden
  • foregone
  • forgiven
  • forgotten
  • forsaken
  • fought
  • found
  • frozen
  • given
  • gone
  • gotten
  • ground
  • grown
  • heard
  • held
  • hidden
  • hit
  • hung
  • hurt
  • kept
  • knelt
  • knit
  • known
  • laid
  • lain
  • leapt
  • learnt
  • led
  • left
  • lent
  • let
  • lighted
  • lost
  • made
  • meant
  • met
  • misspelt
  • mistaken
  • mown
  • overcome
  • overdone
  • overtaken
  • overthrown
  • paid
  • pled
  • proven
  • put
  • quit
  • read
  • rid
  • ridden
  • risen
  • run
  • rung
  • said
  • sat
  • sawn
  • seen
  • sent
  • set
  • sewn
  • shaken
  • shaven
  • shed
  • shod
  • shone
  • shorn
  • shot
  • shown
  • shrunk
  • shut
  • slain
  • slept
  • slid
  • slit
  • slung
  • smitten
  • sold
  • sought
  • sown
  • sped
  • spent
  • spilt
  • spit
  • split
  • spoken
  • spread
  • sprung
  • spun
  • stolen
  • stood
  • stridden
  • striven
  • struck
  • strung
  • stuck
  • stung
  • stunk
  • sung
  • sunk
  • swept
  • swollen
  • sworn
  • swum
  • swung
  • taken
  • taught
  • thought
  • thrived
  • thrown
  • thrust
  • told
  • torn
  • trodden
  • understood
  • upheld
  • upset
  • wed
  • wept
  • withheld
  • withstood
  • woken
  • won
  • worn
  • wound
  • woven
  • written
  • wrung

更多信息 ->

Grafana.GoogleSemicolons

Extends: existence

谨慎使用分号。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • ;

更多信息 ->

Grafana.OAuth

Extends: substitution

使用 <REPLACEMENT TEXT> 替代 <CURRENT TEXT>。

当前文本替代文本
O[Aa]uth 2(?!\.0)OAuth 2.0
O[Aa]uth(?! 2\.0)OAuth 2.0

更多信息 ->

Grafana.Parentheses

Extends: existence

谨慎使用括号。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • \(.{4,}\)

更多信息 ->

Grafana.ReadabilityAutomatedReadability

Extends: metric

<CURRENT TEXT> 目标分数为 8 以下。

更多信息 ->

Grafana.ReadabilityColemanLiau

Extends: metric

<CURRENT TEXT> 目标分数为 9 以下。

更多信息 ->

Grafana.ReadabilityFleschKincaid

Extends: metric

<CURRENT TEXT> 目标分数为 8 以下。

更多信息 ->

Grafana.ReadabilityFleschReadingEase

Extends: metric

<CURRENT TEXT> 目标分数为 70 以上。

更多信息 ->

Grafana.ReadabilityGunningFog

Extends: metric

<CURRENT TEXT> 目标分数为 10 以下。

更多信息 ->

Grafana.ReadabilityLIX

Extends: metric

<CURRENT TEXT> 目标分数为 35 以下。

更多信息 ->

Grafana.ReadabilitySMOG

Extends: metric

<CURRENT TEXT> 目标分数为 10 以下。

更多信息 ->

Grafana.Timeless

Extends: existence

避免使用 <CURRENT TEXT> 以保持文档的时效性。

通常情况下，请记录产品或功能的当前版本。

这减少了保持文档更新所需的维护工作。它避免假设读者熟悉产品的早期版本。

如果您撰写的是过程性或带有时间戳的内容，例如新闻稿、博客文章或发布说明，则可以使用此类基于时间的词汇和短语。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • as of this writing
  • currently
  • does not yet
  • eventually
  • existing
  • future
  • in the future
  • latest
  • new
  • newer
  • now
  • old
  • older
  • presently
  • at present
  • soon

更多信息 ->

Grafana.We

Extends: existence

谨慎使用第一人称复数代词，例如 <CURRENT TEXT>。

讨论读者时，不要使用“we”，请使用“you”。

讨论 Grafana Labs 时，可以使用“we”。

<CURRENT TEXT> 与以下一个或多个正则表达式匹配

  • we
  • we'(?:ve|re)
  • ours?
  • us
  • let's

更多信息 ->