@@ -50,14 +50,18 @@ Each of the following four subsections describe one of the above principles.
50
50
Title Length
51
51
~~~~~~~~~~~~
52
52
53
- Titles should be between 30-60 character long. Pages with titles longer than 60 characters
53
+ Titles should be between 30-60 characters long. Pages with titles longer than 60 characters
54
54
are typically truncated by search engines. A too short title does not convey enough information
55
55
to the search engine, so a page with a too short title might be recommended less by search
56
56
engines. Search engines might also create a longer page title for pages with too short titles.
57
57
58
- When considering title length, keep in mind that the product name and version number
59
- count towards title length. This can add around 6-20 characters to the title, depending
60
- on the length of the product name.
58
+ When considering title length, keep in mind that the product name, version
59
+ number, and "MongoDB Docs" are automatically appended when the title is passed
60
+ to a search engine. For example, a v8.0 Server Manual page titled
61
+ "Install MongoDB", the title is 15 characters long. The full title passed to search
62
+ engines ("Install MongoDB - Database Manual v8.0 - MongoDB Docs") is 53 characters long.
63
+ The appended additions to the title can add around 18-35
64
+ characters to the title, depending on the length of the product name.
61
65
62
66
Standardization
63
67
~~~~~~~~~~~~~~~
@@ -140,6 +144,8 @@ words:
140
144
To learn more about the principles of headline-style capitalization,
141
145
read `section 8.159 <https://www.chicagomanualofstyle.org/book/ed17/part2/ch08/psec159.html>`__ of the *Chicago Manual of Style*.
142
146
147
+ .. _general-title-guidance:
148
+
143
149
Guidelines for Titles and Headings
144
150
----------------------------------
145
151
@@ -148,6 +154,8 @@ titles and headings. Special considerations for stand-alone articles, product
148
154
guides, and tables, figures, and examples can be found in the Product Guides and
149
155
Tables, Figures, and Headings subsections.
150
156
157
+ .. _title-grammar:
158
+
151
159
Grammatical Structure for Different Page Types
152
160
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
153
161
@@ -166,59 +174,59 @@ specific types of content:
166
174
* - Conceptual
167
175
- Any grammatical structure that's appropriate, except a verb,
168
176
gerund, or infinitive
169
- - Linux distributions
177
+ - Linux Distributions
170
178
171
- Best practices for backing up your data
179
+ Best Practices for Backing Up Your Data
172
180
- Core concepts
173
181
174
- How monitoring works
182
+ How Monitoring Works
175
183
176
- Limitations of detaching from MongoDB networks
184
+ Limitations of Detaching from MongoDB Networks
177
185
178
186
* - Tutorial or high-level process
179
187
- An imperative verb
180
188
181
189
.. note::
182
190
For specific guidelines for headings within tasks, see
183
191
:ref:`tasks`.
184
- - Identify network interfaces on Linux
192
+ - Identify Network Interfaces on Linux
185
193
186
- Prepare data disks on servers running Windows
194
+ Prepare Data Disks on Servers Running Windows
187
195
188
- Set up Mobile Sync for Webmail
189
- - Sign up for a MongoDB Atlas account
196
+ Set Up Mobile Sync for Webmail
197
+ - Sign Up for a MongoDB Atlas Account
190
198
191
199
* - Reference
192
200
- A plural noun or a noun phrase
193
- - Permissions matrix for Cloud Networks
201
+ - Permissions Matrix for Cloud Networks
194
202
195
- MongoDB Auto Scale glossary
196
- - Environment variables for the nova and supernova clients
203
+ MongoDB Auto Scale Glossary
204
+ - Environment Variables for the Nova and Supernova Clients
197
205
198
- Restore operations
206
+ Restore Operations
199
207
200
- cURL command summary
208
+ cURL Command Summary
201
209
202
210
* - Troubleshooting
203
211
- A grammatical structure that's appropriate for the type of
204
212
content (a troubleshooting topic can contain task, tutorial,
205
213
concept, or reference information)
206
- - Troubleshoot alarms
214
+ - Troubleshoot Alarms
207
215
208
- Service troubleshooting on Linux
216
+ Service Troubleshooting on Linux
209
217
- Troubleshooting
210
218
211
219
* - FAQ
212
220
- A descriptive noun or noun phrase, followed by *FAQ*
213
221
- MongoDB Cloud Billing FAQ
214
222
215
- Scheduled images FAQ
223
+ Scheduled Images FAQ
216
224
- Not applicable
217
225
218
226
General Style and Structure
219
227
~~~~~~~~~~~~~~~~~~~~~~~~~~~
220
228
221
- The following guidelines apply to all titles and headings;
229
+ The following guidelines apply to all titles and headings:
222
230
223
231
- Create succinct, meaningful, descriptive titles and headings, and
224
232
place the most important words first.
0 commit comments