風格指南

所有被 Istio 文件接受的內容都必須是清晰且易於理解的。我們用來做出此決定的標準由 Google 開發人員風格指南的重點和一般原則定義。請參閱我們的審查頁面，以了解如何審查和接受您的內容貢獻的詳細資訊。

在這裡，您可以找到 Istio 專案決定遵循不同實務的所有情境，以及具有 Istio 特定範例的基本風格指南。

標題使用句子大小寫

在您的文件中，標題使用句子大小寫。除了專有名詞或縮寫字外，只將標題的第一個字大寫。

在前端資訊的 title: 欄位的值使用標題大小寫

前置宣告（front-matter）中 title: 欄位的文字必須使用標題式大小寫。除了連接詞和介系詞外，每個單字的第一個字母都必須大寫。

使用現在時態

例外：如果需要表達正確的含義，請使用未來式或過去式。這個例外情況極為罕見，應盡量避免。

使用主動語態

使用簡單直接的語言

使用簡單直接的語言。避免使用不必要的短語，例如說「請」。

將讀者視為「您」

建立有用的連結

有好的超連結，也有不好的超連結。常見的將連結稱為「這裡」或「點擊這裡」的做法是不好的超連結的例子。請查看這篇優秀的文章，解釋了什麼是好的超連結，並在建立或審閱網站內容時盡量牢記這些準則。

避免使用「我們」

在句子中使用「我們」可能會令人困惑，因為讀者可能不知道他們是否是您描述的「我們」的一部分。

避免使用術語和成語

有些讀者將英語作為第二語言。請避免使用術語和成語，以幫助他們更容易理解。

避免使用關於未來的陳述

避免做出承諾或暗示未來。如果您需要談論開發中的功能，請在前面宣告（front matter）下方新增一個樣板，以相應地識別該資訊。

避免使用很快就會過時的陳述

避免使用很快就會過時的措辭，例如「目前」和「新」。今天新的功能不會持續新很長的時間。