Написание документов GitHub

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

Наша философия документации описывает, какие материалы мы создадим и как мы создадим его.

Все содержимое, опубликованное на GitHub Docs, должно соответствовать этим основным требованиям.

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

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

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

GitHub Docs использует интерфейсные операторы YAML и операторы liquid для поддержки нескольких версий GitHub с одним исходным подходом.

Вы можете использовать Markdown и Liquid для форматирования содержимого, создания повторно используемого содержимого и записи содержимого для различных версий в GitHub Docs.

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

В этом руководстве объясняется, как создавать видео, поддерживающие потребности пользователей в GitHub Docs.

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

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

В этом руководстве объясняется, когда и как создавать схемы для GitHub Docs.

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

Если название, версия или расположение статьи изменены, можно создать перенаправление к текущему содержимому.

Если необходимо изменить название статьи, имя может потребоваться обновить в нескольких местах.

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

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