# Участие в документации по документам GitHub Узнайте, как GitHub Docs команда создаёт документацию и как вы можете внести свой вклад. ## Recommended * [Сведения об участии в GitHub Docs](/ru/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) Вы можете внести свой вклад в содержимое документации GitHub несколькими способами. * [Рекомендации по GitHub Docs](/ru/contributing/writing-for-github-docs/best-practices-for-github-docs) Следуйте этим рекомендациям, чтобы создать документацию, удобную и удобную для понимания. * [Руководство по стилю](/ru/contributing/style-guide-and-content-model/style-guide) Следуйте этому руководству, чтобы GitHubдокументация оставалась последовательной и следовала чётким шаблонам, понятным нашим читателям. * [О con режим палатки l](/ru/contributing/style-guide-and-content-model/about-the-content-model) Con режим палатки l описывает структуру и типы содержимого, которое мы публикуем. * [Использование Markdown и Liquid в документах GitHub](/ru/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs) Вы можете использовать Markdown и Liquid для форматирования содержимого, создания повторно используемого содержимого и записи содержимого для различных версий в GitHub Docs. * [Шаблоны](/ru/contributing/writing-for-github-docs/templates) В этой статье содержатся стартовые шаблоны для различных типов контента, используемых в GitHub Docs. ## Links ### Getting started * [Сведения об участии в GitHub Docs](/ru/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) Вы можете внести свой вклад в содержимое документации GitHub несколькими способами. * [Рекомендации по GitHub Docs](/ru/contributing/writing-for-github-docs/best-practices-for-github-docs) Следуйте этим рекомендациям, чтобы создать документацию, удобную и удобную для понимания. ## Articles * [Рекомендации по GitHub Docs](/ru/contributing/writing-for-github-docs/best-practices-for-github-docs) Следуйте этим рекомендациям, чтобы создать документацию, удобную и удобную для понимания. * [О философии документации GitHub](/ru/contributing/writing-for-github-docs/about-githubs-documentation-philosophy) Наша философия документации описывает, какие материалы мы создадим и как мы создадим его. * [Основные сведения о документации GitHub](/ru/contributing/writing-for-github-docs/about-githubs-documentation-fundamentals) Все содержимое, опубликованное на GitHub Docs, должно соответствовать этим основным требованиям. * [Принципы проектирования содержимого](/ru/contributing/writing-for-github-docs/content-design-principles) Мы совместно используем эти принципы для разработки и создания лучшего содержимого для пользователей, использующих GitHub. * [Написание содержимого для перевода](/ru/contributing/writing-for-github-docs/writing-content-to-be-translated) Наша документация переведена на несколько языков. Как мы подходим к написанию документации по английскому языку, значительно улучшили качество этих переводов. * [Создание доступных для поиска содержимого](/ru/contributing/writing-for-github-docs/making-content-findable-in-search) Следуйте этим рекомендациям по SEO, чтобы помочь пользователям найти документацию GitHub с помощью поисковых систем. * [Документация по управление версиями](/ru/contributing/writing-for-github-docs/versioning-documentation) GitHub Docs использует интерфейсные операторы YAML и операторы liquid для поддержки нескольких версий GitHub с одним исходным подходом. * [Использование Markdown и Liquid в документах GitHub](/ru/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs) Вы можете использовать Markdown и Liquid для форматирования содержимого, создания повторно используемого содержимого и записи содержимого для различных версий в GitHub Docs. * [Использование frontmatter YAML](/ru/contributing/writing-for-github-docs/using-yaml-frontmatter) Интерфейс YAML можно использовать для определения управления версиями, добавления метаданных и управления макетом статей. * [Создание повторно используемых содержимого](/ru/contributing/writing-for-github-docs/creating-reusable-content) Вы можете создать повторно используемый контент, на который можно ссылаться в нескольких файлах содержимого. * [Создание снимков экрана](/ru/contributing/writing-for-github-docs/creating-screenshots) Вы можете помочь пользователям находить элементы пользовательского интерфейса, которые трудно найти, добавив снимки экрана в GitHub Docs. * [Создание схем для GitHub Docs](/ru/contributing/writing-for-github-docs/creating-diagrams-for-github-docs) В этом руководстве объясняется, когда и как создавать схемы для GitHub Docs. * [Создание переключателей инструментов в статьях](/ru/contributing/writing-for-github-docs/creating-tool-switchers-in-articles) Вы можете использовать переключатель инструментов, чтобы показать, как выполнять задачи с помощью определенных средств. * [Настройка перенаправлений](/ru/contributing/writing-for-github-docs/configuring-redirects) Если название, версия или расположение статьи изменены, можно создать перенаправление к текущему содержимому. * [Изменение заголовка статьи](/ru/contributing/writing-for-github-docs/changing-an-articles-title) Если необходимо изменить название статьи, имя может потребоваться обновить в нескольких местах. * [Примеры кода аннотирования](/ru/contributing/writing-for-github-docs/annotating-code-examples) Более длинные примеры кода можно узнать, как они работают и как люди могут настраивать их для других использования. * [Шаблоны](/ru/contributing/writing-for-github-docs/templates) В этой статье содержатся стартовые шаблоны для различных типов контента, используемых в GitHub Docs. * [Руководство по стилю](/ru/contributing/style-guide-and-content-model/style-guide) Следуйте этому руководству, чтобы GitHubдокументация оставалась последовательной и следовала чётким шаблонам, понятным нашим читателям. * [О con режим палатки l](/ru/contributing/style-guide-and-content-model/about-the-content-model) Con режим палатки l описывает структуру и типы содержимого, которое мы публикуем. * [Содержание статьи на GitHub Docs](/ru/contributing/style-guide-and-content-model/contents-of-a-github-docs-article) Каждая статья содержит несколько стандартных элементов и может включать условные или необязательные элементы. Мы также используем стандартный порядок содержимого в статье. * [Понятия, тип содержания](/ru/contributing/style-guide-and-content-model/concepts-content-type) Люди чаще всего используют концептуальное содержимое, когда они учатся о чем-то новом для них. * [Тип справочного контента](/ru/contributing/style-guide-and-content-model/reference-content-type) Справочный контент предоставляет подробную информацию, необходимую людям во время активного использования функции. * [Тип контента с инструкциями](/ru/contributing/style-guide-and-content-model/how-to-content-type) Объясните, как выполнить задачу с помощью GitHub продуктов и функций. * [Устранение неполадок с типом контента](/ru/contributing/style-guide-and-content-model/troubleshooting-content-type) Устранение неполадок содержимого включает встроенные ошибки, которые мы ожидаем, что люди столкнулись, распространенные проблемы, сообщаемые для поддержки, и ситуации, которые могут возникнуть при выполнении задач. * [Тип содержимого заметки о выпуске](/ru/contributing/style-guide-and-content-model/release-note-content-type) Заметки о выпуске позволяют читателям понять и подготовиться к изменениям, которые сталкиваются с пользователем в каждом выпуске GitHubверсий корпоративных продуктов. * [Тип контента для начала](/ru/contributing/style-guide-and-content-model/get-started-content-type) Контент Get Start предоставляет минимальную необходимую информацию для использования продукта или функции. * [Тип контента быстрого запуска](/ru/contributing/style-guide-and-content-model/quickstart-content-type) Краткие руководства лучше всего подходят для людей, которые хотят быстро инструкции без подробных объяснений о том, как что-то работает или почему они хотели бы использовать его. * [Тип контента учебника](/ru/contributing/style-guide-and-content-model/tutorial-content-type) Учебники полезны, если у кого-то есть базовое понимание продукта и заинтересованы в расширении их понимания для решения конкретной проблемы * [Объединение нескольких типов контента](/ru/contributing/style-guide-and-content-model/about-combining-multiple-content-types) Вы можете объединить несколько типов контента в одной статье, чтобы помочь людям выполнять сложные задачи. * [Сведения об участии в GitHub Docs](/ru/contributing/collaborating-on-github-docs/about-contributing-to-github-docs) Вы можете внести свой вклад в содержимое документации GitHub несколькими способами. * [Использование Git на сайте GitHub Docs](/ru/contributing/collaborating-on-github-docs/using-git-on-github-docs) Вы можете использовать Git в командной строке для фиксации изменений, а затем отправить их в репозиторий документации. * [Использование заполнителя TODOCS для выхода заметок](/ru/contributing/collaborating-on-github-docs/using-the-todocs-placeholder-to-leave-notes) Заполнитель `TODOCS` можно использовать для указания работы, которая по-прежнему должна быть завершена. * [Использование содержимого](/ru/contributing/collaborating-on-github-docs/using-the-content-linter) Вы можете использовать содержимое linter для проверки ваших вкладов на наличие ошибок. * [Справочник по метки](/ru/contributing/collaborating-on-github-docs/label-reference) Метки помогут вам найти проблему, с которыми вы хотите помочь. * [Работа с документами GitHub в пространстве кода](/ru/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace) Для работы с документацией для GitHub Codespacesможно использовать GitHub Docs. * [Создание локальной среды](/ru/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment) Приложение GitHub Docs можно запускать локально на компьютере. * [Устранение неполадок с средой](/ru/contributing/setting-up-your-environment-to-work-on-github-docs/troubleshooting-your-environment) Узнайте об устранении неполадок в локальной среде и промежуточной платформе GitHub Docs .