Skip to content

Commit 658e772

Browse files
committed
Fix bullets in voice-tone
1 parent 0436c28 commit 658e772

File tree

1 file changed

+91
-115
lines changed

1 file changed

+91
-115
lines changed

contribute-docs/style-guide/voice-tone.md

Lines changed: 91 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -58,29 +58,26 @@ During the users' journey with Elastic, there are times for excitement and disco
5858

5959
:::::{tab-set}
6060
::::{tab-item} Attributes
61-
We're proud to show new and cool stuff. Be:
61+
We're proud to show new and cool stuff. Be:
6262

63-
- Motivational
64-
- Excited
65-
- Enthusiastic
66-
<br/>
67-
68-
When using this tone, you may:
69-
- Use exclamation marks, but sparingly.
70-
- Help the user understand how the feature benefits them or helps them to achieve their goals.
71-
- Use visuals to support your text, like GIFs or videos.
63+
- Motivational
64+
- Excited
65+
- Enthusiastic
7266

67+
When using this tone, you may:
68+
69+
- Use exclamation marks, but sparingly.
70+
- Help the user understand how the feature benefits them or helps them to achieve their goals.
71+
- Use visuals to support your text, like GIFs or videos.
7372

7473
::::
7574
::::{tab-item} Cases
76-
Although it can be very visible because of the way it's written, the **stimulating** tone is used **quite rarely** overall.
77-
78-
We use it when we want to show new things to users, especially in:
79-
80-
- Getting started guides
81-
- Release highlights
75+
Although it can be very visible because of the way it's written, the **stimulating** tone is used **quite rarely** overall.
8276

77+
We use it when we want to show new things to users, especially in:
8378

79+
- Getting started guides
80+
- Release highlights
8481
::::
8582
::::{tab-item} Examples
8683
Let’s start exploring what’s happening in your environment. After installing Elastic Defend, you’ll see the following page.
@@ -96,29 +93,25 @@ During the users' journey with Elastic, there are times for excitement and disco
9693

9794
:::::{tab-set}
9895
::::{tab-item} Attributes
99-
All's fine, we'll help you find your way. Be:
96+
All's fine, we'll help you find your way. Be:
10097

101-
- Calm
102-
- Positive
103-
- Confident
104-
<br/>
105-
106-
When using this tone, you may:
107-
- Use slightly more casual terminology.
108-
- Explain what's missing or what's happening.
109-
- Provide actions or clearly state when no action is needed.
98+
- Calm
99+
- Positive
100+
- Confident
110101

102+
When using this tone, you may:
111103

104+
- Use slightly more casual terminology.
105+
- Explain what's missing or what's happening.
106+
- Provide actions or clearly state when no action is needed.
112107
::::
113108
::::{tab-item} Cases
114-
The **friendly** tone is used **sparingly** overall.
115-
116-
We use it when trying to orient users in performing their next action or learning different things they could do, especially in:
117-
118-
- Quick starts
119-
- Tutorials
109+
The **friendly** tone is used **sparingly** overall.
120110

111+
We use it when trying to orient users in performing their next action or learning different things they could do, especially in:
121112

113+
- Quick starts
114+
- Tutorials
122115
::::
123116
::::{tab-item} Examples
124117
Got everything working as you want it? Roll out your agent policies to other hosts by deploying Elastic Agents across your infrastructure!
@@ -132,117 +125,104 @@ During the users' journey with Elastic, there are times for excitement and disco
132125

133126
:::::{tab-set}
134127
::::{tab-item} Attributes
135-
E=MC². Be:
136-
137-
- Direct
138-
- Straight to the point
139-
- Neutral
140-
<br/>
141-
142-
When using this tone:
143-
- Use a minimum of words.
144-
- Write for scanning and help users quickly locate what matters to them.
145-
- Use action verbs to:
146-
- Label selection controls
147-
- Describe what settings do or what to do with a setting
148-
- Use clear nouns for menus and form field names.
128+
E=MC². Be:
149129

130+
- Direct
131+
- Straight to the point
132+
- Neutral
150133

