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
- Voice and tone guidelines
Voice and tone guidelines
- Capitalization and punctuation
Guidelines for use of capitalization and punctuation.
- Inclusive writing
- UX writing
Guidelines on creating text, style, and tone in UI components
- Write for developers
Learn to write documentation for software developers and engineers.
- Word list
Guidelines for words to use in writing Grafana 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.