风格指南

所有被 Istio 文档接受的内容都必须**清晰**且**易于理解**。我们用来做出该判断的标准由 Google 开发者风格指南的 重点和 一般原则定义。有关如何审查和接受您的内容贡献的详细信息，请参阅我们的 审查页面。

在这里，您可以找到 Istio 项目决定遵循不同实践和基本风格指南的所有场景，以及带有 Istio 特定示例的基本风格指南。

标题使用句子式大小写

在您的文档中，标题使用句子式大小写。仅将标题的第一个单词的首字母大写，专有名词或首字母缩略词除外。

前置信息的 title: 字段的值使用标题式大小写

前置信息的 title: 字段的文本必须使用标题大小写。除了连词和介词外，每个单词的首字母都要大写。

使用现在时

例外：如果需要传达正确的含义，请使用将来时或过去时。此例外情况极其罕见，应避免。

使用主动语态

使用简洁明了的语言

使用简洁明了的语言。避免使用不必要的短语，例如“请”。

以“你”称呼读者

创建有用的链接

有好的超链接，也有不好的超链接。常见的“此处”或“点击此处”链接都是不好的超链接示例。查看这篇优秀的文章，了解什么是好的超链接，并在创建或审查网站内容时牢记这些指南。

避免使用“我们”

在句子中使用“我们”可能会令人困惑，因为读者可能不知道他们是否是您描述的“我们”的一部分。

避免使用行话和习语

一些读者将英语作为第二语言。避免使用术语和习语，以帮助他们更容易理解。

避免关于未来的陈述

避免做出承诺或暗示未来的情况。如果需要讨论开发中的功能，请在前端信息下添加一个样板，以相应地标识信息。

避免很快就会过时的陈述

避免使用容易过时的措辞，例如“当前”和“新”。今天的新功能很快就不再是新的了。