|
| 1 | +.. _seo-guidelines: |
| 2 | + |
| 3 | +===================================== |
| 4 | +Search Engine Optimization Guidelines |
| 5 | +===================================== |
| 6 | + |
| 7 | +.. default-domain:: mongodb |
| 8 | + |
| 9 | +Search Engine Optimization (SEO) considers the actual terms that users |
| 10 | +enter into serach engines (keywords) and employs best practices to |
| 11 | +improve traffic to web pages from search engines. The following |
| 12 | +guidance should help you optimize your documentation pages for search. |
| 13 | + |
| 14 | +Titles |
| 15 | +------ |
| 16 | + |
| 17 | +Title pages and subsections according to the following SEO best |
| 18 | +practices: |
| 19 | + |
| 20 | +- Use a maximum of 70 characters. |
| 21 | + |
| 22 | +- Include target keywords. |
| 23 | + |
| 24 | +- Avoid excessive or irrelevant words (keyword stuffing). |
| 25 | + |
| 26 | +- Use a unique title for every page. |
| 27 | + |
| 28 | +To learn more, see :ref:`titles-and-headings`. |
| 29 | + |
| 30 | +Alternative Text |
| 31 | +---------------- |
| 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 |
| 35 | +following SEO best practices: |
| 36 | + |
| 37 | +- Use a maximum of 125 characters per image. |
| 38 | + |
| 39 | +- Describe the image with specific language. |
| 40 | + |
| 41 | +- If it makes sense, include keywords. |
| 42 | + |
| 43 | +To learn more, see :ref:`write-for-accessibility`. |
| 44 | + |
| 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 | +- Don't add keywords so broad that they compete with the product page. |
| 56 | + |
| 57 | +- Don't add keywords so specific that we miss the actual behavior of |
| 58 | + our searchers. For example, add “mongodb atlas course” instead of |
| 59 | + “Getting Started with Atlas Data Platform”. |
| 60 | + |
| 61 | +To learn more, see :ref:`metadata`. |
| 62 | + |
| 63 | +Descriptions |
| 64 | +------------ |
| 65 | + |
| 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: |
| 69 | + |
| 70 | +- Make the descriptions informative (and enticing if possible). |
| 71 | + |
| 72 | +- Emphasize the “why” for using the page. |
| 73 | + |
| 74 | +- Use a maximum of 155 characters. |
| 75 | + |
| 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. |
| 81 | + |
| 82 | +- Use unique meta descriptions for every page. |
| 83 | + |
| 84 | +To learn more, see :ref:`metadata`. |
0 commit comments