Skip to content

Commit ffe131c

Browse files
authored
(DOCSP-36143): Aligned SEO guidance with Taxonomy instructions. (#167)
* (DOCSP-36143): Aligned SEO guidance with Taxonomy instructions. * (DOCSP-36143): Incorporated feedback. * (DOCSP-36143): Incorporated Chris's feedback.
1 parent 2741dae commit ffe131c

File tree

2 files changed

+51
-31
lines changed

2 files changed

+51
-31
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ services, with information about the page.
1313

1414
You can specify the ``keywords`` and ``description`` name attributes, which
1515
can help indexing pages on internal and external search engines. To learn
16-
more about how to use these name attributes, see :ref:`seo-guidelines`.
16+
more, see :ref:`seo-guidelines`.
1717

1818
.. important::
1919

20-
MongoDB Technical Writers should use the meta keyword standards defined in
21-
the "Taxonomy Tagging Instructions" internal wiki page.
20+
Use the meta keyword tag standards defined in the
21+
`Taxonomy tagging instructions <https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions>`__.
2222

2323
.. code-block:: rst
2424

source/style-guide/seo-guidelines.txt

Lines changed: 48 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,52 @@ Search Engine Optimization Guidelines
77
Search Engine Optimization (SEO) considers the actual terms that users
88
enter into search engines (keywords) and employs best practices to
99
improve traffic to web pages from search engines. The following
10-
guidance should help you optimize your documentation pages for search.
10+
guidance helps you to optimize your documentation pages for search.
11+
12+
.. important::
13+
14+
In addition to this guidance, our content taxonomy improves
15+
findability and increases relevance for search queries. To learn
16+
more about the instructions and best practices for our content
17+
taxonomy, see the `Taxonomy tagging instructions
18+
<https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions>`__.
19+
20+
Keywords
21+
--------
22+
23+
You can add the actual terms that users enter into search engines
24+
(keywords) to the body of your page to improve its SEO.
25+
26+
.. important::
27+
28+
This guidance makes a distinction between the terms "keywords" and
29+
"keyword meta tags". Here "keywords" are popular search terms added
30+
throughout the content body, and "keyword meta tags" are metadata
31+
specified with the ``.. meta::`` directive. While "keyword meta
32+
tags" are available, some search engines might ignore these tags. To
33+
learn more about "keyword meta tags", see :ref:`metadata`. We
34+
primaily use "keyword meta tags" to supplement our taxonomy. To
35+
learn more about the instructions and best practices for "keyword
36+
meta tags", see the `Taxonomy tagging instructions
37+
<https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions>`__.
38+
39+
Add keywords throughout the page copy according to the following best
40+
practices:
41+
42+
- Take the most concise form of the information that the page conveys
43+
and make that the target keyword.
44+
45+
- Avoid keywords so broad that they compete with the product page.
46+
47+
- Avoid keywords so specific that we miss the actual behavior of
48+
our searchers.
49+
50+
.. example::
51+
52+
If the terms that people search for to try to find a page are
53+
"MongoDB Atlas Course", add that phrase in at least one spot. For
54+
example, use "This MongoDB Atlas course..." instead of "This Getting
55+
Started with Atlas course...".
1156

1257
Titles
1358
------
@@ -16,8 +61,8 @@ Use the following SEO best practices for page and subsection titles:
1661

1762
- Use a maximum of 70 characters.
1863

19-
- Include target keywords (the actual terms that users
20-
enter into search engines to reach your page).
64+
- Include target keywords (the most concise form of the information
65+
that the page conveys).
2166

2267
- Avoid excessive or irrelevant words (keyword stuffing).
2368

@@ -42,31 +87,6 @@ following SEO best practices:
4287

4388
To learn more, see :ref:`write-for-accessibility`.
4489

45-
Keywords
46-
--------
47-
48-
You can add the actual terms that users enter into search engines
49-
(keywords) to your page to improve its SEO. Add keywords according to
50-
the following best practices:
51-
52-
- Take the most concise form of the information that the page conveys
53-
and make that the target keyword.
54-
55-
.. example::
56-
57-
The target keyword for the `Getting Started with MongoDB Atlas
58-
<https://learn.mongodb.com/courses/getting-started-with-mongodb-atlas>`_ University page is
59-
``mongodb atlas course``.
60-
61-
- Don't add keywords so broad that they compete with the product page.
62-
63-
- Don't add keywords so specific that we miss the actual behavior of
64-
our searchers. For example, add “mongodb atlas course” instead of
65-
“Getting Started with Atlas Data Platform”.
66-
67-
While keyword tags are available, some search engines might ignore
68-
these tags. To learn more, see :ref:`metadata`.
69-
7090
Descriptions
7191
------------
7292

0 commit comments

Comments
 (0)