Skip to content

Commit 3f2b79e

Browse files
authored
Add info on topics to content model (#23834)
* Add section on topics * Add checklist to help choose topics
1 parent b486966 commit 3f2b79e

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

contributing/content-model.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,44 @@ Titles are challenging! Use these general guidelines to help create clear, helpf
107107
- Map topic titles: 63 characters and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 30 characters
108108
- Article titles: 80 characters, 60 if possible, and [`shortTitle`](https://github.com/github/docs/tree/main/content#shorttitle) < 31 characters, ideally 20-25 characters
109109

110+
### Topics
111+
112+
Topics are used to filter articles and are searchable across the docs site. For some layouts, such as landing pages or guides, people can select which articles are displayed by filtering topics. Use these guidelines to help choose which topics to add to an article's frontmatter. For more information on adding topics to an article see, "[Topics](https://github.com/github/docs/tree/main/content#topics)" and for a list of all allowed topics, see [`allowed-topics`](https://github.com/github/docs/blob/main/data/allowed-topics.js).
113+
114+
#### Topics for all content types
115+
- All articles should have at least one topic
116+
- Use nouns as topics
117+
- Topics help customers meaningfully group content
118+
- When possible, use more specific topics that are relevant and not just broad topics. For example, `REST` or `GraphQL` rather than just `API`
119+
- Ensure that topics on similar articles are consistent so that people who filter by a topic get all of the relevant articles. For example, all articles about CI should have the `CI` topic plus more specific topics
120+
- Avoid ambiguous topics. For example, `Actions` may not be a useful topic within the Actions product since it could refer to the product GitHub Actions or the product element called an action
121+
- Topics add value beyond and do not replicate the article’s title, type, or category
122+
- For example, within the Actions product, `Actions` does not add value since a customer already knows they are looking at Actions docs
123+
- Use `Fundamentals` for articles related to the core concepts of a product area.
124+
- Use: `Fundamentals` in an article like “Introduction to GitHub Actions”
125+
- Avoid: `Actions` in an article like "Introduction to GitHub Actions"
126+
- Commonly-recognized abbreviations can be used, but obscure or ambiguous abbreviations should be avoided
127+
- Use: `CI` instead of `Continuous integration`
128+
- Avoid: `AS` instead of `Advanced Security`
129+
- Use the short forms of GitHub product names
130+
- Use: `Actions` instead of `GitHub Actions`
131+
132+
#### Checklist for choosing topics
133+
Consider these questions to help choose topics for an article. Not every article will have a topic for each item in the checklist.
134+
135+
- [ ] What is the feature or product area?
136+
- Example: `Enterprise`
137+
- [ ] Is the article about a sub-feature (unless the product name matches the feature name)?
138+
- Example: `Dependabot`
139+
- [ ] Is the feature part of a restricted program?
140+
- Example: `Advanced Security`
141+
- [ ] What element of the feature or product is the article?
142+
- Example: `Organizations`
143+
- [ ] What is the broad purpose of the article?
144+
- Example: `Permissions`
145+
- [ ] What programming languages, package managers, or ecosystems does the article explicitly address? (Note: only include these topics if it adds value to someone filtering the docs, not just if an article lists supported languages, package managers, or ecosystems.)
146+
- Example: `Ruby`
147+
110148
### Reusing content
111149

112150
We use reusable and variable strings to use the same chunk of content, such as a procedural step or a conceptual paragraph, in multiple places. We generally don't reuse large sections of articles without a specific reason. When an entire section of an article might be relevant in more than one article, take a look at the purpose of both. Is there an opportunity to create a single, long-form article? Refer to the content models to clarify the best permanent home for the information, and link to it from the other article.

0 commit comments

Comments
 (0)