DOCSP-49580 Update Titles Guidance #189
Conversation
✅ Deploy Preview for mongodb-docs-meta ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Thanks for this update @lindseymoore ! I left a small suggestion and question for your consideration
|
|
||
| - 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.
|
|
||
| Restore operations | ||
| Restore Operations |
There was a problem hiding this comment.
No action required necessarily here, but just wanted to call out that this is kind of an interesting an example because "Restore Operations" could also be read as a task / action (with "restore" being a verb).
I was wondering if maybe "Restoration Operations" might make this clearer that this is a Reference page? But "restoration" is kind of a clunkier word, so up to you.
There was a problem hiding this comment.
I didn't create this table, but I can see how this would be confusing! Changed to 'Operators and Collectors'
| - Avoid having more than two levels of sections within an article or | ||
| topic. If you use more than two levels of sections, consider whether | ||
| you can reorganize to make the structure flatter. |
There was a problem hiding this comment.
I'm not sure I understand what this means. Could you share an example?
There was a problem hiding this comment.
Changed sections to say 'headings' instead. Hopefully that makes more sense!
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/