You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/contributing/style-guide-and-content-model/style-guide.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -534,7 +534,15 @@ Formatting unordered lists:
534
534
- If the order of items in the list is not important, alphabetize the list items.
535
535
- 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).
536
536
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:
Copy file name to clipboardExpand all lines: contributing/content-model.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Content model for GitHub Docs
2
2
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.
4
4
5
5
_Full TOC :arrow_upper_left:_
6
6
@@ -36,7 +36,7 @@ The homepage includes all top-level doc sets and some categories. Content on the
36
36
37
37
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.
38
38
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.
40
40
41
41
If a category serves as the starting point for using a GitHub product or feature, it can be added to the homepage.
42
42
@@ -71,7 +71,7 @@ Categories are usually organized around a feature or a discrete set of tasks wit
71
71
- Examples
72
72
-[Setting up and managing your GitHub user account](https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account)
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.
77
77
@@ -106,12 +106,12 @@ We organize content predictably within categories, map topics, and articles, fro
106
106
- Procedural content on using a feature
107
107
- Procedural content on managing a feature or setting
108
108
- 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)
110
110
- Troubleshooting information
111
111
112
112
### Titles
113
113
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.
115
115
116
116
Titles are challenging! Use these general guidelines to help create clear, helpful, and descriptive titles. See below for specific guidelines for each content type.
117
117
@@ -121,7 +121,7 @@ Titles are challenging! Use these general guidelines to help create clear, helpf
121
121
- Use: Example of configuring a codespace
122
122
- Avoid: Using the workflow editor sidebar
123
123
- 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):
125
125
- Category titles: 67 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 27 characters
- 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
195
195
We create conceptual articles and conceptual sections within other articles. Most major products, features, or subjects have their own conceptual article.
196
196
197
197
#### 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.
199
199
200
200
- Describe in plain language what the feature, product, or topic is
201
201
- 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
288
288
289
289
### Release notes
290
290
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.
292
292
293
293
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.
294
294
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.
296
296
297
297
#### Types of releases
298
298
@@ -321,7 +321,7 @@ Use known issues to explain the following situations.
321
321
- Behavior that regularly prevents the use of the product or feature for a common purpose.
322
322
- 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.
323
323
324
-
#### How to write troubleshooting content
324
+
#### How to write troubleshooting content
325
325
- Use any GitHub Docs content type to create troubleshooting sections.
326
326
- Whenever possible, keep troubleshooting content contained within procedural content or guides.
327
327
- 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
405
405
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.
406
406
407
407
#### 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.
409
409
410
410
Contents of tutorials:
411
411
- Introduction
@@ -481,7 +481,7 @@ Use the product callout when a feature is available in specific products only an
481
481
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.
482
482
483
483
#### 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.
485
485
- Product callouts also include a link to "GitHub’s products” and occasionally to another relevant article.
486
486
- Examples:
487
487
-[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,
502
502
- Map topic and category intros are one sentence long.
503
503
- API reference intros are one sentence long.
504
504
- 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.
507
507
- 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.
509
509
- When a term in the intro has an acronym we’ll use elsewhere in the article, indicate the acronym.
510
510
- Intros generally don't contain permissions for any tasks contained within the article.
511
511
@@ -516,8 +516,8 @@ Every procedure includes a permissions statement explaining the role required to
516
516
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).
517
517
518
518
#### 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.
521
521
- Don't include permissions in an article’s intro.
522
522
- 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.
523
523
- Language to use in a permissions statement:
@@ -573,7 +573,7 @@ Troubleshooting content helps people avoid or work through errors. See "[Trouble
573
573
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.
574
574
575
575
#### How to write a further reading section
576
-
- Use a bulleted list.
576
+
- Use a bulleted list.
577
577
- Use further reading sections sparingly and when they provide high value - see style guide for guidelines on linking.
578
578
579
579
#### Title and format for further reading sections
Copy file name to clipboardExpand all lines: contributing/content-style-guide.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Content style guide for GitHub Docs <!-- omit in toc -->
2
2
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.
4
4
5
5
Welcome to the content style guide for [GitHub Docs](https://docs.github.com/).
0 commit comments