Skip to main content

О философии документации GitHub

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

О философии документации по GitHub

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

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