Skip to content

Commit 26e6f03

Browse files
committed
Edits, moved voice and tone to writing, from style guidelines
1 parent 7f5250e commit 26e6f03

12 files changed

+69
-28
lines changed

source/style-guide/style/callouts.txt

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ Callouts and Admonitions
66

77
.. default-domain:: mongodb
88

9-
Callouts or admonitions emphasize important or
10-
helpful information. Use callouts sparingly to avoid clutter on
11-
the page and to preserve visual impact.
9+
Callouts or admonitions emphasize important or helpful information. Use
10+
callouts sparingly to avoid clutter on the page and to preserve visual impact.
1211

1312
Callout Types
1413
-------------
@@ -79,12 +78,12 @@ When creating callouts, use the following guidelines:
7978
attempt to create callouts using boldface, headings, or custom
8079
:abbr:`CSS (Cascading Style Sheets)`.
8180

82-
- Don't stack multiple admonitions directly after one another, as these
83-
can be distracting for users. To avoid stacking admonitions, group
84-
supplemental information from admonitions into a dedicated section.
81+
- Don't stack multiple callouts directly after one another, as these can
82+
distract users. To avoid stacking callouts, group supplemental information
83+
from callouts into a dedicated section.
8584

86-
- Don't use admonitions in tables and option lists, if possible, because
87-
admonitions reduce scannability of tables and options lists.
85+
- Don't use callouts in tables and option lists, if possible, because
86+
callouts reduce the scannability of tables and options lists.
8887

8988
- Avoid nesting callouts inside tables and other elements.
9089

@@ -93,11 +92,9 @@ When creating callouts, use the following guidelines:
9392
- Place a callout as close as possible to the information that it
9493
emphasizes or clarifies.
9594

96-
- Avoid "stack" callouts of the same type. For example, avoid adding
95+
- Avoid stacking callouts of the same type. For example, avoid adding
9796
one labeled note directly after another labeled note. Instead, use
9897
separate paragraphs or an unordered list within a single callout.
99-
You can have callouts of different types follow one
100-
another, if necessary, but if possible, avoid such situations also.
10198

10299
The following callouts might appear in existing documentation but are
103100
deprecated. Don't use these callouts in new content:

source/style-guide/style/cloud-account-info.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ API Placeholders
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
915
When users learn how to use our API, they might copy the code and try
1016
to use it as given.
1117

source/style-guide/style/code-examples.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Code Examples
55
=============
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
Use the following guidelines when creating blocks of code as input
814
or output examples:
915

source/style-guide/style/index.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,3 @@ instructions for applying style conventions.
4747
/style-guide/style/titles-and-headings
4848
/style-guide/style/urls
4949
/style-guide/style/version
50-
/style-guide/style/voice-and-tone

source/style-guide/style/ip-addresses.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ IP Addresses
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
915
An *IP address* uses a sequence of numbers to uniquely identify a
1016
particular computer on the Internet.
1117

source/style-guide/style/links-and-cross-references.txt

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@
44
Links and Cross-References
55
==========================
66

7-
.. contents:: On this page
8-
:local:
9-
:backlinks: none
10-
:depth: 2
11-
:class: singlecol
12-
137
.. default-domain:: mongodb
148

159
Documentation writers use links to direct users to related material
@@ -75,25 +69,25 @@ about MongoDB concepts can click through and explore the linked content.
7569
Avoid Inline References in Tutorials
7670
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7771

78-
- Avoid adding inline textual references in tutorials or stepped procedures.
72+
Avoid adding inline textual references in tutorials or stepped procedures.
7973

80-
If users follow inline references while in the middle of a procedure,
81-
they might have difficulty navigating back and reorienting themselves
82-
with their current step.
74+
If users follow inline references while in the middle of a procedure,
75+
they might have difficulty navigating back and reorienting themselves
76+
with their current step.
8377

84-
Inline textual references may be appropriate for more reference-heavy pages.
78+
Inline textual references may be appropriate for more reference-heavy pages.
8579

8680
Minimize Repeated Links
8781
~~~~~~~~~~~~~~~~~~~~~~~
8882

8983
- Don't link to the same target multiple times in the same section.
9084

91-
You may link to the same target more than once on the same page, but
85+
You may link to the same target multiple times on the same page, but
9286
think carefully about whether it's absolutely necessary. For example,
93-
if a page is long and contains many sections, then it might be helpful
94-
to link to a target once or twice from this page to help users who
95-
navigate to a section far down on a page and may miss the initial
96-
reference at the top of the page.
87+
if a page is particularly long and contains many sections, then it might
88+
be helpful to link to a target an additional time or two. Users may
89+
immediately navigate to a section far down on a page and miss the initial
90+
reference.
9791

9892
- If you add repeated links, use the same style for each link.
9993
Consider whether a plaintext link or a monospace link is appropriate.

source/style-guide/style/placeholder-variable-text.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ Placeholder or Variable Text
66

77
.. default-domain:: mongodb
88

9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
915
Use placeholder text for a value when you:
1016

1117
- Don't know its specific value

source/style-guide/writing/index.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ and consistent, and that helps users accomplish their goals.
2323
/style-guide/writing/use-gender-neutral-pronouns
2424
/style-guide/writing/use-positive-statements
2525
/style-guide/writing/use-correct-punctuation
26+
/style-guide/style/voice-and-tone
2627
/style-guide/writing/use-interjections-with-care
2728
/style-guide/writing/write-for-accessibility
2829
/style-guide/terminology/terms-for-global-audience

source/style-guide/writing/use-active-voice.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Use Active Voice
55
================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
713
.. default-domain:: mongodb
814

915
.. _why-active-voice:

source/style-guide/writing/use-positive-statements.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Use Positive Statements
55
=======================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
713
Positive statements are easier to understand than negative statements
814
and are typically shorter.
915

source/style-guide/writing/use-present-tense.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
Use Present Tense
55
=================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
713
.. default-domain:: mongodb
814

915
Users read content to learn how to perform tasks or to gather

source/style-guide/writing/write-to-the-user.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ Use Second Person and Imperative Mood
88

99
.. default-domain:: mongodb
1010

11+
.. contents:: On this page
12+
:local:
13+
:backlinks: none
14+
:depth: 2
15+
:class: singlecol
16+
17+
.. default-domain:: mongodb
18+
1119
Write to the User
1220
-----------------
1321

0 commit comments

Comments
 (0)