Руководство по стилю и con режим палатки l

Следуйте этому руководству, чтобы убедиться, что документация GitHubостается согласованной и соответствует четким шаблонам, которые могут понять наши читатели.

Con режим палатки l описывает структуру и типы содержимого, которое мы публикуем.

Каждая статья содержит несколько стандартных элементов и может включать условные или необязательные элементы. Мы также используем стандартный порядок содержимого в статье.

Используйте разделы, чтобы сделать статьи доступными для поиска.

Люди чаще всего используют концептуальное содержимое, когда они учатся о чем-то новом для них.

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

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

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

Заметки о выпуске позволяют читателям понять и подготовиться к изменениям, которые сталкиваются с пользователем в каждом выпуске GitHubверсий корпоративных продуктов.

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

Учебники полезны, если у кого-то есть базовое понимание продукта и заинтересованы в расширении их понимания для решения конкретной проблемы

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