Skip to content

Commit b45145e

Browse files
authored
Clarify guidance on introducing lists with "the following" and "these" (#45186)
1 parent 29360c7 commit b45145e

3 files changed

Lines changed: 28 additions & 20 deletions

File tree

content/contributing/style-guide-and-content-model/style-guide.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -534,7 +534,15 @@ Formatting unordered lists:
534534
- If the order of items in the list is not important, alphabetize the list items.
535535
- If the order is important, then order the list by the importance to the reader (for example, moving from broadest audience and applicability to a more specialized audience).
536536
537-
When introducing a list, avoid phrasing like “the following” or “these”, terms which are difficult to localize. Instead, be descriptive, yet general enough to allow a list to scale or change without having to update the description.
537+
When introducing a list, avoid short, nonspecific sentences using terms like “the following” or “these”, which are difficult to localize without context. Instead, create a descriptive sentence that clearly conveys the subject of the list, yet allows the list to scale or change without having to update the description.
538+
539+
**Use:**
540+
- For an introduction to {% data variables.product.prodname_dotcom %}, see the following articles:
541+
- SMS authentication is supported in these countries:
542+
543+
**Avoid:**
544+
- There are several articles that provide an introduction to {% data variables.product.prodname_dotcom %}. See the following:
545+
- SMS authentication is supported in 50 countries. These include:
538546
539547
## Placeholders
540548

contributing/content-model.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Content model for GitHub Docs
22

3-
**Note:** This version of the content model is no longer maintained and will be deprecated. See the [style guide](https://docs.github.com/en/contributing/writing-for-github-docs/style-guide) on docs.github.com for the most up to date version. Open any pull requests against the `contributing/writing-for-github-docs/style-guide.md` file.
3+
**Note:** This version of the content model is no longer maintained and will be deprecated. See the [content model](https://docs.github.com/contributing/style-guide-and-content-model/content-model) on docs.github.com for the most up-to-date version. Open any pull requests against the `contributing/style-guide-and-content-model/content-model.md` file.
44

55
_Full TOC :arrow_upper_left:_
66

@@ -36,7 +36,7 @@ The homepage includes all top-level doc sets and some categories. Content on the
3636

3737
The goal of the homepage is to help people find information about the GitHub feature or product that they want to learn about. Every item on the homepage dilutes the discoverability of every other item, so we limit the number of doc sets included on the homepage.
3838

39-
If a new top-level doc set is created, it is added to the homepage.
39+
If a new top-level doc set is created, it is added to the homepage.
4040

4141
If a category serves as the starting point for using a GitHub product or feature, it can be added to the homepage.
4242

@@ -71,7 +71,7 @@ Categories are usually organized around a feature or a discrete set of tasks wit
7171
- Examples
7272
- [Setting up and managing your GitHub user account](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account)
7373
- [Installing GitHub Enterprise](https://docs.github.com/en/enterprise-server@3.0/admin/installation)
74-
74+
7575
#### Intros for categories
7676
All categories have intros. Keep the intros one sentence long, and general or high-level enough to scale with future product changes without having to remember to update the intro. If you significantly change a category’s structure, check its intro for needed updates.
7777

@@ -106,12 +106,12 @@ We organize content predictably within categories, map topics, and articles, fro
106106
- Procedural content on using a feature
107107
- Procedural content on managing a feature or setting
108108
- Procedural content on disabling a feature or setting
109-
- Procedural content on destructive actions (e.g. deletion)
109+
- Procedural content on destructive actions (e.g. deletion)
110110
- Troubleshooting information
111111

112112
### Titles
113113

114-
Titles fully describe what a page is about, and what a user will know by reading it.
114+
Titles fully describe what a page is about, and what a user will know by reading it.
115115

116116
Titles are challenging! Use these general guidelines to help create clear, helpful, and descriptive titles. See below for specific guidelines for each content type.
117117

@@ -121,7 +121,7 @@ Titles are challenging! Use these general guidelines to help create clear, helpf
121121
- Use: Example of configuring a codespace
122122
- Avoid: Using the workflow editor sidebar
123123
- Avoid: Example
124-
- Titles have hard limits for length to keep them easy to understand (and easier to render on the site):
124+
- Titles have hard limits for length to keep them easy to understand (and easier to render on the site):
125125
- Category titles: 67 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 27 characters
126126
- Map topic titles: 63 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 30 characters
127127
- Article titles: 80 characters, 60 if possible, and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 31 characters, ideally 20-25 characters
@@ -195,7 +195,7 @@ Conceptual content helps people understand a feature or topic by providing a cle
195195
We create conceptual articles and conceptual sections within other articles. Most major products, features, or subjects have their own conceptual article.
196196

197197
#### How to write conceptual content
198-
Use the [conceptual content template](https://github.com/github/docs/blob/main/contributing/content-templates.md#conceptual) to write a conceptual article.
198+
Use the [conceptual content template](https://github.com/github/docs/blob/main/contributing/content-templates.md#conceptual) to write a conceptual article.
199199

200200
- Describe in plain language what the feature, product, or topic is
201201
- Describe its purpose and why it’s useful to the reader
@@ -288,11 +288,11 @@ Use the [procedural content template](https://github.com/github/docs/blob/main/c
288288

289289
### Release notes
290290

291-
Release notes enable readers to understand and prepare for the customer-facing changes in each release of GitHub's versioned enterprise products (e.g., GitHub Enterprise Server). Good release notes provide administrators the necessary information to plan system upgrades in environments that require change control, and support end users who want to understand and prepare to use new GitHub features and functionality.
291+
Release notes enable readers to understand and prepare for the customer-facing changes in each release of GitHub's versioned enterprise products (e.g., GitHub Enterprise Server). Good release notes provide administrators the necessary information to plan system upgrades in environments that require change control, and support end users who want to understand and prepare to use new GitHub features and functionality.
292292

293293
Writers source, edit, and publish release notes in collaboration with product DRIs, feature owners, and individual engineers at GitHub. For each individual release, we group release notes by predefined types.
294294

295-
We publish the release notes for [GitHub Enterprise Server](https://docs.github.com/enterprise-server/admin/release-notes) (GHES) and [GitHub AE](https://docs.github.com/github-ae@latest/admin/release-notes) (GHAE) on GitHub Docs, in the "Enterprise administrators" documentation set.
295+
We publish the release notes for [GitHub Enterprise Server](https://docs.github.com/enterprise-server/admin/release-notes) (GHES) and [GitHub AE](https://docs.github.com/github-ae@latest/admin/release-notes) (GHAE) on GitHub Docs, in the "Enterprise administrators" documentation set.
296296

297297
#### Types of releases
298298

@@ -321,7 +321,7 @@ Use known issues to explain the following situations.
321321
- Behavior that regularly prevents the use of the product or feature for a common purpose.
322322
- Rare or severe bugs that GitHub has not yet prioritized fixing, and that are not explained in the product or by existing content on GitHub Docs.
323323

324-
#### How to write troubleshooting content
324+
#### How to write troubleshooting content
325325
- Use any GitHub Docs content type to create troubleshooting sections.
326326
- Whenever possible, keep troubleshooting content contained within procedural content or guides.
327327
- You can create a troubleshooting article when it makes sense to keep it separate, such as when there’s a large amount of troubleshooting content on a particular topic.
@@ -405,7 +405,7 @@ Tutorials help people learn about products and solve real world problems by guid
405405
Tutorials are useful when someone has a basic understanding of the product and is interested in extending their understanding to solve a specific problem. Tutorials are for people who want expert advice and a detailed discussion of best practices related to their problem. Tutorials also help people who've implemented similar solutions in the past with other products use GitHub. Tutorials can also help people validate whether the solution is appropriate for their needs.
406406

407407
#### How to write a tutorial
408-
Use the [tutorial template](https://github.com/github/docs/blob/main/contributing/content-templates.md#tutorial) to create a tutorial.
408+
Use the [tutorial template](https://github.com/github/docs/blob/main/contributing/content-templates.md#tutorial) to create a tutorial.
409409

410410
Contents of tutorials:
411411
- Introduction
@@ -481,7 +481,7 @@ Use the product callout when a feature is available in specific products only an
481481
All product callouts are stored as reusables in [`gated-features`](https://github.com/github/docs/tree/main/data/reusables/gated-features) and added in YAML frontmatter for relevant articles.
482482

483483
#### How to write a product callout
484-
- Product callouts follow a strict format, clearly identifying the feature and which products it’s available in.
484+
- Product callouts follow a strict format, clearly identifying the feature and which products it’s available in.
485485
- Product callouts also include a link to "GitHub’s products” and occasionally to another relevant article.
486486
- Examples:
487487
- [Feature name] is available in [product(s)]. For more information, see "GitHub’s products.”
@@ -502,10 +502,10 @@ The top of every page has an intro that provides context and sets expectations,
502502
- Map topic and category intros are one sentence long.
503503
- API reference intros are one sentence long.
504504
- The intro for an API page should define the feature so that a user knows whether the feature meets their needs without reading the entire article.
505-
- Intros contain a high-level summary of the page’s content, developing the idea presented in a title with more detail.
506-
- Use approachable synonyms of words in the page’s title to help readers understand the article’s purpose differently. Avoid repeating words from the title when possible.
505+
- Intros contain a high-level summary of the page’s content, developing the idea presented in a title with more detail.
506+
- Use approachable synonyms of words in the page’s title to help readers understand the article’s purpose differently. Avoid repeating words from the title when possible.
507507
- Intros are relatively evergreen and high-level, so they can scale with future changes to the content on the page without needing to be frequently updated.
508-
- For searchability, include keywords on the page's subject in the intro.
508+
- For searchability, include keywords on the page's subject in the intro.
509509
- When a term in the intro has an acronym we’ll use elsewhere in the article, indicate the acronym.
510510
- Intros generally don't contain permissions for any tasks contained within the article.
511511

@@ -516,8 +516,8 @@ Every procedure includes a permissions statement explaining the role required to
516516
Occasionally, it's relevant to mention required permissions in conceptual content, especially in standalone conceptual articles. Make sure to also include a permissions statement in related procedures (or write a longer article combining all of the content).
517517

518518
#### How to write a permissions statement
519-
- When a single set of permissions applies to all procedures in an article, use the [permissions frontmatter](https://github.com/github/docs/tree/main/content#permissions).
520-
- When an article contains multiple procedures and different permissions apply, include a separate permissions statement under each relevant header, before each procedure.
519+
- When a single set of permissions applies to all procedures in an article, use the [permissions frontmatter](https://github.com/github/docs/tree/main/content#permissions).
520+
- When an article contains multiple procedures and different permissions apply, include a separate permissions statement under each relevant header, before each procedure.
521521
- Don't include permissions in an article’s intro.
522522
- Roles exist at different levels. Refer only to the role at the same level as the action. For example, you need admin access to a repository (repository-level role) to configure protected branches. You can get admin access to a repository by being an organization owner (organization-level role), but the repository-level role is what actually governs your ability to take the action, so that is the only role that should be mentioned in the permissions statement.
523523
- Language to use in a permissions statement:
@@ -573,7 +573,7 @@ Troubleshooting content helps people avoid or work through errors. See "[Trouble
573573
Further reading sections highlight additional targeted articles that aren’t already included within the article’s content or sidebar. Use further reading sections sparingly when they provide real value.
574574

575575
#### How to write a further reading section
576-
- Use a bulleted list.
576+
- Use a bulleted list.
577577
- Use further reading sections sparingly and when they provide high value - see style guide for guidelines on linking.
578578

579579
#### Title and format for further reading sections

contributing/content-style-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Content style guide for GitHub Docs <!-- omit in toc -->
22

3-
**Note:** This version of the style guide is no longer maintained and will be deprecated. See the [content model](https://docs.github.com/en/contributing/writing-for-github-docs/content-model) on docs.github.com for the most up to date version. Open any pull requests against the `contributing/writing-for-github-docs/content-model.md` file.
3+
**Note:** This version of the style guide is no longer maintained and will be deprecated. See the [style guide](https://docs.github.com/contributing/style-guide-and-content-model/style-guide) on docs.github.com for the most up-to-date version. Open any pull requests against the `contributing/style-guide-and-content-model/style-guide.md` file.
44

55
Welcome to the content style guide for [GitHub Docs](https://docs.github.com/).
66

0 commit comments

Comments
 (0)