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

Тип содержимого ссылок

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

В этой статье

Мы создадим ссылки на статьи и ссылки в других статьях.

  • Для некоторых основных субъектов может потребоваться собственная справочная статья, особенно если имеется большое количество ссылочной информации, например синтаксис поиска или синтаксис YAML в GitHub Actions.
  • Для небольших объемов содержимого или более конкретных сведений, таких как список поддерживаемых языков или оборудования компонента, используйте ссылки в контексте в процедурных или концептуальных статьях.

Как написать ссылки на содержимое

Шаблон содержимого ссылки см. в разделе "Шаблоны".

  • Напишите предложение или весь концептуальный раздел, чтобы представить референциальное содержимое.
  • Представление фактического референциального содержимого четко и согласованно.
  • Для темы с одним элементом, чтобы объяснить, используйте список.
  • Для темы с несколькими элементами, чтобы объяснить, используйте таблицу.
  • Для более длинного ссылочного содержимого, например синтаксис YAML для рабочих процессов, последовательно используйте заголовки.

Заголовки для ссылочной информации

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

Примеры ссылочной информации