Skip to content

Commit c0119c7

Browse files
committed
CR review
1 parent 203c8a6 commit c0119c7

File tree

2 files changed

+50
-30
lines changed

2 files changed

+50
-30
lines changed

source/style-guide/seo-guidelines.txt

Lines changed: 39 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,11 @@ practices:
7070
Titles
7171
------
7272

73-
Consider the following four SEO principles when naming a page:
73+
Search engines weight page titles heavily, as titles are considered most relevant
74+
to a user's search engine query. Name pages appropriately to ensure users can find
75+
relevant content in the MongoDB Documentation when they use a search engine.
76+
77+
Consider the following SEO principles when you name a page:
7478

7579
- Title Length
7680

@@ -80,34 +84,35 @@ Consider the following four SEO principles when naming a page:
8084

8185
- Disambiguation
8286

83-
Each of the following four subsections describe one of the above principles.
87+
The following subsections describe these principles.
8488

8589
Title Length
8690
~~~~~~~~~~~~
8791

88-
Titles should be between 30-60 characters long. Pages with titles longer than 60 characters
89-
are typically truncated by search engines. A too short title does not convey enough information
90-
to the search engine, so a page with a too short title might be recommended less by search
91-
engines. Search engines might also create a longer page title for pages with too short titles.
92-
93-
When considering title length, keep in mind that the product name, version
94-
number, and "MongoDB Docs" are automatically appended when the title is passed
95-
to a search engine. For example, for a v8.0 Server Manual page titled
96-
"Install MongoDB", the title is 15 characters long. The full title passed to search
97-
engines ("Install MongoDB - Database Manual v8.0 - MongoDB Docs") is 53 characters long.
98-
The appended additions to the title can add around 18-35
92+
Titles should be 30-60 characters long. Search engines often truncate pages
93+
with titles longer than 60 characters. Titles with fewer than 30 characters
94+
convey limited information to search engines, so search engines recommend these
95+
pages less often. Search engines might also create a longer page title for pages with
96+
titles under 30 characters.
97+
98+
As described in the :ref:`Page Title Structure <titles-page-title-structure>` subsection,
99+
the product name, version number, and "MongoDB Docs" are automatically appended to a title
100+
when the title is passed to a search engine. For example, for a v8.0 Server
101+
Manual page titled "Install MongoDB", the title is 15 characters long. The full
102+
title when passed to a search engine ("Install MongoDB - Database Manual v8.0 - MongoDB Docs")
103+
is 53 characters long. The appended additions to the title can add about 18-35
99104
characters to the title, depending on the length of the product name.
100105

101106
Standardization
102107
~~~~~~~~~~~~~~~
103108

104-
For pages across MongoDB documentation covering similar concepts, use consistent
109+
For pages across MongoDB documentation that cover similar concepts, use consistent
105110
wording in the page titles to ensure a consistent user experience.
106111

107112
For example, multiple pages in the documentation cover the Read CRUD operation.
108-
The Read CRUD operation can be referred to as a read, find, or query operation.
109-
Page titles for pages documenting the Read operation should be consistent in what
110-
term is used to refer to Read operations, based on what term is most findable.
113+
You can refer to the Read CRUD operation as a read, find, or query operation.
114+
Titles for pages that document the Read operation should use consistent terminology
115+
to refer to Read operations, based on the most findable term.
111116

112117
Findability
113118
~~~~~~~~~~~
@@ -116,18 +121,29 @@ Use the most relevant keywords in a page title. Pay attention to word order in a
116121
page title. Include the most relevant words at the beginning of the title.
117122

118123
When in doubt, search your potential page title in a search engine. The top five search
119-
results should be similar content to the page you are titling.
124+
results should resemble the content on your page.
120125

121126
Disambiguation
122127
~~~~~~~~~~~~~~
123128

124-
Differentiate page titles for pages covering commands with same name but different
125-
functions by adding the command category in the title.
129+
For pages that cover commands with the same name but different
130+
functions, add the command categories to the page titles to differentiate the pages.
126131

127132
For example, ``count`` is a database command, aggregation stage, aggregation
128-
operator, and ``mongosh`` method. For Server Manual pages, you can differentiate
129-
between these pages by including the command category in the title, like
130-
"count (Database Command)".
133+
operator, and ``mongosh`` method. For Server Manual pages, you
134+
can include the command category in the title, like
135+
"count (Database Command)," to differentiate between these pages.
136+
137+
.. _titles-page-title-structure:
138+
139+
Page Title Structure
140+
~~~~~~~~~~~~~~~~~~~~
141+
142+
The product name, version number, and "MongoDB Docs" are automatically appended to
143+
Documentation page titles when the title is passed to a search engine.
144+
145+
For example, a v8.0 Server Manual page titled "Install MongoDB" appears as
146+
"Install MongoDB - Database Manual v8.0 - MongoDB Docs" in search engine results.
131147

132148
General Guidelines
133149
~~~~~~~~~~~~~~~~~~

source/style-guide/style/titles-and-headings.txt

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Titles and Headings
1616
This topic provides guidelines for creating titles and headings in
1717
documentation.
1818

19-
Why Do Page Titles Matter?
20-
--------------------------
19+
Why Do Page Titles Matter for SEO?
20+
----------------------------------
2121

2222
A page title is weighted as most relevant to a user's search engine query. Name
2323
pages appropriately to ensure users can find relevant content in the MongoDB
@@ -27,9 +27,9 @@ Page Title Structure
2727
~~~~~~~~~~~~~~~~~~~~
2828

2929
The product name, version number, and "MongoDB Docs" are automatically appended to
30-
Documentation page titles when they are passed to search engines.
30+
Documentation page titles when a title is passed to a search engine.
3131

32-
For example, a v8.0 Server Manual page titled "Install MongoDB" will appear as
32+
For example, a v8.0 Server Manual page titled "Install MongoDB" appears as
3333
"Install MongoDB - Database Manual v8.0 - MongoDB Docs" in search engine results.
3434

3535
Capitalization
@@ -88,9 +88,9 @@ Guidelines for Titles and Headings
8888
----------------------------------
8989

9090
Use the guidelines in the following subsections to create effective and consistent
91-
titles and headings. Special considerations for stand-alone articles, product
92-
guides, and tables, figures, and examples can be found in the Product Guides and
93-
Tables, Figures, and Headings subsections.
91+
titles and headings. You can find special considerations for stand-alone articles, product
92+
guides, tables, figures, and examples in the :ref:`Product Guides <titles-product-guides>` and
93+
:ref:`Tables, Figures, and Headings <titles-table-figures-ex>` subsections.
9494

9595
.. _title-grammar:
9696

@@ -239,6 +239,8 @@ Support site or in other collections of documentation:
239239
- Start with the highest level of heading that is approved for headings
240240
(for example, h3), and do not skip heading levels.
241241

242+
.. _titles-product-guides:
243+
242244
Product Guides
243245
~~~~~~~~~~~~~~
244246

@@ -257,6 +259,8 @@ when creating titles and headings for sections in product guides:
257259

258260
- Define consistent heading levels, and do not skip levels.
259261

262+
.. _titles-table-figures-ex:
263+
260264
Tables, Figures, and Examples
261265
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
262266

0 commit comments

Comments
 (0)