134+
When using this tone:
135+
136+
- Use a minimum of words.
137+
- Write for scanning and help users quickly locate what matters to them.
138+
- Use action verbs to:
139+
- Label selection controls
140+
- Describe what settings do or what to do with a setting
141+
- Use clear nouns for menus and form field names.
151142
::::
152143
::::{tab-item} Cases
153-
The **informational** tone is the **most used** one. It's everywhere in the docs, and sometimes seems so normal that we forget about it. Yet, it's very important!
154-
155-
We use it for naming and describing things:
156-
157-
- Reference content
158-
- Concepts
159-
- How-tos
160-
- Event logs
161-
- Troubleshooting
144+
The **informational** tone is the **most used** one. It's everywhere in the docs, and sometimes seems so normal that we forget about it. Yet, it's very important!
162145

146+
We use it for naming and describing things:
163147

148+
- Reference content
149+
- Concepts
150+
- How-tos
151+
- Event logs
152+
- Troubleshooting
164153
::::
165154
::::{tab-item} Examples
166-
Mapping is the process of defining how a document, and the fields it contains, are stored and indexed. Each document is a collection of fields, which each have their own data type. When mapping your data, you create a mapping definition, which contains a list of fields that are pertinent to the document. A mapping definition also includes metadata fields, like the `_source` field, which customize how a document’s associated metadata is handled.
155+
Mapping is the process of defining how a document, and the fields it contains, are stored and indexed. Each document is a collection of fields, which each have their own data type. When mapping your data, you create a mapping definition, which contains a list of fields that are pertinent to the document. A mapping definition also includes metadata fields, like the `_source` field, which customize how a document’s associated metadata is handled.
167156

168-
An Elastic Cloud deployment offers you all of the features of the Elastic Stack as a hosted service. To test drive your first deployment, sign up for a free Elastic Cloud trial:
157+
An Elastic Cloud deployment offers you all of the features of the Elastic Stack as a hosted service. To test drive your first deployment, sign up for a free Elastic Cloud trial:
169158

170-
1. Go to our Elastic Cloud Trial page.
171-
1. Enter your email address and a password.
172-
1. After you’ve logged in, you can create a deployment. Give your deployment a name and select **Create deployment**.
159+
1. Go to our Elastic Cloud Trial page.
160+
1. Enter your email address and a password.
161+
1. After you’ve logged in, you can create a deployment. Give your deployment a name and select **Create deployment**.
173162

174-
<br/>
175-
If you receive the following rule failure: `"Bulk Indexing of signals failed: [parent] Data too large"`, this indicates that the alerts payload was too large to process. This can be caused by bad indicator data, a misconfigured rule, or too many event matches. Review your indicator data or rule query. If nothing obvious is misconfigured, try executing the rule against a subset of the original data and continue diagnosis.
163+
If you receive the following rule failure: `"Bulk Indexing of signals failed: [parent] Data too large"`, this indicates that the alerts payload was too large to process. This can be caused by bad indicator data, a misconfigured rule, or too many event matches. Review your indicator data or rule query. If nothing obvious is misconfigured, try executing the rule against a subset of the original data and continue diagnosis.
176164
::::
177165
:::::
178166

179167
### Empathetic
180168

181169
:::::{tab-set}
182170
::::{tab-item} Attributes
183-
Something might be wrong or unexpected and requires attention. Let us help you. Be:
171+
Something might be wrong or unexpected and requires attention. Let us help you. Be:
184172

185-
- Reassuring
186-
- Professional
187-
- Precise
188-
<br/>
189-
190-
When using this tone, you may:
191-
- Be more action-oriented than usual to offer direct paths to users.
173+
- Reassuring
174+
- Professional
175+
- Precise
192176

177+
When using this tone, you may:
193178

179+
- Be more action-oriented than usual to offer direct paths to users.
194180
::::
195181
::::{tab-item} Cases
196-
The **empathetic** tone is used **sparingly** overall and usually becomes visible in forms that draw the user's attention.
197-
198-
We use it when notifying users of things that are not immediately critical but still require attention, especially in:
199-
200-
- Warnings and cautions
201-
- Upgrade and deprecation notices
182+
The **empathetic** tone is used **sparingly** overall and usually becomes visible in forms that draw the user's attention.
202183

184+
We use it when notifying users of things that are not immediately critical but still require attention, especially in:
203185

