Google publicly releases internal developer documentation style guide

Woman_Laptop_Orange_Happy

When people think of contributing to either a closed or open source project, they often imagine needing the knowledge of coding. Actually, there are many ways to contribute besides programming, such as moderating a community for the project, spreading awareness, or helping to write documentation to name a few.

The documentation aspect of any project is very important, as it can help people to both understand it and track changes. Unfortunately, many developers aren't very interested in documentation aspect, so it often gets neglected. Luckily, if you want to maintain proper documentation and stay organized, today, Google is releasing its internal developer documentation style guide. This can quite literally guide your documentation, giving you a great starting point and keeping things consistent.

"For some years now, our technical writers at Google have used an internal-only editorial style guide for most of our developer documentation. In order to better support external contributors to our open source projects, such as Kubernetes, AMP, or Dart, and to allow for more consistency across developer documentation, we're now making that style guide public," says Jed Hartman, Technical Writer, Google.

Hartman further says, "If you contribute documentation to projects like those, you now have direct access to useful guidance about voice, tone, word choice, and other style considerations. It can be useful for general issues, like reminders to use second person, present tense, active voice, and the serial comma; it can also be great for checking very specific issues, like whether to write 'app' or 'application' when you want to be consistent with the Google Developers style."

If you are working on a project that needs documentation, and you want to follow Google's style guide, you can simply access it here. Keep in mind that you don't have to follow it verbatim -- you can internally alter it to your heart's content and make it work best for your project.

Photo Credit: JanVlcek / Shutterstock

© 1998-2017 BetaNews, Inc. All Rights Reserved. Privacy Policy.