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 site configuration. |
There was a problem hiding this comment.
Thanks for this update @lindseymoore ! I left a small suggestion and question for your consideration
| Title Length | ||
| ~~~~~~~~~~~~ | ||
|
|
||
| Titles should be between 30-60 character long. Pages with titles longer than 60 characters |
There was a problem hiding this comment.
| Titles should be between 30-60 character long. Pages with titles longer than 60 characters | |
| Titles should be between 30-60 characters long. Pages with titles longer than 60 characters |
|
|
||
| - 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.
| 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.
|
|
||
| - Use a consistent grammatical structure for the titles and headings of | ||
| specific types of content: | ||
| Use a consistent grammatical structure for the titles and headings of |
There was a problem hiding this comment.
[q] Outside of the diff here, but should the examples in this table use the capitalization approach in the style guide? It's a little confusing that they're in sentence case.
| General Style and Structure | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The following guidelines apply to all titles and headings; |
There was a problem hiding this comment.
| The following guidelines apply to all titles and headings; | |
| The following guidelines apply to all titles and headings: |
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