Skip to content

Commit 86a2a97

Browse files
melissamahoney-mongodbatsansone
authored andcommitted
(DOCSP-11399): Update Voice & Tone w/ JD feedback (#38)
* (DOCSP-11399): Update Voice & Tone w/ JD feedback * copy review
1 parent 5875700 commit 86a2a97

File tree

1 file changed

+70
-70
lines changed

1 file changed

+70
-70
lines changed

source/style-guide/style/voice-and-tone.txt

Lines changed: 70 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1+
.. _voice-and-tone:
2+
13
==============
24
Voice and Tone
35
==============
46

5-
The voice and tone that we use with words influence how people think
7+
.. default-domain:: mongodb
8+
9+
.. include:: /includes/styles/corrections.rst
10+
11+
The *voice* and *tone* that we use influence how people think
612
and feel about MongoDB.
713

8-
Voice is our style and communicates our personality to the user. Tone
9-
is our mood and communicates our attitude about the subject to the
10-
user.
14+
- *Voice* is our style and communicates our personality to the user.
15+
- *Tone* is our mood and communicates our attitude about the subject to
16+
the user.
1117

1218
The words we choose—and the ways we use them—should reflect our goals,
1319
which include the following things:
@@ -22,109 +28,103 @@ No matter where our words land, they should sound like us.
2228
Voice and Tone Attributes
2329
-------------------------
2430

25-
The following table shows attributes for voice and tone:
31+
At MongoDB, we shape our words with the following voice and tone
32+
attributes:
2633

2734
.. list-table::
28-
:widths: 50 50
2935
:header-rows: 1
36+
:widths: 50 50
3037

31-
* - Voice attributes
32-
- Tone attributes
33-
34-
* - **Basic**
35-
36-
* Human
37-
* Conversational
38-
* Friendly
39-
* Confident
40-
* Knowledgeable
41-
* Trustworthy
42-
43-
- **Basic**
44-
45-
* Indispensable
46-
* Helpful
47-
* Approachable
48-
* Smart
49-
* Professional
50-
* Honest
51-
* Accurate
52-
53-
* - **Amplified**
54-
55-
* Bold
56-
* Voice of reality
57-
* Voice of experience
58-
* Committed
59-
* Exuberant
60-
61-
- **Amplified**
62-
63-
* Empathetic without sugarcoating it
64-
* Empowering and proactive
65-
* Playful, but professional
66-
* Steadfast, but open and approachable
38+
* - Voice
39+
- Tone
40+
* - - Human
41+
- Conversational
42+
- Friendly
43+
- Confident
44+
- Knowledgeable
45+
- Trustworthy
46+
47+
- - Indispensable
48+
- Helpful
49+
- Approachable
50+
- Smart
51+
- Professional
52+
- Honest
53+
- Accurate
54+
55+
These attributes make our documentation:
56+
57+
- Empathetic without sugarcoating it.
58+
- Empowering and proactive.
59+
- Committed and energetic.
60+
- Playful, but professional.
61+
- Steadfast, but open and approachable.
62+
- A trusted voice of reality and experience.
6763

6864
Best Practices
6965
--------------
7066

7167
Consider the following best practices for voice and tone:
7268

7369
.. list-table::
74-
:widths: 33 33 34
70+
:widths: 50 25 25
7571
:header-rows: 1
7672

7773
* - Best practices
7874
- Use
79-
- Don't Use
80-
81-
* - Write to the user by using second person and imperative mood.
82-
Users are more engaged with content when it talks to them
83-
directly. You talk to users directly by using second person,
84-
addressing the user as *you*. When you use second person with
85-
the imperative mood (in which the subject *you* is understood)
86-
*and* active voice, you make the text clear, concise, and
87-
direct.
75+
- Avoid
76+
77+
* - :ref:`Write to the user <write-to-the-user>` by using second
78+
person and imperative mood. Users are more engaged with content
79+
when it talks to them directly. You talk to users directly by
80+
using second person, addressing the user as *you*. When you use
81+
second person with the imperative mood (in which the subject
82+
*you* is understood) *and* active voice, you make the text clear,
83+
concise, and direct.
8884
- Click **Yes** to accept the license agreement.
8985
- The license agreement is accepted when the user clicks **Yes**.
9086

91-
* - Write in active voice. Active voice makes the performer of the
92-
action (usually the user) the subject of the sentence.
93-
Active-voice sentences are more direct and easier to understand
94-
than passive-voice sentences.
95-
- After you install the software, start the computer.
87+
* - :ref:`Write in active voice <use-active-voice>`. Active voice
88+
makes the performer of the action (usually the user) the subject
89+
of the sentence. Active-voice sentences are more direct and
90+
easier to understand than passive-voice sentences.
91+
- After you install the software, restart the computer.
9692
- After the software has been installed, the computer can be
97-
started.
93+
restarted.
9894

99-
* - Use present tense. Users read content to help them perform tasks
100-
or to gather information. These activities occur in the users'
101-
present time, so the present tense is appropriate in most
102-
content.
95+
* - :ref:`Use present tense <use-present-tense>`. Users read content
96+
to help them perform tasks or to gather information. These
97+
activities occur in the users' present time, so the present tense
98+
is appropriate in most content.
10399
- The product **prompts** you to verify the deletion.
104100
- The product **will prompt** you to verify the deletion.
105101

106102
* - Be impactful and speak directly to a pain point.
107-
- Stop letting the cloud manage you.
108-
- Are you ready for the managed cloud?
103+
- Stop letting maintenance of your database take time away from
104+
developing your app.
105+
- MongoDB Atlas is built for agile teams who'd rather spend time
106+
building apps than managing databases.
109107

110108
* - It's about them, not us, and promises a solution.
111109
- Offload the burden of managing the cloud to a team of experts.
112110
- The managed cloud difference, fueled by expertise...
113111

114112
* - Be simple and direct.
115-
- The cloud is hard. We can help.
116-
- Let us help you solve your cloud challenges.
113+
- Why MongoDB Atlas? Flexible and scalable document database.
114+
Available as a fully managed service.
115+
- Are you looking for a global cloud database service that deploys
116+
fully managed document databases?
117117

118118
* - Write in a way that the user wants to be spoken to. Use helpful
119119
words and phrases that are informative, simple, clear, and easy
120120
to understand.
121-
- The IP address of the server needs to be entered. Click the **My
122-
Server** button to complete the configuration.
121+
- Enter the IP address of the host. Click :guilabel:`My
122+
Server` to complete the configuration.
123123
- The monitoring engine couldn't connect to the server. Make sure
124124
the information is correctly entered.
125125

126-
* - Temper the enthusiasm conveyed in content.
127-
- You have successfully configured databased for monitoring.
126+
* - Avoid being overly enthusiastic.
127+
- You successfully configured all databases for monitoring.
128128
- Congratulations!! ALL of your databases are now being
129129
monitored!!
130130

0 commit comments

Comments
 (0)