From 6fcbe60a8e94ae0424b337c7d82c2c79f4a7d2f2 Mon Sep 17 00:00:00 2001 From: oddlittlebird <52059945+oddlittlebird@users.noreply.github.com> Date: Mon, 23 Sep 2019 03:53:15 -0700 Subject: [PATCH] Docs: Update documentation-style-guide.md (#19292) * Update documentation-style-guide.md Added heading rules * Update documentation-style-guide.md Added ampersand rule --- style_guides/documentation-style-guide.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/style_guides/documentation-style-guide.md b/style_guides/documentation-style-guide.md index a4cae577f32..5e4c9a9c5d5 100644 --- a/style_guides/documentation-style-guide.md +++ b/style_guides/documentation-style-guide.md @@ -21,6 +21,8 @@ For all items not covered in this guide, refer to the [Microsoft Style Guide](ht * Write in present tense. - Not: The panel will open. - Use: The panel opens. Grafana opens the panel. +* Do not use an ampersand (&) as an abbreviation for "and." + - **Exceptions:** If an ampersand is used in the Grafana UI, then match the UI. ### File naming conventions @@ -36,6 +38,9 @@ For all items not covered in this guide, refer to the [Microsoft Style Guide](ht * Task topic headings start with a verb. - Write a query. Create a dashboard. * Concept and reference topic headings should be nouns or gerunds. Examples: Contributing to docs, Visualizations, Style guide +* Avoid following one heading with another heading. +* Avoid skipping heading levels. For example, an h1 should be followed by an h2 rather than an h3. +* Avoid having just one lower-level heading. For example, h1, h2, h2, h3, h3, h2 is a good order. Do no go h1, h2, h3, h2, h3, h2. ### Images