186+
- Warnings and cautions
187+
- Upgrade and deprecation notices
204188
::::
205189
::::{tab-item} Examples
206-
The kNN search API is deprecated in favor of the new _knn_ option inside the search API. The knn option is now the recommended way of running ANN search.
207-
208-
The indicator index query of the prebuilt rule is misconfigured and will prevent the rule from generating alerts. To resolve this, duplicate the rule and update its settings:
209-
210-
1. Go to the Rules table (**Detect** → **Rules**).
211-
1. Locate the Threat Intel Filebeat Module (v8.x) Indicator Match prebuilt rule.
212-
1. Click the rule to view the rule details.
213-
1. Click the actions menu, then click **Duplicate rule**.
214-
190+
The kNN search API is deprecated in favor of the new _knn_ option inside the search API. The knn option is now the recommended way of running ANN search.
191+
192+
The indicator index query of the prebuilt rule is misconfigured and will prevent the rule from generating alerts. To resolve this, duplicate the rule and update its settings:
193+
194+
1. Go to the Rules table (**Detect****Rules**).
195+
1. Locate the Threat Intel Filebeat Module (v8.x) Indicator Match prebuilt rule.
196+
1. Click the rule to view the rule details.
197+
1. Click the actions menu, then click **Duplicate rule**.
215198
::::
216199
:::::
217200

218201
### Supportive
219202

220203
:::::{tab-set}
221204
::::{tab-item} Attributes
222-
Something is definitely wrong. Here's why, and how to fix it. Be:
205+
Something is definitely wrong. Here's why, and how to fix it. Be:
206+
207+
- Serious
208+
- Concerned
209+
- Urgent
223210

224-
- Serious
225-
- Concerned
226-
- Urgent
227-
<br/>
228-
229-
When using this tone, you may:
230-
- Focus on what went wrong. Don't be apologetic.
231-
- Help users learn how something happened, how to prevent it, how to fix it.
232-
- Provide clear actions, or clearly state if there's no action needed.
211+
When using this tone, you may:
233212

213+
- Focus on what went wrong. Don't be apologetic.
214+
- Help users learn how something happened, how to prevent it, how to fix it.
215+
- Provide clear actions, or clearly state if there's no action needed.
234216

235217
::::
236218
::::{tab-item} Cases
237-
The **supportive** tone is used **sparingly**. It usually becomes visible in forms that draw the user's attention, for example, through callouts or notifications.
238-
239-
We use it when the immediate attention of the user is required, especially in:
240-
241-
- Errors
242-
- Licensing or billing-related content
243-
- Vulnerability and remediation content
219+
The **supportive** tone is used **sparingly**. It usually becomes visible in forms that draw the user's attention, for example, through callouts or notifications.
244220

221+
We use it when the immediate attention of the user is required, especially in:
245222

223+
- Errors
224+
- Licensing or billing-related content
225+
- Vulnerability and remediation content
246226
::::
247227
::::{tab-item} Examples
248228
**NOTE:** To suspend a process on a host running Elastic Defend, you must have the **Process Operations** privilege and at least an Enterprise license to perform this action.
@@ -257,25 +237,21 @@ During the users' journey with Elastic, there are times for excitement and disco
257237
::::{tab-item} Attributes
258238
We don't advise this action and there might be significant implications. Be:
259239

260-
- Deterring
261-
- Heavy with caution
262-
- Advisory
263-
<br/>
264-
265-
When using this tone, you may:
266-
- Use stronger words that highlight possible negative effects.
267-
- Format the content in a way that make the risks stand out.
240+
- Deterring
241+
- Heavy with caution
242+
- Advisory
268243

244+
When using this tone, you may:
269245

246+
- Use stronger words that highlight possible negative effects.
247+
- Format the content in a way that make the risks stand out.
270248
::::
271249
::::{tab-item} Cases
272-
The **stern** tone is **rarely** used. Reserve it for very specific cases, and for advanced or administrative features.
273-
274-
We use it when insisting on the high risks an action could pose, especially in:
275-
276-
- Danger type of warnings
250+
The **stern** tone is **rarely** used. Reserve it for very specific cases, and for advanced or administrative features.
277251

252+
We use it when insisting on the high risks an action could pose, especially in:
278253

254+
- Danger type of warnings
279255
::::
280256
::::{tab-item} Examples
281257
The following changes in Elasticsearch 8.0 might affect your applications and prevent them from operating normally. Before upgrading to 8.0, review these changes and take the described steps to mitigate the impact.

0 commit comments

Comments
 (0)