Сведения о темах

Разделы используются для фильтрации статей и доступны для поиска по сайту GitHub Docs . Для некоторых макетов, таких как целевые страницы или руководства, пользователи могут выбрать, какие статьи отображаются путем фильтрации тем. Используйте эти рекомендации, чтобы выбрать разделы, которые нужно добавить в интерфейсную часть статьи. Дополнительные сведения о добавлении тем в статью см. в разделе "Темы" и список всех разрешенных разделов.allowed-topics

Разделы для всех типов контента

• Все статьи должны иметь по крайней мере один раздел
• Использование существительных в качестве разделов
• Разделы помогают людям осмысленно группировать содержимое
  • По возможности используйте более конкретные темы, которые являются актуальными и не только широкими. Например, или GraphQL вместо того, REST чтобы простоAPI
  • Убедитесь, что разделы по аналогичным статьям согласованы таким образом, чтобы пользователи, которые фильтрулись по теме, получают все соответствующие статьи. Например, все статьи о CI должны содержать CI раздел, а также более конкретные темы
  • Избегайте неоднозначных тем. Например, не может быть полезным разделом в продукте Actions, Actions так как он может ссылаться на продукт GitHub 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