Google 公开 “开发者文档风格指南”

Google 公开 “开发者文档风格指南” 发布人:技术文案 Jed Hartman 现在,您可以将我们的开发者文档风格指南用于开放源代码文档项目。 多年以来,Google 的技术文案都在根据一份仅限内部使用的编辑风格指南编写我们的大多数开发者文档。为了更好地支持参与我们的开放源代码项目(例如 Kubernetes、AMP 或 Dart)的外部贡献者,以及提高开…

发布人:技术文案 Jed Hartman

现在,您可以将我们的开发者文档风格指南用于开放源代码文档项目。

多年以来,Google 的技术文案都在根据一份仅限内部使用的编辑风格指南编写我们的大多数开发者文档。为了更好地支持参与我们的开放源代码项目(例如 KubernetesAMPDart)的外部贡献者,以及提高开发者文档间的一致性,我们现在将这份风格指南公开。

如果您向这类项目贡献文档,可以直接查阅这份有用的指导文档来了解语态、语气、用词,以及其他风格注意事项。它对一些常规问题非常有帮助,例如提醒作者使用第二人称、现在时、主动语态和连续逗号;也可用于查阅一些非常具体的问题,例如为了保持与 Google Developers 风格一致,应使用“app”还是“application”。

风格指南是一种参考文档,因此,您可以根据需要查找具体信息,而不用全篇通读。对于标点、语法和格式问题,您可以在左侧导航窗格内进行页面内搜索,查阅“Commas”(逗号)、“Lists”(列表)和“Link text”(链接文本)等章节。对于具体的术语和短语,您可以查看词表

请密切留意版本说明页面,了解最新动态和变动,并通过这份指南每个页面上的 Send Feedback(发送反馈)链接向我们发送您的意见和建议 - 我们希望收到您的反馈,以便帮助我们不断完善风格指南。