Эта версия GitHub Enterprise Server будет прекращена 2026-04-09. Исправления выпускаться не будут даже при критических проблемах безопасности. Для повышения производительности, повышения безопасности и новых функций выполните обновление до последней версии GitHub Enterprise Server. Чтобы получить справку по обновлению, обратитесь в службу поддержки GitHub Enterprise.

Тип контента с инструкциями

Объясните, как выполнить задачу с помощью GitHub продуктов и функций.

В этой статье

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

Инструкции посвящены минимальным необходимым шагам для выполнения задачи. Они могут ссылаться на другие типы контента как предварительные материалы (особенно концепции или справочные) или следующие шаги (особенно туториалы). В соответствии с нашей стратегией связи, эти средства должны использоваться только в тех случаях, когда они явно полезны и необходимы.

Обычно можно включить 1-2 коротких вводных предложения перед этапами. Если требуется дополнительное объяснение, выходящее за рамки нескольких предложений, рассмотрите возможность добавления информации в виде концептуальной статьи.

Устранение неполадок — это отдельный тип контента, но инструкции могут включать короткие разделы по устранению неполадок, которые помогают выполнить задачу.

Заголовки для статей с инструкциями

Обучающие заголовки и разделы в статьях основаны на задачах и начинаются с герундия.

  • Используй: «Подаю заявку на студенческий набор разработчиков». Используй активные и конкретные глаголы (мозговой штурм или тезаурус, когда нужно). Заголовки специально описывают задачу, содержащуюся в статье или заголовке, но достаточно общие, чтобы отразить все содержимое.

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

  • Использовать: «Управлять планом» или «Создавать проблемы с Copilot»

Инструкции по выполнению

Для шаблона с инструкциями см. Шаблоны.

  • Следуйте рекомендациям по стилю для процедурных действий в Руководство по стилю.
  • Инструкции могут стать однообразными — ищите возможности сгруппировать связанный контент в одну более длинную статью.
    • Сгруппируйте несколько связанных инструкций в одну статью, если нет веской причины этого не делать.
    • Если отключение настройки или отмена задачи требует тех же шагов и не имеет особых последствий, не пишите отдельное руководство.
    • Если отключение настройки или отмена задачи требует других шагов или имеет важные или особые последствия, создайте более длинную статью с обоими инструкциями.
  • Всегда указывайте желаемый результат инструкции (обычно это будет название).
  • Включите советы по устранению известных проблем.

Примеры обучающих материалов

  •         [AUTOTITLE](/actions/using-workflows/using-starter-workflows)