Skip to main content

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

Устранение неполадок с типом контента

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

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

Известные проблемы

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

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

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

Владельцы продуктов и компонентов (PMs и EMs) должны помочь спланировать и просмотреть известное содержимое проблемы.

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

  • Поведение продукта, которое регулярно противоречит ожиданиям людей, но пока не является приоритетным для исправления.
  • Поведение, которое регулярно предотвращает использование продукта или компонента для общей цели.
  • Редкие или серьезные ошибки, которые GitHub еще не определены в приоритете, и которые не объясняются в продукте или существующим содержимым на GitHub Docs.

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

  • Используйте любой тип контента GitHub Docs для создания разделов устранения неполадок.
  • По возможности продолжайте устранять неполадки с содержимым, содержащимся в процедурных содержимом или руководствах.
  • Вы можете создать статью по устранению неполадок, если имеет смысл сохранить ее отдельно, например при наличии большого количества содержимого по устранению неполадок в определенной теме.
  • Вы можете создать раздел карты устранения неполадок, если продукт или компонент содержит множество статей по устранению неполадок, напримерУстранение неполадок с SSH.

Рекомендации по устранению неполадок с содержимым

  • Устранение неполадок с ФУНКЦИЕЙ
  • Ошибка: ИМЯ ОШИБКИ
  • Известные проблемы для PRODUCT

Примеры устранения неполадок с содержимым