From a8ba503b35844da30ca5273ac08fe72243005a7a Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Tue, 5 May 2020 07:50:18 -0700 Subject: [PATCH] Update documentation-style-guide.md (#24020) * Update documentation-style-guide.md Added guidance on jargon * Update documentation-style-guide.md --- contribute/style-guides/documentation-style-guide.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index 2f0465a647f..82541a2fee3 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -33,6 +33,7 @@ The following sections provide general guidelines on topics specific to Grafana - 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. +* Avoid using internal slang and jargon in technical documentation. ### File naming conventions @@ -112,7 +113,7 @@ Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk ### Word usage -Grafana products has some words, abbreviations, and slang particular to this discourse community. +Grafana products has some words, abbreviations, and terms particular to the Grafana discourse community. #### checkout, check out @@ -141,6 +142,10 @@ Two words, not one * Correct, but passive voice: Your list of active alarms is displayed. * Incorrect: The list of active alarms displays. +#### drawer + +Do not use. This is developer jargon that refers to a UI panel. Refer to the panel or feature by its proper name. + #### intro, introduction "Introduction" is the preferred word. Use "intro" if there are space constraints (like on the side menu) or you are specifically trying for a less formal, more conversational tone.