DocumentationWriters' ToolkitWriteStyle guide

Style guide

This style guide is a set of content guidelines that covers aspects of content style such as grammar, language, formatting, and tone. It’s intended for anyone who contributes to technical documentation at Grafana Labs.

It includes rules and best practices on the following:

• Style conventions
  A non-exhaustive list of technical writing techniques and styles you should consider when you write technical documentation for Grafana Labs.
• Voice and tone guidelines
  Guidelines for voice and tone in Grafana Labs' documentation.
• Capitalization and punctuation
  Guidelines for use of capitalization and punctuation.
• Inclusive writing
  Understand the importance of inclusive writing at Grafana Labs and learn how to write inclusively.
• Write for developers
  Learn to write documentation for software developers and engineers using Grafana Labs products.
• UX writing
  Guidelines on creating text, style, and tone in UI components
• Word list
  Guidelines for words to use in writing Grafana Labs documentation.
• UI elements list
  Guidelines for referring to UI elements in Grafana documentation.

When a matter of style isn’t covered here, refer to the Google developer documentation style guide.

Last reviewed: June 27, 2024