Skip to content

Commit 57fab45

Browse files
committed
(DOCSP-29016): Incorporated Chris's feedback.
1 parent 9f03e26 commit 57fab45

File tree

3 files changed

+22
-24
lines changed

3 files changed

+22
-24
lines changed

source/style-guide.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ MongoDB external and internal customers.
3939
however, when writing release notes for any product or service.
4040

4141
:doc:`/style-guide/seo-guidelines`
42-
Provides guidance for optimizing your documentations pages for
42+
Provides guidance for optimizing your documentation pages for
4343
search.
4444

4545
:github:`User Interface Guidelines </mongodb/leafygreen-ui>`

source/style-guide/markup/directives/metadata.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Page Metadata Directives
55
========================
66

7-
.. default-domain:: mongodb
8-
97
meta
108
----
119

@@ -20,7 +18,7 @@ keywords and descriptions. To learn more, see :ref:`seo-guidelines`.
2018
:description: You can tune the consistency and availability of your application using write concerns and read concerns.
2119

2220
Add the ``.. meta::`` directive on the line below the
23-
``.. default-domain::`` directive with a line break in between.
21+
page title with a line break in between.
2422

2523
Learn more about the ``meta`` directive from the
2624
`{+docutils+} documentation <http://docutils.sourceforge.net/docs/ref/rst/directives.html#meta>`__.

source/style-guide/seo-guidelines.txt

+20-20
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@
44
Search Engine Optimization Guidelines
55
=====================================
66

7-
.. default-domain:: mongodb
8-
97
Search Engine Optimization (SEO) considers the actual terms that users
10-
enter into serach engines (keywords) and employs best practices to
8+
enter into search engines (keywords) and employs best practices to
119
improve traffic to web pages from search engines. The following
1210
guidance should help you optimize your documentation pages for search.
1311

@@ -19,26 +17,29 @@ practices:
1917

2018
- Use a maximum of 70 characters.
2119

22-
- Include target keywords.
20+
- Include target keywords (the actual terms that users
21+
enter into search engines to reach your page).
2322

2423
- Avoid excessive or irrelevant words (keyword stuffing).
2524

26-
- Use a unique title for every page.
25+
- Strive for unique page titles. Identical titles, even between
26+
documentation sets, might compete in search results.
2727

2828
To learn more, see :ref:`titles-and-headings`.
2929

3030
Alternative Text
3131
----------------
3232

33-
Screen readers read alternative text aloud so that users can better
34-
understand an on-page image. Specify alterative text according to the
33+
Screen readers read alternative text for images aloud so that users can
34+
better understand an image. Specify alternative text according to the
3535
following SEO best practices:
3636

3737
- Use a maximum of 125 characters per image.
3838

39-
- Describe the image with specific language.
39+
- Describe the image with sufficient detail to understand what it shows.
4040

41-
- If it makes sense, include keywords.
41+
- If it makes sense, include keywords (the actual terms that users
42+
enter into search engines).
4243

4344
To learn more, see :ref:`write-for-accessibility`.
4445

@@ -58,27 +59,26 @@ the following best practices:
5859
our searchers. For example, add “mongodb atlas course” instead of
5960
“Getting Started with Atlas Data Platform”.
6061

61-
To learn more, see :ref:`metadata`.
62+
While keyword tags are available, some search engines might ignore
63+
these tags. To learn more, see :ref:`metadata`.
6264

6365
Descriptions
6466
------------
6567

66-
The snippet that appears under the link in the search results can
67-
impact SEO. Write these descriptions according to the following best
68-
practices:
68+
The description is a snippet that appears under the link in the search
69+
results, which can impact SEO. Write these descriptions according to
70+
the following best practices:
6971

70-
- Make the descriptions informative (and enticing if possible).
72+
- Use a concise description of the page content that is enticing, if
73+
possible.
7174

7275
- Emphasize the “why” for using the page.
7376

7477
- Use a maximum of 155 characters.
7578

76-
- Include target keywords and a call to action.
77-
78-
- Keep the description short, simple, and concise.
79-
80-
- Concisely, explain the page content.
79+
- Include target keywords and a call to action (CTA) that prompts the
80+
user to complete their desired task.
8181

82-
- Use unique meta descriptions for every page.
82+
- Use unique descriptions for every page.
8383

8484
To learn more, see :ref:`metadata`.

0 commit comments

Comments
 (0)