Doc: Update documentation-style-guide.md (#29082)

* Update documentation-style-guide.md

* Update documentation-style-guide.md
pull/29107/head
Diana Payton 5 years ago committed by GitHub
parent 1bdcd2f9ab
commit ec864f6461
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      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.

Loading…
Cancel
Save