Статью можно определить как релевантную для одной или нескольких тем, указав эти темы, перечисленные в frontmatter статьи. Например:
---
title: "Managing branches in your repository"
topics:
- "GitHub"
- "Git"
- "Repositories"
---
Дополнительные сведения о добавлении тем в статью см. в разделе "Использование frontmatter YAML". Список всех разрешенных разделов см. в разделе allowed-topics
.
Разделы для всех типов контента
- Использование существительных в качестве разделов
- Разделы помогают людям осмысленно группировать содержимое
- По возможности используйте более конкретные темы, которые являются актуальными и не только широкими. Например, или
GraphQL
вместо того,REST
чтобы простоAPI
- Убедитесь, что разделы по аналогичным статьям согласованы таким образом, чтобы пользователи, которые фильтрулись по теме, получают все соответствующие статьи. Например, все статьи о CI должны содержать
CI
раздел, а также более конкретные темы - Избегайте неоднозначных тем. Например, не может быть полезным разделом в продукте Actions,
Actions
так как он может ссылаться на продукт GitHub Actions или элемент продукта, называемый действием
- По возможности используйте более конкретные темы, которые являются актуальными и не только широкими. Например, или
- Разделы добавляют значение за пределы и не реплицируют название, тип или категорию статьи
- Например, в продукте Actions не добавляется значение,
Actions
так как кто-то в этом разделе документации уже знает, что они смотрят на документы Actions
- Например, в продукте Actions не добавляется значение,
- Используйте
Fundamentals
статьи, связанные с основными понятиями области продукта.- Использование:
Fundamentals
в статье,например "Введение в GitHub Actions" - Избегайте:
Actions
в статье,например "Введение в GitHub Actions"
- Использование:
- Часто распознаваемые аббревиатуры можно использовать, но неясные или неоднозначные аббревиатуры следует избегать
- Использование:
CI
вместоContinuous integration
- Избегайте:
AS
вместоAdvanced Security
- Использование:
- Используйте короткие формы имен продуктов GitHub
- Использование:
Actions
вместоGitHub Actions
- Использование:
Контрольный список для выбора тем
Рассмотрим эти вопросы, чтобы помочь выбрать темы для статьи. Не каждая статья содержит раздел для каждого элемента в контрольном списке.
- Что такое функция или область продукта?
- Пример:
Enterprise
статья о подфункционе (если имя продукта не совпадает с именем функции)? - Пример:
Dependabot
- Пример:
- Является ли функция частью ограниченной программы?
- Пример:
Advanced Security
- Пример:
- Какой элемент компонента или продукта является статьей?
- Пример:
Organizations
- Пример:
- Какова широкая цель статьи?
- Пример:
Permissions
- Пример:
- Какие языки программирования, руководители пакетов или экосистемы явно рассматриваются в статье? Включайте только эти разделы, если он добавляет значение для кого-то, кто фильтрует документы, а не только если статья содержит поддерживаемые языки, диспетчеры пакетов или экосистемы.
- Пример:
Ruby
- Пример: