DOCSP-49580 Update Titles Guidance #189
Merged
+195
−85
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for mongodb-docs-meta ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
sarahemlin
reviewed
May 12, 2025
sarahemlin
approved these changes
May 12, 2025
ltran-mdb2
reviewed
May 12, 2025
There was a problem hiding this comment.
Thanks for this update @lindseymoore ! I left a small suggestion and question for your consideration
stephmarie17
approved these changes
May 13, 2025
|
|
||
| - Disambiguation | ||
|
|
||
| Each of the following four subsections describe one of the above principles. |
There was a problem hiding this comment.
[s] Would it be possible to include an example for each principle (use vs don't use)? Might be helpful for writers who haven't started updating titles yet to see the difference.
There was a problem hiding this comment.
I tried to provide an example in each section. More in depth examples might require a whole subsection because I would have to set up a scenario for each example. Let's see if the rest of the reviewers think deeper examples are necessary!
| Use the guidelines in the following subsections to create effective and consistent | ||
| titles and headings. Special considerations for stand-alone articles, product | ||
| guides, and tables, figures, and examples can be found in the Product Guides and | ||
| Tables, Figures, and Headings subsections. |
There was a problem hiding this comment.
[s] Suggestion to add some ref links here.
jeff-allen-mongo
approved these changes
Jun 13, 2025
corryroot
requested changes
Jun 20, 2025
There was a problem hiding this comment.
Great work, @lindseymoore! I added some comments to make these guidelines more active and concise.
Comment on lines
93
to
99
| When considering title length, keep in mind that the product name, version | ||
| number, and "MongoDB Docs" are automatically appended when the title is passed | ||
| to a search engine. For example, for a v8.0 Server Manual page titled | ||
| "Install MongoDB", the title is 15 characters long. The full title passed to search | ||
| engines ("Install MongoDB - Database Manual v8.0 - MongoDB Docs") is 53 characters long. | ||
| The appended additions to the title can add around 18-35 | ||
| characters to the title, depending on the length of the product name. |
There was a problem hiding this comment.
Suggested change
| When considering title length, keep in mind that the product name, version | |
| number, and "MongoDB Docs" are automatically appended when the title is passed | |
| to a search engine. For example, for a v8.0 Server Manual page titled | |
| "Install MongoDB", the title is 15 characters long. The full title passed to search | |
| engines ("Install MongoDB - Database Manual v8.0 - MongoDB Docs") is 53 characters long. | |
| The appended additions to the title can add around 18-35 | |
| characters to the title, depending on the length of the product name. | |
| When you consider title length, remember that the product name, version | |
| number, and "MongoDB Docs" are automatically appended to the title as it passes | |
| to a search engine. For example, for a v8.0 Server Manual page titled | |
| "Install MongoDB", the title is 15 characters long. The full title that passes to search | |
| engines ("Install MongoDB - Database Manual v8.0 - MongoDB Docs") is 53 characters long. | |
| The appended additions to the title can add about 18-35 | |
| characters to the title, depending on the length of the product name. |
There was a problem hiding this comment.
Changed language to 'when passed to a search engine'. Let me if you have any further thoughts on this!
Comment on lines
19
to
24
| Why Do Page Titles Matter? | ||
| -------------------------- | ||
|
|
||
| A page title is weighted as most relevant to a user's search engine query. Name | ||
| pages appropriately to ensure users can find relevant content in the MongoDB | ||
| Documentation when using a search engine. |
There was a problem hiding this comment.
I think this belongs on the SEO page because title matter for more reasons than described.
Suggested change
| Why Do Page Titles Matter? | |
| -------------------------- | |
| A page title is weighted as most relevant to a user's search engine query. Name | |
| pages appropriately to ensure users can find relevant content in the MongoDB | |
| Documentation when using a search engine. | |
| Why Do Page Titles Matter for SEO? | |
| ------------------------------------ | |
| Search engines weight page titles heavily. Name pages appropriately to ensure users can find relevant content in the MongoDB Documentation when they use a search engine. |
There was a problem hiding this comment.
Used this paragraph as the intro for the Titles section on the SEO page.
Comment on lines
90
to
93
| Use the guidelines in the following subsections to create effective and consistent | ||
| titles and headings. Special considerations for stand-alone articles, product | ||
| guides, and tables, figures, and examples can be found in the Product Guides and | ||
| Tables, Figures, and Headings subsections. |
There was a problem hiding this comment.
Yes, use ref links.
Suggested change
| Use the guidelines in the following subsections to create effective and consistent | |
| titles and headings. Special considerations for stand-alone articles, product | |
| guides, and tables, figures, and examples can be found in the Product Guides and | |
| Tables, Figures, and Headings subsections. | |
| Use the guidelines in the following subsections to create effective and consistent | |
| titles and headings. You can find special considerations for stand-alone articles, product | |
| guides, tables, figures, and examples in the Product Guides and | |
| Tables, Figures, and Headings subsections. |
🔄 Deploy Preview for mongodb-docs-meta processing
|
corryroot
approved these changes
Jun 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
JIRA URL: https://jira.mongodb.org/browse/DOCSP-49580
Staging URL: https://deploy-preview-189--mongodb-docs-meta.netlify.app/style-guide/style/titles-and-headings/#titles-and-headings
https://deploy-preview-189--mongodb-docs-meta.netlify.app/style-guide/seo-guidelines/