Content Deep Dive
Making the Google Developers documentation style guide public
Blog post from Google Cloud
Post Details
Company
Date Published
Author
-
Word Count
285
Language
English
Hacker News Points
-
Summary
Google has made its internal developer-documentation style guide publicly accessible to support external contributors to open source projects such as Kubernetes, AMP, or Dart, thereby promoting consistency across developer documentation. This style guide offers guidance on various aspects of writing, including voice, tone, word choice, and other stylistic considerations, and can be used as a reference for both general and specific issues. It features a searchable format for efficiently locating information on punctuation, grammar, formatting, and specific terms, and encourages users to check the release notes for updates. Moreover, Google invites feedback from users to aid in the ongoing development of the guide.