DocumentationWriters' Toolkit
Open source

Writers’ Toolkit

Writers’ Toolkit is for anyone who writes or edits customer-facing technical documentation for Grafana Labs. Use it as the source of truth for voice and tone, grammar, style, templates, and more.

Writers’ Toolkit helps you to create technical documentation that’s consistent and applies the voice and tone in use at Grafana Labs.

The style guide extends Google’s developer documentation style guide. If you can’t find guidance on a specific topic in Writers’ Toolkit, refer to Google’s style guide.

If it’s your first time using the guide, start with the Get started section.

Questions and feedback

Writers’ Toolkit is open source and available at grafana/writers-toolkit. If you have questions, or feedback on how to improve this documentation, open an issue and help make this an even better resource.