Skip to main content

Sobre a filosofia de documentação do GitHub

Nossa filosofia de documentação orienta qual conteúdo criamos e como o criamos.

Sobre a filosofia de documentação do GitHub

Como o lar da maior comunidade de desenvolvedores do mundo, desejamos garantir que nossa documentação seja precisa, valiosa, inclusiva e fácil de usar. Nossa filosofia de documentação nos leva a essas metas.

  • Defendemos nossos usuários. Isso pode ocorrer a qualquer momento no processo de documentação, do planejamento à escrita e à publicação. Respondemos aos comentários e trabalhamos proativamente para criar a melhor experiência de usuário possível no site do GitHub Docs.
  • Escrevemos para um público-alvo internacional, de modo que nosso conteúdo possa ser traduzido e inclua todas as pessoas.
  • Criamos conteúdo que pode ser acessado por um amplo grupo de usuários. Nosso kit de ferramentas de conteúdo inclui recursos e diretrizes para reduzir as barreiras para pessoas com deficiências e priorizamos manter-se atualizados com os padrões de acessibilidade mais recentes.
  • Criamos conteúdo baseado em tarefas. Consideramos o que as pessoas estão tentando realizar quando usam o GitHub e, em seguida, criamos um conteúdo que as ajuda a atingir as metas e descobrir novas possibilidades.
  • Colaboramos com as equipes do GitHub e com a comunidade de código aberto para criar conteúdo de alta qualidade.
  • Aprendemos e aprimoramos continuamente para coletar a melhor experiência para as pessoas que usam o GitHub.