(DOCSP-29016): Added SEO guidelines. #144
Conversation
corryroot
requested review from
jeff-allen-mongo,
ccho-mongodb and
lindseymoore
corryroot
force-pushed
the
DOCSP-29016
branch
2 times, most recently
from
91d64e8 to
c0ffca5
Compare
| You can add the actual terms that users enter into search engines | ||
| (keywords) to your page to improve its SEO. Add keywords according to | ||
| the following best practices: |
There was a problem hiding this comment.
Suggestion:
I think it might be better to suggest that keywords may not help SEO nor be used to match up with search terms, at least with Google. See
https://developers.google.com/search/docs/crawling-indexing/special-tags#unsupported
for more info.
There was a problem hiding this comment.
Yes, there are two parts to these recommendations. We should use the language that users search for in our content. But, search engines might not account for the keyword tags that we use.
|
|
||
| - Use a maximum of 155 characters. | ||
|
|
||
| - Include target keywords and a call to action. |
There was a problem hiding this comment.
Question:
I thought Call to Action (CTA) is usually a UI element such as a button that contains text that prompts a user to do do something such as click. I don't think that's something you can include in a text tag. If it's something else, could that be explained here?
There was a problem hiding this comment.
We want to call the user to action with the description that appears in the search result.
There was a problem hiding this comment.
Not a blocker for me, but maybe including an example could be helpful. Does this mean including text like "Click here to learn more" in the meta description?
There was a problem hiding this comment.
@corryroot thanks for this update. As someone who knows very little about SEO, this is super helpful and I learned a lot reading it. I left a couple comments and suggestions for your consideration.
Jeff
| ======================== | ||
| Page Metadata Directives | ||
| ======================== | ||
|
|
||
| meta | ||
| ---- | ||
|
|
||
| Generates HTML ``<meta>`` tags. | ||
| Use ``.. meta::`` to add |html| meta tags to a page. Adding meta tags | ||
| aids in searches both internally and via the Internet. You can add both |
There was a problem hiding this comment.
[issue]
Our style guide suggests avoiding "via". Maybe consider "through the Internet" instead?
Style guide link: https://www.mongodb.com/docs/meta/style-guide/terminology/alphabetical-terms/#v
| Titles | ||
| ------ | ||
|
|
||
| Title pages and subsections according to the following SEO best |
There was a problem hiding this comment.
[suggestion, wording]
It wasn't immediately clear to me that we're using "title" as a verb in this sentence. On initial reading I thought "title page" was a noun. Perhaps we can tweak this to something like:
"Use the following SEO best practices for page and subsection titles: "
| - Take the most concise form of the information that the page conveys | ||
| and make that the target keyword. |
There was a problem hiding this comment.
[suggestion, non-blocking]
Would it be possible to include an example of this practice? For instance, I would find it helpful if we provided a link to some docs page and highlighted what the target keyword would be for that page.
| - If it makes sense, include keywords (the actual terms that users | ||
| enter into search engines). |
There was a problem hiding this comment.
[question]
The phrase "if it makes sense" makes me wonder in which situations this practice doesn't make sense. Is that something we can possibly clarify a bit here?
There was a problem hiding this comment.
I guess it's a question about whether the keywords for the page really apply to the image. I can think of examples where they might not. I'll change the wording to "If they apply to the image..."
|
Elizabeth Baggan approved this PR on Slack. |
Pull Request Process
Please read the
Style Guide Review Process
wiki page.
Contributors should take the following actions:
they will merge the PR and notify you of the merge in the Slack channel.
Pull Request Description
I created this PR in relation to #118. I incorporated the guidance that Cloud Docs received from the SEO team.
JIRA
STAGE
BUILD