Docs: Update documentation-style-guide.md (#19292)

* Update documentation-style-guide.md

Added heading rules

* Update documentation-style-guide.md

Added ampersand rule
This commit is contained in:
oddlittlebird 2019-09-23 03:53:15 -07:00 committed by Torkel Ödegaard
parent 50b4695cf5
commit 6fcbe60a8e

View File

@ -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