diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index a7333273469..e6516616161 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -51,8 +51,11 @@ The following sections provide general guidelines on topics specific to Grafana ### General - Use active voice. Avoid passive voice. - - Active: Grafana displays the heatmap visualization. - - Passive: The heatmap visualization is displayed. + - Use active: Grafana displays the heatmap visualization. + - Avoid passive: The heatmap visualization is displayed. +- Write directly to the reader. + - Use: "After you create a dashboard, you can add a panel to it." + - Avoid: "After you create a dashboard, it is possible to add a panel to it." - Write in the imperative second person. Examples: You can write a query. Click the panel. Close the window. - Write in present tense. - Use: The panel opens. Grafana opens the panel.