From ec864f646110bfb8b4fef78d5c3fb284a55edf25 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Fri, 13 Nov 2020 07:33:33 -0800 Subject: [PATCH] Doc: Update documentation-style-guide.md (#29082) * Update documentation-style-guide.md * Update documentation-style-guide.md --- contribute/style-guides/documentation-style-guide.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) 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.