Объединение нескольких типов контента

Вы можете объединить несколько типов контента в одной статье, чтобы помочь людям выполнять сложные задачи.

В этой статье

Часто полезно группировать информацию в контексте, чтобы помочь людям выполнить сложную задачу, понять набор связанных задач или проиллюстрировать весь рабочий процесс. Используйте более длинные статьи, объединяющие типы контента, чтобы убедиться, что люди находят контекстное содержимое в нужном месте. Более длинные статьи также помогают исключить дублирование содержимого и подготовить содержимое для масштабирования по мере добавления дополнительных параметров в продукт. Люди чаще всего нуждаются в более длинных статьях во время активного использования продукта, и им может потребоваться обратиться к статье в различных точках их путешествия.

Объединение нескольких типов контента в статье

  • Используйте концептуальное, процедурное, референциальное, устранение неполадок или известное содержимое проблемы в более длинной статье, а также не используйте краткие руководства или руководства.
  • Используйте разделы различных типов контента в статье по мере необходимости и следуйте рекомендациям по заголовку для типа контента.
  • Чаще всего эти статьи будут содержать по крайней мере один процедурный раздел плюс хотя бы один дополнительный концептуальный, референтный или процедурный раздел.
  • Используйте рекомендации по упорядочению содержимого для упорядочивания заголовков в статье.
  • Используйте сведения об устранении неполадок как можно чаще.
  • При необходимости вы можете реплицировать заголовок статьи в заголовке.

Рекомендации по заголовку статей, которые объединяют несколько типов контента

  • Если в статье есть процедура, используйте название на основе задач, начинающееся с герунда.
  • Заголовки достаточно общие, чтобы описать диапазон информации и задач, содержащихся в статье.
  • Заголовки описывают параметр, который переключается и не зависит от того, какой параметр выбирает читатель, например "Настройка видимости репозитория" вместо "Создание общедоступного частного репозитория".

Примеры статей, которые объединяют несколько типов контента

  •         [AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)

  •         [AUTOTITLE](/enterprise-cloud@latest/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise)

  •         [AUTOTITLE](/free-pro-team@latest/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription)

  •         [AUTOTITLE](/enterprise-server@latest/admin/configuration/enabling-and-scheduling-maintenance-mode)