Skip to content

Commit 6d7cb6d

Browse files
committed
Fix formatting in grammar-spelling.md
1 parent 850dba0 commit 6d7cb6d

File tree

1 file changed

+24
-21
lines changed

1 file changed

+24
-21
lines changed

contribute-docs/style-guide/grammar-spelling.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ description: Guidelines for using correct grammar and spelling in your writing.
55

66
# Grammar and spelling
77

8-
## Pronouns do's and don'ts
8+
## Pronouns do's and don'ts
99

10-
### Be unambiguous
10+
### Be unambiguous
1111

1212
In order to make your sentences as clear as possible when using pronouns, they should always be unambiguous.
1313

@@ -23,9 +23,9 @@ And while we're at it, let's remove the *in order* since it doesn't really add a
2323

2424
### Use second-person pronouns (*you*, *your*, *yours*)
2525

26-
In general, write in the second person to establish a friendly, casual tone with the reader as though you're speaking to them. Writing in the second person also helps you avoid using passive voice. However, don't overuse *your* when referring to user interaction.
26+
In general, write in the second person to establish a friendly, casual tone with the reader as though you're speaking to them. Writing in the second person also helps you avoid using passive voice. However, don't overuse *your* when referring to user interaction.
2727

28-
For example: *Your Elastic Agents* can feel overly familiar if used too many times. However, *your environment* as opposed to *the environment* sounds more casual. It can be tricky when deciding word choice, but when in doubt, try replacing the pronoun with *the* to see if it's an appropriate substitute.
28+
For example: *Your Elastic Agents* can feel overly familiar if used too many times. However, *your environment* as opposed to *the environment* sounds more casual. It can be tricky when deciding word choice, but when in doubt, try replacing the pronoun with *the* to see if it's an appropriate substitute.
2929

3030
:::{dropdown} Examples
3131
* Log in to your account to display the settings.
@@ -34,40 +34,40 @@ For example: *Your Elastic Agents* can feel overly familiar if used too many tim
3434

3535
### Use singular first-person pronouns sparingly (*I*, *me*, *my*, *mine*)
3636

37-
Typically, you should never write in the first person. You can, however, use first-person pronouns if they appear in the product UI.
37+
Typically, you should never write in the first person. You can, however, use first-person pronouns if they appear in the product UI.
3838

3939
:::{dropdown} Example
40-
Select the checkbox that says, "Confirm my selection."
40+
Select the checkbox that says, "Confirm my selection."
4141
:::
4242

43-
### Use plural first-person pronouns wisely (*we*, *us*, *our*, *our*)
43+
### Use plural first-person pronouns wisely (*we*, *us*, *our*, *our*)
4444

45-
First-person plural pronouns can sometimes convey a stuffy and serious tone—the opposite of Elastic's more casual tone. In some instances, however, it's okay to use these sparingly. For example, it's perfectly acceptable to say *we recommend*, and in fact is preferable over *it is recommended* since that uses passive voice.
45+
First-person plural pronouns can sometimes convey a stuffy and serious tone—the opposite of Elastic's more casual tone. In some instances, however, it's okay to use these sparingly. For example, it's perfectly acceptable to say *we recommend*, and in fact is preferable over *it is recommended* since that uses passive voice.
4646

4747
### Avoid gendered pronouns
4848

4949
Use gender-neutral pronouns as appropriate. Avoid using *he*, *him*, *his*, *she*, and *her*. Instead, try replacing it with a form of *user*. Also, avoid using combination pronouns such as *he/she* or *(s)he*. Use *they* or *them* instead.
5050

51-
## Verb tense
51+
## Verb tense
5252

5353
Avoid temporal words like *currently*, *now*, or *will* and conditional words like *should* or *could*. Write in the present tense to describe the state of the product as it is now. You may need to use the past tense occasionally, but try to change it to the present tense to see if that's a better fit.
5454

5555
:::{dropdown} Example
5656
**Don't**: If you didn't select all the required permissions, an error message will appear.
5757

58-
✔️ **Do**: If you don't select all the required permissions, an error message appears.
58+
✔️ **Do**: If you don't select all the required permissions, an error message appears.
5959
:::
6060

6161
## Contraction do's and dont's
6262

63-
Use contractions: they're (an acceptable contraction, by the way) conversational and don't require a lot of thought because we use them in everyday language. However, don't mix contractions and their spelled-out equivalents. For example, don't use *don't* and *do not* in the same context unless you absolutely need the latter for emphasis.
63+
Use contractions: they're (an acceptable contraction, by the way) conversational and don't require a lot of thought because we use them in everyday language. However, don't mix contractions and their spelled-out equivalents. For example, don't use *don't* and *do not* in the same context unless you absolutely need the latter for emphasis.
6464

65-
Don't use Elastic references as a contraction to replace *Elastic is*.
65+
Don't use Elastic references as a contraction to replace *Elastic is*.
6666

6767
:::{dropdown} Example
6868
**Don't**: Elastic's excited to release this new feature.
6969

70-
✔️ **Do**: Elastic's new feature helps you find information fast.
70+
✔️ **Do**: Elastic's new feature helps you find information fast.
7171
:::
7272

7373
Avoid ambiguous or awkward contractions, such as *there'd*, *it'll*, and *they'd*.
@@ -96,7 +96,7 @@ Avoid gerunds in prepositional phrases—this will make your instructions easier
9696
✔️ **Do**: Refer to instructions on how to configure the Elastic Agent.
9797
:::
9898

99-
## Punctuation
99+
## Punctuation
100100

101101
### Colons
102102

@@ -184,17 +184,19 @@ Use a hyphen:
184184
* When a prefixed word has two vowels together.
185185

186186
:::{dropdown} Examples
187-
* Re-enable
188-
* Pre-approve
187+
188+
* Re-enable
189+
* Pre-approve
189190
:::
190191

191192
* When two or more words modify the following noun, making a compound adjective.
192193

193194
:::{dropdown} Examples
194-
* Real-time results
195-
* AI-generated text
196-
* User-defined values
197-
* Up-to-date environment
195+
196+
* Real-time results
197+
* AI-generated text
198+
* User-defined values
199+
* Up-to-date environment
198200
:::
199201

200202
* Whenever the prefix is `self-`, `ex-`, or `all-`.
@@ -206,7 +208,8 @@ Use a hyphen:
206208
* For a minus sign and to indicate negative numbers. In formulas and equations, add spacing between the numbers and arithmetic operators. For negative numbers, don't add spacing between the minus and the number.
207209

208210
:::{dropdown} Examples
209-
* 12 - 3 = 9
211+
212+
* 12 - 3 = 9
210213
* -79
211214
:::
212215

0 commit comments

Comments
 (0)