目标和观众

本指南的主要目标是编纂和记录Google开发者关系小组关于风格的决策。该指南可以帮助您避免一遍又一遍地对同一问题做出决策,可以在构建和编写文档时提供编辑帮助,并可以帮助您保持文档与我们的其他文档一致。

非目标

本指南适用于与Google相关的开发人员文档;它不适用于所有Google文档。如果您已经拥有自己的样式指南,可以继续使用它。

本指南不是为了提供行业文档标准,也不是为了与其他着名的风格指南竞争。这是对我们家庭风格的描述,而不是我们的决定客观正确的陈述。

本指南并非旨在从头开始提供一整套写作指南。例如,它不包括词性,主语 - 动词协议或其他写作基础知识。

本指南是一份活文件;它随着时间的推移而变化,当它发生变化时,我们通常不会更改以前发布的文档以进行匹配。我们在可行的范围内努力保持一致性,但在任何给定时间,我们的文档中肯定会出现与此样式指南不匹配的部分内容。如有疑问,请遵循本指南,而不是模仿现有文档。

本指南不提供法律建议;法律问题超出了其范围。有关法律事务的问题,请咨询您的律师。特别是,本文档中的指南并未限制Google可以对其文档所做的更改。此外,如果您没有阅读给定的指南,那么这并不能免除您在文件方面的道德行为和法律规定。

如何使用指南

如果您正在寻找特定主题,请执行搜索页面以查看左侧导航中是否提及该主题(也称为“左侧导航”)。如果没有,请尝试使用页面顶部的搜索框,默认情况下该搜索框仅限于搜索本指南。

本指南是参考文件;而不是按线性顺序读取它,您可以使用它来根据需要查找特定问题。

如果您是样式指南的新手,并希望大致了解我们的风格,请参阅“精彩集锦”页面。

有关本指南未涉及的问题,请参阅其他编辑资源中列出的指南。

打破规则

请记住,本指南中的所有内容都是指导原则,而不是严格的规则。在大多数情况下,如果这些指南不适合上下文,Google就没有能力也不愿意执行这些指南。但我们希望您能和我们一起努力争取高质量的文档。

“比任何直截了当的野蛮行为更早地打破这些规则。”

-George Orwell,“政治与英语”

像大多数样式指南一样,我们的样式指南旨在改进我们的文档,特别是通过提高一致性因此,有些情况可能会偏离我们的指导方针,以使您的文档更好。

参考资料

Google Developer Documentation Style Guide