4
4
Search Engine Optimization Guidelines
5
5
=====================================
6
6
7
- .. default-domain:: mongodb
8
-
9
7
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
11
9
improve traffic to web pages from search engines. The following
12
10
guidance should help you optimize your documentation pages for search.
13
11
@@ -19,26 +17,29 @@ practices:
19
17
20
18
- Use a maximum of 70 characters.
21
19
22
- - Include target keywords.
20
+ - Include target keywords (the actual terms that users
21
+ enter into search engines to reach your page).
23
22
24
23
- Avoid excessive or irrelevant words (keyword stuffing).
25
24
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.
27
27
28
28
To learn more, see :ref:`titles-and-headings`.
29
29
30
30
Alternative Text
31
31
----------------
32
32
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
35
35
following SEO best practices:
36
36
37
37
- Use a maximum of 125 characters per image.
38
38
39
- - Describe the image with specific language .
39
+ - Describe the image with sufficient detail to understand what it shows .
40
40
41
- - If it makes sense, include keywords.
41
+ - If it makes sense, include keywords (the actual terms that users
42
+ enter into search engines).
42
43
43
44
To learn more, see :ref:`write-for-accessibility`.
44
45
@@ -58,27 +59,26 @@ the following best practices:
58
59
our searchers. For example, add “mongodb atlas course” instead of
59
60
“Getting Started with Atlas Data Platform”.
60
61
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`.
62
64
63
65
Descriptions
64
66
------------
65
67
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:
69
71
70
- - Make the descriptions informative (and enticing if possible).
72
+ - Use a concise description of the page content that is enticing, if
73
+ possible.
71
74
72
75
- Emphasize the “why” for using the page.
73
76
74
77
- Use a maximum of 155 characters.
75
78
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.
81
81
82
- - Use unique meta descriptions for every page.
82
+ - Use unique descriptions for every page.
83
83
84
84
To learn more, see :ref:`metadata`.
0 commit comments