风格指南

    您可以在此通过 Istio 特有的示例,找到 Istio 遵循的基本风格与实践指南的所有场景。

    在您的文档中,为标题使用句首字母大写。即:仅将标题中第一个单词的首字母大写,专有名词或缩写除外。

    front-matter 中 title: 字段的值使用首字母大写

    使用现在时

    正确做法错误做法
    命令启动代理服务器。命令将启动代理服务器。

    例外:确实需要通过使用将来时或过去时才能表达正确的含义时。这种例外极为罕见,应尽可能的避免。

    使用简单直接的语言

    使用简单直接的语言。避免使用不必要的短语,例如:“please”。

    正确做法错误做法
    创建 ReplicaSet, …为了要创建 , …
    参见配置文件。请参见配置文件。
    查看 Pods。通过下一个命令,可查看 Pods。

    使用“您”称呼读者

    避免使用“我们”

    在句子中使用“我们”可能会造成混淆,因为读者可能不知道他们是否属于您所描述的“我们”。

    正确做法错误做法
    1.4 版本中包括…在 1.4 版本中,我们添加了…
    Istio 为 … 提供了一项新功能。我们提供了一个新功能……
    该页面教您如何使用 Pod。在此页面中,我们将学习 Pod。

    避免俚语和方言

    一些读者的母语不是英语,避免使用术语和习惯用语,可用以帮助他们更轻松的理解。

    避免使用“当前”和“新”之类的词。今天的新功能可能在几个月后就不会被视为新功能。

    正确做法错误做法
    在版本 1.4 中 …在当前版本中 …
    联合身份验证功能提供 …新的联合身份验证功能提供了…