|
| 1 | +--- |
| 2 | +title: SEO Checklist for Documentation |
| 3 | +description: Use this SEO checklist as a useful final review when you're developing new content or publishing updates to current content. |
| 4 | +ms.date: 07/27/2023 |
| 5 | +author: ps0394 |
| 6 | +ms.author: paulsanders |
| 7 | +ms.topic: contributor-guide |
| 8 | +ms.service: learn |
| 9 | +ms.custom: internal-contributor-guide |
| 10 | +--- |
| 11 | + |
| 12 | +# SEO checklist |
| 13 | + |
| 14 | +This checklist is a short reference to the basics of on-page SEO for contributors to the Learn platform. Review this checklist prior to publishing new or updated content once you do your keyword research and establish your user intent. |
| 15 | + |
| 16 | +## URL |
| 17 | + |
| 18 | +The page URL displays on the search engine results page (SERP) and contributes to both rank and relevance. The URL should: |
| 19 | + |
| 20 | +> [!div class="checklist"] |
| 21 | +> * Include the primary keyword. |
| 22 | +> * Follow the URL naming convention for your site. |
| 23 | +> * Should be 75 characters max using lowercase letters, numbers, and hyphens. |
| 24 | +> * Once chosen, it shouldn't be changed as it affects tracking and could send conflicting signals to search engines. |
| 25 | +
|
| 26 | +Learn more about [how to optimize URLs](/help/platform/seo-optimize-urls). |
| 27 | + |
| 28 | +## Meta title |
| 29 | + |
| 30 | +The meta title is displayed on the SERP and browser bar heading. It has the greatest impact on search rank and click-through-rate (CTR). The meta title isn't the same as the H1. The meta title should: |
| 31 | + |
| 32 | +> [!div class="checklist"] |
| 33 | +> * Include the primary keyword. |
| 34 | +> * Be written in title case (capitalize every word except for words like a, an, of, the, etc.) |
| 35 | +> * Be 30-65 characters in length. (The entire title is the metadata title + the metadata titleSuffix + the suffix "| Microsoft Learn." Some teams use titleSuffix to add the product name. If your team doesn't use titleSuffix then add the product brand name into the metadata title.) |
| 36 | +> * Show enough information for users to determine relevance. |
| 37 | +> * Describe a specific scenario or benefit. |
| 38 | +
|
| 39 | +Learn more about [how to optimize meta titles](/help/platform/seo-meta-title). |
| 40 | + |
| 41 | +## Meta description |
| 42 | + |
| 43 | +The meta description is a short block of text (usually one to three sentences) that gives users a preview of what your page is about. It should be a summary that entices users to click. The meta description allows the search engine and user to understand the page content. The meta description should: |
| 44 | + |
| 45 | +> [!div class="checklist"] |
| 46 | +> * Include the primary keyword. |
| 47 | +> * Be between 120 and 165 characters including spaces. |
| 48 | +> * Describe the specific scenario and/or benefit of the article. |
| 49 | +> * Entice users to click through to the page. |
| 50 | +> * Include a call-to-action to improve the click-through-rate. |
| 51 | +
|
| 52 | +Learn more about [how to optimize meta descriptions](/help/platform/seo-meta-description). |
| 53 | + |
| 54 | +## Main heading (H1) |
| 55 | + |
| 56 | +The H1 is the main heading at the top of the article. H1 is the second most important text string for search rank and relevance. They also help crawlers and copilots make sense of the page content. H1 isn't the same as the meta title. The H1 should: |
| 57 | + |
| 58 | +> [!div class="checklist"] |
| 59 | +> * Include the primary keyword. |
| 60 | +> * Be unique and specific (although it's acceptible to copy the meta title). |
| 61 | +
|
| 62 | +Learn more about [how to optimize main headings](/help/platform/seo-main-headings). |
| 63 | + |
| 64 | +## Introduction |
| 65 | + |
| 66 | +The introduction is the first paragraph of the article. It should explain what the article is about and show the benefit to the user. It also helps crawlers and copilots make sense of the page content. The introduction should: |
| 67 | + |
| 68 | +> [!div class="checklist"] |
| 69 | +> * Include the primary keyword in the first or second sentence. |
| 70 | +> * Describe what the article is about early in the paragraph. |
| 71 | +> * Describe the specific scenario and/or benefit of the article. |
| 72 | +> * Be clear and concise. |
| 73 | +
|
| 74 | +Learn more about [how to optimize introductions](/help/platform/seo-page-content-structure). |
| 75 | + |
| 76 | +## Subheadings (H2-H3) |
| 77 | + |
| 78 | +H2s divide the primary sections on a page. Search engines often display H2s as extra links below the meta description. They also help crawlers and copilots make sense of the page content. Subheadings should: |
| 79 | + |
| 80 | +> [!div class="checklist"] |
| 81 | +> * Include secondary keywords. |
| 82 | +> * Be descriptive of a section's content. |
| 83 | +> * Use a heading hierarchy (H2-H3) without skipping a level. |
| 84 | +
|
| 85 | +Learn more about [how to optimize subheadings](/help/platform/seo-page-content-structure). |
| 86 | + |
| 87 | +## Image alt text |
| 88 | + |
| 89 | +Although alt text is primarily an accessibility feature, it can also improve SEO. Alt text can get a page one result in the image carousel, even if your article isn't on page one of the search results otherwise. Alt text should: |
| 90 | + |
| 91 | +> [!div class="checklist"] |
| 92 | +> * Include the primary keyword and/or secondary keywords when possible. |
| 93 | +> * Describe the contents of the image clearly and concisely. |
| 94 | +> * Be between 40 to 150 characters. |
| 95 | +> * Increase accessibility for users. |
| 96 | +> * Avoid language like “image of” or "picture of." |
| 97 | +
|
| 98 | +Learn more about [how to optimize image alt text](/help/platform/seo-page-content-structure). |
| 99 | + |
| 100 | +## Image filenames |
| 101 | + |
| 102 | +Like alt text, image filenames can get a page one result in the image carousel, even if your article isn't on page one of the search results otherwise. Image filenames should: |
| 103 | + |
| 104 | +> [!div class="checklist"] |
| 105 | +> * Include the primary keyword and/or secondary keywords. |
| 106 | +> * Use letters, numbers, and hyphens only. |
| 107 | +> * Be a maximum of 80 characters including spaces. |
| 108 | +> * Describe the image. |
| 109 | +
|
| 110 | +Learn more about [how to optimize image filenames](/help/platform/seo-page-content-structure). |
| 111 | + |
| 112 | +## Search Results Preview |
| 113 | +The Learn Authoring Pack for Visual Studio Code now includes a Search Results Preview to help verify your title and description are helpful to users when returned in search results. |
| 114 | + |
| 115 | +> [!div class="checklist"] |
| 116 | +> * Access the Command Palette with **ALT + M**. |
| 117 | +> * Select **Search Results Preview**. |
| 118 | +
|
| 119 | +Learn more about the [anatomy of a webpage](/help/platform/seo-anatomy-webpage). |
0 commit comments