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

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

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

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

People most often use conceptual content when they are learning about something new to them.

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

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

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

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

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

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

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